Environment

An environment resource designates the container image, the image pull policy, working directory, security parameters, and others. It exposes all the necessary tools (open source, 3rd party, or custom tools) along with their connection interfaces including external node port and the container ports. You can also specify a standard, distributed, or inference workload architecture for the environment. An environment is a mandatory building block for the creation of a workload. For more information, see Environments.

List environment assets.

Use to retrieve a list of environment assets.

SecuritybearerAuth

Request

query Parameters

name	string Filter results by name.
scope	string Filter results by scope.
projectId	integer <int32> Filter results by project id. if scope filter is project, only assets from the specific project will be included in the response. otherwise, the response will include both project, department, cluster and tenant assets.
departmentId	string Filter using the department id. Example: departmentId=1
clusterId	string <uuid> Filter using the Universally Unique Identifier (UUID) of the cluster. Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
usageInfo	boolean Whether the query should include asset usage information as part of the response.
complyToProject	integer <int32> Include workload creation compliance information of an asset, for a given project, as part of the response. To check compliance, you need to provide both project id and workload type.
complyToWorkloadType	string Include workload creation compliance information of an asset, for a given workload type, as part of the response. To check compliance, you need to provide both project id and workload type. Enum: "Workspace" "Training" "Distributed" "Inference"
distributedFramework	string Filter results to workload of type distributed and distributedFramework.
isDistributed	boolean Filter results to workload of type distributed.
isTraining	boolean Filter results to workload of type training.
isWorkspace	boolean Filter results to workload of type workspace.
isInference	boolean Filter results to workload of type inference.
complyToReplicaType	string Include workload creation compliance information of an asset, for a given replica type, as part of the response. To check compliance, you need to provide both project id and workload type. For distributed, replica type should be provided as well. Enum: "Worker" "Master"
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/environment

Response samples

application/json

{"entries": [{"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": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"image": "python:3.8",
"imagePullPolicy": "Always",
"workingDir": "/home/myfolder",
"createHomeDir": true,
"probes": {"readiness": {"initialDelaySeconds": 0,
"periodSeconds": 1,
"timeoutSeconds": 1,
"successThreshold": 1,
"failureThreshold": 1,
"handler": {"httpGet": {"path": null,
"port": null,
"host": null,
"scheme": null
}
}
}
},
"uidGidSource": "fromTheImage",
"capabilities": ["CHOWN",
"KILL"
],
"seccompProfileType": "RuntimeDefault",
"runAsNonRoot": true,
"readOnlyRootFilesystem": false,
"tty": true,
"stdin": true,
"allowPrivilegeEscalation": false,
"hostIpc": false,
"hostNetwork": false,
"connections": [{"name": "string",
"isExternal": false,
"internalToolInfo": {"toolType": "jupyter-notebook",
"connectionType": "LoadBalancer",
"containerPort": 1,
"nodePortInfo": {"isCustomPort": null
},
"externalUrlInfo": {"isCustomUrl": null,
"externalUrl": null
},
"servingPortInfo": {"protocol": null
}
},
"externalToolInfo": {"toolType": "wandb",
"externalUrl": "https://wandb.com/myteam/${PROJECT_NAME}"
}
}
],
"overrideUidGidInWorkspace": false
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": null
}
}
]
}
},
"usageTimes": {"lastUsedByWorkload": "2019-08-24T14:15:22Z"
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
}
}
]
}

Create an environment asset.

Use to create an environment asset.

SecuritybearerAuth

Request

Request Body schema: application/json

required	object (AssetCreationRequest)
required	object or null (EnvironmentAssetSpec) Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

409

The specified resource already exists

503

unexpected error

post/api/v1/asset/environment

Request samples

Payload

application/json

