Create a workload. | NVIDIA Run:ai Documentation

{
  "metadata": {
    "name": "my-workload-name",
    "projectId": "1",
    "id": "string",
    "gvk": {
      "version": "v1",
      "kind": "Deployment",
      "group": "apps"
    },
    "projectName": "project-a",
    "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
    "tenantId": 1001,
    "departmentId": "2",
    "departmentName": "default",
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "user@run.ai",
    "updatedAt": "2024-01-15T10:35:00Z",
    "updatedBy": "user@run.ai",
    "priority": "string",
    "category": "string",
    "preemptibility": "preemptible",
    "configuration": {
      "mnnvl": "string",
      "userCredentials": {
        "sources": [
          {
            "ref": "my-hf-token-abc1234567"
          }
        ]
      }
    },
    "deletedAt": "2024-01-15T10:35:00Z",
    "deletedBy": "user@run.ai"
  },
  "desiredPhase": "Running",
  "workloadManifest": {
    "apiVersion": "apps/v1",
    "kind": "Deployment",
    "metadata": {
      "name": "my-app"
    },
    "spec": {
      "replicas": 1,
      "selector": {
        "matchLabels": {
          "app": "my-app"
        }
      },
      "template": {
        "metadata": {
          "labels": {
            "app": "my-app"
          }
        },
        "spec": {
          "containers": [
            {
              "image": "nginx:latest",
              "name": "app"
            }
          ]
        }
      }
    }
  },
  "rawManifest": {
    "apiVersion": "apps/v1",
    "kind": "Deployment",
    "metadata": {
      "name": "my-app"
    },
    "spec": {
      "replicas": 1,
      "selector": {
        "matchLabels": {
          "app": "my-app"
        }
      },
      "template": {
        "metadata": {
          "labels": {
            "app": "my-app"
          }
        },
        "spec": {
          "containers": [
            {
              "image": "nginx:latest",
              "name": "app"
            }
          ]
        }
      }
    }
  }
}

Submit a workload with metadata and a Kubernetes manifest.

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

dryRunbooleanOptionalDefaults to false

True to perform validations only, without side effects.

Request

Workload metadata and manifest

metadataobjectRequired

manifestmap from strings to anyOptional

The full Kubernetes manifest for the workload in JSON form. Mutually exclusive with manifestEncodedBase64.

manifestBase64EncodedstringOptionalformat: "byte"<=2097152 characters

Kubernetes YAML manifest encoded in base 64. Mutually exclusive with manifest.

Response

Workload creation request accepted.

metadataobject

desiredPhaseenum

The desired phase of the workload.

Allowed values:

workloadManifestmap from strings to any

The full Kubernetes manifest for the workload in JSON form. Mutually exclusive with manifestEncodedBase64.

rawManifestmap from strings to any

The full Kubernetes manifest for the workload in JSON form. Mutually exclusive with manifestEncodedBase64.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

503

Service Unavailable Error