Exporting StackSpot Content

In this section, you will find the steps to export the contents of StackSpot EDP.a

The StackSpot Content Exporter Action allows you to export Plugins, Actions, and Workflows from the StackSpot Content Manager. You can choose to export by Organization, Studio, or Stack. Use this Action to back up, migrate, or analyze your content from the StackSpot platform.

Prerequisites

Before you begin, ensure you have:

An active StackSpot account.
Permission to access the desired content (ORG, STUDIO, or STACK).
Installed the STK CLI.
You are authenticated in the STK CLI:
```
stk login
stk exit workspace
```

How to use

Input parameters

export_level: Sets the export level (ORG, STUDIO, STACK).
export_list: List of Studios or Stacks to export (depending on the level).
filter_content_by: Types of content to export (PLUGINS_APP, PLUGINS_INFRA, ACTIONS, WORKFLOWS).

Execution

In your project directory, run:

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

Follow the interactive prompts to select the level and filters you want.
The selected content will be downloaded and saved locally according to your choices.

Usage examples

Export all organization content:

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

Export specific Stacks:

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

Export all content from a Studio:

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

Idempotency

The Action saves downloaded and indexed content to your local machine. If you run it again with different filters or parameters, only new content will be downloaded; existing files will not be overwritten or downloaded again. This ensures that the process is idempotent.

Exported files structure

Exported content is organized into subfolders by type within the export directory.

Folder organization

The main directory contains subfolders for each studio, with their respective content types:

actions/
plugins_app/
plugins_infra/
stacks/
workflows/

Example structure:

root/
  <studio-name>/
    actions/
      <action-name>/
        <version>.zip
    plugins_app/
      <plugin-app-name>/
        <version>.zip
    plugins_infra/
      <plugin-infra-name>/
        <version>.zip
    stacks/
      <stack-name>/
        <version>.yaml
        DRAFT.yaml (if exists)
        stack.yaml
        image.png (if logo exists)
    workflows/
      <workflow-name>/
        <version>.zip

File details

ZIPs: Each .zip file contains the complete exported Plugin, Action, or Workflow (templates, scripts, and documentation).
YAMLs: .yaml files in Stacks represent exported versions.
Images: Files like image.png appear if the Stack has a registered logo.

Exported YAML file structure

YAML files describe all components, versions, and dependencies of the Stack, making it easy to port, analyze, and re-import the Stack into other StackSpot environments.

1. `stack.yaml` file

Contains Stack metadata.

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

name: Stack or Studio name.
description: Brief description of the Stack.

2. Stack version file (e.g., `runtime-developer-stack@6.0.0.yaml`)

Lists all components (Plugins, Actions, Workflows, Starters) associated with the Stack, including versions and artifact paths.

slug: runtime-developer-stack@6.0.0
docs: { }
plugins_app:
  - slug: angular-basic-app
    version: 1.0.0
    path: /absolute/path/to/zip
    relative_path: relative/path/to/zip
# ... other sections omitted for brevity ...

Key fields:

slug / version: Unique identifier and version of the component.
path / relative_path: Absolute and relative path to the exported artifact.
description, type, docs (in starters): Descriptive metadata.
required_plugins, optional_plugins (in starters): Required and optional Plugins.

tip

Debug tip

If you encounter an error, run with the --debug or --trace flag for more details:

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

This generates a log file in the command root directory. Send it to StackSpot support for analysis.

You can also check the general log:

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

If you have any questions or problems, please contact StackSpot support.