Pular para o conteúdo principal

Aplicar um Plugin

Visão geral

Este documento apresenta as regras e instruções para aplicar Plugins na StackSpot EDP. Você encontra definições sobre Starter, Plugin, Workspace, Studio e qualifier, exemplos práticos de uso e orientações para manipulação segura do arquivo stk.yaml.

Uso de Plugins e Starters

Na StackSpot EDP, o conceito de Starter facilita o uso combinado de Plugins. Um Starter é um conjunto pré-configurado de Plugins criado para atender a um caso de uso específico.

Com isso, é possível criar Aplicações ou Infraestruturas rapidamente, sem selecionar ou configurar cada Plugin individualmente.

Alguns conceitos importantes:

  • Plugin: componente reutilizável que adiciona funcionalidades a uma Aplicação ou Infraestrutura.
  • Starter: conjunto de Plugins pré-definido dentro de uma Stack.
  • Workspace: ambiente de trabalho colaborativo onde Plugins, Stacks e Starters podem ser usados.
  • Studio: espaço organizacional na StackSpot onde são criados Plugins, Stacks e Starters.

O que são qualifiers?

Para aplicar um Plugin, é necessário utilizar um qualifier, que identifica o Plugin de forma única. Existem dois tipos de qualifiers na StackSpot EDP:

  • Studio Qualifier: utilizado quando o Plugin é aplicado diretamente a partir de um Studio, sem uma Stack.

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

    Exemplo: meu-studio/auth-plugin@1.0.0

  • Stack Qualifier: utilizado quando o Plugin faz parte de uma Stack, normalmente dentro de um Workspace.

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

    Exemplo: meu-studio/minha-stack@1.0.0/auth-plugin

Como usar um Plugin

Você pode utilizar Plugins da StackSpot das seguintes maneiras:

  • Opção 1. Individualmente: aplicar um único Plugin usando o qualifier:

    stk apply plugin <qualifier>

  • Opção 2. Em conjunto: aplicar um conjunto de Plugins ao criar uma Aplicação ou Infraestrutura com um Starter:

    stk create app <nome-da-aplicacao> --starter <nome-do-starter>
    stk create infra <nome-da-infraestrutura> --starter <nome-do-starter>

Arquivo stk.yaml da StackSpot

Sempre que você aplica um Plugin, de forma individual ou em conjunto, e independentemente do qualifier, a StackSpot cria (ou atualiza, se já existir) um arquivo chamado stk.yaml na pasta onde o comando foi executado.

Esse arquivo representa o estado da sua Aplicação ou Infraestrutura na StackSpot e tem como principal função gerenciar o fluxo de deploy, além de outras operações internas.

Atenção!

Não edite manualmente o arquivo stk.yaml de uma Aplicação ou Infraestrutura.

Altere os Plugins somente por meio dos comandos oficiais da StackSpot, para garantir a integridade do projeto e o correto funcionamento dos deploys.

Para gerenciar Plugins, utilize:

  • Modificar a versão ou configurações de um Plugin:

    stk update plugin

  • Remover um Plugin:

    stk remove plugin

  • Adicionar novos Plugins ao projeto:

    stk apply plugin