Skip to main content

Application Infrastructure Deployment

In this section, you will find how to deploy your Application infrastructure.


caution

The Deploy configuration flow and addition of Cloud accounts in StackSpot in this way is only available for:

  • Enterprise accounts created before 2024.

Enterprise accounts created from January 2024 onwards must deploy via Self-hosted Runtimes.

warning

This deployment guide is exclusive to StackSpot Enterprise Accounts because they use StackSpot's Deploy and Self-Hosted services.


In a Deployment flow with StackSpot, the Deploy Engine is responsible for provisioning infrastructure and cloud resources for Applications and Infrastructures.

At StackSpot, it is possible to Deploy the Infrastructure of two types of Plugins:

  • App Type: Done using the stk deploy app command, it will deploy the Application Infrastructure pieces that the Plugin generates;
  • Infra Type: Done by the command stk deploy infra, it will deploy the Infrastructure parts of the Infrastructure that the Plugin generates.

Deploys execute within an Environment connected to an Account in your Cloud service and associated with a Workspace.

info

A StackSpot Account can consist of one Cloud Service Account for each Workspace and Environment association.

Requirements

How to start a deployment via STK CLI

Step 1. In your terminal, log in to your StackSpot Account and select your Workspace. Execute the command below:

stk use workspace <NAME-WORKSPACE>

For information about this command, go to theWorkspace Commands page.

Step 2. Go to your Application project folder:

cd <application-name>

Step 3. In your Application project, execute the command below:

stk deploy app --version<version> --env<environment-id> -w
tip
  • Version: The Application tag appears on the StackSpot Platform if the deployment is successful.
  • Environment: Configured in the Workspace where the Applications deploy.
  • Branch: You can add the flag --branch<branch-name>. The name of your branch used with the repository you added in the Application manifest. It is an optional flag. If you need to check out the repository during deployment, add this flag, and Deploy will clone the repository in the branch. Check the step-by-step to release access to private repositories.

Step 4. To track the Deployment status, execute the command:

stk deploy status <application id> --watch

In this case, the id is an argument in your STK CLI after you deploy.

The output status can be:

  • Running: Running deployment.
  • Succeeded: Successful deployment.
  • User error: User error. It is usually related to executing the terraform apply command. The Plugin's IaC template was not generated as expected. It can also be a permission problem on the Cloud account.
  • Runtime error: Runtime error. It is an internal StackSpot error. The engineering team needs to evaluate.

When the deployment is complete, an Activity screen appears on the website. You can review all the deployment history and the Environment's versions.

info

To debug the deployment and access the Terraform logs, run the command below:

stk deploy status 01H8FCXE6ZEM79X9HJYSVN12C0 --report md

What can you do after the deployment?

1. Monitor your Application on the StackSpot Platform

Learn to monitor your Application on the Activities section.

2. Rollback an Application

Rollback works like a deployment but with a specific ID. When executing a Rollback, state a version to deploy again with the same IaCs generated in the version.

The user who will rollback must have the following role: runtime:deploy_app.

Follow the steps to rollback:

Step 1: In your terminal, access your project folder. Select your Workspace running the command:

stk use workspace <NOME-WORKSPACE>

Step 2: Run the command below:

stk rollback app --version=<version> --env=<environment-id>
  • version: is the deployed version chosen for the rollback. In the rollback, a new deployment is made based on the version entered without creating a new tag.

To monitor the rollback status, run the command:

stk rollback status <run-id>

In this case, run-id is an argument.

3. Destroy an Application

warning

This feature is temporarily disabled. During this period, if you need to destroy an Application Infrastructure, please contact our support team.

After you deploy an Application Infrastructure, if you want to delete it, you need to "destroy" it.

The user who will destroy must have the following role: runtime:destroy_app.

info

When you execute the command stk destroy app, you only destroy the application's infrastructure.

Its registration continues to exist in your Workspace. To delete it, you must follow the steps in the section How to delete your Application in the StackSpot Portal.

To destroy your Application, follow the steps below:

Step 1. In your terminal, access the directory of the Application project you want to destroy:

cd <application-name>

Step 2. Then, execute the command below to destroy the Application:

stk destroy app --env=<environment-id>

For example:

stk destroy app --env=sandbox

Step 3. In the STK CLI, answer the question and confirm that you want to destroy the Application;

Step 4. To watch the status of the destroy, run the command below:

stk destroy app  --env<environment-id> --watch