-
Notifications
You must be signed in to change notification settings - Fork 446
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'ray-project:master' into simplify_k8s_client_creation
- Loading branch information
Showing
39 changed files
with
2,059 additions
and
621 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,3 +43,4 @@ | |
| # Dependency directories (remove the comment below to include it) | ||
| **/vendor/ | ||
|
|
||
| .ipynb_checkpoints | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| # KubeRay APIServer | ||
|
|
||
| KubeRay APIServer provides the gRPC and HTTP API to manage kuberay resources. | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Compute Template | ||
|
|
||
| #### Create compute templates | ||
| ``` | ||
| POST {{baseUrl}}/apis/v1alpha1/compute_templates | ||
| ``` | ||
|
|
||
| ``` | ||
| { | ||
| "name": "default-template", | ||
| "cpu": 2, | ||
| "memory": 4, | ||
| "gpu": 1, | ||
| "gpuAccelerator": "Tesla-V100" | ||
| } | ||
| ``` | ||
|
|
||
| #### List all compute templates | ||
|
|
||
| ``` | ||
| GET {{baseUrl}}/apis/v1alpha1/compute_templates | ||
| ``` | ||
|
|
||
| ``` | ||
| { | ||
| "compute_templates": [ | ||
| { | ||
| "id": "", | ||
| "name": "default-template", | ||
| "cpu": 2, | ||
| "memory": 4, | ||
| "gpu": 1, | ||
| "gpu_accelerator": "Tesla-V100" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| #### Get compute template by name | ||
|
|
||
| ``` | ||
| GET {{baseUrl}}/apis/v1alpha1/compute_templates/?name=<compute_template_name> | ||
| ``` | ||
|
|
||
| #### Delete compute template by | ||
|
|
||
| ``` | ||
| DELETE {{baseUrl}}/apis/v1alpha1/compute_templates/?name=<compute_template_name> | ||
| ``` | ||
|
|
||
| ### Clusters | ||
|
|
||
| #### Create cluster | ||
|
|
||
| ``` | ||
| POST {{baseUrl}}/apis/v1alpha1/clusters | ||
| ``` | ||
|
|
||
| payload | ||
| ``` | ||
| { | ||
| "name": "test-cluster", | ||
| "namespace": "ray-system", | ||
| "user": "jiaxin.shan", | ||
| "version": "1.9.2", | ||
| "environment": "DEV", | ||
| "clusterSpec": { | ||
| "headGroupSpec": { | ||
| "computeTemplate": "head-template", | ||
| "image": "ray.io/ray:1.9.2", | ||
| "serviceType": "NodePort", | ||
| "rayStartParams": {} | ||
| }, | ||
| "workerGroupSepc": [ | ||
| { | ||
| "groupName": "small-wg", | ||
| "computeTemplate": "worker-template", | ||
| "image": "ray.io/ray:1.9.2", | ||
| "replicas": 2, | ||
| "minReplicas": 0, | ||
| "maxReplicas": 5, | ||
| "rayStartParams": {} | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| #### List all clusters | ||
|
|
||
| ``` | ||
| GET {{baseUrl}}/apis/v1alpha1/clusters | ||
| ``` | ||
|
|
||
| ``` | ||
| { | ||
| "clusters": [ | ||
| { | ||
| "name": "test-cluster", | ||
| "namespace": "ray-system", | ||
| "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_sepc": [ | ||
| { | ||
| "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 | ||
| }, | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| #### Get cluster by name | ||
|
|
||
| ``` | ||
| GET {{baseUrl}}/apis/v1alpha1/clusters/?name=<cluster_name> | ||
| ``` | ||
|
|
||
|
|
||
| #### Delete cluster by name | ||
|
|
||
| ``` | ||
| DELETE {{baseUrl}}/apis/v1alpha1/clusters/?name=<cluster_name> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.