Create a distributed inference.

POST

http://localhost:8080/api/v1/workloads/distributed-inferences

POST

/api/v1/workloads/distributed-inferences

curl -X POST http://localhost:8080/api/v1/workloads/distributed-inferences \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "my-workload-name",
  "projectId": "1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210"
}'

{
  "name": "my-workload-name",
  "requestedName": "string",
  "workloadId": "string",
  "projectId": "1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "createdBy": "test@lab.com",
  "createdAt": "2022-01-01T03:49:52.531Z",
  "desiredPhase": "Running",
  "departmentId": "2",
  "deletedAt": "2022-01-01T03:49:52.531Z",
  "actualPhase": "Creating",
  "spec": {
    "category": "string",
    "nodePools": [
      "my-node-pool-a",
      "my-node-pool-b"
    ],
    "preemptibility": "preemptible",
    "priorityClass": "string",
    "restartPolicy": "RecreateGroupOnPodRestart",
    "servingPort": {
      "authorizationType": "public",
      "authorizedGroups": [
        "group-a",
        "group-b"
      ],
      "authorizedUsers": [
        "user.a@example.com",
        "user.b@example.com"
      ],
      "exposeExternally": true,
      "exposedUrl": "string",
      "port": 8080,
      "protocol": "http"
    },
    "startupPolicy": "LeaderCreated",
    "workers": 4,
    "replicas": 2,
    "leader": {
      "annotations": [
        {
          "name": "billing",
          "value": "my-billing-unit",
          "exclude": false
        }
      ],
      "args": "-x my-script.py",
      "command": "python",
      "compute": {
        "cpuCoreLimit": 2,
        "cpuCoreRequest": 0.5,
        "cpuMemoryLimit": "30M",
        "cpuMemoryRequest": "20M",
        "extendedResources": [
          {
            "resource": "hardware-vendor.example/foo",
            "quantity": "2",
            "exclude": false
          }
        ],
        "gpuDevicesRequest": 1,
        "gpuMemoryLimit": "10M",
        "gpuMemoryRequest": "10M",
        "gpuPortionLimit": 0.5,
        "gpuPortionRequest": 0.5,
        "gpuRequestType": "portion",
        "largeShmRequest": false
      },
      "createHomeDir": true,
      "environmentVariables": [
        {
          "name": "HOME",
          "value": "/home/my-folder",
          "secret": {
            "name": "postgress_secret",
            "key": "POSTGRES_PASSWORD"
          },
          "configMap": {
            "name": "my-config-map",
            "key": "MY_POSTGRES_SCHEMA"
          },
          "podFieldRef": {
            "path": "metadata.name"
          },
          "userCredential": {
            "name": "my_postgres_user_and_password",
            "key": "POSTGRES_PASSWORD"
          },
          "exclude": false,
          "description": "Home directory of the user."
        }
      ],
      "image": "python:3.8",
      "imagePullPolicy": "Always",
      "imagePullSecrets": [
        {
          "name": "string",
          "userCredential": true,
          "exclude": false
        }
      ],
      "labels": [
        {
          "name": "stage",
          "value": "initial-research",
          "exclude": false
        }
      ],
      "nodeAffinityRequired": {
        "nodeSelectorTerms": [
          {
            "matchExpressions": [
              {
                "key": "string",
                "operator": "In",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      },
      "nodeType": "my-node-type",
      "podAffinity": {
        "type": "Required",
        "key": "string"
      },
      "probes": {
        "readiness": {
          "initialDelaySeconds": 1,
          "periodSeconds": 1,
          "timeoutSeconds": 1,
          "successThreshold": 1,
          "failureThreshold": 1,
          "handler": {
            "httpGet": {
              "path": "/",
              "port": 1,
              "host": "example.com",
              "scheme": "HTTP"
            }
          }
        }
      },
      "security": {
        "capabilities": [
          "CHOWN",
          "KILL"
        ],
        "hostIpc": false,
        "hostNetwork": false,
        "readOnlyRootFilesystem": false,
        "runAsGid": 30,
        "runAsNonRoot": true,
        "runAsUid": 500,
        "seccompProfileType": "RuntimeDefault",
        "supplementalGroups": "2,3,5,8",
        "uidGidSource": "fromTheImage"
      },
      "storage": {
        "configMapVolume": [
          {
            "configMap": "string",
            "defaultMode": "0644",
            "exclude": false,
            "mountPath": "string",
            "name": "storage-instance-a",
            "subPath": "string"
          }
        ],
        "emptyDirVolume": [
          {
            "exclude": false,
            "medium": "string",
            "name": "storage-instance-a",
            "path": "/mnt/emptydir",
            "sizeLimit": "1G"
          }
        ],
        "pvc": [
          {
            "claimInfo": {
              "size": "1G",
              "storageClass": "my-storage-class",
              "accessModes": {
                "readWriteOnce": true,
                "readOnlyMany": false,
                "readWriteMany": false
              },
              "volumeMode": "Filesystem",
              "addedAttrValues": [
                {
                  "key": "dnsname",
                  "value": "my.dns.com"
                }
              ]
            },
            "claimName": "my-claim",
            "dataSharing": false,
            "ephemeral": false,
            "exclude": false,
            "existingPvc": false,
            "name": "storage-instance-a",
            "path": "/container/my-claim",
            "readOnly": false
          }
        ],
        "secretVolume": [
          {
            "defaultMode": "0644",
            "exclude": false,
            "mountPath": "string",
            "name": "storage-instance-a",
            "secret": "string"
          }
        ]
      },
      "tolerations": [
        {
          "name": "string",
          "operator": "Equal",
          "key": "string",
          "value": "string",
          "effect": "NoSchedule",
          "seconds": 1,
          "exclude": false
        }
      ],
      "workingDir": "/home/myfolder"
    },
    "worker": {
      "annotations": [
        {
          "name": "billing",
          "value": "my-billing-unit",
          "exclude": false
        }
      ],
      "args": "-x my-script.py",
      "command": "python",
      "compute": {
        "cpuCoreLimit": 2,
        "cpuCoreRequest": 0.5,
        "cpuMemoryLimit": "30M",
        "cpuMemoryRequest": "20M",
        "extendedResources": [
          {
            "resource": "hardware-vendor.example/foo",
            "quantity": "2",
            "exclude": false
          }
        ],
        "gpuDevicesRequest": 1,
        "gpuMemoryLimit": "10M",
        "gpuMemoryRequest": "10M",
        "gpuPortionLimit": 0.5,
        "gpuPortionRequest": 0.5,
        "gpuRequestType": "portion",
        "largeShmRequest": false
      },
      "createHomeDir": true,
      "environmentVariables": [
        {
          "name": "HOME",
          "value": "/home/my-folder",
          "secret": {
            "name": "postgress_secret",
            "key": "POSTGRES_PASSWORD"
          },
          "configMap": {
            "name": "my-config-map",
            "key": "MY_POSTGRES_SCHEMA"
          },
          "podFieldRef": {
            "path": "metadata.name"
          },
          "userCredential": {
            "name": "my_postgres_user_and_password",
            "key": "POSTGRES_PASSWORD"
          },
          "exclude": false,
          "description": "Home directory of the user."
        }
      ],
      "image": "python:3.8",
      "imagePullPolicy": "Always",
      "imagePullSecrets": [
        {
          "name": "string",
          "userCredential": true,
          "exclude": false
        }
      ],
      "labels": [
        {
          "name": "stage",
          "value": "initial-research",
          "exclude": false
        }
      ],
      "nodeAffinityRequired": {
        "nodeSelectorTerms": [
          {
            "matchExpressions": [
              {
                "key": "string",
                "operator": "In",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      },
      "nodeType": "my-node-type",
      "podAffinity": {
        "type": "Required",
        "key": "string"
      },
      "probes": {
        "readiness": {
          "initialDelaySeconds": 1,
          "periodSeconds": 1,
          "timeoutSeconds": 1,
          "successThreshold": 1,
          "failureThreshold": 1,
          "handler": {
            "httpGet": {
              "path": "/",
              "port": 1,
              "host": "example.com",
              "scheme": "HTTP"
            }
          }
        }
      },
      "security": {
        "capabilities": [
          "CHOWN",
          "KILL"
        ],
        "hostIpc": false,
        "hostNetwork": false,
        "readOnlyRootFilesystem": false,
        "runAsGid": 30,
        "runAsNonRoot": true,
        "runAsUid": 500,
        "seccompProfileType": "RuntimeDefault",
        "supplementalGroups": "2,3,5,8",
        "uidGidSource": "fromTheImage"
      },
      "storage": {
        "configMapVolume": [
          {
            "configMap": "string",
            "defaultMode": "0644",
            "exclude": false,
            "mountPath": "string",
            "name": "storage-instance-a",
            "subPath": "string"
          }
        ],
        "emptyDirVolume": [
          {
            "exclude": false,
            "medium": "string",
            "name": "storage-instance-a",
            "path": "/mnt/emptydir",
            "sizeLimit": "1G"
          }
        ],
        "pvc": [
          {
            "claimInfo": {
              "size": "1G",
              "storageClass": "my-storage-class",
              "accessModes": {
                "readWriteOnce": true,
                "readOnlyMany": false,
                "readWriteMany": false
              },
              "volumeMode": "Filesystem",
              "addedAttrValues": [
                {
                  "key": "dnsname",
                  "value": "my.dns.com"
                }
              ]
            },
            "claimName": "my-claim",
            "dataSharing": false,
            "ephemeral": false,
            "exclude": false,
            "existingPvc": false,
            "name": "storage-instance-a",
            "path": "/container/my-claim",
            "readOnly": false
          }
        ],
        "secretVolume": [
          {
            "defaultMode": "0644",
            "exclude": false,
            "mountPath": "string",
            "name": "storage-instance-a",
            "secret": "string"
          }
        ]
      },
      "tolerations": [
        {
          "name": "string",
          "operator": "Equal",
          "key": "string",
          "value": "string",
          "effect": "NoSchedule",
          "seconds": 1,
          "exclude": false
        }
      ],
      "workingDir": "/home/myfolder"
    }
  }
}

Create a distributed inference using container related fields.

Authentication

AuthorizationBearer

Bearer authentication

Request

This endpoint expects an object.

namestringRequiredformat: ".*">=1 character

The name of the workload.

projectIdstringRequiredformat: ".*"

The id of the project.

clusterIdstringRequiredformat: "uuid"

The id of the cluster.

useGivenNameAsPrefixbooleanOptionalDefaults to false

When true, the requested name will be treated as a prefix. The final name of the workload will be composed of the name followed by a random set of characters.

templateIdstring or nullOptionalformat: "uuid"

The unique identifier of the template to use for submitting this workload. The combined values provided in the spec, template and assets will be used to create the workload.

assetsobject or nullOptional

specobjectOptional

Response

Request completed successfully.

namestringformat: ".*">=1 character

The name of the workload.

requestedNamestring

The name as was requested for the workload. If useGivenNameAsPrefix, in the creation request, is false, name and requestedName should be identical. Otherwise, name should be composed of requestedName followed by a suffix of random characters.

workloadIdstringformat: "uuid"

A unique ID of the workload.

projectIdstringformat: ".*"

The id of the project.

clusterIdstringformat: "uuid"

The id of the cluster.

createdBystring

The user who created the workload

createdAtdatetime

The creation time of the workload.

desiredPhaseenum

The desired phase of the workload.

Allowed values:

departmentIdstringOptionalformat: ".*">=1 character

The id of the department.

deletedAtdatetime or nullOptional

The deletion time of the workload.

actualPhaseenumOptional

specobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error