bitnamicharts/kuberay

Bitnami KubeRay 文档

镜像概述和主要用途

KubeRay 是一个 Kubernetes Operator，用于通过自定义资源定义（CustomResourceDefinitions）在 Kubernetes 上部署和管理 Ray 应用。Bitnami 提供的此镜像包通过 Helm Chart 简化了 KubeRay 在 Kubernetes 集群中的部署流程，使开发者能够快速搭建和管理 Ray 应用环境。

KubeRay 概述

商标声明：本软件列表由 Bitnami 打包。所提及的相关商标归各自公司所有，使用这些商标并不意味着任何关联或背书。

核心功能和特性

• Helm 一键部署：通过 Helm Chart 实现 KubeRay 在 Kubernetes 集群上的快速部署和版本管理。
• 资源配置灵活：支持自定义资源请求（requests）和限制（limits），可通过 resourcesPreset 预设或手动配置适配不同 workload 需求。
• 监控集成：支持与 Prometheus 集成，通过启用 *.metrics.enabled 暴露指标端点，并可自动配置 ServiceMonitor 以支持 Prometheus Operator。
• 扩展性强：支持添加额外环境变量（通过 extraEnvVars、extraEnvVarsCM 或 extraEnvVarsSecret）、Sidecar 容器及 Init 容器，满足高级部署需求。
• Ray 集群自定义：可通过 cluster.head 和 cluster.worker 配置 Ray 集群的 Head 节点和 Worker 节点，支持多 Worker 组规格（cluster.worker.groupSpecs）。
• Pod 调度优化：支持自定义 Pod 亲和性（affinity）、反亲和性及节点亲和性，或通过预设（podAffinityPreset 等）简化配置。
• 兼容性适配：支持 OpenShift 环境，通过 global.compatibility.openshift.adaptSecurityContext 自动调整安全上下文。

使用场景和适用范围

适用场景

• 在 Kubernetes 集群上部署分布式 Ray 应用，如机器学习训练、大规模数据处理、分布式计算任务等。
• 需要通过自定义资源（CRD）简化 Ray 集群生命周期管理的场景。
• 开发和测试环境中快速搭建 Ray 应用原型，验证分布式任务逻辑。

适用范围

• 开发环境：免费版提供非硬化的 Debian 基础镜像，仅包含“latest”标签，适合开发和测试。
• 生产环境：根据 Bitnami 政策，生产环境建议使用 Bitnami Secure Images，包含硬化容器、CVE 透明度、SBOM 及企业支持（详见下方重要通知）。

⚠️ 重要通知：Bitnami 目录即将变更

自 2025 年 8 月 28 日起，Bitnami 将升级其公共目录，推出新的 Bitnami Secure Images 计划，提供精选的硬化、安全聚焦镜像。过渡详情如下：

• 首次向社区用户开放安全优化镜像：提供流行容器镜像的安全优化版本。
• 逐步淘汰非硬化 Debian 镜像：免费层将逐步停止支持非硬化的 Debian 基础镜像，并从公共目录中移除非最新标签。社区用户将仅能访问数量减少的硬化镜像（仅“latest”标签），适用于开发目的。
• 镜像迁移至“Bitnami Legacy”仓库：自 8 月 28 日起，两周内所有现有容器镜像（包括旧版本标签，如 2.50.0、10.6）将从公共目录（docker.io/bitnami）迁移至“Bitnami Legacy”仓库（docker.io/bitnamilegacy），且不再接收更新。
• 生产环境建议：对于生产工作负载和长期支持，建议采用 Bitnami Secure Images，包含硬化容器、更小***面、CVE 透明度（通过 VEX/KEV）、SBOM 及企业支持。

这些变更旨在通过推广软件供应链完整性最佳实践和最新部署，提升所有 Bitnami 用户的安全态势。详情参见 https://github.com/bitnami/containers/issues/83267%E3%80%82

详细使用方法和配置说明

前提条件

• Kubernetes 集群版本 1.23+
• Helm 版本 3.8.0+

安装步骤

快速开始

console
helm install my-release oci://registry-1.docker.io/bitnamicharts/kuberay

标准安装

使用 Helm 安装 chart，指定发布名称（如 my-release）：

console
helm install my-release REGISTRY_NAME/REPOSITORY_NAME/kuberay

注意：需将 REGISTRY_NAME 和 REPOSITORY_NAME 替换为实际的 Helm 仓库地址。例如，Bitnami 仓库需设置 REGISTRY_NAME=registry-1.docker.io 和 REPOSITORY_NAME=bitnamicharts。

配置参数

全局参数

公共参数

Kuberay Operator 参数

高级配置

Prometheus 监控集成

1. 启用指标：设置 operator.metrics.enabled=true 和 apiserver.metrics.enabled=true 以暴露 Prometheus 指标端点。
2. ServiceMonitor 配置：若使用 Prometheus Operator，设置 operator.metrics.serviceMonitor.enabled=true 和 apiserver.metrics.serviceMonitor.enabled=true 以自动创建 ServiceMonitor 对象。
3. 前提条件：需预先安装 Prometheus 或 Prometheus Operator，推荐使用 https://github.com/bitnami/charts/tree/main/bitnami/prometheus 或 https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus%E3%80%82

资源请求与限制

通过 resources 参数配置容器资源：

yaml
operator:
  resources:
    requests:
      cpu: 100m
      memory: 128Mi
    limits:
      cpu: 500m
      memory: 256Mi

或使用预设资源配置（详见 https://github.com/bitnami/charts/tree/main/bitnami/common#affinities%EF%BC%89%EF%BC%9A

yaml
operator:
  resourcesPreset: medium

额外环境变量

通过 extraEnvVars 添加环境变量：

yaml
operator:
  extraEnvVars:
    - name: LOG_LEVEL
      value: error

或通过 ConfigMap/Secret 注入：

yaml
operator:
  extraEnvVarsCM: my-configmap  # 包含环境变量的 ConfigMap 名称
  extraEnvVarsSecret: my-secret  # 包含环境变量的 Secret 名称

Sidecar 和 Init 容器

添加 Sidecar 容器：

yaml
operator:
  sidecars:
    - name: metrics-exporter
      image: my-exporter:latest
      imagePullPolicy: Always
      ports:
        - name: exporter-port
          containerPort: 9100

添加 Init 容器：

yaml
operator:
  initContainers:
    - name: init-config
      image: busybox:latest
      command: ["sh", "-c", "echo 'init' > /config/init.txt"]
      volumeMounts:
        - name: config-volume
          mountPath: /config

Ray 集群部署

通过 cluster 配置 Ray 集群：

yaml
cluster:
  head:
    replicas: 1
    resources:
      requests:
        cpu: 1
        memory: 2Gi
  worker:
    common:
      resources:
        requests:
          cpu: 500m
          memory: 1Gi
    groupSpecs:
      - replicas: 2
        resources:
          limits:
            cpu: 1
            memory: 2Gi

备份与恢复

使用 Velero 工具备份和恢复 Helm 部署的持久化卷。具体步骤参见 Velero 使用指南。

注：本 chart 的完整 README 因长度限制已截断，完整文档参见 https://github.com/bitnami/charts/blob/main/bitnami/kuberay/README.md%E3%80%82