mirror of
https://github.com/hanzo-ml/kuberay.git
synced 2026-10-30 19:48:47 +00:00
Right now the example workers' initContainer that checks for head Pod to be running logs the message `waiting for myservice`. There is no `myservice` per se. The actual thing it's waiting for is the K8s Service for the head group. This change updates the log message to be more descriptive and removes the string `myservice` from various places to not be misleading. Signed-off-by: David Xia <[email protected]>
KubeRay ApiServer
The KubeRay ApiServer provides gRPC and HTTP APIs to manage KubeRay resources.
!!! note
The KubeRay ApiServer is an optional component. It provides a layer of simplified
configuration for KubeRay resources. The KubeRay API server is used internally
by some organizations to back user interfaces for KubeRay resource management.
The KubeRay ApiServer is community-managed and is not officially endorsed by the
Ray maintainers. At this time, the only officially supported methods for
managing KubeRay resources are
- Direct management of KubeRay custom resources via kubectl, kustomize, and Kubernetes language clients.
- Helm charts.
KubeRay ApiServer maintainer contacts (GitHub handles):
@Jeffwan @scarlet25151
Usage
Compute Template
Create compute templates in a given namespace
POST {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/compute_templates
{
"name": "default-template",
"namespace": "<namespace>",
"cpu": 2,
"memory": 4,
"gpu": 1,
"gpuAccelerator": "Tesla-V100"
}
List all compute templates in a given namespace
GET {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/compute_templates
{
"compute_templates": [
{
"name": "default-template",
"namespace": "<namespace>",
"cpu": 2,
"memory": 4,
"gpu": 1,
"gpu_accelerator": "Tesla-V100"
}
]
}
List all compute templates in all namespaces
GET {{baseUrl}}/apis/v1alpha2/compute_templates
Get compute template by name
GET {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/compute_templates/<compute_template_name>
Delete compute template by name
DELETE {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/compute_templates/<compute_template_name>
Clusters
Create cluster in a given namespace
POST {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/clusters
payload
{
"name": "test-cluster",
"namespace": "<namespace>",
"user": "jiaxin.shan",
"version": "1.9.2",
"environment": "DEV",
"clusterSpec": {
"headGroupSpec": {
"computeTemplate": "head-template",
"image": "ray.io/ray:1.9.2",
"serviceType": "NodePort",
"rayStartParams": {}
},
"workerGroupSpec": [
{
"groupName": "small-wg",
"computeTemplate": "worker-template",
"image": "ray.io/ray:1.9.2",
"replicas": 2,
"minReplicas": 0,
"maxReplicas": 5,
"rayStartParams": {}
}
]
}
}
List all clusters in a given namespace
GET {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/clusters
{
"clusters": [
{
"name": "test-cluster",
"namespace": "<namespace>",
"user": "jiaxin.shan",
"version": "1.9.2",
"environment": "DEV",
"cluster_spec": {
"head_group_spec": {
"compute_template": "head-template",
"image": "rayproject/ray:1.9.2",
"service_type": "NodePort",
"ray_start_params": {
"dashboard-host": "0.0.0.0",
"node-ip-address": "$MY_POD_IP",
"port": "6379"
}
},
"worker_group_spec": [
{
"group_name": "small-wg",
"compute_template": "worker-template",
"image": "rayproject/ray:1.9.2",
"replicas": 2,
"min_replicas": 0,
"max_replicas": 5,
"ray_start_params": {
"node-ip-address": "$MY_POD_IP",
}
}
]
},
"created_at": "2022-03-13T15:13:09Z",
"deleted_at": null
},
]
}
List all clusters in all namespaces
GET {{baseUrl}}/apis/v1alpha2/clusters
Get cluster by its name and namespace
GET {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/clusters/<cluster_name>
Delete cluster by its name and namespace
DELETE {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/clusters/<cluster_name>
RayJob
Create ray job in a given namespace
POST {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/jobs
payload
{
"name": "string",
"namespace": "string",
"user": "string",
"entrypoint": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"runtimeEnv": "string",
"jobId": "string",
"shutdownAfterJobFinishes": true,
"clusterSelector": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"clusterSpec": {
"headGroupSpec": {
"computeTemplate": "string",
"image": "string",
"serviceType": "string",
"rayStartParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"volumes": [
{
"mountPath": "string",
"volumeType": "PERSISTENT_VOLUME_CLAIM",
"name": "string",
"source": "string",
"readOnly": true,
"hostPathType": "DIRECTORY",
"mountPropagationMode": "NONE"
}
]
},
"workerGroupSpec": [
{
"groupName": "string",
"computeTemplate": "string",
"image": "string",
"replicas": 0,
"minReplicas": 0,
"maxReplicas": 0,
"rayStartParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"volumes": [
{
"mountPath": "string",
"volumeType": "PERSISTENT_VOLUME_CLAIM",
"name": "string",
"source": "string",
"readOnly": true,
"hostPathType": "DIRECTORY",
"mountPropagationMode": "NONE"
}
]
}
]
},
"ttlSecondsAfterFinished": 0,
"createdAt": "2022-08-19T21:20:30.494Z",
"deleteAt": "2022-08-19T21:20:30.494Z",
"jobStatus": "string",
"jobDeploymentStatus": "string",
"message": "string"
}
List all jobs in a given namespace
GET {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/jobs
Response
{
"jobs": [
{
"name": "string",
"namespace": "string",
"user": "string",
"entrypoint": "string",
"metadata": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"runtimeEnv": "string",
"jobId": "string",
"shutdownAfterJobFinishes": true,
"clusterSelector": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"clusterSpec": {
"headGroupSpec": {
"computeTemplate": "string",
"image": "string",
"serviceType": "string",
"rayStartParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"volumes": [
{
"mountPath": "string",
"volumeType": "PERSISTENT_VOLUME_CLAIM",
"name": "string",
"source": "string",
"readOnly": true,
"hostPathType": "DIRECTORY",
"mountPropagationMode": "NONE"
}
]
},
"workerGroupSpec": [
{
"groupName": "string",
"computeTemplate": "string",
"image": "string",
"replicas": 0,
"minReplicas": 0,
"maxReplicas": 0,
"rayStartParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"volumes": [
{
"mountPath": "string",
"volumeType": "PERSISTENT_VOLUME_CLAIM",
"name": "string",
"source": "string",
"readOnly": true,
"hostPathType": "DIRECTORY",
"mountPropagationMode": "NONE"
}
]
}
]
},
"ttlSecondsAfterFinished": 0,
"createdAt": "2022-08-19T21:31:24.352Z",
"deleteAt": "2022-08-19T21:31:24.352Z",
"jobStatus": "string",
"jobDeploymentStatus": "string",
"message": "string"
}
]
}
List all jobs in all namespaces
GET {{baseUrl}}/apis/v1alpha2/jobs
Get job by its name and namespace
GET {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/jobs/<job_name>
Delete job by its name and namespace
DELETE {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/jobs/<job_name>
RayService
Create ray service in a given namespace
POST {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/services
payload
{
"name": "string",
"namespace": "string",
"user": "string",
"serveDeploymentGraphSpec": {
"importPath": "string",
"runtimeEnv": "string",
"serveConfigs": [
{
"deploymentName": "string",
"replicas": 0,
"routePrefix": "string",
"maxConcurrentQueries": 0,
"userConfig": "string",
"autoscalingConfig": "string",
"actorOptions": {
"runtimeEnv": "string",
"cpus": 0,
"gpu": 0,
"memory": 0,
"objectStoreMemory": 0,
"resource": "string",
"accceleratorType": "string"
}
}
]
},
"clusterSpec": {
"headGroupSpec": {
"computeTemplate": "string",
"image": "string",
"serviceType": "string",
"rayStartParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"volumes": [
{
"mountPath": "string",
"volumeType": "PERSISTENT_VOLUME_CLAIM",
"name": "string",
"source": "string",
"readOnly": true,
"hostPathType": "DIRECTORY",
"mountPropagationMode": "NONE"
}
]
},
"workerGroupSpec": [
{
"groupName": "string",
"computeTemplate": "string",
"image": "string",
"replicas": 0,
"minReplicas": 0,
"maxReplicas": 0,
"rayStartParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"volumes": [
{
"mountPath": "string",
"volumeType": "PERSISTENT_VOLUME_CLAIM",
"name": "string",
"source": "string",
"readOnly": true,
"hostPathType": "DIRECTORY",
"mountPropagationMode": "NONE"
}
]
}
]
},
"rayServiceStatus": {
"applicationStatus": "string",
"applicationMessage": "string",
"serveDeploymentStatus": [
{
"deploymentName": "string",
"status": "string",
"message": "string"
}
],
"rayServiceEvent": [
{
"id": "string",
"name": "string",
"createdAt": "2022-08-19T21:30:01.097Z",
"firstTimestamp": "2022-08-19T21:30:01.097Z",
"lastTimestamp": "2022-08-19T21:30:01.097Z",
"reason": "string",
"message": "string",
"type": "string",
"count": 0
}
],
"rayClusterName": "string",
"rayClusterState": "string",
"serviceEndpoint": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"createdAt": "2022-08-19T21:30:01.097Z",
"deleteAt": "2022-08-19T21:30:01.097Z"
}
List all services in a given namespace
GET {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/services
Response
"name": "string",
"namespace": "string",
"user": "string",
"serveDeploymentGraphSpec": {
"importPath": "string",
"runtimeEnv": "string",
"serveConfigs": [
{
"deploymentName": "string",
"replicas": 0,
"routePrefix": "string",
"maxConcurrentQueries": 0,
"userConfig": "string",
"autoscalingConfig": "string",
"actorOptions": {
"runtimeEnv": "string",
"cpus": 0,
"gpu": 0,
"memory": 0,
"objectStoreMemory": 0,
"resource": "string",
"accceleratorType": "string"
}
}
]
},
"clusterSpec": {
"headGroupSpec": {
"computeTemplate": "string",
"image": "string",
"serviceType": "string",
"rayStartParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"volumes": [
{
"mountPath": "string",
"volumeType": "PERSISTENT_VOLUME_CLAIM",
"name": "string",
"source": "string",
"readOnly": true,
"hostPathType": "DIRECTORY",
"mountPropagationMode": "NONE"
}
]
},
"workerGroupSpec": [
{
"groupName": "string",
"computeTemplate": "string",
"image": "string",
"replicas": 0,
"minReplicas": 0,
"maxReplicas": 0,
"rayStartParams": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"volumes": [
{
"mountPath": "string",
"volumeType": "PERSISTENT_VOLUME_CLAIM",
"name": "string",
"source": "string",
"readOnly": true,
"hostPathType": "DIRECTORY",
"mountPropagationMode": "NONE"
}
]
}
]
},
"rayServiceStatus": {
"applicationStatus": "string",
"applicationMessage": "string",
"serveDeploymentStatus": [
{
"deploymentName": "string",
"status": "string",
"message": "string"
}
],
"rayServiceEvent": [
{
"id": "string",
"name": "string",
"createdAt": "2022-08-19T21:33:15.485Z",
"firstTimestamp": "2022-08-19T21:33:15.485Z",
"lastTimestamp": "2022-08-19T21:33:15.485Z",
"reason": "string",
"message": "string",
"type": "string",
"count": 0
}
],
"rayClusterName": "string",
"rayClusterState": "string",
"serviceEndpoint": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"createdAt": "2022-08-19T21:33:15.485Z",
"deleteAt": "2022-08-19T21:33:15.485Z"
}
List all services in all namespaces
GET {{baseUrl}}/apis/v1alpha2/services
Get service by its name and namespace
GET {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/services/<service_name>
Delete service by its name and namespace
DELETE {{baseUrl}}/apis/v1alpha2/namespaces/<namespace>/services/<service_name>
Swagger Support
- Download Swagger UI from Swagger-UI. In this case, we use
swagger-ui-3.51.2.tar.gz - Unzip package and copy
distfolder tothird_partyfolder - Use
go-bindatato generate go code from static files.
mkdir third_party
tar -zvxf ~/Downloads/swagger-ui-3.51.2.tar.gz /tmp
mv /tmp/swagger-ui-3.51.2/dist third_party/swagger-ui
cd apiserver/
go-bindata --nocompress --pkg swagger -o pkg/swagger/datafile.go ./third_party/swagger-ui/...