Pular para o conteúdo principal

Aplicar um Plugin

Uso do Plugin e Starters

Na StackSpot EDP, o conceito de Starter facilita o uso dos Plugins em conjunto. Um Starter é como uma "receita pronta" que combina um conjunto de Plugins pré-configurados para atender a um caso de uso específico. Ele permite que pessoas desenvolvedoras criem Aplicações ou Infraestruturas rapidamente, sem precisar configurar cada Plugin individualmente.

O que são qualifiers?

Para aplicar um Plugin, você precisa utilizar um qualifier, que identifica o Plugin de forma única. Existem dois tipos de qualifiers:

1. Studio Qualifier. Usado quando você aplica o Plugin fora de um Workspace.


<studio-name>/<plugin-name>@<version>

Exemplo: my-studio/auth-plugin@1.0.0

2. Stack Qualifier. Usado quando você aplica o Plugin dentro de um Workspace.


<studio-name>/<stack-name>@<version>/<plugin-name>

Exemplo: my-studio/my-stack@1.0.0/auth-plugin

Como usar um Plugin

Os Plugins da StackSpot podem ser utilizados de duas maneiras:

Opção 1. Unitariamente: aplicando um único Plugin com o comando:

stk apply plugin <qualifier>

Opção 2. Em Conjunto: aplicando um conjunto de Plugins ao criar uma Aplicação ou Infraestrutura com os seguintes comandos:

stk create app <app-name> --starter <starter-name>
stk create infra <infra-name> --starter <starter-name>

StackSpot YAML (stk.yaml)

Sempre que você aplicar um Plugin, seja de forma individual ou em conjunto, e independente do qualifier, a StackSpot cria (ou atualiza, se já existir) um arquivo chamado stk.yaml na pasta onde o comando foi executado. Esse arquivo é o state da StackSpot e tem várias funções importantes, sendo a principal delas gerenciar o fluxo de deploy.

Atenção!

O arquivo stk.yaml de uma Aplicação ou Infraestrutura não deve ser editado manualmente. Você pode modificar os Plugins da sua Aplicação ou Infraestrutura, para isso, use comandos a seguir:

  • Para modificar a versão ou configurações de um Plugin:
stk update plugin
  • Para remover um Plugin:
stk remove plugin
  • Para adicionar novos recursos ao seu projeto:
stk apply plugin