{"meta": {"name": "my-asset",
"scope": "tenant",
"workloadSupportedTypes": {"workspace": false,
"training": false,
"inference": false,
"distributed": true,
"distFramework": "TF"
}
},
"spec": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"image": "python:3.8",
"imagePullPolicy": "Always",
"workingDir": "/home/myfolder",
"createHomeDir": true,
"probes": {"readiness": {"initialDelaySeconds": 0,
"periodSeconds": 1,
"timeoutSeconds": 1,
"successThreshold": 1,
"failureThreshold": 1,
"handler": {"httpGet": {"path": "/",
"port": 1,
"host": "example.com",
"scheme": "HTTP"
}
}
}
},
"uidGidSource": "fromTheImage",
"capabilities": ["CHOWN",
"KILL"
],
"seccompProfileType": "RuntimeDefault",
"runAsNonRoot": true,
"readOnlyRootFilesystem": false,
"tty": true,
"stdin": true,
"allowPrivilegeEscalation": false,
"hostIpc": false,
"hostNetwork": false,
"connections": [{"name": "string",
"isExternal": false,
"internalToolInfo": {"toolType": "jupyter-notebook",
"connectionType": "LoadBalancer",
"containerPort": 1,
"nodePortInfo": {"isCustomPort": false
},
"externalUrlInfo": {"isCustomUrl": false,
"externalUrl": "string"
},
"servingPortInfo": {"protocol": "grpc"
}
},
"externalToolInfo": {"toolType": "wandb",
"externalUrl": "https://wandb.com/myteam/${PROJECT_NAME}"
}
}
],
"overrideUidGidInWorkspace": false
}
}

Response samples

application/json

{"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": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"image": "python:3.8",
"imagePullPolicy": "Always",
"workingDir": "/home/myfolder",
"createHomeDir": true,
"probes": {"readiness": {"initialDelaySeconds": 0,
"periodSeconds": 1,
"timeoutSeconds": 1,
"successThreshold": 1,
"failureThreshold": 1,
"handler": {"httpGet": {"path": "/",
"port": 1,
"host": "example.com",
"scheme": "HTTP"
}
}
}
},
"uidGidSource": "fromTheImage",
"capabilities": ["CHOWN",
"KILL"
],
"seccompProfileType": "RuntimeDefault",
"runAsNonRoot": true,
"readOnlyRootFilesystem": false,
"tty": true,
"stdin": true,
"allowPrivilegeEscalation": false,
"hostIpc": false,
"hostNetwork": false,
"connections": [{"name": "string",
"isExternal": false,
"internalToolInfo": {"toolType": "jupyter-notebook",
"connectionType": "LoadBalancer",
"containerPort": 1,
"nodePortInfo": {"isCustomPort": false
},
"externalUrlInfo": {"isCustomUrl": false,
"externalUrl": "string"
},
"servingPortInfo": {"protocol": "grpc"
}
},
"externalToolInfo": {"toolType": "wandb",
"externalUrl": "https://wandb.com/myteam/${PROJECT_NAME}"
}
}
],
"overrideUidGidInWorkspace": false
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"usageTimes": {"lastUsedByWorkload": "2019-08-24T14:15:22Z"
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
}
}

Get an environment asset.

Use to retrieve the details of environment asset by id.

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

query Parameters

usageInfo	boolean Whether the query should include asset usage information as part of the response.
complyToProject	integer <int32> Include workload creation compliance information of an asset, for a given project, as part of the response. To check compliance, you need to provide both project id and workload type.
complyToWorkloadType	string Include workload creation compliance information of an asset, for a given workload type, as part of the response. To check compliance, you need to provide both project id and workload type. Enum: "Workspace" "Training" "Distributed" "Inference"
complyToReplicaType	string Include workload creation compliance information of an asset, for a given replica type, as part of the response. To check compliance, you need to provide both project id and workload type. For distributed, replica type should be provided as well. Enum: "Worker" "Master"
statusInfo	boolean Whether the query should include asset status information as part of the response.

Responses

200

Request completed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

get/api/v1/asset/environment/{AssetId}

Response samples

application/json

{"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": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"image": "python:3.8",
"imagePullPolicy": "Always",
"workingDir": "/home/myfolder",
"createHomeDir": true,
"probes": {"readiness": {"initialDelaySeconds": 0,
"periodSeconds": 1,
"timeoutSeconds": 1,
"successThreshold": 1,
"failureThreshold": 1,
"handler": {"httpGet": {"path": "/",
"port": 1,
"host": "example.com",
"scheme": "HTTP"
}
}
}
},
"uidGidSource": "fromTheImage",
"capabilities": ["CHOWN",
"KILL"
],
"seccompProfileType": "RuntimeDefault",
"runAsNonRoot": true,
"readOnlyRootFilesystem": false,
"tty": true,
"stdin": true,
"allowPrivilegeEscalation": false,
"hostIpc": false,
"hostNetwork": false,
"connections": [{"name": "string",
"isExternal": false,
"internalToolInfo": {"toolType": "jupyter-notebook",
"connectionType": "LoadBalancer",
"containerPort": 1,
"nodePortInfo": {"isCustomPort": false
},
"externalUrlInfo": {"isCustomUrl": false,
"externalUrl": "string"
},
"servingPortInfo": {"protocol": "grpc"
}
},
"externalToolInfo": {"toolType": "wandb",
"externalUrl": "https://wandb.com/myteam/${PROJECT_NAME}"
}
}
],
"overrideUidGidInWorkspace": false
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"usageTimes": {"lastUsedByWorkload": "2019-08-24T14:15:22Z"
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
}
}

