Deployment request

The Deployment request feature in Spark allows users to submit a deployment request that will initiate a Continuous Integration / Continuous Deployment process (CI/CD). The request triggers a downstream application to initiate the process.

In order to make use of this capability, the following functionalities are required:

• Webhooks must be enabled, see Webhooks: Connect Spark with external systems to automate workflows.

• Downstream web application that is capable of accepting POST method requests.

• We recommend the use of the ImpEx APIs that facilitate moving Spark services between environments and tenants.

Implement a deployment to production

The diagram and steps below describe how the Deployment request feature can be used with the required functionalities as part of a CI/CD process to deploy a Spark service from the UAT to PROD environment.

1. User permissions to make a deployment request can be managed in Tenant configuration.

2. In the UAT environment, a user submits an Deployment request by selecting the Folder, Service, and Service version.

3. Spark sends a notification to the downstream application via a POST method using a webhook.

4. The downstream application receives the notification and conducts the following processing on the UAT environment:

   1. Check that the notification relates to a deployment request by checking the request body for "UserAction": "DeploymentRequest“.

   2. Acquire an access token via the Client Credentials grant.

   3. Generate the export package using the Export API, download and store it.

5. The downstream application then performs the remaining actions on the PROD environment.

   1. Acquire an access token via the Client Credentials grant.

   2. Publish the previously exported package using the Import API.

Demo video

This short video demonstrates the use of a Deployment request to copy a service version between environments.

2MB

Coherent Spark Deployment request.mp4

Open