Create a new workspace template. [Experimental]

POST

http://localhost:8080/api/v1/workload-templates/workspaces

POST

/api/v1/workload-templates/workspaces

curl -X POST http://localhost:8080/api/v1/workload-templates/workspaces \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "meta": {
    "name": "my-template-name",
    "scopeType": "system"
  }
}'

{
  "meta": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "my-template-name",
    "workloadType": "Workspace",
    "scopeType": "system",
    "scopeId": "string",
    "createdBy": "test@lab.com",
    "createdAt": "2022-01-01T03:49:52.531Z",
    "description": "description of my template.",
    "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
    "departmentId": "2",
    "projectId": 1,
    "updatedBy": "test@lab.com",
    "updatedAt": "2022-01-01T03:49:52.531Z"
  },
  "spec": {
    "annotations": [
      {
        "name": "billing",
        "value": "my-billing-unit",
        "exclude": false
      }
    ],
    "args": "-x my-script.py",
    "autoDeletionTimeAfterCompletionSeconds": 15,
    "backoffLimit": 3,
    "category": "string",
    "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."
      }
    ],
    "exposedUrls": [
      {
        "container": 8080,
        "url": "https://my-url.com",
        "authorizationType": "authenticatedUsers",
        "authorizedUsers": [
          "user-a",
          "user-b"
        ],
        "authorizedGroups": [
          "group-a",
          "group-b"
        ],
        "toolType": "jupyter",
        "toolName": "my-pytorch",
        "name": "url-instance-a",
        "exclude": false
      }
    ],
    "image": "python:3.8",
    "imagePullPolicy": "Always",
    "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",
    "podAffinity": {
      "type": "Required",
      "key": "string"
    },
    "ports": [
      {
        "container": 8080,
        "serviceType": "LoadBalancer",
        "external": 30080,
        "toolType": "pytorch",
        "toolName": "my-pytorch",
        "name": "port-instance-a",
        "exclude": false
      }
    ],
    "preemptibility": "preemptible",
    "priorityClass": "string",
    "probes": {
      "readiness": {
        "initialDelaySeconds": 1,
        "periodSeconds": 1,
        "timeoutSeconds": 1,
        "successThreshold": 1,
        "failureThreshold": 1,
        "handler": {
          "httpGet": {
            "path": "/",
            "port": 1,
            "host": "example.com",
            "scheme": "HTTP"
          }
        }
      }
    },
    "relatedUrls": [
      {
        "url": "https://my-url.com",
        "type": "wandb",
        "name": "url-instance-a",
        "exclude": false
      }
    ],
    "restartPolicy": "Always",
    "security": {
      "allowPrivilegeEscalation": false,
      "capabilities": [
        "CHOWN",
        "KILL"
      ],
      "hostIpc": false,
      "hostNetwork": false,
      "readOnlyRootFilesystem": false,
      "runAsGid": 30,
      "runAsNonRoot": true,
      "runAsUid": 500,
      "seccompProfileType": "RuntimeDefault",
      "supplementalGroups": "2,3,5,8",
      "uidGidSource": "fromTheImage"
    },
    "stdin": true,
    "storage": {
      "configMapVolume": [
        {
          "configMap": "string",
          "defaultMode": "0644",
          "exclude": false,
          "mountPath": "string",
          "name": "storage-instance-a",
          "subPath": "string"
        }
      ],
      "dataVolume": [
        {
          "exclude": false,
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "mountPath": "/mnt/data"
        }
      ],
      "emptyDirVolume": [
        {
          "exclude": false,
          "medium": "string",
          "name": "storage-instance-a",
          "path": "/mnt/emptydir",
          "sizeLimit": "1G"
        }
      ],
      "git": [
        {
          "branch": "main",
          "exclude": false,
          "name": "storage-instance-a",
          "passwordSecret": "my-password-secret",
          "path": "/container/my-repository",
          "repository": "https://github.com/my-git/my-repo",
          "revision": "string",
          "secretKeyOfPassword": "Password",
          "secretKeyOfUser": "User",
          "secretRef": {
            "name": "my-password-secret",
            "authenticationMethod": "password",
            "secretKeyOfUser": "User",
            "secretKeyOfPassword": "Password"
          }
        }
      ],
      "hostPath": [
        {
          "exclude": false,
          "mountPath": "/local/directory",
          "mountPropagation": "None",
          "name": "storage-instance-a",
          "path": "/container/directory",
          "readOnly": true
        }
      ],
      "nfs": [
        {
          "exclude": false,
          "mountPath": "/local/nfs",
          "name": "storage-instance-a",
          "path": "/container/nfs",
          "readOnly": true,
          "server": "my.nfs.com"
        }
      ],
      "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
        }
      ],
      "s3": [
        {
          "accessKeySecret": "my-access-key-secret",
          "bucket": "my-bucket",
          "exclude": false,
          "name": "storage-instance-a",
          "path": "/container/my-bucket",
          "secretKeyOfAccessKeyId": "AccessKeyId",
          "secretKeyOfSecretKey": "SecretKey",
          "url": "https://s3.amazonaws.com"
        }
      ],
      "secretVolume": [
        {
          "defaultMode": "0644",
          "exclude": false,
          "mountPath": "string",
          "name": "storage-instance-a",
          "secret": "string"
        }
      ]
    },
    "terminateAfterPreemption": false,
    "terminationGracePeriodSeconds": 20,
    "tolerations": [
      {
        "name": "string",
        "operator": "Equal",
        "key": "string",
        "value": "string",
        "effect": "NoSchedule",
        "seconds": 1,
        "exclude": false
      }
    ],
    "tty": true,
    "workingDir": "/home/myfolder"
  },
  "runnable": {
    "isRunnable": false,
    "issue": "mandatory image is not provided"
  },
  "combinedSpec": {
    "annotations": [
      {
        "name": "billing",
        "value": "my-billing-unit",
        "exclude": false
      }
    ],
    "args": "-x my-script.py",
    "autoDeletionTimeAfterCompletionSeconds": 15,
    "backoffLimit": 3,
    "category": "string",
    "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."
      }
    ],
    "exposedUrls": [
      {
        "container": 8080,
        "url": "https://my-url.com",
        "authorizationType": "authenticatedUsers",
        "authorizedUsers": [
          "user-a",
          "user-b"
        ],
        "authorizedGroups": [
          "group-a",
          "group-b"
        ],
        "toolType": "jupyter",
        "toolName": "my-pytorch",
        "name": "url-instance-a",
        "exclude": false
      }
    ],
    "image": "python:3.8",
    "imagePullPolicy": "Always",
    "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",
    "podAffinity": {
      "type": "Required",
      "key": "string"
    },
    "ports": [
      {
        "container": 8080,
        "serviceType": "LoadBalancer",
        "external": 30080,
        "toolType": "pytorch",
        "toolName": "my-pytorch",
        "name": "port-instance-a",
        "exclude": false
      }
    ],
    "preemptibility": "preemptible",
    "priorityClass": "string",
    "probes": {
      "readiness": {
        "initialDelaySeconds": 1,
        "periodSeconds": 1,
        "timeoutSeconds": 1,
        "successThreshold": 1,
        "failureThreshold": 1,
        "handler": {
          "httpGet": {
            "path": "/",
            "port": 1,
            "host": "example.com",
            "scheme": "HTTP"
          }
        }
      }
    },
    "relatedUrls": [
      {
        "url": "https://my-url.com",
        "type": "wandb",
        "name": "url-instance-a",
        "exclude": false
      }
    ],
    "restartPolicy": "Always",
    "security": {
      "allowPrivilegeEscalation": false,
      "capabilities": [
        "CHOWN",
        "KILL"
      ],
      "hostIpc": false,
      "hostNetwork": false,
      "readOnlyRootFilesystem": false,
      "runAsGid": 30,
      "runAsNonRoot": true,
      "runAsUid": 500,
      "seccompProfileType": "RuntimeDefault",
      "supplementalGroups": "2,3,5,8",
      "uidGidSource": "fromTheImage"
    },
    "stdin": true,
    "storage": {
      "configMapVolume": [
        {
          "configMap": "string",
          "defaultMode": "0644",
          "exclude": false,
          "mountPath": "string",
          "name": "storage-instance-a",
          "subPath": "string"
        }
      ],
      "dataVolume": [
        {
          "exclude": false,
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "mountPath": "/mnt/data"
        }
      ],
      "emptyDirVolume": [
        {
          "exclude": false,
          "medium": "string",
          "name": "storage-instance-a",
          "path": "/mnt/emptydir",
          "sizeLimit": "1G"
        }
      ],
      "git": [
        {
          "branch": "main",
          "exclude": false,
          "name": "storage-instance-a",
          "passwordSecret": "my-password-secret",
          "path": "/container/my-repository",
          "repository": "https://github.com/my-git/my-repo",
          "revision": "string",
          "secretKeyOfPassword": "Password",
          "secretKeyOfUser": "User",
          "secretRef": {
            "name": "my-password-secret",
            "authenticationMethod": "password",
            "secretKeyOfUser": "User",
            "secretKeyOfPassword": "Password"
          }
        }
      ],
      "hostPath": [
        {
          "exclude": false,
          "mountPath": "/local/directory",
          "mountPropagation": "None",
          "name": "storage-instance-a",
          "path": "/container/directory",
          "readOnly": true
        }
      ],
      "nfs": [
        {
          "exclude": false,
          "mountPath": "/local/nfs",
          "name": "storage-instance-a",
          "path": "/container/nfs",
          "readOnly": true,
          "server": "my.nfs.com"
        }
      ],
      "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
        }
      ],
      "s3": [
        {
          "accessKeySecret": "my-access-key-secret",
          "bucket": "my-bucket",
          "exclude": false,
          "name": "storage-instance-a",
          "path": "/container/my-bucket",
          "secretKeyOfAccessKeyId": "AccessKeyId",
          "secretKeyOfSecretKey": "SecretKey",
          "url": "https://s3.amazonaws.com"
        }
      ],
      "secretVolume": [
        {
          "defaultMode": "0644",
          "exclude": false,
          "mountPath": "string",
          "name": "storage-instance-a",
          "secret": "string"
        }
      ]
    },
    "terminateAfterPreemption": false,
    "terminationGracePeriodSeconds": 20,
    "tolerations": [
      {
        "name": "string",
        "operator": "Equal",
        "key": "string",
        "value": "string",
        "effect": "NoSchedule",
        "seconds": 1,
        "exclude": false
      }
    ],
    "tty": true,
    "workingDir": "/home/myfolder"
  }
}

Create a new workspace template.

Authentication

AuthorizationBearer

Bearer authentication

Request

This endpoint expects an object.

metaobjectRequired

specobjectOptional

Response

Request completed successfully.

metaobject

specobjectOptional

runnableobjectOptional

whether the template can be submitted, as is

combinedSpecobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

503

Service Unavailable Error