mirror of
https://github.com/hanzo-ml/kuberay.git
synced 2026-10-30 19:48:47 +00:00
* update kuberay 1.6.0 helm chart and readme Signed-off-by: Future-Outlier <[email protected]> * [Helm] Fix apiserver README chart version and align ray-cluster resource defaults Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> * fix ctl test Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> --------- Signed-off-by: Future-Outlier <[email protected]>
429 lines
13 KiB
YAML
429 lines
13 KiB
YAML
# Default values for ray-cluster.
|
|
# This is a YAML-formatted file.
|
|
# Declare variables to be passed into your templates.
|
|
|
|
# The KubeRay community welcomes PRs to expose additional configuration
|
|
# in this Helm chart.
|
|
|
|
image:
|
|
# -- Image repository.
|
|
repository: rayproject/ray
|
|
# -- Image tag.
|
|
tag: 2.52.0
|
|
# -- Image pull policy.
|
|
pullPolicy: IfNotPresent
|
|
|
|
# -- String to partially override release name.
|
|
nameOverride: "kuberay"
|
|
|
|
# -- String to fully override release name.
|
|
fullnameOverride: ""
|
|
|
|
# -- Secrets with credentials to pull images from a private registry
|
|
imagePullSecrets: []
|
|
# - name: an-existing-secret
|
|
|
|
# gcsFaultTolerance specifies configuration for GCS fault tolerance.
|
|
# See https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/kuberay-gcs-ft.html#kuberay-gcs-ft
|
|
# for more details.
|
|
gcsFaultTolerance:
|
|
enabled: false
|
|
# In most cases, you don't need to set `externalStorageNamespace` because KubeRay will
|
|
# automatically set it to the UID of RayCluster. Only modify this annotation if you fully understand
|
|
# the behaviors of the Ray GCS FT and RayService to avoid misconfiguration.
|
|
# externalStorageNamespace: "my-raycluster-storage"
|
|
# redisAddress: "redis:6379"
|
|
# redisPassword:
|
|
# Reference to a secret key containing the Redis password
|
|
# Secret must be manually created in the namespace
|
|
# valueFrom:
|
|
# secretKeyRef:
|
|
# name: redis-password-secret
|
|
# key: password
|
|
# redisUsername:
|
|
# Reference to a secret key containing the Redis username
|
|
# Secret must be manually created in the namespace
|
|
# valueFrom:
|
|
# secretKeyRef:
|
|
# name: redis-username-secret
|
|
# key: username
|
|
|
|
|
|
# common defined values shared between the head and worker
|
|
common:
|
|
# -- containerEnv specifies environment variables for the Ray head and worker containers.
|
|
# Follows standard K8s container env schema.
|
|
containerEnv: []
|
|
# - name: BLAH
|
|
# value: VAL
|
|
head:
|
|
# rayVersion determines the autoscaler's image version.
|
|
# It should match the Ray version in the image of the containers.
|
|
# rayVersion: 2.52.0
|
|
|
|
# If enableInTreeAutoscaling is true, the autoscaler sidecar will be added to the Ray head pod.
|
|
# Ray autoscaler integration is supported only for Ray versions >= 1.11.0
|
|
# Ray autoscaler integration is Beta with KubeRay >= 0.3.0 and Ray >= 2.0.0.
|
|
# enableInTreeAutoscaling: true
|
|
|
|
# autoscalerOptions is an OPTIONAL field specifying configuration overrides for the Ray autoscaler.
|
|
# The example configuration shown below represents the DEFAULT values.
|
|
# autoscalerOptions:
|
|
# upscalingMode: Default
|
|
# idleTimeoutSeconds is the number of seconds to wait before scaling down a worker pod which is not using Ray resources.
|
|
# idleTimeoutSeconds: 60
|
|
# imagePullPolicy optionally overrides the autoscaler container's default image pull policy (IfNotPresent).
|
|
# imagePullPolicy: IfNotPresent
|
|
# Optionally specify the autoscaler container's securityContext.
|
|
# securityContext: {}
|
|
# env: []
|
|
# envFrom: []
|
|
# resources specifies optional resource request and limit overrides for the autoscaler container.
|
|
# For large Ray clusters, we recommend monitoring container resource usage to determine if overriding the defaults is required.
|
|
# resources:
|
|
# limits:
|
|
# cpu: "500m"
|
|
# memory: "512Mi"
|
|
# requests:
|
|
# cpu: "500m"
|
|
# memory: "512Mi"
|
|
|
|
# -- Init containers to add to the head pod
|
|
initContainers: []
|
|
# -- Labels for the head pod
|
|
labels: {}
|
|
|
|
# Note: From KubeRay v0.6.0, users need to create the ServiceAccount by themselves if they specify the `serviceAccountName`
|
|
# in the headGroupSpec. See https://github.com/ray-project/kuberay/pull/1128 for more details.
|
|
serviceAccountName: ""
|
|
restartPolicy: ""
|
|
|
|
# -- runtimeClassName is the name of the RuntimeClass to use to run the head Pod.
|
|
runtimeClassName: ""
|
|
|
|
# containerEnv specifies environment variables for the Ray container,
|
|
# Follows standard K8s container env schema.
|
|
containerEnv: []
|
|
# - name: EXAMPLE_ENV
|
|
# value: "1"
|
|
|
|
# -- envFrom to pass to head pod
|
|
envFrom: []
|
|
# - secretRef:
|
|
# name: my-env-secret
|
|
|
|
# ports optionally allows specifying ports for the Ray container.
|
|
# ports: []
|
|
|
|
# resource requests and limits for the Ray head container.
|
|
# Modify as needed for your application.
|
|
# Note that the resources in this example are much too small for production;
|
|
# we don't recommend allocating less than 8G memory for a Ray pod in production.
|
|
# Ray pods should be sized to take up entire K8s nodes when possible.
|
|
# Always set CPU and memory limits for Ray pods.
|
|
# It is usually best to set requests equal to limits.
|
|
# See https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/config.html#resources
|
|
# for further guidance.
|
|
resources:
|
|
limits:
|
|
cpu: "1"
|
|
# To avoid out-of-memory issues, never allocate less than 2G memory for the Ray head.
|
|
memory: "5Gi"
|
|
requests:
|
|
cpu: "1"
|
|
memory: "5Gi"
|
|
|
|
# -- ResourceClaims to allocate with the head pod
|
|
resourceClaims: []
|
|
|
|
# -- Extra annotations for head pod
|
|
annotations: {}
|
|
|
|
# -- Node labels for head pod assignment
|
|
nodeSelector: {}
|
|
|
|
# -- Node tolerations for head pod scheduling to nodes with taints
|
|
tolerations: []
|
|
|
|
# -- Head pod affinity
|
|
affinity: {}
|
|
|
|
# -- Head pod security context.
|
|
podSecurityContext: {}
|
|
|
|
# -- Ray container security context.
|
|
securityContext: {}
|
|
|
|
# Optional: The following volumes/volumeMounts configurations are optional but recommended because
|
|
# Ray writes logs to /tmp/ray/session_latests/logs instead of stdout/stderr.
|
|
volumes:
|
|
- name: log-volume
|
|
emptyDir: {}
|
|
volumeMounts:
|
|
- mountPath: /tmp/ray
|
|
name: log-volume
|
|
|
|
# sidecarContainers specifies additional containers to attach to the Ray pod.
|
|
# Follows standard K8s container spec.
|
|
sidecarContainers: []
|
|
|
|
# See docs/guidance/pod-command.md for more details about how to specify
|
|
# container command for head Pod.
|
|
command: []
|
|
args: []
|
|
|
|
# Optional, for the user to provide any additional fields to the service.
|
|
# See https://pkg.go.dev/k8s.io/Kubernetes/pkg/api/v1#Service
|
|
headService: {}
|
|
# metadata:
|
|
# annotations:
|
|
# prometheus.io/scrape: "true"
|
|
|
|
# Custom pod DNS configuration
|
|
# See https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-dns-config
|
|
# dnsConfig:
|
|
# nameservers:
|
|
# - 8.8.8.8
|
|
# searches:
|
|
# - example.local
|
|
# options:
|
|
# - name: ndots
|
|
# value: "2"
|
|
# - name: edns0
|
|
topologySpreadConstraints: []
|
|
|
|
# https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/configuring-autoscaling.html#set-the-raystartparams-and-the-resource-limits-for-the-ray-container
|
|
rayStartParams: {}
|
|
|
|
worker:
|
|
# If you want to disable the default workergroup
|
|
# uncomment the line below
|
|
# disabled: true
|
|
|
|
# -- The name of the workergroup
|
|
groupName: workergroup
|
|
|
|
# -- The number of replicas for the worker pod
|
|
replicas: 1
|
|
|
|
# -- The minimum number of replicas for the worker pod
|
|
minReplicas: 1
|
|
|
|
# -- The maximum number of replicas for the worker pod
|
|
maxReplicas: 5
|
|
|
|
# -- Labels for the worker pod
|
|
labels: {}
|
|
serviceAccountName: ""
|
|
restartPolicy: ""
|
|
|
|
# -- runtimeClassName is the name of the RuntimeClass to use to run the worker Pods.
|
|
runtimeClassName: ""
|
|
|
|
# -- Init containers to add to the worker pod
|
|
initContainers: []
|
|
|
|
# containerEnv specifies environment variables for the Ray container,
|
|
# Follows standard K8s container env schema.
|
|
containerEnv: []
|
|
# - name: EXAMPLE_ENV
|
|
# value: "1"
|
|
|
|
# -- envFrom to pass to worker pod
|
|
envFrom: []
|
|
# - secretRef:
|
|
# name: my-env-secret
|
|
|
|
# ports optionally allows specifying ports for the Ray container.
|
|
# ports: []
|
|
|
|
# resource requests and limits for the Ray head container.
|
|
# Modify as needed for your application.
|
|
# Note that the resources in this example are much too small for production;
|
|
# we don't recommend allocating less than 8G memory for a Ray pod in production.
|
|
# Ray pods should be sized to take up entire K8s nodes when possible.
|
|
# Always set CPU and memory limits for Ray pods.
|
|
# It is usually best to set requests equal to limits.
|
|
# See https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/config.html#resources
|
|
# for further guidance.
|
|
resources:
|
|
limits:
|
|
cpu: "1"
|
|
memory: "1Gi"
|
|
requests:
|
|
cpu: "1"
|
|
memory: "1Gi"
|
|
|
|
# -- ResourceClaims to allocate with the worker pod
|
|
resourceClaims: []
|
|
|
|
# -- Extra annotations for worker pod
|
|
annotations: {}
|
|
|
|
# -- Node labels for worker pod assignment
|
|
nodeSelector: {}
|
|
|
|
# -- Node tolerations for worker pod scheduling to nodes with taints
|
|
tolerations: []
|
|
|
|
# -- Worker pod affinity
|
|
affinity: {}
|
|
|
|
# -- Worker pod security context.
|
|
podSecurityContext: {}
|
|
|
|
# -- Ray container security context.
|
|
securityContext: {}
|
|
|
|
# Optional: The following volumes/volumeMounts configurations are optional but recommended because
|
|
# Ray writes logs to /tmp/ray/session_latests/logs instead of stdout/stderr.
|
|
volumes:
|
|
- name: log-volume
|
|
emptyDir: {}
|
|
volumeMounts:
|
|
- mountPath: /tmp/ray
|
|
name: log-volume
|
|
|
|
# sidecarContainers specifies additional containers to attach to the Ray pod.
|
|
# Follows standard K8s container spec.
|
|
sidecarContainers: []
|
|
|
|
# See docs/guidance/pod-command.md for more details about how to specify
|
|
# container command for worker Pod.
|
|
command: []
|
|
args: []
|
|
topologySpreadConstraints: []
|
|
|
|
# https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/configuring-autoscaling.html#set-the-raystartparams-and-the-resource-limits-for-the-ray-container
|
|
rayStartParams: {}
|
|
|
|
# Custom pod DNS configuration
|
|
# See https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-dns-config
|
|
# dnsConfig:
|
|
# nameservers:
|
|
# - 8.8.8.8
|
|
# searches:
|
|
# - example.local
|
|
# options:
|
|
# - name: ndots
|
|
# value: "2"
|
|
# - name: edns0
|
|
|
|
# The map's key is used as the groupName.
|
|
# For example, key:small-group in the map below
|
|
# will be used as the groupName
|
|
additionalWorkerGroups:
|
|
smallGroup:
|
|
# Disabled by default
|
|
disabled: true
|
|
|
|
# -- The number of replicas for the additional worker pod
|
|
replicas: 0
|
|
|
|
# -- The minimum number of replicas for the additional worker pod
|
|
minReplicas: 0
|
|
|
|
# -- The maximum number of replicas for the additional worker pod
|
|
maxReplicas: 5
|
|
|
|
# -- Labels for the additional worker pod
|
|
labels: {}
|
|
serviceAccountName: ""
|
|
restartPolicy: ""
|
|
|
|
# -- runtimeClassName for this additional worker group. Empty string means default runtime.
|
|
runtimeClassName: ""
|
|
|
|
# containerEnv specifies environment variables for the Ray container,
|
|
# Follows standard K8s container env schema.
|
|
containerEnv: []
|
|
# - name: EXAMPLE_ENV
|
|
# value: "1"
|
|
|
|
# -- envFrom to pass to additional worker pod
|
|
envFrom: []
|
|
# - secretRef:
|
|
# name: my-env-secret
|
|
|
|
# ports optionally allows specifying ports for the Ray container.
|
|
# ports: []
|
|
|
|
# resource requests and limits for the Ray head container.
|
|
# Modify as needed for your application.
|
|
# Note that the resources in this example are much too small for production;
|
|
# we don't recommend allocating less than 8G memory for a Ray pod in production.
|
|
# Ray pods should be sized to take up entire K8s nodes when possible.
|
|
# Always set CPU and memory limits for Ray pods.
|
|
# It is usually best to set requests equal to limits.
|
|
# See https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/config.html#resources
|
|
# for further guidance.
|
|
resources:
|
|
limits:
|
|
cpu: 1
|
|
memory: "1Gi"
|
|
requests:
|
|
cpu: 1
|
|
memory: "1Gi"
|
|
|
|
# -- ResourceClaims to allocate with the additional worker pod
|
|
resourceClaims: []
|
|
|
|
# -- Extra annotations for additional worker pod
|
|
annotations: {}
|
|
|
|
# -- Node labels for additional worker pod assignment
|
|
nodeSelector: {}
|
|
|
|
# -- Node tolerations for additional worker pod scheduling to nodes with taints
|
|
tolerations: []
|
|
|
|
# -- Additional worker pod affinity
|
|
affinity: {}
|
|
|
|
# -- Additional worker pod security context.
|
|
podSecurityContext: {}
|
|
|
|
# -- Ray container security context.
|
|
securityContext: {}
|
|
|
|
# Optional: The following volumes/volumeMounts configurations are optional but recommended because
|
|
# Ray writes logs to /tmp/ray/session_latests/logs instead of stdout/stderr.
|
|
volumes:
|
|
- name: log-volume
|
|
emptyDir: {}
|
|
volumeMounts:
|
|
- mountPath: /tmp/ray
|
|
name: log-volume
|
|
|
|
sidecarContainers: []
|
|
|
|
# See docs/guidance/pod-command.md for more details about how to specify
|
|
# container command for worker Pod.
|
|
command: []
|
|
args: []
|
|
|
|
# Topology Spread Constraints for worker pods
|
|
# See: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/
|
|
topologySpreadConstraints: []
|
|
|
|
# Custom pod DNS configuration
|
|
# See https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-dns-config
|
|
# dnsConfig:
|
|
# nameservers:
|
|
# - 8.8.8.8
|
|
# searches:
|
|
# - example.local
|
|
# options:
|
|
# - name: ndots
|
|
# value: "2"
|
|
# - name: edns0
|
|
|
|
# https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/configuring-autoscaling.html#set-the-raystartparams-and-the-resource-limits-for-the-ray-container
|
|
rayStartParams: {}
|
|
|
|
|
|
# Configuration for Head's Kubernetes Service
|
|
service:
|
|
# This is optional, and the default is ClusterIP.
|
|
type: ClusterIP
|