Skip to content

Commit

Permalink
Helm: updated local ray charts by the official ones (#107)
Browse files Browse the repository at this point in the history 
* Updated ray charts to use the new official package

* Updated documentation

* Added missed image
  • Loading branch information
@Tansito
Tansito authored Jan 12, 2023
1 parent 63f2de1 commit 98ee32a
Show file tree
Hide file tree
Showing 29 changed files with 40 additions and 36,041 deletions.
14 changes: 7 additions & 7 deletions infrastructure/helm/quantumserverless/Chart.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@ dependencies:
- name: jupyter
repository: ""
version: 0.1.0
- name: operator
repository: ""
version: 0.3.0
- name: kuberay-operator
repository: https://ray-project.github.io/kuberay-helm
version: 0.4.0
- name: ray-cluster
repository: ""
version: 0.3.0
repository: https://ray-project.github.io/kuberay-helm
version: 0.4.0
- name: manager
repository: ""
version: 0.1.0
- name: redis
repository: https://charts.bitnami.com/bitnami
version: 17.4.1
digest: sha256:7f98311605fe354572f27462aba2f2606e646e80db7da003c87c29e22671d43a
generated: "2023-01-05T14:16:47.505228+01:00"
digest: sha256:505bca14d3c11880618e3acced06e9d78420bb5659b1141d089b01104b5cafb3
generated: "2023-01-11T15:59:23.454696+01:00"
10 changes: 6 additions & 4 deletions infrastructure/helm/quantumserverless/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ dependencies:
- name: jupyter
condition: jupyterEnable
version: 0.1.0
- name: operator
condition: rayOperatorEnable
version: 0.3.0
- name: kuberay-operator
condition: kuberayOperatorEnable
version: 0.4.0
repository: https://ray-project.github.io/kuberay-helm
- name: ray-cluster
condition: rayClusterEnable
version: 0.3.0
version: 0.4.0
repository: https://ray-project.github.io/kuberay-helm
- name: manager
condition: managerEnable
version: 0.1.0
Expand Down
53 changes: 12 additions & 41 deletions infrastructure/helm/quantumserverless/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,15 @@ Install from specific values file
helm -n ray install quantum-serverless -f <PATH_TO_VALUES_FILE> --create-namespace .
```

## Helm chart versions

The Quantum Serverless Chart has several internal and external dependencies. If you are interested to know what versions the project is using you can check them in the [Chart.lock file](./Chart.lock).

## Helm chart values

**Redis**

For our Redis dependency we are using the configuration offered by Bitnami. To simplify the configuration we offered you with a straigh-forward initial parameters setup. But if you are interested in more complex configurations you have access to all the parameters that Bitnami added in the chart specified in their [README](https://artifacthub.io/packages/helm/bitnami/redis).
For our Redis dependency we are using the configuration created by Bitnami. To simplify the configuration we offered you with a straigh-forward initial parameters setup. But if you are interested in more complex configurations you have access to all the parameters that Bitnami added in the chart specified in their [README](https://artifacthub.io/packages/helm/bitnami/redis).

**Jupyter notebook**

Expand All @@ -46,43 +50,10 @@ For our Redis dependency we are using the configuration offered by Bitnami. To s
| manager.service.port | Port number that service will be exposed externally. |
| manager.ingress.enabled | Specifies if you are going to use ingress to expose the service. |

**Ray cluster**

| Name | Description |
|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| rayClusterEnable | Specify if helm will execute the ray-cluster configuration. |
| ray-cluster.image | Docker image configuration to deploy the manager. |
| ray-cluster.imagePullSecrets | Secrets to pull the image from a private registry. |
| ray-cluster.nameOverride | Replaces the name of the chart in the Chart.yaml. |
| ray-cluster.fullnameOverride | Completely replaces the generated name. |
| ray-cluster.head | Head pod configuration which hosts global control processes for the Ray cluster. |
| ray-cluster.head.initArgs.dashboard-host | Host to expose the Ray dashboard outside the Ray cluster. |
| ray-cluster.head.initArgs.port | Port to expose the Ray dashboard outside the Ray cluster. |
| ray-cluster.worker | Worker pods configuration which run Ray tasks and actors. |
| ray-cluster.worker.replicas | Specifies the number of worker pods of that group to keep in the cluster. It has optional **minReplicas** and **maxReplicas** fields. |
| ray-cluster.ports | Port configuration for the worker. |
| ray-cluster.resources | Computational resources configuration for the worker. |
| ray-cluster.headServiceSuffix | Suffix used by the head service. |
| ray-cluster.service.type | Options are ClusterIP, NodePort, and LoadBalancer. Exposing the head’s service outside the cluster may require using a service of type LoadBalancer or NodePort. |
| ray-cluster.service.port | Port number that the head's service will be exposed externally. |



**KubeRay operator**

| Name | Description |
|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| rayOperatorEnable | Specify if helm will execute the kuberay-operator configuration. |
| operator.image | Docker image configuration to deploy the KubeRay Operator. |
| operator.nameOverride | Replaces the name of the chart in the Chart.yaml. |
| operator.fullnameOverride | Completely replaces the generated name. |
| operator.rbac.true | Specifies whether you want to install the default RBAC roles and bindings. |
| operator.serviceAccount.true | Specifies whether a service account should be created. |
| operator.serviceAccount.name | The name of the service account to use. |
| operator.service.type | Options are ClusterIP, NodePort, and LoadBalancer. Exposing the operators’ service outside the cluster may require using a service of type LoadBalancer or NodePort. |
| operator.service.port | Port number that the operators' service will user. |
| operator.ingress.enabled | Specifies if you are going to use ingress to expose the service. |
| operator.livenessProbe | Liveness probe configuration. |
| operator.readinessProbe | Readiness probe configuration. |
| operator.createCustomResource | Specifies whether helm should create a custom resource. |
| operator.rbacEnable | Specifies whether rbac roles are enable. |
**Ray cluster & Kuberay operator**

For our Ray Charts dependencies we are using the configuration created by the Ray Project. To simplify the configuration we offered you with a straigh-forward initial parameters setup. But if you are interested in more complex configurations you have access to their Helm project [in GitHub](https://github.com/ray-project/kuberay-helm) to analyze the different variables:

- For Kuberay Operator you can read their [values.yaml](https://github.com/ray-project/kuberay-helm/blob/main/helm-chart/kuberay-operator/values.yaml).

- For Ray Cluster they provide you with a commented initial setup in their [values.yaml](https://github.com/ray-project/kuberay-helm/blob/main/helm-chart/ray-cluster/values.yaml).
22 changes: 0 additions & 22 deletions infrastructure/helm/quantumserverless/charts/operator/.helmignore
View file

This file was deleted.

7 changes: 0 additions & 7 deletions infrastructure/helm/quantumserverless/charts/operator/Chart.yaml
View file

This file was deleted.

97 changes: 0 additions & 97 deletions infrastructure/helm/quantumserverless/charts/operator/README.md
View file

This file was deleted.

Loading

0 comments on commit 98ee32a

Please sign in to comment.