Criar Infraestrutura com Starter Local

Nesta seção, você encontra um guia de como criar a sua Infraestrutura com um Starter local.

Para criar uma Infraestrutura, você precisa escolher um Starter que contenha o conjunto de Plugins a serem aplicados. A Infraestrutura pode ser criada dentro ou fora de um Workspace, mas o Starter e os Plugins devem estar obrigatoriamente publicados e disponíveis em um Estúdio na plataforma da StackSpot.

Para facilitar o desenvolvimento e testes, é possível criar o seu Starter localmente e utilizar Plugins publicados para gerar sua Infraestrutura. Antes de começar, considere as observações a seguir:

Atenção!

1. Ao criar a Infraestrutura, o Starter local desconsidera o Workspace. Portanto, Infraestruturas criadas com um Starter local não podem ser registradas ou passar por deploys na StackSpot.

2. O arquivo do Starter precisa estar dentro da pasta de uma Stack.

Gerar estrutura do Starter local

Primeiro, acesse a pasta de uma Stack. Caso você não tenha uma Stack, confira a seção para criar uma Stack com o STK CLI.

Passo 1. Criar o Starter

Dentro da pasta da sua Stack, execute o comando a seguir e preencha as informações do Starter.

stk create starter

Responda às perguntas no seu terminal:

• Nomeie seu starter: Digite um nome para o seu Starter.
• Tipo: Informe o tipo do Starter. Para criar uma Infraestrutura, escolha o tipo Infra.
• Você deseja iniciar um repositório git?: Digite S para iniciar ou N para não iniciar um repositório Git.
• Adicionar remote?: Se você iniciou o repositório Git, responda S para adicionar um repositório remoto ou N para não adicionar.
• Git URL para definir como remote origin: Adicione a URL do repositório remoto (por exemplo, um repositório do GitHub).
• Descrição do starter: Adicione uma descrição explicando o propósito do Starter.

Certifique-se de que o nome do Starter foi adicionado em seu arquivo stack.yaml.

Passo 2. Adicionar os Plugins ao Starter

Dentro da Stack, a pasta starters é gerada contendo o arquivo starter.yaml. A estrutura é semelhante ao exemplo:

/starters/starter.yaml

schema-version: v1
kind: starter
metadata:
  name: local-starter-infra
  description: Describe your starter explaining its purpose
spec:
  type: infra
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md  

O Starter é minimamente funcional. Você precisa adicionar os Plugins dos Estúdios aos quais tem acesso. Utilize o padrão a seguir para adicionar os Plugins desejados:

/starters/starter.yaml

schema-version: v1
kind: starter
metadata:
  name: local-starter-infra
  description: Describe your starter explaining its purpose
spec:
  type: infra
  docs:
    en-us: docs/en_us/docs.md
    pt-br: docs/pt_br/docs.md  
  plugins:
    required:
      - name: studio-slug/<plugin-name>
    optional:
      - name: studio-slug/<plugin-name> 

Confira o exemplo no GIF a seguir:

Com a Stack e o Starter prontos, siga para a criação da Infraestrutura.

Criar Infraestrutura com o Starter Local

Execute o comando para criar a Infraestrutura informando a opção --starter e adicione o caminho completo do arquivo do Starter.

O comando a seguir cria uma Infraestrutura com o nome infra-with-local-starter. Este é apenas um exemplo, você pode informar o nome que desejar.

Nota: O caminho do arquivo do Starter no exemplo é ilustrativo. Informe o caminho completo do Starter que você criou na pasta da sua Stack.

stk create infra infra-with-local-starter --starter /User/Documents/Stacks/my-stack-test2/starters/starter.yaml

A Infraestrutura é criada e os Plugins listados no Starter são aplicados. Se desejar, consulte outras opções:

• Utilize as outras opções do comando stk create infra.
• Confira mais detalhes sobre a criação de uma Infraestrutura neste guia.