Skip to main content

Getting Started

Before you begin

Get started creating content for the first time with StackSpot. You will learn how to create your first Plugin and Stack.

1. Log in to your StackSpot Account

  1. Go to StackSpot website and log in with your organization's email.

2. Download STK CLI

3. Access your organization's Studio

4. Create a Stack

Go to your Studio's Dashboard on the StackSpot's website:

Step 1. Click on the 'Create Stack' button, on the left corner of the screen.

Fill out the following:

  • Stack Name: Add your Stack's name.
  • Slug (Identifier): Add a slug for your Stack. After you publish your Stack, this field can’t change.
  • Description: Describe your Stack's goal.

Step 2. Review your information and click on the 'Create' button. Done!

The first version of your Stack is ready, but it is not published yet. You need to add at least one Plugin linked to a Starter or not.

5. Create an app (or infra) Plugin

Step 1. Open your terminal and run the command:

stk create plugin

Add a name for your Plugin, for example:

stk create plugin my-first-plugin

Answer the questions on your terminal. See some response examples:

- Plugin type: App

- Add a repository: No (If you already have a repository, you need to add it. If not, you will create the Plugin on your directory).

- Version: (0.0.1)

- Plugin description: Creating my first Plugin.

Step 2. Go to the Plugin's folder you created and check the files generated. You should see a structure like the one below:

/docs #required
/templates #required
/tests #optional
plugin.yaml #required
.gitignore #required

Step 3. Open Visual Studio Code (or your other IDE) and check your Plugin configuration file (plugin.yaml file). You can change the schema field and the other inputs in the spec according to what you need.

See below an example of a Plugin that adds endpoints to a Lambda API:

schema-version:v1 #optional #warning
kind: plugin #required
metadata: #required
  name: lambda-new-endpoint #required
  description: Add new endpoint to an existing Lambda API.  #required
  display-name: Endpoint para Lambda  #required
  version: 1.0.0  #required
  release-notes: release-notes-{{version}}.md #required
  picture: plugin.png  #optional
spec: #required
  type: app   #required
  compatibility: #optional
    - python
  about: about.md  #optional #warning
  usage: usage.md  #optional #warning
  implementation: implementation.md  #optional #warning
  requirements: requirements.md   #optional  #warning
  repository: https://github.com/stack-spot/environments-runtime-stack  #optional
  technologies: #optional 
    - Api

For more information about Plugins, see the Plugins section.

6. Create Starter

Starter is a set of predefined Plugins of a Stack, see the Main Concepts section.

Follow the steps to create one:

Step 1. On your Stack Dashboard, click on the 'Create a new starter' button.

Step 2. In 'Starter info', fill out the information:

  • Slug (Starter name): Add a new name for your Starter.
  • Descriptiono: Describe your Starter.

Click on 'Next'.

Step 3. In 'Add Plugins', add the Plugins you want to include in your Starter.

You can choose Plugins from the Studio and the Account.

After that, click on 'Add Plugins'.

Warning

Check the order you are adding Plugins to the Starter. The order defines the sequence they are applied in the Stack. You can only change the order while your Stack is as a Draft.

Step 4. Confira a ordem dos Plugins no Starter e clique no botão 'Próximo'. Revise as informações e clique em 'Concluir'.

For more details about a Starter, see the Stacks section.

7. Add Plugin and Actions to a Stack

To add Plugin:

Step 1. On the StackSpot website, go to the Stack section and click on Plugin;

Step 2. Choose the Plugin type you want to add to the Stack:

  • App: Click on 'Add App Plugin' button.
  • Infra: Click on the 'Add Infra Plugin' button.

Step 3. On the right side of the page, choose the Plugins and click on the 'Add Plugins' button.

To add Action:

Step 1. In your Stack, click on 'Actions'. Then click on the 'Add action' button, in the right corner of the screen;

Step 2. Add the Actions with the 'Available in Studio' filter and you can also 'Explore';

In the 'Explore' tab, you can group the Actions by Studio and select which version of the Action you want.

Step 3. Select the Actions and click on the 'Add Action' button.

For more details about a Actions, see the Action section.

8. Publish your first Stack

Follow the instruction to publish your Stack:

  1. Access StackSpot website;
  2. Click on the 'Stack' section;
  3. Click on the 'Publish' button, in the left corner of the screen.

Next Steps

See more details about each step in the following sections:

Was this page helpful?