sync kuberay helm charts for v1.6.0-rc.0

Signed-off-by: Future-Outlier <eric901201@gmail.com>

Author: Future-Outlier

helm-chart/Makefile

@@ -63,6 +63,8 @@ helm-lint: ## Run Helm chart lint test.
 .PHONY: helm-docs
 helm-docs: helm-docs-plugin ## Generates markdown documentation for Helm charts from requirements and values files.
 	$(HELM_DOCS) --chart-search-root=$(WORKDIR) --chart-to-generate=$(KUBERAY_OPERATOR_CHART_PATH) --sort-values-order=file
+	$(HELM_DOCS) --chart-search-root=$(WORKDIR) --chart-to-generate=$(RAY_CLUSTER_CHART_PATH) --sort-values-order=file
+	$(HELM_DOCS) --chart-search-root=$(WORKDIR) --chart-to-generate=$(KUBERAY_APISERVER_CHART_PATH) --sort-values-order=file
 
 ##@ Dependencies
 

helm-chart/bin/helm-v3.17.3

@@ -15,4 +15,4 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.4.2
+version: 1.6.0-rc.0

helm-chart/kuberay-apiserver/Chart.yaml

@@ -1,6 +1,14 @@
-# KubeRay API Server
+# KubeRay APIServer
 
