Comandos de Workflow
Nesta seção, você encontra a lista dos comandos de Workflow.
Comando Descrição stk create workflow Cria uma estrutura básica de um Workflow e o arquivo workflow.yaml.stk list workflow Lista todos os Workflows registrados em um Workspace ativo ou Estúdio. stk publish workflow Publica o seu Workflow em um Estúdio no Portal da StackSpot EDP. stk resume workflow Inicia a execução de Workflows com a execução suspensa. stk run workflow Executa um Workflow do tipo reusable.stk validate workflow Valida a estrutura de um Workflow.
stk create workflow
O comando stk create workflow cria uma estrutura básica de um Workflow.
Uso
Para criar um Workflow, execute o comando abaixo e informe um nome para o Workflow. Preencha os dados do Workflow no terminal ou informe diretamente pela linha de comando:
stk create workflow NOME-WORKFLOW --description "TEXTO DA DESCRIÇÃO" --type deploy/destroy/rollback/starter/reusable --target "./CAMINHO/PARA/OUTRA/PASTA" --non-interactive
Exemplo:
stk create workflow sqs-workflow-config --description "Configuração de uma fila AWS SQS" --type deploy --target "localUser/Documents/infra-workflows" --non-interactive
Parâmetros
| Opções | Descrição | Exemplo |
|---|---|---|
-d, --description TEXT | Texto para descrever o Workflow e o seu propósito. | stk create workflow nome-workflow --description "Descrição do Workflow" |
-o, --target TEXT | A opção -o, --target define o caminho do diretório onde o Workflow será adicionado. Caso contrário o Workflow é criado na pasta atual. | stk create workflow meu-workflow --target "home/user/Documents" |
-t, --type TEXT | Define o tipo do Workflow. Os tipos disponíveis são deploy,destroy,rollback,starter,reusable. | stk create workflow nome-workflow --description "Descrição do Workflow" --type reusable |
-q, --non-interactive | Não pergunta para o usuário por parâmetros de entrada que faltam e retorna um erro caso algum parâmetro obrigatório não tenha sido fornecido. | stk create workflow nome-workflow --description "Descrição do Workflow" --type reusable --non-interactive |
-h, --help | Exibe a ajuda do comando e sai. | stk create workflow --help |
stk list workflow
O comando stk list workflow lista todos os Workflows de um Estúdio ou Workspace. Se você estiver com um Workspace ativo, os Workflows deste Workspace serão listados, caso contrário você deve informar o nome de um Estúdio para listar os Workflows de um Estúdio.
Uso
Para listar os Workflows de um Workspace:
- Primeiro acesse um Workspace com o comando:
stk use workspace NOME-WORKSPACE
- Liste os Workflows do Workspace ativo:
stk list workflow
Para listar os Workflows de um Estúdio:
- Certifique-se de que não esteja com um Workspace ativo, execute o comando a seguir:
stk exit workspace
- Execute o comando a seguir informando o nome (slug) do seu Estúdio:
stk list workflow --studio NOME-ESTUDIO
Parâmetros
| Opções | Descrição | Exemplo |
|---|---|---|
-stu, --studio TEXT | Filtra os Workflows pelo nome do Estúdio (slug do Estúdio). | stk list workflow --studio techwriters-studio |
-h, --help | Exibe a ajuda do comando e sai. | stk list workflow --help |
stk publish workflow
O comando stk publish workflow faz a publicação de um Workflow em um Estúdio na plataforma StackSpot EDP.
Uso
Dentro da pasta do Workflow, execute o comando a seguir e informe o nome do Estúdio (slug do Estúdio) em que o Workflow será publicado:
stk publish workflow --studio NOME-ESTUDIO --verbose
Exemplo:
stk publish workflow --studio techwriters-studio --verbose
Parâmetros
| Opções | Descrição | Exemplo |
|---|---|---|
-s, --studio | Nome do Estúdio (slug do Estúdio) para publicar o Workflow. | stk publish workflow --studio techwriters-studio |
-v, --verbose | Habilita no terminal a exibição do log das etapas de publicação do Workflow. | stk publish workflow --studio techwriters-studio --verbose |
-h, --help | Exibe a ajuda do comando e sai. | stk publish workflow --help |
stk resume workflow
O comando stk resume workflow inicia a execução de um Workflow pausado ou suspenso.
Um Workflow fica "pausado" em uma pipeline até ser identificado e executado automaticamente pelo STK CLI com o comando stk resume workflow. Para execuções locais o comando stk resume workflow deve ser executado manualmente.
Workflows suspensos (status suspend), são Workflows que têm a sua execução suspensa pelo mecanismo de "Aprovação". Ocorre quando um dos passos do Workflow precisa de aprovação de um administrador da Conta ou Workspace para continuar a execução do passo. O comando stk resume workflow é acionado após o passo do Workflow for aprovado.
Uso
Execute o comando a seguir e informe o ID do Workflow:
stk resume workflow WORKFLOW-ID
Para execuções locais, informe o ID e o caminho da pasta do Workflow:
stk resume workflow WORKFLOW-ID --path "./Documents/workflows-stk/"
O ID do Workflow é obtido no log do terminal após a sua execução.
Parâmetros
| Opções | Descrição | Exemplo |
|---|---|---|
-p, --path TEXT | Caminho para a pasta de um Workflow local que está em execução. | stk resume workflow WORKFLOW-ID --path "./Documents/workflows-stk/" |
-h, --help | Exibe a ajuda do comando e sai. | stk add action --help |
stk run workflow
O comando stk run workflow executa Workflows do tipo reusable.
Uso
Para executar um Workflow do tipo reusable execute o comando a seguir:
Sintaxe:
stk run workflow NOME-WORKFLOW|CAMINHO/PASTA/WORKFLOW --inputs-json '{"input_1": "valor", "input_2": "valor"}' --non-interactive --report-status --env NOME-AMBIENTE
Exemplo:
stk run workflow documentation-wf-reusable --inputs-json '{"input_1": "valor", "input_2": "valor"}' --non-interactive --report-status --env dev
Execução local do Workflow:
stk run workflow /Documents/Workflows/documentation-wf-reusable --inputs-json '{"input_1": "valor", "input_2": "valor"}' --non-interactive --report-status --env stg
Parâmetros
| Opções | Descrição | Exemplo |
|---|---|---|
-i, --inputs-json TEXT | Informa os valores dos inputs do Workflow no formato JSON. | stk run workflow documentation-wf-reusable --inputs-json '{"input_1": "valor", "input_2": "valor"}' --non-interactive --report-status --env prod |
-e, --env TEXT | Nome do ambiente (slug do ambiente) em que o Workflow vai executar. É necessário quando o Workflow do tipo reusable interage com recursos de outros Workflows do tipo deploy, destroy e rollback. | stk run workflow documentation-wf-reusable --inputs-json '{"input_1": "valor", "input_2": "valor"}' --non-interactive --report-status --env dev |
-q, --non-interactive | Não pergunta para o usuário por parâmetros de entrada que faltam e retorna um erro caso algum parâmetro obrigatório não tenha sido fornecido. | stk run workflow documentation-wf-reusable --inputs-json '{"input_1": "valor", "input_2": "valor"}' --non-interactive --report-status --env dev |
-r, --report-status | Envia o relatório da execução do Workflow para o histórico de atividades da Aplicação ou Infraestrutura atual que usa o Workflow. | stk run workflow documentation-wf-reusable --inputs-json '{"input_1": "valor", "input_2": "valor"}' --report-status |
-h, --help | Exibe a ajuda do comando e sai. | stk run workflow --help |
stk validate workflow
O comando stk validate workflow verifica a estrutura do arquivo workflow.yaml e exibe um log no terminal com os erros encontrados no seu Workflow. O comando também é executado automaticamente antes da publicação de um Workflow e interrompe a publicação se algum erro for encontrado.
Uso
Para executar a validação da estrutura do seu Workflow, execute o comando a seguir dentro da pasta do Workflow:
stk validate workflow --studio NOME-ESTUDIO --verbose
Exemplo:
stk validate workflow --studio techwriters-studio --verbose
Parâmetros
| Opções | Descrição | Exemplo |
|---|---|---|
-v, --verbose | Habilita no terminal a exibição do log das etapas de validação da estrutura do Workflow. | stk validate workflow --studio techwriters-studio --verbose |
-s, --studio | Nome do Estúdio (slug do Estúdio) para validar o Workflow atual baseado nas informações de uma versão anterior publicada do Workflow. | stk validate workflow --studio techwriters-studio |
-h, --help | Exibe a ajuda do comando e sai. | stk validate workflow --help |