This is an automated email from the ASF dual-hosted git repository. gyfora pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 27f66d9a [hotfix][docs] Fix Helm broken table documentation page
27f66d9a is described below
commit 27f66d9a368c92f4036782947e9e07bb41f35580
Author: Dennis-Mircea Ciupitu <[email protected]>
AuthorDate: Mon Apr 20 12:12:11 2026 +0300
[hotfix][docs] Fix Helm broken table documentation page
---
docs/content.zh/docs/operations/helm.md | 76 +++++++++++++++---------------
docs/content/docs/operations/helm.md | 83 ++++++++++++++++-----------------
2 files changed, 79 insertions(+), 80 deletions(-)
diff --git a/docs/content.zh/docs/operations/helm.md
b/docs/content.zh/docs/operations/helm.md
index 851d3bf0..75c6ff89 100644
--- a/docs/content.zh/docs/operations/helm.md
+++ b/docs/content.zh/docs/operations/helm.md
@@ -70,62 +70,62 @@ The configurable parameters of the Helm chart and which
default values as detail
| Parameters | Description
| Default Value
[...]
|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| watchNamespaces | List of kubernetes
namespaces to watch for FlinkDeployment changes, empty means all namespaces.
|
[...]
-| image.repository | The image repository of
flink-kubernetes-operator.
|
ghcr.io/apache/flink-kubernetes-operator
[...]
+| defaultConfiguration.append | Whether to append
configuration files with configs.
| true
[...]
+| defaultConfiguration.create | Whether to enable default
configuration to create for flink-kubernetes-operator.
| true
[...]
+| defaultConfiguration.flink-conf.yaml | The default configuration
of flink-conf.yaml.
|
kubernetes.operator.metrics.reporter.slf4j.factory.class:
org.apache.flink.metrics.slf4j.Slf4jReporterFactory<br/>kubernetes.operator.metrics.reporter.slf4j.interval:
5 MINUTE<br/>kubernetes.operator.reconcile.interval: 15
s<br/>kubernetes.operator.observer.progress-check.interva [...]
+| defaultConfiguration.log4j-console.properties | The default configuration
of log4j-console.properties.
|
[...]
+| defaultConfiguration.log4j-operator.properties | The default configuration
of log4j-operator.properties.
|
[...]
+| fullnameOverride | Overrides the fullname with
the specified full name.
|
[...]
+| image.digest | The image tag of
flink-kubernetes-operator. If set then it takes precedence and the image tag
will be ignored. |
[...]
| image.pullPolicy | The image pull policy of
flink-kubernetes-operator.
| IfNotPresent
[...]
+| image.repository | The image repository of
flink-kubernetes-operator.
|
ghcr.io/apache/flink-kubernetes-operator
[...]
| image.tag | The image tag of
flink-kubernetes-operator.
| latest
[...]
-| image.digest | The image tag of
flink-kubernetes-operator. If set then it takes precedence and the image tag
will be ignored. |
[...]
-| replicas | Operator replica count.
Must be 1 unless leader election is configured.
| 1
[...]
-| strategy.type | Operator pod upgrade
strategy. Must be Recreate unless leader election is configured.
| Recreate
[...]
-| rbac.create | Whether to enable RBAC to
create for said namespaces.
| true
[...]
-| rbac.nodesRule.create | Whether to add RBAC rule to
list nodes which is needed for rest-service exposed as NodePort type.
| false
[...]
+| imagePullSecrets | The image pull secrets of
flink-kubernetes-operator.
|
[...]
+| jobServiceAccount.annotations | The annotations of job
service account.
|
"helm.sh/resource-policy": keep
[...]
+| jobServiceAccount.create | Whether to enable job
service account to create for flink jobmanager/taskmanager pods.
| true
[...]
+| jobServiceAccount.name | The name of job service
account.
| flink
[...]
+| jvmArgs.operator | The JVM start up options
for operator.
|
[...]
+| jvmArgs.webhook | The JVM start up options
for webhook.
|
[...]
+| metrics.port | The metrics port on the
container for default configuration.
|
[...]
+| nameOverride | Overrides the name with the
specified name.
|
[...]
+| operatorHealth.livenessProbe | Liveness probe
configuration for the operator using the health endpoint. Only time settings
should be configured, endpoint is set automatically based on port. |
[...]
+| operatorHealth.port | Operator health endpoint
port to be used by the probes.
| 8085
[...]
+| operatorHealth.startupProbe | Startup probe configuration
for the operator using the health endpoint. Only time settings should be
configured, endpoint is set automatically based on port. |
[...]
| operatorPod.annotations | Custom annotations to be
added to the operator pod (but not the deployment).
|
[...]
-| operatorPod.labels | Custom labels to be added
to the operator pod and deployment.
|
|
+| operatorPod.dnsConfig | DNS configuration to be
used by the operator pod.
|
[...]
+| operatorPod.dnsPolicy | DNS policy to be used by
the operator pod.
|
[...]
| operatorPod.env | Custom env to be added to
the operator pod.
|
[...]
| operatorPod.envFrom | Custom envFrom settings to
be added to the operator pod.
|
[...]
-| operatorPod.dnsPolicy | DNS policy to be used by
the operator pod.
|
[...]
-| operatorPod.dnsConfig | DNS configuration to be
used by the operator pod.
|
[...]
+| operatorPod.labels | Custom labels to be added
to the operator pod and deployment.
|
[...]
| operatorPod.nodeSelector | Custom nodeSelector to be
added to the operator pod.
|
[...]
-| operatorPod.topologySpreadConstraints | Custom
topologySpreadConstraints to be added to the operator pod.
|
[...]
| operatorPod.resources | Custom resources block to
be added to the operator pod on main container.
|
[...]
-| operatorPod.webhook.resources | Custom resources block to
be added to the operator pod on flink-webhook container.
|
[...]
| operatorPod.tolerations | Custom tolerations to be
added to the operator pod.
|
[...]
-| operatorServiceAccount.create | Whether to enable operator
service account to create for flink-kubernetes-operator.
| true
[...]
+| operatorPod.topologySpreadConstraints | Custom
topologySpreadConstraints to be added to the operator pod.
|
[...]
+| operatorPod.webhook.resources | Custom resources block to
be added to the operator pod on flink-webhook container.
|
[...]
+| operatorSecurityContext | Defines privilege and
access control settings for a pod or container for operator security context.
|
[...]
| operatorServiceAccount.annotations | The annotations of operator
service account.
|
[...]
+| operatorServiceAccount.create | Whether to enable operator
service account to create for flink-kubernetes-operator.
| true
[...]
| operatorServiceAccount.name | The name of operator
service account.
| flink-operator
[...]
-| jobServiceAccount.create | Whether to enable job
service account to create for flink jobmanager/taskmanager pods.
| true
[...]
-| jobServiceAccount.annotations | The annotations of job
service account.
|
"helm.sh/resource-policy": keep
[...]
-| jobServiceAccount.name | The name of job service
account.
| flink
[...]
| operatorVolumeMounts.create | Whether to enable operator
volume mounts to create for flink-kubernetes-operator.
| false
[...]
| operatorVolumeMounts.data | List of mount paths of
operator volume mounts.
| - name:
flink-artifacts<br/> mountPath: /opt/flink/artifacts
[...]
| operatorVolumes.create | Whether to enable operator
volumes to create for flink-kubernetes-operator.
| false
[...]
| operatorVolumes.data | The ConfigMap of operator
volumes.
| - name:
flink-artifacts<br/> hostPath:<br/> path:
/tmp/flink/artifacts<br/> type: DirectoryOrCreate
[...]
| podSecurityContext | Defines privilege and
access control settings for a pod or container for pod security context.
| runAsUser:
9999<br/>runAsGroup: 9999
[...]
-| operatorSecurityContext | Defines privilege and
access control settings for a pod or container for operator security context.
|
[...]
-| webhookSecurityContext | Defines privilege and
access control settings for a pod or container for webhook security context.
|
[...]
-| webhook.create | Whether to enable
validating and mutating webhooks for flink-kubernetes-operator.
| true
[...]
-| webhook.mutator.create | Enable or disable mutating
webhook, overrides `webhook.create`
|
[...]
-| webhook.validator.create | Enable or disable
validating webhook, overrides `webhook.create`
|
[...]
-| webhook.keystore | The ConfigMap of webhook
key store.
| useDefaultPassword:
true
[...]
-| defaultConfiguration.create | Whether to enable default
configuration to create for flink-kubernetes-operator.
| true
[...]
-| defaultConfiguration.append | Whether to append
configuration files with configs.
| true
[...]
-| defaultConfiguration.flink-conf.yaml | The default configuration
of flink-conf.yaml.
|
kubernetes.operator.metrics.reporter.slf4j.factory.class:
org.apache.flink.metrics.slf4j.Slf4jReporterFactory<br/>kubernetes.operator.metrics.reporter.slf4j.interval:
5 MINUTE<br/>kubernetes.operator.reconcile.interval: 15
s<br/>kubernetes.operator.observer.progress-check.interva [...]
-| defaultConfiguration.log4j-operator.properties | The default configuration
of log4j-operator.properties.
|
[...]
-| defaultConfiguration.log4j-console.properties | The default configuration
of log4j-console.properties.
|
[...]
-| metrics.port | The metrics port on the
container for default configuration.
|
[...]
-| imagePullSecrets | The image pull secrets of
flink-kubernetes-operator.
|
[...]
-| nameOverride | Overrides the name with the
specified name.
|
[...]
-| fullnameOverride | Overrides the fullname with
the specified full name.
|
[...]
-| jvmArgs.webhook | The JVM start up options
for webhook.
|
[...]
-| jvmArgs.operator | The JVM start up options
for operator.
|
[...]
-| operatorHealth.port | Operator health endpoint
port to be used by the probes.
| 8085
[...]
-| operatorHealth.livenessProbe | Liveness probe
configuration for the operator using the health endpoint. Only time settings
should be configured, endpoint is set automatically based on port. |
[...]
-| operatorHealth.startupProbe | Startup probe configuration
for the operator using the health endpoint. Only time settings should be
configured, endpoint is set automatically based on port. |
[...]
| postStart | The postStart hook
configuration for the main container.
|
[...]
+| rbac.create | Whether to enable RBAC to
create for said namespaces.
| true
[...]
+| rbac.nodesRule.create | Whether to add RBAC rule to
list nodes which is needed for rest-service exposed as NodePort type.
| false
[...]
+| replicas | Operator replica count.
Must be 1 unless leader election is configured.
| 1
[...]
+| strategy.type | Operator pod upgrade
strategy. Must be Recreate unless leader election is configured.
| Recreate
[...]
| tls.create | Whether to mount an
optional secret containing a tls truststore for the flink-kubernetes-operator.
| false
[...]
+| tls.secretKeyRef.key | The key that holds this
password
| password
[...]
+| tls.secretKeyRef.name | The name of the secret
containing the password for the java keystore/truststore
|
operator-certificate-password
[...]
| tls.secretName | The name of the tls secret
| flink-operator-cert
[...]
-| tls.secretKeyRef.name | The name of the secret containing
the password for the java keystore/truststore
| operator-certificate-password
|
-| tls.secretKeyRef.key | The key that holds this password
| password
|
+| watchNamespaces | List of kubernetes
namespaces to watch for FlinkDeployment changes, empty means all namespaces.
|
[...]
+| webhook.create | Whether to enable
validating and mutating webhooks for flink-kubernetes-operator.
| true
[...]
+| webhook.keystore | The ConfigMap of webhook
key store.
| useDefaultPassword:
true
[...]
+| webhook.mutator.create | Enable or disable mutating
webhook, overrides `webhook.create`
|
[...]
+| webhook.validator.create | Enable or disable
validating webhook, overrides `webhook.create`
|
[...]
+| webhookSecurityContext | Defines privilege and
access control settings for a pod or container for webhook security context.
|
[...]
For more information check the [Helm
documentation](https://helm.sh/docs/helm/helm_install/).
diff --git a/docs/content/docs/operations/helm.md
b/docs/content/docs/operations/helm.md
index c5409705..84e14828 100644
--- a/docs/content/docs/operations/helm.md
+++ b/docs/content/docs/operations/helm.md
@@ -70,66 +70,65 @@ The configurable parameters of the Helm chart and which
default values as detail
| Parameters | Description
| Default Value
[...]
|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| watchNamespaces | List of kubernetes
namespaces to watch for FlinkDeployment changes, empty means all namespaces.
|
[...]
-| image.repository | The image repository of
flink-kubernetes-operator.
|
ghcr.io/apache/flink-kubernetes-operator
[...]
+| defaultConfiguration.append | Whether to append
configuration files with configs.
| true
[...]
+| defaultConfiguration.config.yaml | The newer configuration
file format for flink that will enforced in Flink 2.0. Note this was introduced
in flink 1.19. |
kubernetes.operator.metrics.reporter.slf4j.factory.class:
org.apache.flink.metrics.slf4j.Slf4jReporterFactory<br/>kubernetes.operator.metrics.reporter.slf4j.interval:
5 MINUTE<br/>kubernetes.operator.reconcile.interval: 15
s<br/>kubernetes.operator.observer.progress-check.interva [...]
+| defaultConfiguration.create | Whether to enable default
configuration to create for flink-kubernetes-operator.
| true
[...]
+| defaultConfiguration.flink-conf.yaml | The default configuration
of flink-conf.yaml.
|
kubernetes.operator.metrics.reporter.slf4j.factory.class:
org.apache.flink.metrics.slf4j.Slf4jReporterFactory<br/>kubernetes.operator.metrics.reporter.slf4j.interval:
5 MINUTE<br/>kubernetes.operator.reconcile.interval: 15
s<br/>kubernetes.operator.observer.progress-check.interva [...]
+| defaultConfiguration.log4j-console.properties | The default configuration
of log4j-console.properties.
|
[...]
+| defaultConfiguration.log4j-operator.properties | The default configuration
of log4j-operator.properties.
|
[...]
+| fullnameOverride | Overrides the fullname with
the specified full name.
|
[...]
+| image.digest | The image tag of
flink-kubernetes-operator. If set then it takes precedence and the image tag
will be ignored. |
[...]
| image.pullPolicy | The image pull policy of
flink-kubernetes-operator.
| IfNotPresent
[...]
+| image.repository | The image repository of
flink-kubernetes-operator.
|
ghcr.io/apache/flink-kubernetes-operator
[...]
| image.tag | The image tag of
flink-kubernetes-operator.
| latest
[...]
-| image.digest | The image tag of
flink-kubernetes-operator. If set then it takes precedence and the image tag
will be ignored. |
[...]
-| replicas | Operator replica count.
Must be 1 unless leader election is configured.
| 1
[...]
-| strategy.type | Operator pod upgrade
strategy. Must be Recreate unless leader election is configured.
| Recreate
[...]
-| rbac.create | Whether to enable RBAC to
create for said namespaces.
| true
[...]
-| rbac.nodesRule.create | Whether to add RBAC rule to
list nodes which is needed for rest-service exposed as NodePort type.
| false
[...]
+| imagePullSecrets | The image pull secrets of
flink-kubernetes-operator.
|
[...]
+| jobServiceAccount.annotations | The annotations of job
service account.
|
"helm.sh/resource-policy": keep
[...]
+| jobServiceAccount.create | Whether to enable job
service account to create for flink jobmanager/taskmanager pods.
| true
[...]
+| jobServiceAccount.name | The name of job service
account.
| flink
[...]
+| jvmArgs.operator | The JVM start up options
for operator.
|
[...]
+| jvmArgs.webhook | The JVM start up options
for webhook.
|
[...]
+| metrics.port | The metrics port on the
container for default configuration.
|
[...]
+| nameOverride | Overrides the name with the
specified name.
|
[...]
+| operatorHealth.livenessProbe | Liveness probe
configuration for the operator using the health endpoint. Only time settings
should be configured, endpoint is set automatically based on port. |
[...]
+| operatorHealth.port | Operator health endpoint
port to be used by the probes.
| 8085
[...]
+| operatorHealth.startupProbe | Startup probe configuration
for the operator using the health endpoint. Only time settings should be
configured, endpoint is set automatically based on port. |
[...]
| operatorPod.annotations | Custom annotations to be
added to the operator pod (but not the deployment).
|
[...]
-| operatorPod.labels | Custom labels to be added
to the operator pod and deployment.
|
[...]
+| operatorPod.dnsConfig | DNS configuration to be
used by the operator pod.
|
[...]
+| operatorPod.dnsPolicy | DNS policy to be used by
the operator pod.
|
[...]
| operatorPod.env | Custom env to be added to
the operator pod.
|
[...]
| operatorPod.envFrom | Custom envFrom settings to
be added to the operator pod.
|
[...]
-| operatorPod.dnsPolicy | DNS policy to be used by
the operator pod.
|
[...]
-| operatorPod.dnsConfig | DNS configuration to be
used by the operator pod.
|
[...]
+| operatorPod.labels | Custom labels to be added
to the operator pod and deployment.
|
[...]
| operatorPod.nodeSelector | Custom nodeSelector to be
added to the operator pod.
|
[...]
-| operatorPod.topologySpreadConstraints | Custom
topologySpreadConstraints to be added to the operator pod.
|
[...]
| operatorPod.resources | Custom resources block to
be added to the operator pod on main container.
|
[...]
-| operatorPod.webhook.resources | Custom resources block to
be added to the operator pod on flink-webhook container.
|
[...]
-| operatorPod.webhook.container.env | Custom env to be added to
the flink-webhook container
|
|
| operatorPod.tolerations | Custom tolerations to be
added to the operator pod.
|
[...]
-| operatorServiceAccount.create | Whether to enable operator
service account to create for flink-kubernetes-operator.
| true
[...]
+| operatorPod.topologySpreadConstraints | Custom
topologySpreadConstraints to be added to the operator pod.
|
[...]
+| operatorPod.webhook.container.env | Custom env to be added to
the flink-webhook container
|
[...]
+| operatorPod.webhook.resources | Custom resources block to
be added to the operator pod on flink-webhook container.
|
[...]
+| operatorSecurityContext | Defines privilege and
access control settings for a pod or container for operator security context.
|
[...]
| operatorServiceAccount.annotations | The annotations of operator
service account.
|
[...]
+| operatorServiceAccount.create | Whether to enable operator
service account to create for flink-kubernetes-operator.
| true
[...]
| operatorServiceAccount.name | The name of operator
service account.
| flink-operator
[...]
-| jobServiceAccount.create | Whether to enable job
service account to create for flink jobmanager/taskmanager pods.
| true
[...]
-| jobServiceAccount.annotations | The annotations of job
service account.
|
"helm.sh/resource-policy": keep
[...]
-| jobServiceAccount.name | The name of job service
account.
| flink
[...]
| operatorVolumeMounts.create | Whether to enable operator
volume mounts to create for flink-kubernetes-operator.
| false
[...]
| operatorVolumeMounts.data | List of mount paths of
operator volume mounts.
| - name:
flink-artifacts<br/> mountPath: /opt/flink/artifacts
[...]
| operatorVolumes.create | Whether to enable operator
volumes to create for flink-kubernetes-operator.
| false
[...]
| operatorVolumes.data | The ConfigMap of operator
volumes.
| - name:
flink-artifacts<br/> hostPath:<br/> path:
/tmp/flink/artifacts<br/> type: DirectoryOrCreate
[...]
| podSecurityContext | Defines privilege and
access control settings for a pod or container for pod security context.
| runAsUser:
9999<br/>runAsGroup: 9999
[...]
-| operatorSecurityContext | Defines privilege and
access control settings for a pod or container for operator security context.
|
[...]
-| webhookSecurityContext | Defines privilege and
access control settings for a pod or container for webhook security context.
|
[...]
-| webhook.create | Whether to enable
validating and mutating webhooks for flink-kubernetes-operator.
| true
[...]
-| webhook.mutator.create | Enable or disable mutating
webhook, overrides `webhook.create`
|
[...]
-| webhook.validator.create | Enable or disable
validating webhook, overrides `webhook.create`
|
[...]
-| webhook.keystore | The ConfigMap of webhook
key store.
| useDefaultPassword:
true
[...]
-| webhook.serviceLabels | The labels for
flink-operator-webhook-service-resource.
|
|
-| defaultConfiguration.create | Whether to enable default
configuration to create for flink-kubernetes-operator.
| true
[...]
-| defaultConfiguration.append | Whether to append
configuration files with configs.
| true
[...]
-| defaultConfiguration.flink-conf.yaml | The default configuration
of flink-conf.yaml.
|
kubernetes.operator.metrics.reporter.slf4j.factory.class:
org.apache.flink.metrics.slf4j.Slf4jReporterFactory<br/>kubernetes.operator.metrics.reporter.slf4j.interval:
5 MINUTE<br/>kubernetes.operator.reconcile.interval: 15
s<br/>kubernetes.operator.observer.progress-check.interva [...]
-| defaultConfiguration.config.yaml | The newer configuration file
format for flink that will enforced in Flink 2.0. Note this was introduced in
flink 1.19.
|
kubernetes.operator.metrics.reporter.slf4j.factory.class:
org.apache.flink.metrics.slf4j.Slf4jReporterFactory<br/>kubernetes.operator.metrics.reporter.slf4j.interval:
5 MINUTE<br/>kubernetes.operator.reconcile. [...]
-
-| defaultConfiguration.log4j-operator.properties | The default configuration
of log4j-operator.properties.
|
[...]
-| defaultConfiguration.log4j-console.properties | The default configuration
of log4j-console.properties.
|
[...]
-| metrics.port | The metrics port on the
container for default configuration.
|
[...]
-| imagePullSecrets | The image pull secrets of
flink-kubernetes-operator.
|
[...]
-| nameOverride | Overrides the name with the
specified name.
|
[...]
-| fullnameOverride | Overrides the fullname with
the specified full name.
|
[...]
-| jvmArgs.webhook | The JVM start up options
for webhook.
|
[...]
-| jvmArgs.operator | The JVM start up options
for operator.
|
[...]
-| operatorHealth.port | Operator health endpoint
port to be used by the probes.
| 8085
[...]
-| operatorHealth.livenessProbe | Liveness probe
configuration for the operator using the health endpoint. Only time settings
should be configured, endpoint is set automatically based on port. |
[...]
-| operatorHealth.startupProbe | Startup probe configuration
for the operator using the health endpoint. Only time settings should be
configured, endpoint is set automatically based on port. |
[...]
| postStart | The postStart hook
configuration for the main container.
|
[...]
+| rbac.create | Whether to enable RBAC to
create for said namespaces.
| true
[...]
+| rbac.nodesRule.create | Whether to add RBAC rule to
list nodes which is needed for rest-service exposed as NodePort type.
| false
[...]
+| replicas | Operator replica count.
Must be 1 unless leader election is configured.
| 1
[...]
+| strategy.type | Operator pod upgrade
strategy. Must be Recreate unless leader election is configured.
| Recreate
[...]
| tls.create | Whether to mount an
optional secret containing a tls truststore for the flink-kubernetes-operator.
| false
[...]
+| tls.secretKeyRef.key | The key that holds this
password
| password
[...]
+| tls.secretKeyRef.name | The name of the secret
containing the password for the java keystore/truststore
|
operator-certificate-password
[...]
| tls.secretName | The name of the tls secret
| flink-operator-cert
[...]
-| tls.secretKeyRef.name | The name of the secret containing
the password for the java keystore/truststore
| operator-certificate-password
|
-| tls.secretKeyRef.key | The key that holds this password
| password
|
+| watchNamespaces | List of kubernetes
namespaces to watch for FlinkDeployment changes, empty means all namespaces.
|
[...]
+| webhook.create | Whether to enable
validating and mutating webhooks for flink-kubernetes-operator.
| true
[...]
+| webhook.keystore | The ConfigMap of webhook
key store.
| useDefaultPassword:
true
[...]
+| webhook.mutator.create | Enable or disable mutating
webhook, overrides `webhook.create`
|
[...]
+| webhook.serviceLabels | The labels for
flink-operator-webhook-service-resource.
|
[...]
+| webhook.validator.create | Enable or disable
validating webhook, overrides `webhook.create`
|
[...]
+| webhookSecurityContext | Defines privilege and
access control settings for a pod or container for webhook security context.
|
[...]
For more information check the [Helm
documentation](https://helm.sh/docs/helm/helm_install/).
