Creating Deployments

This endpoint registers a new ROCKIT Edge deployment. A deployment must contain an origin configuration describing where the generated ROCKIT Images and ROCKIT Patches should be published.

It may also contain a download authentication group in case ROCKIT Edge should also handle the CDN download authentication, for example for using the ROCKIT StreamInstaller.

File structure on deployment:

The generated file structure can be obtained from GET /be/v1/apps. It returns all relevant information to access ROCKIT images via an dxfName as well as the available patches in an array fromBuildId-toBuildId. ROCKITPLAY deploys the files according to the following file structure to your origin:
DxF path: originPrefix/dxf/orgName/appName/iCurBuild/dxfName/*
Patch path: originPrefix/pat/orgName/appName/toBuildId/fromBuildId/*
with
originPrefix: is defined when you call POST /be/v1/deployments
orgName: "is defined when creating an organization"
appName: is defined when you call POST /be/v1/apps
dxfName, fromBuildId-toBuildId, iCurBuild: can be obtained from GET /be/v1/apps
in paths buildIds are masked as 4 digit number, e.g. iCurBuild = 1 becomes 0001 in path

Important:

If incorrect credentials are used when creating a deployment, the deployment will still be created without errors. However, this issue will surface later during the app creation and build import process (e.g., with POST /be/v1/apps and POST /be/v1/builds).

Common Problem Indicators:
If an app tries to deploy but cannot, it will enter an error state.
Checking GET /be/v1/apps will show that the app is in an error state.
GET /be/v1/tasks can be used to inspect which task failed.

Solution:
If an app fails to deploy due to incorrect credentials or deployment issues, you can resolve it in one of the following ways:

Update the Deployment Credentials & Retry the Task

Use PATCH /deployments to update the deployment with the correct credentials.

Use Retry Task to trigger the failed task again.

If the task now succeeds, the app will no longer be in an error state.

Deregister the Faulty Deployment & Retry the Task

Deregister the incorrect deployment(s) from the app with PATCH /apps.

Use Retry Task to redeploy the app to all correctly registered deployments.

If successful, the app will no longer be in an error state.

Additional Notes

In order that AWS S3 buckets work correctly, please make sure the hostname does
not contain the bucket name and contains the region, i.e.
s3.us-east-1.amazonaws.com.

Currently no other region than us-east-1 is supported for the original AWS S3.

Required Permissions

deployments.create

See Roles for more details.

Request

Header Params

Body Params application/json

Example

{
    "name" : "gcore",
    "label" : "Gcore Object Storage / Gcore CDN",
    "origin" : {
        "s3" : {
            "hostname" : "{{EDGE_ORIGIN_GCORE_HOSTNAME}}",
            "accessKey": "{{EDGE_ORIGIN_GCORE_ACCESS_KEY}}",
            "secretKey": "{{EDGE_ORIGIN_GCORE_SECRET_KEY}}",
            "location" : "{{EDGE_ORIGIN_GCORE_LOCATION}}",
            "bucket"   : "{{EDGE_ORIGIN_GCORE_BUCKET}}",
            "prefix"   : "{{EDGE_ORIGIN_GCORE_PREFIX}}"
        }
    },
    "dlAuth": {
        "gcore": {
            "baseUrl"    : "{{EDGE_ORIGIN_GCORE_BASE_URL}}",
            "secureToken": "{{EDGE_ORIGIN_GCORE_SECURE_TOKEN}}",
            "bucket"     : "{{EDGE_ORIGIN_GCORE_BUCKET}}",
            "prefix"     : "{{EDGE_ORIGIN_GCORE_PREFIX}}"
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

File structure on deployment:#

Important:#

Additional Notes#