Create a template.

Deprecated

POST

http://localhost:8080/api/v1/asset/workload-template

POST

/api/v1/asset/workload-template

curl -X POST http://localhost:8080/api/v1/asset/workload-template \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "workloadSupportedTypes": {
      "inference": false,
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "assets": {
      "environment": "string"
    }
  }
}'

{
  "meta": {
    "name": "my-asset",
    "scope": "tenant",
    "id": "a418ed33-9399-48c0-a890-122cadd13bfd",
    "kind": "s3",
    "createdBy": "test@run.ai",
    "createdAt": "2023-02-23T14:25:36.707685Z",
    "updatedBy": "test@run.ai",
    "updatedAt": "2023-02-23T14:25:36.707685Z",
    "workloadSupportedTypes": {
      "workspace": false,
      "training": false,
      "distributed": true,
      "distFramework": "TF"
    }
  },
  "spec": {
    "assets": {
      "environment": {
        "id": "string",
        "name": "my-asset",
        "toolTypes": [
          "jupyter-notebook"
        ]
      },
      "compute": {
        "id": "string",
        "name": "my-asset"
      },
      "datasources": [
        {
          "id": "string",
          "name": "my-asset",
          "kind": "compute",
          "overrides": {
            "containerPath": "/container/directory"
          }
        }
      ],
      "workloadVolumes": [
        "string"
      ]
    },
    "specificEnv": {
      "allowOverQuota": true,
      "annotations": [
        {
          "name": "billing",
          "value": "my-billing-unit",
          "exclude": false
        }
      ],
      "args": "-x my-script.py",
      "autoDeletionTimeAfterCompletionSeconds": 15,
      "autoScaling": {
        "activationReplicas": 1,
        "concurrencyHardLimit": 1,
        "initialReplicas": 1,
        "maxReplicas": 1,
        "metricThresholdPercentage": 1.1,
        "minReplicas": 1,
        "scaleDownDelaySeconds": 1,
        "scaleToZeroRetentionSeconds": 1,
        "thresholdMetric": "http_requests_total",
        "thresholdValue": 1,
        "initializationTimeoutSeconds": 1
      },
      "backoffLimit": 3,
      "category": "string",
      "command": "python",
      "completions": 1,
      "connections": [
        {
          "name": "string",
          "nodePort": 1,
          "externalUrl": "string",
          "authorizedUsers": [
            "string"
          ],
          "authorizedGroups": [
            "string"
          ]
        }
      ],
      "environmentVariables": [
        {
          "name": "HOME",
          "value": "/home/my-folder",
          "credential": {
            "assetId": "string",
            "key": "POSTGRES_PASSWORD"
          },
          "configMap": {
            "name": "my-config-map",
            "key": "MY_POSTGRES_SCHEMA"
          },
          "podFieldRef": {
            "path": "metadata.name"
          },
          "exclude": false,
          "description": "Home directory of the user."
        }
      ],
      "imagePullSecrets": [
        {
          "name": "string",
          "userCredential": true,
          "exclude": false
        }
      ],
      "labels": [
        {
          "name": "stage",
          "value": "initial-research",
          "exclude": false
        }
      ],
      "nodeAffinityRequired": {
        "nodeSelectorTerms": [
          {
            "matchExpressions": [
              {
                "key": "string",
                "operator": "In",
                "values": [
                  "string"
                ]
              }
            ]
          }
        ]
      },
      "nodePools": [
        "my-node-pool-a",
        "my-node-pool-b"
      ],
      "nodeType": "my-node-type",
      "parallelism": 1,
      "podAffinity": {
        "type": "Required",
        "key": "string"
      },
      "preemptibility": "preemptible",
      "priorityClass": "string",
      "restartPolicy": "Always",
      "runAsGid": 30,
      "runAsUid": 500,
      "servingPortAccess": {
        "authorizationType": "public",
        "authorizedUsers": [
          "user-a",
          "user-b"
        ],
        "authorizedGroups": [
          "group-a",
          "group-b"
        ],
        "clusterLocalAccessOnly": true
      },
      "supplementalGroups": "2,3,5,8",
      "terminateAfterPreemption": false,
      "terminationGracePeriodSeconds": 20,
      "tolerations": [
        {
          "name": "string",
          "operator": "Equal",
          "key": "string",
          "value": "string",
          "effect": "NoSchedule",
          "seconds": 1,
          "exclude": false
        }
      ]
    },
    "distributed": {
      "numWorkers": 1,
      "noMaster": true,
      "distFramework": "MPI",
      "master": {
        "assets": {
          "environment": {
            "id": "string",
            "name": "my-asset",
            "toolTypes": [
              "jupyter-notebook"
            ]
          },
          "compute": {
            "id": "string",
            "name": "my-asset"
          },
          "datasources": [
            {
              "id": "string",
              "name": "my-asset",
              "kind": "compute",
              "overrides": {
                "containerPath": "/container/directory"
              }
            }
          ],
          "workloadVolumes": [
            "string"
          ]
        },
        "specificEnv": {
          "allowOverQuota": true,
          "annotations": [
            {
              "name": "billing",
              "value": "my-billing-unit",
              "exclude": false
            }
          ],
          "args": "-x my-script.py",
          "autoDeletionTimeAfterCompletionSeconds": 15,
          "autoScaling": {
            "activationReplicas": 1,
            "concurrencyHardLimit": 1,
            "initialReplicas": 1,
            "maxReplicas": 1,
            "metricThresholdPercentage": 1.1,
            "minReplicas": 1,
            "scaleDownDelaySeconds": 1,
            "scaleToZeroRetentionSeconds": 1,
            "thresholdMetric": "http_requests_total",
            "thresholdValue": 1,
            "initializationTimeoutSeconds": 1
          },
          "backoffLimit": 3,
          "category": "string",
          "command": "python",
          "completions": 1,
          "connections": [
            {
              "name": "string",
              "nodePort": 1,
              "externalUrl": "string",
              "authorizedUsers": [
                "string"
              ],
              "authorizedGroups": [
                "string"
              ]
            }
          ],
          "environmentVariables": [
            {
              "name": "HOME",
              "value": "/home/my-folder",
              "credential": {
                "assetId": "string",
                "key": "POSTGRES_PASSWORD"
              },
              "configMap": {
                "name": "my-config-map",
                "key": "MY_POSTGRES_SCHEMA"
              },
              "podFieldRef": {
                "path": "metadata.name"
              },
              "exclude": false,
              "description": "Home directory of the user."
            }
          ],
          "imagePullSecrets": [
            {
              "name": "string",
              "userCredential": true,
              "exclude": false
            }
          ],
          "labels": [
            {
              "name": "stage",
              "value": "initial-research",
              "exclude": false
            }
          ],
          "nodeAffinityRequired": {
            "nodeSelectorTerms": [
              {
                "matchExpressions": [
                  {
                    "key": "string",
                    "operator": "In",
                    "values": [
                      "string"
                    ]
                  }
                ]
              }
            ]
          },
          "nodePools": [
            "my-node-pool-a",
            "my-node-pool-b"
          ],
          "nodeType": "my-node-type",
          "parallelism": 1,
          "podAffinity": {
            "type": "Required",
            "key": "string"
          },
          "preemptibility": "preemptible",
          "priorityClass": "string",
          "restartPolicy": "Always",
          "runAsGid": 30,
          "runAsUid": 500,
          "servingPortAccess": {
            "authorizationType": "public",
            "authorizedUsers": [
              "user-a",
              "user-b"
            ],
            "authorizedGroups": [
              "group-a",
              "group-b"
            ],
            "clusterLocalAccessOnly": true
          },
          "supplementalGroups": "2,3,5,8",
          "terminateAfterPreemption": false,
          "terminationGracePeriodSeconds": 20,
          "tolerations": [
            {
              "name": "string",
              "operator": "Equal",
              "key": "string",
              "value": "string",
              "effect": "NoSchedule",
              "seconds": 1,
              "exclude": false
            }
          ]
        }
      }
    }
  }
}

Use to create a template.

Authentication

AuthorizationBearer

Bearer authentication

Request

This endpoint expects an object.

metaobjectRequired

specobjectRequired

The information needed for creating az template - a set of assets and an optional set of specific environment parameters.

Response

Request accepted successfully.

metaobject

specobject

Information about the set of assets which comprises a workspace, training or template, and an optional set of specific run parameters.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

503

Service Unavailable Error