bitnamicharts/kuberay
Bitnami Helm chart for KubeRay
50K+
KubeRay is a Kubernetes operator for deploying and management of Ray applications on Kubernetes using CustomResourceDefinitions.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/kuberay
Looking to use KubeRay in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
This chart bootstraps a KubeRay deployment on a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release REGISTRY_NAME/REPOSITORY_NAME/kuberay
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
The command deploys kuberay on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
This chart can be integrated with Prometheus by setting *.metrics.enabled
(under the operator
and apiserver
sections) to true. This will expose the Kuberay native Prometheus endpoint in both the containers and services. The services will also have the necessary annotations to be automatically scraped by Prometheus.
Prometheus requirements
It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
Integration with Prometheus Operator
The chart can deploy ServiceMonitor
objects for integration with Prometheus Operator installations. To do so, set the value *.metrics.serviceMonitor.enabled=true
(under the operator
and apiserver
sections). Ensure that the Prometheus Operator CustomResourceDefinitions
are installed in the cluster or it will fail with the following error:
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars
property inside the operator
, apiserver
and cluster
sections.
operator:
extraEnvVars:
- name: LOG_LEVEL
value: error
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM
or the extraEnvVarsSecret
values inside the operator
, apiserver
and cluster
sections.
If additional containers are needed in the same pod as KubeRay (such as additional metrics or logging exporters), they can be defined using the sidecars
parameter inside the operator
, apiserver
and cluster
sections.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts
parameter (where available), as shown in the example below:
service:
extraPorts:
- name: extraPort
port: 11311
targetPort: 11311
NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the
--enable-metrics=true
parameter at deployment time. Thesidecars
parameter should therefore only be used for any extra sidecar containers.
If additional init containers are needed in the same pod, they can be defined using the initContainers
parameter. Here is an example:
initContainers:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Learn more about sidecar containers and init containers.
The Bitnami KubeRay chart allows deploying a RayCluster object. It is possible to define the head parameters under the cluster.head
section, as well as the properties of the workers using the cluster.worker
section. It is possible to describe different groupspecs under the cluster.worker.groupSpecs
section (any parameter not defined will be taken from the cluster.worker.common
section).
This chart allows you to set your custom affinity using the affinity
parameter. Find more information about Pod affinity in the kubernetes documentation.
As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters inside the operator
, apiserver
and cluster
sections.
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.storageClass | DEPRECATED: use global.defaultStorageClass instead | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Override Kubernetes version | "" |
nameOverride | String to partially override common.names.name | "" |
fullnameOverride | String to fully override common.names.fullname | "" |
namespaceOverride | String to fully override common.names.namespace | "" |
commonLabels | Labels to add to all deployed objects | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
clusterDomain | Kubernetes cluster domain name | cluster.local |
extraDeploy | Array of extra objects to deploy with the release | [] |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the deployment | ["sleep"] |
diagnosticMode.args | Args to override all containers in the deployment | ["infinity"] |
rayImage.registry | Ray registry | REGISTRY_NAME |
rayImage.repository | Ray repository | REPOSITORY_NAME/ray |
rayImage.digest | Kuberay Ray digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) | "" |
rayImage.pullPolicy | Kuberay Ray pull policy | IfNotPresent |
rayImage.pullSecrets | Kuberay Ray pull secrets | [] |
rayImage.debug | Enable Kuberay Ray debug mode | false |
Name | Description | Value |
---|---|---|
operator.enabled | Enable Kuberay Operator | true |
operator.image.registry | Kuberay Operator image registry | REGISTRY_NAME |
operator.image.repository | Kuberay Operator image repository | REPOSITORY_NAME/kuberay-operator |
operator.image.digest | Kuberay Operator image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) | "" |
operator.image.pullPolicy | Kuberay Operator image pull policy | IfNotPresent |
operator.image.pullSecrets | Kuberay Operator image pull secrets | [] |
operator.image.debug | Enable Kuberay Operator image debug mode | false |
operator.replicaCount | Number of Kuberay Operator replicas to deploy | 1 |
operator.containerPorts.metrics | Kuberay Operator metrics container port | 8080 |
operator.containerPorts.health | Kuberay Operator health container port | 8082 |
operator.livenessProbe.enabled | Enable livenessProbe on Kuberay Operator containers | true |
operator.livenessProbe.initialDelaySeconds | Initial delay seconds for livenessProbe | 5 |
operator.livenessProbe.periodSeconds | Period seconds for livenessProbe | 10 |
operator.livenessProbe.timeoutSeconds | Timeout seconds for livenessProbe | 5 |
operator.livenessProbe.failureThreshold | Failure threshold for livenessProbe | 5 |
operator.livenessProbe.successThreshold | Success threshold for livenessProbe | 1 |
operator.readinessProbe.enabled | Enable readinessProbe on Kuberay Operator containers | true |
operator.readinessProbe.initialDelaySeconds | Initial delay seconds for readinessProbe | 5 |
operator.readinessProbe.periodSeconds | Period seconds for readinessProbe | 10 |
operator.readinessProbe.timeoutSeconds | Timeout seconds for readinessProbe | 5 |
operator.readinessProbe.failureThreshold | Failure threshold for readinessProbe | 5 |
operator.readinessProbe.successThreshold | Success threshold for readinessProbe | 1 |
operator.startupProbe.enabled | Enable startupProbe on Kuberay Operator containers | false |
operator.startupProbe.initialDelaySeconds | Initial delay seconds for startupProbe | 5 |
operator.startupProbe.periodSeconds | Period seconds for startupProbe | 10 |
operator.startupProbe.timeoutSeconds | Timeout seconds for startupProbe |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/kuberay/README.md