v1

latestOpenAPI 3.0.0Apache 2.02026-07-17392074.2 KB
launch

Launches the runtime environment described by the provided manifest in an asynchronous manner

put/launch/async

Query parameters

impersonatestring

User to impersonate (user encoded in authorization token must be configured as an administrator)

dispatchIdstring

Force the use of a specific DispatchID instead of generation of a new one.

Request body

manifestVersionstring required
additionalPropertiesobject

Example request

{
  "manifestVersion": "v1",
  "clientMetadata": {
    "name": "track-analysis",
    "title": "Track analysis",
    "description": "A track analysis environment"
  },
  "warehouseMetadata": {
    "owner": "lhamilton",
    "created": "2019-03-25 11:40:59 Z",
    "modified": "2019-03-25 11:41:32 Z",
    "version": "abc345d",
    "tags": [
      "default",
      "latest"
    ],
    "server": "http://example.org/warehouse/"
  },
  "dispatchMetadata": {
    "owner": "vbottas",
    "dispatcher": "com.cray.analytics.capsules.dispatcher.k8s.KubernetesDispatcher",
    "carriers": {
      "track-analyser": "com.cray.analytics.capsules.carriers.k8s.PodCarrier"
    },
    "launched": "2019-03-25 13:38:00 Z",
    "userInterfaces": [
      {
        "type": "web",
        "location": "http://some-pod.kubernetes.svc.default"
      }
    ]
  },
  "payloads": [
    {
      "name": "track-analyser",
      "id": "com.f1.analytics.tracks",
      "version": 1,
      "carriers": [
        "com.cray.analytics.capsules.carriers.k8s.PodCarrier"
      ],
      "launchParameters": {
        "mode": "interactive",
        "configuration": {
          "track": "bahrain"
        },
        "images": {
          "default": "track-analyser:latest"
        },
        "arguments": [
          "--g-force"
        ]
      },
      "resourceRequirements": {
        "instances": {
          "total": 1
        },
        "cores": {
          "total": 16
        },
        "memory": {
          "total": "128GiB"
        },
        "gpus": {
          "total": 1
        }
      }
    }
  ],
  "sharedData": [
    {
      "mountLocations": [
        "master",
        "workers"
      ],
      "name": "Environmentdata",
      "readOnly": false,
      "source": "/data/mydata",
      "target": "/var/data",
      "type": "Directory"
    }
  ]
}

Response

Runtime environment was accepted for launch

launchingUserstring
dispatchIdstring
state'UNKNOWN' | 'PENDING' | 'RUNNING' | 'TERMINATING' | 'MISSING' | 'TERMINATED' | 'COMPLETED' | 'FAILED'
lastUpdatedstring
payloadStatesobject
additionalPropertiesobject

Example response

{
  "lastUpdated": "lastUpdated",
  "payloadStates": {},
  "launchedCapsuleReference": {
    "owner": "owner",
    "name": "name",
    "version": "version"
  },
  "launchingUser": "launchingUser",
  "additionalProperties": "{}",
  "events": [
    {
      "level": "TRACE",
      "reporter": "reporter",
      "additionalProperties": "{}",
      "message": "message",
      "timestamp": "timestamp",
      "extraInfo": {
        "key": "extraInfo"
      }
    },
    {
      "level": "TRACE",
      "reporter": "reporter",
      "additionalProperties": "{}",
      "message": "message",
      "timestamp": "timestamp",
      "extraInfo": {
        "key": "extraInfo"
      }
    }
  ],
  "dispatchId": "dispatchId"
}