stk create template

Nesta seção, você encontra mais informações sobre o comando ‘stk create template’.

Descrição

O comando stk create template cria a estrutura de um Template de Stack. Essa estrutura contém os arquivos necessários para criar um Template.

Esse Template será usado no stk create app, no stk create env ou em ambos os comandos.

Como funciona?

Ao executar o comando no terminal dentro da pasta de uma Stack, uma sub-pasta é gerada com a estrutura para criar o Template. O usuário deve editar o arquivo template.yaml e configurar os parâmetros de entrada do Template.

Criar Templates em repositórios separados

Se você quiser criar um Template separado de uma Stack para poder ser utilizado em mais de uma Stack, é preciso executar o comando no terminal fora da uma pasta de uma Stack. Depois disso, uma pasta é gerada com a estrutura para criar o Template.

Esta pasta será inicializada como um repositório Git.

O usuário deve editar o arquivo template.yaml e configurar os parâmetros de entrada do Template.

Parâmetros

A sintaxe do comando é: stk create template [OPTIONS] [NAME]

Confira a opção disponível no comando:

ParâmetroDescrição
NAMEDefine o nome do Template criado. Se o nome não for informado, é definido o nome do repositório do parâmetro --remote.
--descriptionÉ o texto que descreve o Template e a sua finalidade. Esta descrição também será exibida no comando stk list template para que o usuário saiba sobre o Template.
--remoteÉ um parâmetro que define a url remota do repositório Git, que será usada como origin para o Template. Se o usuário não informar o remote, será preciso executar o git add remote para poder publicar o Template no Git. Ele deve ser usado somente em casos que estejam usando repositórios separados para Templates.

Parâmetros Depreciados

ParâmetroDescrição
--typesDefine os tipos do Template. O Template pode ser aplicado nos comandos stk create app, stk create env ou nos dois. Se for aplicado nesta última, os valores para isso são: app-template e env-template. Para definir mais de um tipo de Template, use uma vírgula.
--deployAdiciona uma seção de ciclo de vida no plugin.yaml, onde você pode definir os comandos executados pelo stk deploy do CLI.

Exemplos

Confira um exemplo de template abaixo:

Leia também