Skip to main content

Create, Deprecate or Delete a Starter

In this section, you will find a guide on how to create Starters.


A Starter is a tool for content creators to define common Plugin combinations in Stacks, addressing specific use cases. You can include multiple Plugins in a Starter.

There are two types of Starter:

  • App Starter: a combination of App Plugins.
  • Infra Starter: a combination of Infra Plugins.

A Starter works like a recipe. It keeps the configuration of a set of Plugins already defined and applied. This configuration is used when you run the stk create app or stk create infra commands.

With a Starter, you can create a project that already includes a set of Plugins using a single command.


See below how to:

How to create a Starter in your Stack

To create and add a Starter to your Stack, follow the steps below:

Prerequisites

warning
  • The Starter name is limited to 60 characters.

Steps

Step 1. Log in to the StackSpot Platform and go to 'Studios';

Step 2. Select the Studio where you want to create the Starter;

Step 3. Click the 'Stacks' tab and select the Stack where you want to create the Starter;

warning

If the Stack is already published, create a new version before Starter creation. Click 'Create new version' within the Stack and then continue following this guide.

Step 4. Click the 'Starters' tab. Then, click the 'Create starter' button;

Step 5. Select the type of Starter: App Starter or Infra Starter.

Step 6. On 'Basic information' provide the following information:

  • Slug (Starter name): add a name for your Starter.
  • Description: describe your Starter.

Click the 'Continue' button;

Step 7. On 'Plugins', add the Plugins you want to include in the Starter. Click 'Add Plugins';

Select Plugins from the Studio, Account, or insert a Qualifier.

warning

Check the order in which the Plugins are added to the Starter, as it defines the apply sequence of the Plugins during the creation of an Application or Infrastructure. This sequence configuration can only be changed while the Stack is in Draft mode. For Plugins that require other Plugins, the least dependent ones come first in the apply order, and the most dependent ones come later.

tip

App-type Starters accept App Plugins and Infra Plugins, but only when the app allowed true flag is set in the Plugin's yaml.

If a Plugin that will be added to the Starter has other required Plugins, you must add them to the Stack and to the Starter before continuing.

After selecting the Plugins, click 'Add Plugins';

Step 8. Confirm the order of Plugins using the numbers beside them and define whether a Plugin will have optional application or not. After verification, click 'Continue';

When adding a Plugin in a Starter that uses the range template, choosing a specific version of the Plugin will not be possible.

warning

Check the order in which you are adding Plugins to the Starter. This order defines how you apply the Plugin in the Stack. You can only change it while the Stack is in Draft.

Step 9. On 'Review', check the Starter information and click 'Save'.

Animation showing how to create a Starter in StackSpot Portal

You added a Starter to your Stack.

Remove Plugin Version from Starter

You can remove the version of a Plugin in a Starter, but only when the Stack version is in draft. Follow the steps below:

Step 1. Log in to the StackSpot Platform and access 'Studios';

Step 2. Select the Studio with your Stack and Starter;

Step 3. In the main tab of the Studio, click 'Stacks' and choose the Stack containing the version of the Starter with the Plugins to remove;

Step 4. Click on the 'Starters' tab and go to the Starter. Inside it, click on the 'trash' icon next to the Plugins you want to remove from the Starter;

Step 5. Click 'Save'.

You removed a Plugin from your Starter.

Delete Starter from Stack

tip

For more information, access the deletion rules page.

You can only delete a Starter if the Stack is in 'Draft'.

Follow the steps:

Step 1. Log in to the StackSpot Platform and access 'Studios';

Step 2. Select the Studio with your Stack and Starter;

Step 3. In the main Studio tab, click 'Stacks' and choose the Stack containing the Starter to delete;

Step 4. Within the 'Starters' section, click the Starter to delete;

Step 5. Within the Starter click 'Settings';

Step 6. At the bottom of the page, click 'Delete Starter' and fill in the field with the slug of the Starter;

Step 7. To finish, click on the button 'Confirm removal'.

You deleted the Starter from your Stack.

Animation showing how to delete a Starter in StackSpot Portal

Deprecate Starter Version in Stack

tip

For more information, access the deprecation rules page.

You can also deprecate a Starter version. Deprecation indicates that using that version is not recommended.

To deprecate a Starter version, follow the rules below:

  1. You must have permission to deprecate content.
  2. You must belong to the Studio or Stack where the Starter version will be deprecated.

Step 1. Log in to the StackSpot Platform and access 'Studios';

Step 2. Select the Studio that has your Stack and Starter;

Step 3. In the main tab of the Studio, click 'Stacks' and choose the Stack containing the Starter to deprecate;

Step 4. Within the 'Starters' tab, select the Starter to deprecate;

Step 5. Within the Starter click 'Settings';

Step 6. Then click the 'Deprecate Starter' button;

Step 7. Fill out the following fields:

  • Reasons to deprecate:

    • Lack of Maintenance;
    • Security Issues;
    • Bugs;
    • Other

  • The slug of the Starter to deprecate.

To continue, click on the 'Deprecate Starter' button.

You deprecated a version of the Starter.

Animation showing how to deprecate a Starter in StackSpot Portal

Next Steps