Skip to main content
Version: v4.5.0

Quickstart for Users

Before you begin​

As a User, you can:

  • Create applications.
  • Register applications in the Runtime Engine.
  • Create/change a Runtimes manifest (oam.yaml), specifying the application components.
  • Commit/push to start the CI (Continuous Integration)/CD (Continuous Delivery) pipeline.
caution

About the CI/CD pipeline:

  • CI is your Organization's responsibility.
  • CD is Runtimes responsibility.
  • Application deployment.

In this Quickstart guide, you will learn how to create an application using OAM and the Runtimes API, and deploy the application using a REST request.

Create an Application​

What is an Application in StackSpot's Runtimes

It is an abstraction that represents software. It guarantees part of the domain (or business) rules of the enterprise, designed, developed, and published by developers.

In the StackSpot context, the application represents a group of components, including the Cloud resources that run the application software and services such as databases and caching.

See below how to create, register, and deploy your application.

Step 1. Fill out the application specification​

Enter your application's data and its components. Use one of the templates below:

Sample template with the OAM specification for your application.

apiVersion: core.aom.dev/v1beta1
kind: Application
spec:
  components:
  - name: my-simple-app
    type: microservice
    properties:
      image: 

  - name:
    type:
    properties:

Step 2. Submit your application to your repository​

commit and push the changes to your repository.

In this step the CI process starts.

caution

The CI process is the responsibility of your organization. You need to request to start the CD process. The Runtimes Engine runs this part.

Step 3. Deploy the application​

This is an abstraction, it represents the publishing of an application to an environment, including timing (timestamp) and state (success, error). The definition of this application is described using OAM and sent as a parameter to the API.

If your Organization does not have a CI process, you can manually register the application to the Runtimes Engine.

To deploy your application, follow the steps below:

Register Application​

  • Register your application with StackSpot's Runtimes Engine.

To do this, under --data-raw '{"name": "app-name"}', fill in app-name with the name of your application and run the command below:

curl --location --request PUT 'https://runtime-engine-api.runtimes.stackspot.com/apps/' \
--header 'Content-Type: application/json' \
--data-raw '{"name": "app-name"}'
caution

Write down the application ID and targetID that will be returned. You need these to run the deployment.

Make a deployment​

Use the targetID returned in the register your application, then in form ''target="{targetId}" fill in the targetID.

Run the command below to perform this deployment from the terminal:

curl --location --request POST 'https://runtime-engine-api.runtimes.stackspot.com/apps/{appId}/deploys/' \
--header 'Content-Type: multipart/form-data' \
--form 'spec=@"/.application-oam.yml"' \
--form 'target="{targetId}"'
caution

When changing {targetID} to the target where you will perform your deployment, make sure you are using the correct target.

Every time a deployment is performed, a status log is generated. This log provides the following information:

  • Application name;
  • Deployment status;
  • The steps that occurred in the deployment;
  • Components that were applied;
  • Which Target was applied.
info

Check your application’s deployment status:

Was this page helpful?