Skip to content

Commit f43ed3d

Browse files
committed
Run make helm-docs
Signed-off-by: Yi Chen <[email protected]>
1 parent f252aad commit f43ed3d

File tree

2 files changed

+4
-8
lines changed

2 files changed

+4
-8
lines changed

helm-chart/kuberay-operator/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,18 +167,14 @@ spec:
167167
| featureGates[1].enabled | bool | `false` | |
168168
| metrics.enabled | bool | `true` | Whether KubeRay operator should emit control plane metrics. |
169169
| operatorCommand | string | `"/manager"` | Path to the operator binary |
170+
| useKubernetesProxy | bool | `false` | |
170171
| leaderElectionEnabled | bool | `true` | If leaderElectionEnabled is set to true, the KubeRay operator will use leader election for high availability. |
171172
| rbacEnable | bool | `true` | If rbacEnable is set to false, no RBAC resources will be created, including the Role for leader election, the Role for Pods and Services, and so on. |
172173
| crNamespacedRbacEnable | bool | `true` | When crNamespacedRbacEnable is set to true, the KubeRay operator will create a Role for RayCluster preparation (e.g., Pods, Services) and a corresponding RoleBinding for each namespace listed in the "watchNamespace" parameter. Please note that even if crNamespacedRbacEnable is set to false, the Role and RoleBinding for leader election will still be created. Note: (1) This variable is only effective when rbacEnable and singleNamespaceInstall are both set to true. (2) In most cases, it should be set to true, unless you are using a Kubernetes cluster managed by GitOps tools such as ArgoCD. |
173174
| singleNamespaceInstall | bool | `false` | When singleNamespaceInstall is true: - Install namespaced RBAC resources such as Role and RoleBinding instead of cluster-scoped ones like ClusterRole and ClusterRoleBinding so that the chart can be installed by users with permissions restricted to a single namespace. (Please note that this excludes the CRDs, which can only be installed at the cluster scope.) - If "watchNamespace" is not set, the KubeRay operator will, by default, only listen to resource events within its own namespace. |
175+
| watchNamespace | list | `[]` | The KubeRay operator will watch the custom resources in the namespaces listed in the "watchNamespace" parameter. |
174176
| env | string | `nil` | Environment variables. |
175177
| resources | object | `{"limits":{"cpu":"100m","memory":"512Mi"}}` | Resource requests and limits for containers. |
176-
| livenessProbe.initialDelaySeconds | int | `10` | |
177-
| livenessProbe.periodSeconds | int | `5` | |
178-
| livenessProbe.failureThreshold | int | `5` | |
179-
| readinessProbe.initialDelaySeconds | int | `10` | |
180-
| readinessProbe.periodSeconds | int | `5` | |
181-
| readinessProbe.failureThreshold | int | `5` | |
182178
| podSecurityContext | object | `{}` | Set up `securityContext` to improve Pod security. |
183179
| service.type | string | `"ClusterIP"` | Service type. |
184180
| service.port | int | `8080` | Service port. |

helm-chart/kuberay-operator/values.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,13 +172,13 @@ resources:
172172
# cpu: 100m
173173
# memory: 512Mi
174174

175-
# @Ignore -- Pod liveness probe configuration.
175+
# @ignore -- Pod liveness probe configuration.
176176
livenessProbe:
177177
initialDelaySeconds: 10
178178
periodSeconds: 5
179179
failureThreshold: 5
180180

181-
# @Ignore -- Pod readiness probe configuration.
181+
# @ignore -- Pod readiness probe configuration.
182182
readinessProbe:
183183
initialDelaySeconds: 10
184184
periodSeconds: 5

0 commit comments

Comments
 (0)