Introducing our new CEO Don Johnson - Read More

bitnamicharts/kuberay

Verified Publisher

By VMware

Updated 1 day ago

Bitnami Helm chart for KubeRay

Helm
Image
Integration & Delivery
Machine Learning & AI
Security
0

50K+

Bitnami package for KubeRay

KubeRay is a Kubernetes operator for deploying and management of Ray applications on Kubernetes using CustomResourceDefinitions.

Overview of KubeRay

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.

TL;DR

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.

Introduction

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.

Prerequisites

  • Kubernetes 1.23+
  • Helm 3.8.0+

Installing the Chart

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 and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_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

Configuration and installation details

Resource requests and limits

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.

Prometheus metrics

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.

Backup and restore

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.

Rolling VS Immutable tags

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.

Additional environment variables

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.

Sidecars

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. The sidecars 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.

Deploying Ray Cluster

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).

Pod affinity

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.

Parameters

Global parameters
NameDescriptionValue
global.imageRegistryGlobal Docker image registry""
global.imagePullSecretsGlobal Docker registry secret names as an array[]
global.defaultStorageClassGlobal default StorageClass for Persistent Volume(s)""
global.storageClassDEPRECATED: use global.defaultStorageClass instead""
global.security.allowInsecureImagesAllows skipping image verificationfalse
global.compatibility.openshift.adaptSecurityContextAdapt 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
Common parameters
NameDescriptionValue
kubeVersionOverride Kubernetes version""
nameOverrideString to partially override common.names.name""
fullnameOverrideString to fully override common.names.fullname""
namespaceOverrideString to fully override common.names.namespace""
commonLabelsLabels to add to all deployed objects{}
commonAnnotationsAnnotations to add to all deployed objects{}
clusterDomainKubernetes cluster domain namecluster.local
extraDeployArray of extra objects to deploy with the release[]
diagnosticMode.enabledEnable diagnostic mode (all probes will be disabled and the command will be overridden)false
diagnosticMode.commandCommand to override all containers in the deployment["sleep"]
diagnosticMode.argsArgs to override all containers in the deployment["infinity"]
rayImage.registryRay registryREGISTRY_NAME
rayImage.repositoryRay repositoryREPOSITORY_NAME/ray
rayImage.digestKuberay Ray digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended)""
rayImage.pullPolicyKuberay Ray pull policyIfNotPresent
rayImage.pullSecretsKuberay Ray pull secrets[]
rayImage.debugEnable Kuberay Ray debug modefalse
Kuberay Operator Parameters
NameDescriptionValue
operator.enabledEnable Kuberay Operatortrue
operator.image.registryKuberay Operator image registryREGISTRY_NAME
operator.image.repositoryKuberay Operator image repositoryREPOSITORY_NAME/kuberay-operator
operator.image.digestKuberay 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.pullPolicyKuberay Operator image pull policyIfNotPresent
operator.image.pullSecretsKuberay Operator image pull secrets[]
operator.image.debugEnable Kuberay Operator image debug modefalse
operator.replicaCountNumber of Kuberay Operator replicas to deploy1
operator.containerPorts.metricsKuberay Operator metrics container port8080
operator.containerPorts.healthKuberay Operator health container port8082
operator.livenessProbe.enabledEnable livenessProbe on Kuberay Operator containerstrue
operator.livenessProbe.initialDelaySecondsInitial delay seconds for livenessProbe5
operator.livenessProbe.periodSecondsPeriod seconds for livenessProbe10
operator.livenessProbe.timeoutSecondsTimeout seconds for livenessProbe5
operator.livenessProbe.failureThresholdFailure threshold for livenessProbe5
operator.livenessProbe.successThresholdSuccess threshold for livenessProbe1
operator.readinessProbe.enabledEnable readinessProbe on Kuberay Operator containerstrue
operator.readinessProbe.initialDelaySecondsInitial delay seconds for readinessProbe5
operator.readinessProbe.periodSecondsPeriod seconds for readinessProbe10
operator.readinessProbe.timeoutSecondsTimeout seconds for readinessProbe5
operator.readinessProbe.failureThresholdFailure threshold for readinessProbe5
operator.readinessProbe.successThresholdSuccess threshold for readinessProbe1
operator.startupProbe.enabledEnable startupProbe on Kuberay Operator containersfalse
operator.startupProbe.initialDelaySecondsInitial delay seconds for startupProbe5
operator.startupProbe.periodSecondsPeriod seconds for startupProbe10
operator.startupProbe.timeoutSecondsTimeout 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

Docker Pull Command

docker pull bitnamicharts/kuberay
Bitnami