Update an environment asset.

Use to update the details of environment asset by id.

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json

required	object (AssetUpdateRequest)
required	object or null (EnvironmentAssetSpec) Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses

202

Request accepted successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

default

unexpected error

put/api/v1/asset/environment/{AssetId}

Request samples

Payload

application/json

{"meta": {"name": "my-asset"
},
"spec": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"image": "python:3.8",
"imagePullPolicy": "Always",
"workingDir": "/home/myfolder",
"createHomeDir": true,
"probes": {"readiness": {"initialDelaySeconds": 0,
"periodSeconds": 1,
"timeoutSeconds": 1,
"successThreshold": 1,
"failureThreshold": 1,
"handler": {"httpGet": {"path": "/",
"port": 1,
"host": "example.com",
"scheme": "HTTP"
}
}
}
},
"uidGidSource": "fromTheImage",
"capabilities": ["CHOWN",
"KILL"
],
"seccompProfileType": "RuntimeDefault",
"runAsNonRoot": true,
"readOnlyRootFilesystem": false,
"tty": true,
"stdin": true,
"allowPrivilegeEscalation": false,
"hostIpc": false,
"hostNetwork": false,
"connections": [{"name": "string",
"isExternal": false,
"internalToolInfo": {"toolType": "jupyter-notebook",
"connectionType": "LoadBalancer",
"containerPort": 1,
"nodePortInfo": {"isCustomPort": false
},
"externalUrlInfo": {"isCustomUrl": false,
"externalUrl": "string"
},
"servingPortInfo": {"protocol": "grpc"
}
},
"externalToolInfo": {"toolType": "wandb",
"externalUrl": "https://wandb.com/myteam/${PROJECT_NAME}"
}
}
],
"overrideUidGidInWorkspace": false
}
}

Response samples

202
401
403
404
default

application/json

{"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": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"image": "python:3.8",
"imagePullPolicy": "Always",
"workingDir": "/home/myfolder",
"createHomeDir": true,
"probes": {"readiness": {"initialDelaySeconds": 0,
"periodSeconds": 1,
"timeoutSeconds": 1,
"successThreshold": 1,
"failureThreshold": 1,
"handler": {"httpGet": {"path": "/",
"port": 1,
"host": "example.com",
"scheme": "HTTP"
}
}
}
},
"uidGidSource": "fromTheImage",
"capabilities": ["CHOWN",
"KILL"
],
"seccompProfileType": "RuntimeDefault",
"runAsNonRoot": true,
"readOnlyRootFilesystem": false,
"tty": true,
"stdin": true,
"allowPrivilegeEscalation": false,
"hostIpc": false,
"hostNetwork": false,
"connections": [{"name": "string",
"isExternal": false,
"internalToolInfo": {"toolType": "jupyter-notebook",
"connectionType": "LoadBalancer",
"containerPort": 1,
"nodePortInfo": {"isCustomPort": false
},
"externalUrlInfo": {"isCustomUrl": false,
"externalUrl": "string"
},
"servingPortInfo": {"protocol": "grpc"
}
},
"externalToolInfo": {"toolType": "wandb",
"externalUrl": "https://wandb.com/myteam/${PROJECT_NAME}"
}
}
],
"overrideUidGidInWorkspace": false
},
"usedBy": {"workspaces": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"trainings": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"distributed": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"inferences": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-workload-name",
"status": "string"
}
],
"templates": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"environments": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"computes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
}
],
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute",
"overrides": {"containerPath": "/container/directory"
}
}
]
}
},
"usageTimes": {"lastUsedByWorkload": "2019-08-24T14:15:22Z"
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
},
"status": {"status": "Issues found",
"issues": [{"scopeId": "string",
"scopeType": "system",
"issue": "ReplicationError"
}
],
"message": "string",
"url": "string"
}
}

Delete an environment asset.

Use to delete an environment asset by id.

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Responses

202

Accepted.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

delete/api/v1/asset/environment/{AssetId}

Response samples

application/json

{"code": 202,
"message": "Request has been accepted."
}

➔ Next to Storage Classes