Pular para o conteúdo principal

Criar e Publicar Infraestrutura via Portal

Nesta seção, você encontra um guia de como criar e publicar a sua Infraestrutura no Portal da StackSpot.


Uma Infraestrutura na StackSpot é composta por Stacks que contêm Plugins de Infraestrutura. Esses Plugins geram os componentes de infraestrutura (código IaC). O processo é semelhante a criar uma Aplicação, que gera código-fonte a partir de Plugins de Aplicação.

Pré-requisitos

  • Ser membro de um Workspace.
  • Ter feito login em sua conta StackSpot.
  • Ter acesso a um Estúdio.
  • Ter uma Stack e um Starter disponíveis.
  • Ter ambientes criados na sua conta.
  • Ter configurado o Deployment via Self-Hosted para conectar os ambientes na Conta Cloud.
  • Ter o SCM configurado (configuração feita pela pessoa responsável por administrar sua conta).
  • Caso sua conta seja Enterprise e a administração decida que os usuários devem gerenciar o acesso ao
    SCM
     via PAT (Personal Access Token) de forma individual    , você deve configurá-lo em 'Conexões Externas'.

Se você não cumprir algum dos requisitos acima, complete-o antes de seguir este guia.


Siga os passos para criar sua Infraestrutura no Portal

Passo 1. Faça login no Portal StackSpot EDP;

Passo 2. No menu lateral, clique no botão 'Criar' e selecione a opção ’Infraestrutura’;

Atenção!

  • Caso a pessoa administradora da sua Conta não tenha configurado o SCM, você não poderá prosseguir. Para mais detalhes, confira a seção Configurar SCM.

  • Caso a pessoa administradora da sua Conta exija que os usuários gerenciem o acesso ao SCM via PAT (Personal Access Token) individualmente, você deve configurá-lo em 'Conexões Externas'.

Passo 3. Selecione:

  • Workspace: O Workspace onde você quer criar sua Infraestrutura;
  • Stack: Uma Stack base de infraestrutura e sua versão;
  • Starter: Um Starter, que é um modelo pré-definido com as especificações de um conjunto de Plugins. Escolher um Starter é opcional.

Clique no botão ‘Próximo’.

Confira o processo no GIF abaixo:

GIF demonstrando a seleção de Workspace, Stack e Starter durante a criação de uma infraestrutura


informação
  • A Stack de Infraestrutura já foi criada. Agora, você precisa configurá-la e enviá-la.
  • Você verá uma lista com os Plugins de Infraestrutura pré-selecionados da Stack. É possível escolher quais você deseja aplicar.

Passo 4. Na tela 'Criar Infraestrutura', informe os dados:

  • Nome: Nome da Infraestrutura;
  • Descrição: Breve descrição da Infraestrutura.

Passo 5. Na tela 'Repositório do Código Fonte', escolha o repositório para sua Infraestrutura. Existem duas opções:

  1. Criar um repositório do zero: Esta opção estará disponível apenas se houver uma Action vinculada a este passo no Workflow. Preencha:
    • Nome: Nome do repositório.
    • Visibilidade: Se o repositório será público ou privado no SCM.
    • Descrição: Breve descrição para o repositório.

Os campos desta seção podem variar conforme o Workflow configurado. Por exemplo, sua Organização pode ter Actions configuradas com inputs diferentes deste exemplo.


Você pode editar esse passo apenas se o Account Holder liberar o acesso.


  1. Já tenho um repositório:
    • URL: Adicione a URL do repositório existente.
Atenção!

Antes de acessar os Plugins, caso existam outras Actions configuradas na etapa Before (antes), elas serão exibidas como etapas sequenciais. Preencha as informações necessárias em cada passo.

Clique em 'Próximo'.


Passo 6. Aplique os Plugins na sua Infraestrutura. Os Plugins da Stack selecionada estarão listados.

  • Para adicionar mais Plugins, clique no botão 'Adicionar Plugins', selecione os desejados e clique em 'Adicionar Plugins' para confirmar.

Passo 7. Configure cada Plugin preenchendo seus campos de entrada (inputs). Para configurar, clique no Plugin para expandir a aba, conforme a imagem abaixo:

Para saber mais sobre regras de preenchimento, confira a seção de Configuração de Inputs.


Tela de configuração de plugins no Portal StackSpot, exibindo campos para preenchimento

Cuidado!

Se o Plugin contiver a flag single-use, você não poderá adicioná-lo mais de uma vez.


  • Exemplo:
    Se você precisa de dois Buckets S3 na sua Infraestrutura (um para imagens e outro para logs), deve aplicar o Plugin duas vezes. Se o Plugin for single-use, ele só permite uma aplicação. Nesse caso, você precisaria de um Plugin que suporte múltiplas instâncias ou de outro Plugin equivalente.

