Exportar Conteúdos da StackSpot

Nesta seção, você encontra os passos para exportar os conteúdos do StackSpot EDP.

A Action StackSpot Content Exporter permite exportar Plugins, Actions, e Workflows da StackSpot Content Manager. Você pode escolher exportar por Organização, Estúdio ou Stack. Use esta Action para fazer backup, migrar ou analisar seus conteúdos da plataforma StackSpot.

Pré-requisitos

Antes de começar, certifique-se de que você:

Possui uma conta ativa na StackSpot;
Tem permissão de Account Holder para acessar o conteúdo desejado (ORG, STUDIO ou STACK);
Instalou o STK CLI;
Está autenticado no STK CLI:
```
stk login
stk exit workspace
```

Como usar

Parâmetros de entrada

export_level: define o nível de exportação (ORG, STUDIO, STACK).
export_list: lista de Estúdios ou Stacks a serem exportados (dependendo do nível).
filter_content_by: tipos de conteúdo para exportar (PLUGINS_APP, PLUGINS_INFRA, ACTIONS, WORKFLOWS).

Execução

No diretório do seu projeto, execute:

stk run action stackspot-core/stackspot-content-exporter

Siga as perguntas interativas para selecionar o nível e os filtros desejados.
Os conteúdos serão baixados e salvos localmente conforme as opções escolhidas.

Exemplos de uso

Exportar todos os conteúdos da Organização:

stk run action stackspot-core/stackspot-content-exporter \
  --export_level 'ORG' \
  --filter_content_by '["PLUGINS_APP", "PLUGINS_INFRA", "ACTIONS", "WORKFLOWS"]' \
  -q

Exportar Stacks específicas:

stk run action stackspot-core/stackspot-content-exporter \
  --export_level 'STACK' \
  --export_list '["meu-studio/minha-stack"]' \
  --filter_content_by '["PLUGINS_APP", "PLUGINS_INFRA", "ACTIONS", "WORKFLOWS"]' \
  -q

Exportar todos os conteúdos de um Estúdio:

stk run action stackspot-core/stackspot-content-exporter \
  --export_level 'STUDIO' \
  --export_list '["meu-studio"]' \
  --filter_content_by '["PLUGINS_APP", "PLUGINS_INFRA", "ACTIONS", "WORKFLOWS"]' \
  -q

Idempotência

A Action salva os conteúdos baixados e indexados no seu computador. Se você executar de novo com outros filtros ou parâmetros, apenas novos conteúdos serão baixados; os arquivos já existentes não serão sobrescritos ou baixados novamente. Isso garante idempotência ao processo.

Estrutura dos arquivos exportados

Os conteúdos exportados são organizados em subpastas por tipo dentro do diretório de exportação.

Organização das pastas

O diretório principal tem subpastas para cada Estúdio, contendo os seguintes tipos de conteúdo:

actions/
plugins_app/
plugins_infra/
stacks/
workflows/

Exemplo de estrutura:

raiz/
  <studio-name>/
    actions/
      <action-name>/
        <versão>.zip
    plugins_app/
      <plugin-app-name>/
        <versão>.zip
    plugins_infra/
      <plugin-infra-name>/
        <versão>.zip
    stacks/
      <stack-name>/
        <versão>.yaml
        DRAFT.yaml (se existir)
        stack.yaml
        image.png (se houver logo)
    workflows/
      <workflow-name>/
        <versão>.zip

Detalhes dos arquivos

ZIPs: cada arquivo .zip contém o conteúdo completo do Plugin, Action ou Workflow exportado (templates, scripts e documentação).
YAMLs: arquivos .yaml em Stacks representam as versões exportadas.
Imagens: arquivos como image.png aparecem se a Stack tiver uma logo cadastrada.

Estrutura dos arquivos YAML exportados

Os arquivos YAML descrevem todos os componentes, versões e dependências da Stack, facilitando portabilidade, análise e reimportação em outros ambientes StackSpot.

1. Arquivo `stack.yaml`

Contém metadados da Stack.

name: edp-deploy-test-cli-stack
description: This stack is to test Stacks created using CLI

name: nome da Stack ou Estúdio.
description: descrição breve da Stack.

2. Arquivo de versão da Stack (ex: `runtime-developer-stack@6.0.0.yaml`)

Lista todos os componentes (Plugins, Actions, Workflows, Starters) associados à Stack, incluindo versões e caminhos dos artefatos exportados.

slug: runtime-developer-stack@6.0.0
docs: { }
plugins_app:
  - slug: angular-basic-app
    version: 1.0.0
    path: /caminho/absoluto/para/zip
    relative_path: caminho/relativo/para/zip
# ... demais seções omitidas para brevidade ...

Principais campos:

slug / version: Identificação única do componente e sua versão.
path / relative_path: Caminho absoluto e relativo para o artefato exportado.
description, type, docs (em Starters): Metadados descritivos.
required_plugins, optional_plugins (em Starters): Plugins obrigatórios e opcionais.

Dica!

Dica de debug

Se ocorrer algum erro e quiser saber mais detalhes, execute o comando a seguir, com a flag --debug ou --trace:

stk run action stackspot-core/stackspot-content-exporter --debug

Isso gera um arquivo de log na raiz do comando. Envie-o para o suporte da StackSpot analisar.

Você também pode consultar o log geral:

cat $HOME/.stk/logs/logs.log

Em caso de dúvidas ou problemas, entre em contato com o suporte da StackSpot.