Create and Publish Infrastructure via STK CLI

In this section, you will find a guide on how to create and publish an Infrastructure via STK CLI..

To create Infrastructure on StackSpot, you can use Infrastructure Plugins that generate infrastructure pieces (IAC code). This process is similar to creating an Application, which generates source code from Application Plugins.

See the steps

Requirements

• STK CLI installed and a Workspace member.
• You must be logged in to your StackSpot Account.
• Access a Studio.
• You need a Stack and a Starter.
• You must have environments on your account
• Must have configured the Deployment via Self-Hosted to set up and connect the environments in the Cloud Account
• You must have your SCM configured (Your Account administrator is responsible for this configuration).
• If your account is Enterprise and the administrator decides that users should manage access to
  SCM

  Source code management (SCM) tracks changes to a code repository, keeping a record of alterations and assisting in managing conflicts that arise when integrating updates from different contributors.
  via Personal Access Token (PAT) individually. You must configure it in 'External Connections'.

If you still need to meet these requirements, click the links to complete them before proceeding.

Follow the steps to create your Shared Infra via STK CLI

You will follow the steps below via STK CLI.

Step 1. Open your terminal, select the Workspace you want to use for Infrastructure and execute:

stk use workspace

Choose the Workspace from the list and press Enter.

tip

To see the list of available workspaces from your terminal, run the command stk list workspace . Your workspace is marked with a star *.

You can also see the list on the StackSpot Platform in the 'Workspaces section.

Step 2. To create an Infrastructure, execute:

stk create infra

Answer the questions on the terminal:

• Name your Infrastructure: Enter the name of your Infrastructure;

• The Infrastructure name has a 60-character limit.

• Do you want to start a git repository?: Answer '(Y/n) Yes or No' to start a Git repository in the Infrastructure folder. If the answer is '(Y) Yes', then you must enter the URL of the remote repository;

• Infrastructure Description: Enter a brief description for your Infrastructure;

• Select the Studio: Select one of the Studios available in your account;

• Select Stack: Select the desired Stack;

• Select the version of the Stack: Select the version of the Stack you want to use.

• Select the desired infrastructure Plugins: Select the desired infrastructure plugins from the list displayed in the terminal;

• Name the use of the Plugin: Plugin usage is automatically filled. You must then answer the Plugin inputs.

caution

You can apply the same Plugin more than once in your Infrastructure. That's why the question below appears every time:

? Name the usage of the plugin (studio/stack/name-of-plugin)

It is the alias of the Plugin's usage, and it comes already filled out as default input by the STK CLI. For example:

• The name of the Plugin is bucket-s3
• If it is the first time you apply this Plugin, the alias should be the bucket-s3-1694809616257 name. This number is a Unix Timestamp.

The alias indicates the purpose of this first Plugin application and avoids duplicate names.

The alias is immutable once configured. If you want to edit this name, this is the only time you can.

Step 3. Answer the questions in your terminal. If any Plugin requires a Connection Interface, provide the usage's alias.

Please just repeat the process for all the Plugins you apply.

You created your Infrastructure!

danger

You cannot manually edit the stk.yaml file of an Application or Infrastructure should. You can modify the Plugins in your Application or Infrastructure. To do so, use the following commands:

• To modify the version or settings of a Plugin:

stk update plugin

• To remove a Plugin:

stk remove plugin

• To add new features to your project:

stk apply plugin

Step 4. Register your Shared Infra into the account. Access its directory:

cd <shared-infra-name> 

Then, execute the command below to register:

stk register infra

Answer the questions:

• Repository URL: Inform the repository that will store your application's code;
• Base branch: Inform the branch you will use in the repository.

Your Shared Infra was created and registered.

Check all the steps above:

You can now view your Infrastructure data within your Workspace on the StackSpot Platform. Access the 'Infrastructure’ section.

caution

The infrastructure deployment is only performed at this stage if your organization has configured the deployment via Runtime Self-Hosted.

Here is the translation of your text into English:

How to Use Account Variables to Configure Plugins in Your Application

You can choose to use Custom Variables created by your Organization to fill in the inputs for Plugins and Actions when creating your Infrastructure.

To do this, type {{ when responding to the input and select the Variable you want to use.

Visit the How to Create Account Variables page to learn more.

Next step

• Learn how to deploy your Infrastructure, in the Deployment section.
• Manage how you run Actions in your Infrastructure.
• Manage and monitor your Infrastructure.
• To destroy your Infrastructure see the Destroy section.