[Release] Release v1.4.0-rc.0 helm chart (#65)

Signed-off-by: Chi-Sheng Liu <[email protected]>

Author: MortalHappiness

helm-chart/Makefile

@@ -0,0 +1,101 @@
+.SILENT:
+
+# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
+ifeq (,$(shell go env GOBIN))
+GOBIN=$(shell go env GOPATH)/bin
+else
+GOBIN=$(shell go env GOBIN)
+endif
+
+# Setting SHELL to bash allows bash commands to be executed by recipes.
+# Options are set to exit when a recipe line exits non-zero or a piped command fails.
+SHELL = /usr/bin/env bash -o pipefail
+.SHELLFLAGS = -ec
+
+# Absolute path to Makefile (trim trailing slash).
+WORKDIR ?= $(patsubst %/,%,$(dir $(abspath $(lastword $(MAKEFILE_LIST)))))
+
+# Absolute paths to Helm charts.
+KUBERAY_OPERATOR_CHART_PATH ?= $(WORKDIR)/kuberay-operator
+KUBERAY_APISERVER_CHART_PATH ?= $(WORKDIR)/kuberay-apiserver
+RAY_CLUSTER_CHART_PATH ?= $(WORKDIR)/ray-cluster
+
+# Tool versions.
+HELM_VERSION ?= v3.17.3
+HELM_UNITTEST_VERSION ?= 0.8.1
+HELM_DOCS_VERSION ?= v1.14.2
+
+# Tool binaries.
+LOCALBIN ?= $(WORKDIR)/bin
+HELM ?= $(LOCALBIN)/helm-$(HELM_VERSION)
+HELM_DOCS ?= $(LOCALBIN)/helm-docs-$(HELM_DOCS_VERSION)
+
+##@ General
+
+# The help target prints out all targets with their descriptions organized
+# beneath their categories. The categories are represented by '##@' and the
+# target descriptions by '##'. The awk command is responsible for reading the
+# entire set of makefiles included in this invocation, looking for lines of the
+# file as xyz: ## something, and then pretty-format the target and help. Then,
+# if there's a line with ##@ something, that gets pretty-printed as a category.
+# More info on the usage of ANSI control characters for terminal formatting:
+# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
+# More info on the awk command:
+# http://linuxcommand.org/lc3_adv_awk.php
+
+.PHONY: help
+help: ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-30s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+##@ Helm
+
+.PHONY: helm-unittest
+helm-unittest: helm-unittest-plugin ## Run Helm chart unittests.
+	$(HELM) unittest $(KUBERAY_OPERATOR_CHART_PATH) --file "tests/**/*_test.yaml" --strict --debug
+	$(HELM) unittest $(KUBERAY_APISERVER_CHART_PATH) --file "tests/**/*_test.yaml" --strict --debug
+	$(HELM) unittest $(RAY_CLUSTER_CHART_PATH) --file "tests/**/*_test.yaml" --strict --debug
+
+.PHONY: helm-lint
+helm-lint: ## Run Helm chart lint test.
+	docker run --rm --workdir /workspace --volume $(WORKDIR):/workspace quay.io/helmpack/chart-testing:v3.12.0 \
+	ct lint --chart-dirs=. --charts=kuberay-operator,kuberay-apiserver,ray-cluster --target-branch=master --validate-maintainers=false
+
+.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
+
+##@ Dependencies
+
+$(LOCALBIN):
+	mkdir -p $(LOCALBIN)
+
+.PHONY: helm
+helm: $(HELM) ## Download helm locally if necessary.
+$(HELM): $(LOCALBIN)
+	$(call go-install-tool,$(HELM),helm.sh/helm/v3/cmd/helm,$(HELM_VERSION))
+
+.PHONY: helm-unittest-plugin
+helm-unittest-plugin: helm ## Download helm unittest plugin locally if necessary.
+	if [ -z "$(shell $(HELM) plugin list | grep unittest)" ]; then \
+		echo "Installing helm unittest plugin"; \
+		$(HELM) plugin install https://github.com/helm-unittest/helm-unittest.git --version $(HELM_UNITTEST_VERSION); \
+	fi
+
+.PHONY: helm-docs-plugin
+helm-docs-plugin: $(HELM_DOCS) ## Download helm-docs plugin locally if necessary.
+$(HELM_DOCS): $(LOCALBIN)
+	$(call go-install-tool,$(HELM_DOCS),github.com/norwoodj/helm-docs/cmd/helm-docs,$(HELM_DOCS_VERSION))
+
+# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
+# $1 - target path with name of binary (ideally with version)
+# $2 - package url which can be installed
+# $3 - specific version of package
+define go-install-tool
+@[ -f $(1) ] || { \
+set -e; \
+package=$(2)@$(3) ;\
+echo "Downloading $${package}" ;\
+GOBIN=$(LOCALBIN) go install $${package} ;\
+mv "$$(echo "$(1)" | sed "s/-$(3)$$//")" $(1) ;\
+}
+endef

helm-chart/kuberay-apiserver/.helmignore

@@ -1,7 +1,10 @@
 # Patterns to ignore when building packages.
 # This supports shell glob matching, relative path matching, and
 # negation (prefixed with !). Only one pattern per line.
-.DS_Store
+
+ci/
+.helmignore
+
 # Common VCS dirs
 .git/
 .gitignore
@@ -10,14 +13,27 @@
 .hg/
 .hgignore
 .svn/
+
 # Common backup files
 *.swp
 *.bak
 *.tmp
 *.orig
 *~
+
 # Various IDEs
+*.tmproj
 .project
 .idea/
-*.tmproj
 .vscode/
+
+# helm-unittest
+tests
+.debug
+__snapshot__
+
+# helm-docs
+README.md.gotmpl
+
+# MacOS
+.DS_Store

helm-chart/kuberay-apiserver/Chart.yaml

@@ -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.3.0
+version: 1.4.0-rc.0

helm-chart/kuberay-apiserver/README.md

@@ -4,36 +4,65 @@ This document provides instructions to install the KubeRay API Server with a Hel
 
 ## Helm
 
-Make sure the version of Helm is v3+. Currently, [existing CI tests](https://github.com/ray-project/kuberay/blob/master/.github/workflows/helm-lint.yaml) are based on Helm v3.4.1 and v3.9.4.
+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 API Server
 
-* Install a stable version via Helm repository (only supports KubeRay v0.4.0+)
-  ```sh
-  helm repo add kuberay https://ray-project.github.io/kuberay-helm/
+### Without security proxy
 
-  # Install the KubeRay API Server at Version v1.1.0.
-  helm install kuberay-apiserver kuberay/kuberay-apiserver --version 1.1.0
+- Install a stable version via Helm repository
 
-  # Check that the KubeRay API Server is running in the "default" namespaces.
-  kubectl get pods
-  # NAME                        READY   STATUS    RESTARTS   AGE
-  # kuberay-apiserver-xxxxxx    1/1     Running   0          17s
-  ```
+```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.0 --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 the nightly version
-  ```sh
-  # Step1: Clone KubeRay repository
+- Install a stable version via Helm repository
 
-  # Step2: Move to `helm-chart/kuberay-apiserver`
+```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.0
+```
+
+- Install the nightly version
+
+```sh
+# Step1: Clone KubeRay repository
 
-  # Step3: Install the KubeRay apiserver
-  helm install kuberay-apiserver .
-  ```
+# 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
 
@@ -55,3 +84,5 @@ helm uninstall kuberay-apiserver
 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

helm-chart/kuberay-apiserver/ci/ci-values.yaml

@@ -0,0 +1,10 @@
+image:
+  repository: kuberay/apiserver
+  tag: local
+  pullPolicy: Never
+
+security:
+  proxy:
+    repository: kuberay/security-proxy
+    tag: local
+    pullPolicy: Never

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

@@ -2,39 +2,53 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: {{ .Values.name }}
+  namespace: {{ .Release.Namespace }}
   labels:
-{{ include "kuberay-apiserver.labels" . | indent 4 }}
-{{- if .Values.labels }}
-{{- toYaml .Values.labels | nindent 4 }}
-{{- end }}
+    {{- include "kuberay-apiserver.labels" . | nindent 4 }}
+    {{- with .Values.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
+  replicas: {{ .Values.replicaCount }}
   selector:
     matchLabels:
       app.kubernetes.io/component: {{ include "kuberay-apiserver.name" . }}
       app.kubernetes.io/name: {{ .Release.Name }}
-  replicas: {{ .Values.replicaCount }}
   template:
     metadata:
       labels:
         app.kubernetes.io/component: {{ include "kuberay-apiserver.name" . }}
         app.kubernetes.io/name: {{ .Release.Name }}
-        {{- if .Values.labels }}
-        {{- toYaml .Values.labels | nindent 8 }}
+        {{- with .Values.labels }}
+        {{- toYaml . | nindent 8 }}
         {{- end }}
-      {{- if .Values.annotations }}
+      {{- with .Values.annotations }}
       annotations:
-        {{- toYaml .Values.annotations | nindent 8 }}
+        {{- toYaml . | nindent 8 }}
       {{- end }}
     spec:
-      serviceAccountName: {{ .Values.serviceAccount.name }}
       containers:
       - name: {{ .Values.name }}-container
         image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
-        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        {{- with .Values.image.pullPolicy }}
+        imagePullPolicy: {{ . }}
+        {{- end }}
+        args:
+          {{- $argList := list -}}
+          {{- $argList = append $argList (printf "--enable-api-server-v2=%t" .Values.enableAPIServerV2) -}}
+          {{- if .Values.cors }}
+            {{- with .Values.cors.allowOrigin }}
+              {{- $argList = append $argList (printf "--cors-allow-origin=%s" .) -}}
+            {{- end }}
+          {{- end }}
+          {{- (printf "\n") -}}
+          {{- $argList | toYaml | indent 10 }}
         ports:
           {{- toYaml .Values.containerPort | nindent 8 }}
+        {{- with .Values.resources }}
         resources:
-          {{- toYaml .Values.resources | nindent 10 }}
+          {{- toYaml . | nindent 10 }}
+        {{- end }}
         livenessProbe:
           httpGet:
             path: /healthz
@@ -46,35 +60,38 @@ spec:
       {{- if .Values.security }}
       - name: security-proxy-container
         image: "{{ .Values.security.proxy.repository }}:{{ .Values.security.proxy.tag }}"
-        imagePullPolicy: {{ .Values.security.proxy.pullPolicy }}
+        {{- with .Values.security.proxy.pullPolicy }}
+        imagePullPolicy: {{ . }}
+        {{- end }}
         ports:
-          - name: http
-            containerPort: {{ .Values.security.env.HTTP_LOCAL_PORT }}
-            protocol: TCP
-          - name: grpc
-            containerPort: {{ .Values.security.env.GRPC_LOCAL_PORT }}
-            protocol: TCP
+        - name: http
+          containerPort: {{ .Values.security.env.HTTP_LOCAL_PORT }}
+          protocol: TCP
+        - name: grpc
+          containerPort: {{ .Values.security.env.GRPC_LOCAL_PORT }}
+          protocol: TCP
         env:
-          {{- range $key, $value := .Values.security.env }}
-          - name: {{ $key }}
-            value: {{ $value | quote }}
+        {{- range $key, $value := .Values.security.env }}
+        - name: {{ $key }}
+          value: {{ $value | quote }}
+        {{- end }}
+        {{- range $port := .Values.containerPort }}
+          {{- if eq $port.name "http" }}
+        - name: "HTTP_REMOTE_PORT"
+          value: {{ $port.containerPort | quote }}
           {{- end }}
-          {{- range $port := .Values.containerPort  }}
-            {{- if eq $port.name "http" }}
-          - name: "HTTP_REMOTE_PORT"
-            value: {{ $port.containerPort | quote }}
-            {{- end }}
-            {{- if eq $port.name "grpc" }}
-          - name: "GRPC_REMOTE_PORT"
-            value: {{ $port.containerPort | quote }}
-            {{- end }}
+          {{- if eq $port.name "grpc" }}
+        - name: "GRPC_REMOTE_PORT"
+          value: {{ $port.containerPort | quote }}
           {{- end }}
+        {{- end }}
+        {{- with .Values.resources }}
         resources:
-          {{- toYaml .Values.resources | nindent 10 }}
+          {{- toYaml . | nindent 10 }}
+        {{- end }}
       {{- end }}
-
-      {{- if .Values.sidecarContainers }}
-      {{- toYaml .Values.sidecarContainers | nindent 6 }}
+      {{- with .Values.sidecarContainers }}
+      {{- toYaml . | nindent 6 }}
       {{- end }}
       {{- with .Values.nodeSelector }}
       nodeSelector:
@@ -86,5 +103,6 @@ spec:
       {{- end }}
       {{- with .Values.tolerations }}
       tolerations:
-        {{- toYaml . | nindent 8 }}
+      {{- toYaml . | nindent 6 }}
       {{- end }}
+      serviceAccountName: {{ .Values.serviceAccount.name }}

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

@@ -16,6 +16,7 @@ apiVersion: extensions/v1beta1
 kind: Ingress
 metadata:
   name: {{ $fullName }}
+  namespace: {{ $.Release.Namespace }}
   labels:
     {{- include "kuberay-apiserver.labels" . | nindent 4 }}
   {{- with .Values.ingress.annotations }}