-This document provides instructions to install the KubeRay API Server with a Helm chart.
+![Version: 1.6.0-rc.0](https://img.shields.io/badge/Version-1.6.0--rc.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+
+A Helm chart for kuberay-apiserver
+
+## Introduction
+
+This document provides instructions to install the KubeRay APIServer with a Helm chart.
+KubeRay APIServer V2 is enabled by default, for more information,
+please refer to the [KubeRay APIServer V2 documentation].
 
 ## Helm
 
@@ -11,7 +19,7 @@ v3.9.4.
 helm version
 ```
 
-## Install KubeRay API Server
+## Install KubeRay APIServer
 
 ### Without security proxy
 
@@ -32,7 +40,7 @@ helm install kuberay-apiserver kuberay/kuberay-apiserver --version 1.4.2 --set s
 # Step2: Navigate to `helm-chart/kuberay-apiserver`
 cd helm-chart/kuberay-apiserver
 
-# Step3: Install the KubeRay apiserver
+# Step3: Install the KubeRay APIServer
 helm install kuberay-apiserver . --set security=null
 ```
 
@@ -55,7 +63,7 @@ helm install kuberay-apiserver kuberay/kuberay-apiserver --version 1.4.2
 # Step2: Navigate to `helm-chart/kuberay-apiserver`
 cd helm-chart/kuberay-apiserver
 
-# Step3: Install the KubeRay apiserver
+# Step3: Install the KubeRay APIServer
 helm install kuberay-apiserver .
 ```
 
@@ -70,8 +78,8 @@ To list the `kuberay-apiserver` release:
 
 ```sh
 helm ls
-# NAME                      NAMESPACE       REVISION        UPDATED                                    STATUS         CHART
-# kuberay-apiserver         default         1               2022-12-02 02:13:37.514445313 +0000 UTC    deployed       kuberay-apiserver-1.1.0
+# NAME                    NAMESPACE       REVISION        UPDATED                                 STATUS          CHART
+# kuberay-apiserver       default         1               2025-08-08 17:07:51.472353906 +0000 UTC deployed        kuberay-apiserver-1.4.2
 ```
 
 ## Uninstall the Chart
@@ -80,9 +88,49 @@ helm ls
 # Uninstall the `kuberay-apiserver` release
 helm uninstall kuberay-apiserver
 
-# The API Server Pod should be removed.
+# The APIServer Pod should be removed.
 kubectl get pods
 # No resources found in default namespace.
 ```
 
-[existing CI tests]: https://github.com/ray-project/kuberay/blob/master/.github/workflows/helm-lint.yaml
+[existing CI tests]: https://github.com/ray-project/kuberay/blob/master/.github/workflows/helm.yaml
+[KubeRay APIServer V2 documentation]: https://github.com/ray-project/kuberay/blob/master/apiserversdk/README.md
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| replicaCount | int | `1` |  |
+| name | string | `"kuberay-apiserver"` |  |
+| image.repository | string | `"quay.io/kuberay/apiserver"` | Image repository. |
+| image.tag | string | `"v1.6.0-rc.0"` | Image tag. |
+| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy. |
+| cors | string | `nil` |  |
+| labels | object | `{}` | Extra labels. |
+| annotations | object | `{}` | Extra annotations. |
+| serviceAccount.create | bool | `true` | Specifies whether a service account should be created. |
+| serviceAccount.name | string | `"kuberay-apiserver"` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
+| containerPort[0].name | string | `"http"` |  |
+| containerPort[0].containerPort | int | `8888` |  |
+| containerPort[0].protocol | string | `"TCP"` |  |
+| containerPort[1].name | string | `"grpc"` |  |
+| containerPort[1].containerPort | int | `8887` |  |
+| containerPort[1].protocol | string | `"TCP"` |  |
+| resources | object | `{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"300m","memory":"300Mi"}}` | Resource requests and limits for containers. |
+| sidecarContainers | list | `[]` | Sidecar containers to run along with the main container. |
+| nodeSelector | object | `{}` | Node selector for pods. |
+| affinity | object | `{}` | Affinity for pods. |
+| tolerations | list | `[]` | Tolerations for pods. |
+| service.type | string | `"ClusterIP"` | Service type. |
+| service.ports | list | `[{"name":"http","port":8888,"protocol":"TCP","targetPort":8888},{"name":"rpc","port":8887,"protocol":"TCP","targetPort":8887}]` | Service port. |
+| ingress.enabled | bool | `false` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `""` |  |
+| ingress.tls | list | `[]` |  |
+| route.enabled | bool | `false` |  |
+| route.annotations | object | `{}` |  |
+| rbacEnable | bool | `true` | Install Default RBAC roles and bindings |
+| singleNamespaceInstall | bool | `false` | The chart can be installed by users with permissions to a single namespace only |
+| enableAPIServerV2 | bool | `true` | If set to true, APIServer v2 would be served on the same port as the APIServer v1. |
+| security.proxy | object | `{"pullPolicy":"IfNotPresent","repository":"quay.io/kuberay/security-proxy","tag":"nightly"}` | security proxy image. |
+| security.env | object | `{"ENABLE_GRPC":"true","GRPC_LOCAL_PORT":8987,"HTTP_LOCAL_PORT":8988,"SECURITY_PREFIX":"/","SECURITY_TOKEN":"12345"}` | security proxy environment variables. |

helm-chart/kuberay-apiserver/README.md

@@ -0,0 +1,104 @@
+# KubeRay APIServer
+
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+
+## Introduction
+
+This document provides instructions to install the KubeRay APIServer with a Helm chart.
+KubeRay APIServer V2 is enabled by default, for more information,
+please refer to the [KubeRay APIServer V2 documentation].
+
+
+## Helm
+
+Make sure the version of Helm is v3+. Currently, [existing CI tests] are based on Helm v3.4.1 and
+v3.9.4.
+
+```sh
+helm version
+```
+
+## Install KubeRay APIServer
+
+### Without security proxy
+
+- Install a stable version via Helm repository
+
+```sh
+helm repo add kuberay https://ray-project.github.io/kuberay-helm/
+helm repo update
+# Install KubeRay APIServer without security proxy
+helm install kuberay-apiserver kuberay/kuberay-apiserver --version 1.4.2 --set security=null
+```
+
+- Install the nightly version
+
+```sh
+# Step1: Clone KubeRay repository
+
+# Step2: Navigate to `helm-chart/kuberay-apiserver`
+cd helm-chart/kuberay-apiserver
+
+# Step3: Install the KubeRay APIServer
+helm install kuberay-apiserver . --set security=null
+```
+
+### With security proxy
+
+- Install a stable version via Helm repository
+
+```sh
+helm repo add kuberay https://ray-project.github.io/kuberay-helm/
+helm repo update
+# Install KubeRay APIServer
+helm install kuberay-apiserver kuberay/kuberay-apiserver --version 1.4.2
+```
+
+- Install the nightly version
+
+```sh
+# Step1: Clone KubeRay repository
+
+# Step2: Navigate to `helm-chart/kuberay-apiserver`
+cd helm-chart/kuberay-apiserver
+
+# Step3: Install the KubeRay APIServer
+helm install kuberay-apiserver .
+```
+
+> [!IMPORTANT]
+> If you receive an "Unauthorized" error when making a request, please add an
+> authorization header to the request: `-H 'Authorization: 12345'` or install the
+> APIServer without a security proxy.
+
+## List the chart
+
+To list the `kuberay-apiserver` release:
+
+```sh
+helm ls
+# NAME                    NAMESPACE       REVISION        UPDATED                                 STATUS          CHART
+# kuberay-apiserver       default         1               2025-08-08 17:07:51.472353906 +0000 UTC deployed        kuberay-apiserver-1.4.2
+```
+
+## Uninstall the Chart
+
+```sh
+# Uninstall the `kuberay-apiserver` release
+helm uninstall kuberay-apiserver
+
+# The APIServer Pod should be removed.
+kubectl get pods
+# No resources found in default namespace.
+```
+
+[existing CI tests]: https://github.com/ray-project/kuberay/blob/master/.github/workflows/helm.yaml
+[KubeRay APIServer V2 documentation]: https://github.com/ray-project/kuberay/blob/master/apiserversdk/README.md
+
+{{ template "chart.valuesSection" . }}

helm-chart/kuberay-apiserver/README.md.gotmpl

@@ -1,5 +1,6 @@
 {{- if .Values.ingress.enabled -}}
 {{- $fullName := include "kuberay-apiserver.fullname" . -}}
+{{- $svcName := printf "%s-service" $fullName -}}
 {{- $svcPort := .Values.service.port -}}
 {{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
   {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }}
@@ -50,11 +51,11 @@ spec:
             backend:
               {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
               service:
-                name: {{ $fullName }}
+                name: {{ $svcName }}
                 port:
                   number: {{ $svcPort }}
               {{- else }}
-              serviceName: {{ $fullName }}
+              serviceName: {{ $svcName }}
               servicePort: {{ $svcPort }}
               {{- end }}
           {{- end }}

helm-chart/kuberay-apiserver/templates/ingress.yaml

@@ -14,7 +14,7 @@ spec:
   subdomain: api-server-kuberay
   to:
     kind: Service
-    name: {{ .Values.name }}-service
+    name: {{ include "kuberay-apiserver.fullname" . }}-service
     weight: 100
   port:
     targetPort: http

helm-chart/kuberay-apiserver/templates/route.yaml

@@ -1,7 +1,7 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: {{ .Values.name }}-service
+  name: {{ include "kuberay-apiserver.fullname" . }}-service
   namespace: {{ .Release.Namespace }}
   labels:
     app.kubernetes.io/component: kuberay-apiserver

helm-chart/kuberay-apiserver/templates/service.yaml

@@ -57,3 +57,93 @@ tests:
           kind: Ingress
           name: kuberay-apiserver
           namespace: kuberay-system
+
+  - it: Should have ingress backend service name matching the service name
+    capabilities:
+      majorVersion: 1
+      minorVersion: 19
+    set:
+      ingress:
+        enabled: true
+        hosts:
+          - host: example.com
+            paths:
+              - path: /
+                pathType: Prefix
+      service:
+        port: 8888
+    asserts:
+      - equal:
+          path: spec.rules[0].http.paths[0].backend.service.name
+          value: kuberay-apiserver-service
+
+  - it: Should have ingress backend service name matching the service name when fullnameOverride is set
+    capabilities:
+      majorVersion: 1
+      minorVersion: 19
+    set:
+      fullnameOverride: test-name
+      ingress:
+        enabled: true
+        hosts:
+          - host: example.com
+            paths:
+              - path: /
+                pathType: Prefix
+      service:
+        port: 8888
+    asserts:
+      - equal:
+          path: spec.rules[0].http.paths[0].backend.service.name
+          value: test-name-service
+
+  - it: Should have ingress backend service name matching the service name when nameOverride is set
+    capabilities:
+      majorVersion: 1
+      minorVersion: 19
+    set:
+      nameOverride: custom-api
+      ingress:
+        enabled: true
+        hosts:
+          - host: example.com
+            paths:
+              - path: /
+                pathType: Prefix
+      service:
+        port: 8888
+    asserts:
+      - equal:
+          path: spec.rules[0].http.paths[0].backend.service.name
+          value: kuberay-apiserver-custom-api-service
+
+  - it: Should have correct service name in all backend references with multiple hosts and paths
+    capabilities:
+      majorVersion: 1
+      minorVersion: 19
+    set:
+      ingress:
+        enabled: true
+        hosts:
+          - host: example.com
+            paths:
+              - path: /api
+                pathType: Prefix
+              - path: /health
+                pathType: Exact
+          - host: api.example.com
+            paths:
+              - path: /
+                pathType: Prefix
+      service:
+        port: 8888
+    asserts:
+      - equal:
+          path: spec.rules[0].http.paths[0].backend.service.name
+          value: kuberay-apiserver-service
+      - equal:
+          path: spec.rules[0].http.paths[1].backend.service.name
+          value: kuberay-apiserver-service
+      - equal:
+          path: spec.rules[1].http.paths[0].backend.service.name
+          value: kuberay-apiserver-service

helm-chart/kuberay-apiserver/tests/ingress_test.yaml

@@ -41,3 +41,32 @@ tests:
       - equal:
           path: metadata.annotations.key2
           value: value2
+
+  - it: Should have route backend service name matching the service name
+    set:
+      route:
+        enabled: true
+    asserts:
+      - equal:
+          path: spec.to.name
+          value: kuberay-apiserver-service
+
+  - it: Should have route backend service name matching the service name when fullnameOverride is set
+    set:
+      fullnameOverride: test-name
+      route:
+        enabled: true
+    asserts:
+      - equal:
+          path: spec.to.name
+          value: test-name-service
+
+  - it: Should have route backend service name matching the service name when nameOverride is set
+    set:
+      nameOverride: custom-api
+      route:
+        enabled: true
+    asserts:
+      - equal:
+          path: spec.to.name
+          value: kuberay-apiserver-custom-api-service