NFS

Use NFS as a data source location for data sets that are relevant to the workload being submitted.

List NFS assets.

Retrieve a list of NFS datasource 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"
assetIds	string^\b(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-... Filter results by the ids of the assets. Provided value should be a comma separated string of UUIDs. Example: assetIds=dbf4767e-2fa1-43b0-97a2-7c0cecda180b,550e8400-e29b-41d4-a716-44665544000a
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"

Responses

200

Request completed successfully.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/datasource/nfs

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": {"path": "/container/nfs",
"readOnly": true,
"server": "my.nfs.com",
"mountPath": "/local/nfs"
},
"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"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
]
}
},
"usageTimes": {"lastUsedByWorkload": "2019-08-24T14:15:22Z"
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
}
}
]
}

Create an NFS asset.

Use to create an NFS datasource asset.

SecuritybearerAuth

Request

Request Body schema: application/json

required	object (AssetCreationRequest)
required	object or null (NFSAssetSpec)

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/datasource/nfs

Request samples

Payload

application/json

{"meta": {"name": "my-asset",
"scope": "tenant",
"workloadSupportedTypes": {"workspace": false,
"training": false,
"inference": false,
"distributed": true,
"distFramework": "TF"
}
},
"spec": {"path": "/container/nfs",
"readOnly": true,
"server": "my.nfs.com",
"mountPath": "/local/nfs"
}
}

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": {"bucket": "my-bucket",
"path": "/container/my-bucket",
"url": "https://s3.amazonaws.com",
"accessKeyAssetId": "85754ae3-3c5c-44f4-b3c9-d15423577c51"
},
"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"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
]
}
},
"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 NFS asset.

Use to retrieve the details of NFS datasource 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"

Responses

200

Request completed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

get/api/v1/asset/datasource/nfs/{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": {"path": "/container/nfs",
"readOnly": true,
"server": "my.nfs.com",
"mountPath": "/local/nfs"
},
"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"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
]
}
},
"usageTimes": {"lastUsedByWorkload": "2019-08-24T14:15:22Z"
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
}
}

Update an NFS asset.

Use to update the details of NFS datasource 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 (NFSAssetSpec)

Responses

202

Request accepted successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

default

unexpected error

put/api/v1/asset/datasource/nfs/{AssetId}

Request samples

Payload

application/json

{"meta": {"name": "my-asset"
},
"spec": {"path": "/container/nfs",
"readOnly": true,
"server": "my.nfs.com",
"mountPath": "/local/nfs"
}
}

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": {"path": "/container/nfs",
"readOnly": true,
"server": "my.nfs.com",
"mountPath": "/local/nfs"
},
"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"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
]
}
},
"usageTimes": {"lastUsedByWorkload": "2019-08-24T14:15:22Z"
},
"compliance": {"imposed": true,
"compliance": true,
"reason": [{"field": "string",
"details": "string"
}
]
}
}

Delete an NFS asset.

Use to delete an NFS datasource 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/datasource/nfs/{AssetId}

Response samples

application/json

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

➔ Next to PVC