Informações importantes sobre alguns inputs

  • ID do Plugin: Este campo serve para nomear a utilização do Plugin e indicar seu objetivo, já que Plugins podem ser aplicados múltiplas vezes. Ele vem preenchido automaticamente, mas você pode editá-lo clicando no campo.
    O ID do Plugin é imutável após a criação. Este é o único momento para editá-lo.

Campo ID do Plugin em destaque na tela de configuração

  • Definir valores por ambiente: Se o Plugin possui scope: env configurado no YAML, é possível parametrizar valores por ambiente:

    1. No Portal, localize a opção 'Definir valores por ambientes';
    2. Selecione-a e configure os inputs para cada ambiente desejado.

  • Campo 'Nomeie recursos para usar depois': Se o Plugin foi criado com Schema v.2 e gera uma Connection Interface, nomeie-a neste campo.

  • Campo 'Recursos Requerido': Se o Plugin foi criado com Schema v.2 e exige uma Connection Interface, selecione uma opção clicando no campo.

Confira na imagem um exemplo para Plugins com Schema v.2:


Campos de input 'Nomeie recursos para usar depois' e 'Recurso Requerido' em destaque

  • Uma lista de Connection Interfaces já provisionadas será exibida. Você pode:
    1. Selecionar uma das interfaces listadas; ou
    2. Escolher outro Plugin para gerar a Connection Interface necessária clicando em 'Adicionar connection de um Plugin'.
Cuidado!

Se o Plugin utiliza Schema v3, os textos dos inputs de Connection Interfaces são definidos por quem desenvolveu o Plugin. Portanto, podem variar e não seguir um padrão fixo. Em caso de dúvidas, consulte a documentação do Plugin.

Passo 8. Após configurar todos os Plugins, clique no botão 'Próximo'.

Informação Adicional
  • Uma tag indica o status de configuração do Plugin. Quando finalizado, a tag fica verde ('Plugin Configurado').
  • Se houver contextos definidos, algumas variáveis podem vir preenchidas e bloqueadas para edição (caso sejam obrigatórias).

Passo 9. Se o Workflow configurado possuir passos adicionais (Actions na etapa 'After' ou Extensões), preencha as informações solicitadas.

Extensões configuradas no workflow.yaml funcionam apenas via Portal.

Passo 10. Revise as informações da sua Infraestrutura. Se necessário, clique em 'Editar' para fazer alterações.

Passo 11. Clique em 'Criar' para enviar a Infraestrutura para o repositório.

Atenção!

O deploy da Infraestrutura (provisionamento na nuvem) só ocorrerá automaticamente neste momento se sua organização tiver configurado o deploy via Runtime Self-Hosted.

Pronto, você criou a sua Infraestrutura.

Dica!
  • A sua Infraestrutura é publicada no Workspace.
  • O commit do código é feito no repositório Git informado.

Após a finalização do Workflow, a Infraestrutura estará disponível para uso em Aplicações.

Erro ao criar uma Infraestrutura


Veja como reexecutar o 'Workflow de Criação' em caso de erro. Este processo é possível apenas via Portal.


Ao clicar em 'Criar' (ou Executar), você inicia um Workflow. Se este Workflow falhar, a criação é interrompida. Você precisará verificar o erro e reexecutar o Workflow.

Siga os passos:


Passo 1. No Workspace, localize a janela 'Running' (Executando) no canto inferior esquerdo e clique em 'Ver detalhes'.


Informação Adicional

Se você fechou o modal com o log de execução:

  1. Acesse seu Workspace;
  2. No menu lateral, clique em 'Infraestruturas' e selecione a Infraestrutura criada;
  3. Clique em 'Atividades' no menu da Infraestrutura;
  4. Selecione o Workflow com falha e analise o atributo "errorLog";
  5. No log, clique no botão 'Retornar para a revisão da criação da Infraestrutura';
  6. Continue a partir do 'Passo 3' abaixo.

Passo 2. Na página de 'Commit', clique em 'Voltar para Revisão';

Passo 3. Verifique os dados, edite o que for necessário clicando em 'Editar' ou use o botão 'Voltar' para navegar entre as etapas;

Passo 4. Salve as alterações e clique novamente no botão 'Commit' (ou Criar).

Atenção!

Se o erro persistir, repita o processo de análise do log.


Editar nome e descrição da Infraestrutura no Portal

Mesmo após o deploy, você pode editar o nome e a descrição da sua Infraestrutura.

Passo 1. Faça login no Portal StackSpot EDP e clique em ’Infraestruturas’ no menu principal;

Passo 2. Selecione sua Infraestrutura para acessar o dashboard. No menu lateral, clique em 'Configurações';

Passo 3. Visualize as informações básicas. Clique em 'Editar', faça as alterações desejadas e clique em 'Salvar'.

Próximos passos

Atenção!

Após criar sua Infraestrutura, é preciso realizar o deploy (caso não tenha ocorrido automaticamente). Os passos variam conforme a configuração da sua Organização. Contate o Administrador da Conta para detalhes sobre o ambiente Self-hosted.