Skip to main content

Introduction

In this section, you will find more details about Deploy Engine.


â—€
Account Configuration
You are here!
Deployment Configuration
Create Content
Use Content
â–¶

Overview

The deployment in StackSpot EDP consists of two parts:

  1. Deploy the infrastructure of your Application using Runtime via Self-Hosted: Self-Hosted adds steps to your Workflow to provide cloud resources using the orchestration of the Deploy Engine with your organization's runners. Currently, Self-Hosted only supports GitHub Actions service.

  2. Deploy the Application itself, using your own CI/CD Pipeline and execute the deployment registration on the StackSpot EDP Platform.


caution

If your Account meets the following conditions:

  1. Enterprise Accounts created before 2024.
  2. Accounts of type Personal.

The deployment can still be done via the StackSpot EDP Deploy Engine.

For information about this deployment model, check the StackSpot Deploy Engine section.


Below are the key Deployment concepts:

Key concepts

See below some main concepts related to StackSpot's Deploy:

Runtime

A Runtime represents all the infrastructure resources (Cloud computing, storage, network, and security) required to run an Application on a Cloud.

Application

Software developed to solve a business problem materialized as source code in a Git repository. The app's settings are stored in the stk.yaml file.

An Application is composed of App and Infra Plugins.

Infrastructure

A project developed to provision and operate Cloud resources. It is created from an Infra Plugin, directly connected to Cloud resources such as an S3 bucket or an RDS database.

Infrastructure is composed of Infra Plugins.

Connection Interface

A Connection Interface represents a set of attributes required for connection to Cloud resources, provisioned through Plugin deployment. For example, a Connection Interface can represent the host of an RDS instance or the path of an S3 bucket.

Each Connection Interface is associated with a specific type (Connection Interface Type), which defines a contract with a list of required attributes.

These attributes can be used as inputs for other Plugins, facilitating integration and reuse of connections.

Connection Interface Type

A Connection Interface Type defines a contract specifying the outputs that a Connection Interface, provisioned through an Infra Plugin, must follow.

The implementation of this Infra Plugin must respect this contract to ensure that the resources provisioned during the deployment of the Application or Infrastructure in the Workspace can be correctly shared.

Deploy

Deploy means making an application available for use or putting it online. For example: uploading files from your machine to a server, which can be a staging or production environment.

In the case of StackSpot, the deployment done on the platform provisions the infrastructure resources of the Application in the desired environment. The deployment of the Application itself must be done through your own Pipeline.

In StackSpot EDP, deployment is done via Self-Hosted: The Self-Hosted adds to your Workflow the necessary steps to provision Cloud resources, using the orchestration of the Deploy Engine with your organization's runners. Currently, Self-Hosted exclusively supports GitHub Actions.

After deploying on StackSpot, you can monitor it directly on the platform, on the Activities screen of the Application or Infrastructure. Through this screen, you can view logs, identify and correct errors, and perform a rollback if necessary.

Cloud Account and Provider

A cloud account represents a public cloud account identified by a provider. This account is just a record used to identify where to deploy App or Infra projects.

Additionally, cloud accounts can be connected or disconnected from StackSpot accounts and attached or detached in one or more environments within Workspaces.

Currently, the provider supported by StackSpot is aws.

Run and Tasks

A run represents any operation performed in the Deploy Engine, such as deploy, destroy, or rollback. Each run happens asynchronously and returns an ID that can be used to check the status later. A run is composed of a set of tasks.

The types of run are:

  • Deploy
  • Rollback
  • Destroy

The statuses are:

  • Running
  • Succeeded
  • User error
  • Runtime error
  • Aborted (When the user manually cancels the run). Currently, this status is exclusive to the Self-Hosted runner.

A run task represents a specific operation related to a run. A run task is directly linked to Plugin deployments.

The types of run task are:

  • IAC: creates an IaC for a Plugin.
  • Deploy: deploys a Plugin.
  • Destroy

The run task statuses are:

  • Pending
  • Ready to run
  • Running
  • Succeeded
  • Failed
  • Internal Error
  • Aborted

Deploy

  • The process of making an Application available.
  • Provisioning: Setting up infrastructure and making resources for Shared Infra in a specific environment.

Next steps

Now that you have an overview of Deployment in StackSpot, proceed to the initial setup, provisioning, and operation of Applications in the Cloud.