Criar Connection Interface
Nesta seção, você encontra como criar Connection Interfaces.
O que é uma Connection Interface?
Connection Interface é um contrato com parâmetros, inputs, variáveis ou lista de atributos que um conjunto de recursos de Nuvem precisa ter para ser conectável ou compatível entre si.
Uma Connection Interface é criada ao usar um Plugin de Infraestrutura que implementa uma Connection Interface Type ao gerar peças de Cloud. Dessa forma, qualquer Aplicação compatível com o contrato da Connection Interface pode usar o mesmo conjunto de recursos, já que seguem a mesma interface.
A instância de uma Connection Interface só é gerada após a aplicação de um Plugin e quando acontece o deploy de uma Infraestrutura ou Aplicação. Confira a imagem a seguir:
Exemplo
Imagine que você tem um ECS Cluster Fargate provisionado na AWS. A forma como você irá utilizá-lo e como esse recurso está provisionado e configurado é chamada de Connection Interface. O nome dessa interface será ECS Cluster Fargate Conn.
Como criar uma Connection Interface manualmente no Workspace
Você pode criar uma Connection Interface manualmente no seu Workspace. Siga os passos a seguir:
Passo 1. Faça login no Portal StackSpot EDP e no menu principal da página inicial clique em ’Workspaces’;
Passo 2. No menu principal do Workspace, clique em 'Connection Interfaces';
Passo 3. Selecione aba Criada por pessoas usuárias;
Passo 4. Clique no botão Criar Connection Interface';
Passo 5. Na tela de 'Informações', preencha o campo de 'Nome'. 'Selecione o tipo de conexão'. Em seguida, clique no botão 'Próximo';
Passo 6. Em 'Parâmetros', insira os valores dos parâmetros da sua Connection Interface.
Por padrão, os valores serão aplicados a todos os ambientes. Para definir valores específicos por ambiente, escolha a opção 'Definir valores por ambiente' e faça as alterações para cada um.
Confira mais detalhes sobre cada tipo de output para cada tipo de Connection Interface na seção Parâmetros.
Geralmente, os parâmetros são do tipo string. Porém, alguns tipos de Connection Interface possuem parâmetros do tipo Object ou Array e que devem ser inseridos como JSON de acordo com o JSON Schema mostrado no editor de texto.
Passo 7. Na tela de 'Resumo', revise as informações e, em seguida, clique no botão 'Concluir'.
Pronto, você criou uma Connection Interface. Para configurá-la, confira o passo a passo a seguir.
Como configurar a visibilidade de uma Connection Interface no Workspace
Você pode configurar a visibilidade das Connection Interfaces existentes no seu Workspace. Ou seja, escolher se os usuários podem ver a Connection Interface a nível da Conta, Aplicação ou Workspace.
Confira as regras de visibilidade:
- Conta: todos os usuários da Conta podem visualizar e usar a Connection Interface.
- Workspace: apenas os membros dos Workspaces selecionados podem utilizar a Connection Interface
- Aplicação: apenas as Aplicações selecionadas podem utilizar a Connection Interface.
Para configurar, siga os passos:
Passo 1. No menu principal do Workspace, clique em 'Connection Interfaces'
Passo 2. Clique em uma das opções da lista de Connection Interfaces disponíveis para configurar;
Passo 3. Ao final da tela, clique em 'Visibilidade' e selecione o nível de visibilidade que deseja configurar. Logo após, confira se a visibilidade foi alterada no seu Workspace.
Agora você tem a Connection Interface criada, configurada e pronta para ser usada.
Os dados da Connection Interface que serão exibidos na tela não serão tratados como sensíveis.
Parâmetros
Os outputs do Terraform serão expostos como outputs do Connection Interface Type.
Para mais informações, acesse a página Contratos de Connection Interface Types
Como referenciar uma Connection Interface no Jinja
Você pode referenciar Jinja na Connection Interface, confira:
V2:
Você pode acessar os atributos das Connection Interfaces usando um connection. Além disso, também é possível incluir um alias na sintaxe. Há duas formas de acessar os atributos:
- Kebab case: acessar os atributos usando
{e uma string , semelhante a um dicionário. Confira o exemplo:
{{connections["connection-interface-one"].engine}}
- Snake case: converta o Kebab case para Snake case. Exemplo:
{{connections.connection_interface_one.is_stackspot_fun}}
Uma opção extra é acessar através de um Camel case. Confira o exemplo:
{{connections["connectionInterfaceOne"].engine}}