This is an automated email from the ASF dual-hosted git repository.
rmetzger 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 c63cd672 [hotfix][docs] Sync Chinese helm and upgrade with English
(#1091)
c63cd672 is described below
commit c63cd6729a893858ce0a969552c13fa7d6cbbea9
Author: Purushottam Sinha <[email protected]>
AuthorDate: Thu Apr 23 11:47:27 2026 +0530
[hotfix][docs] Sync Chinese helm and upgrade with English (#1091)
* [hotfix][docs] Sync Chinese helm.md and upgrade.md with English
helm.md: add missing rows for defaultConfiguration.config.yaml,
operatorPod.webhook.container.env, and webhook.serviceLabels.
upgrade.md: add missing "Upgrading the Java client library" bullet
to the intro list so it matches the section headings below; add the
FlinkStateSnapshot CRD to the description and kubectl replace block;
restore the "If the CRD does not exist yet..." hint sentence; fix
typo FlinkDeployemnt -> FlinkDeployment.
* removed duplicates after conflicts
---
docs/content.zh/docs/operations/helm.md | 3 +++
docs/content.zh/docs/operations/upgrade.md | 11 +++++++----
2 files changed, 10 insertions(+), 4 deletions(-)
diff --git a/docs/content.zh/docs/operations/helm.md
b/docs/content.zh/docs/operations/helm.md
index 75c6ff89..b2a843a6 100644
--- a/docs/content.zh/docs/operations/helm.md
+++ b/docs/content.zh/docs/operations/helm.md
@@ -71,6 +71,7 @@ The configurable parameters of the Helm chart and which
default values as detail
| Parameters | Description
| Default Value
[...]
|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| defaultConfiguration.append | Whether to append
configuration files with configs.
| true
[...]
+| defaultConfiguration.config.yaml | The newer configuration
file format for flink that will be 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.
|
[...]
@@ -101,6 +102,7 @@ The configurable parameters of the Helm chart and which
default values as detail
| operatorPod.resources | Custom resources block to
be added to the operator pod on main container.
|
[...]
| operatorPod.tolerations | Custom tolerations to be
added to the operator pod.
|
[...]
| 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.
|
[...]
@@ -124,6 +126,7 @@ The configurable parameters of the Helm chart and which
default values as detail
| 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.
|
[...]
diff --git a/docs/content.zh/docs/operations/upgrade.md
b/docs/content.zh/docs/operations/upgrade.md
index 1bb3d350..659047cf 100644
--- a/docs/content.zh/docs/operations/upgrade.md
+++ b/docs/content.zh/docs/operations/upgrade.md
@@ -38,8 +38,9 @@ Please check the [related
section](#upgrading-from-v1alpha1---v1beta1).
## Normal Upgrade Process
If you are upgrading from `kubernetes-operator-1.0.0` or later, please refer
to the following two steps:
-1. Upgrading the CRDs
-2. Upgrading the Helm deployment
+1. Upgrading the Java client library
+2. Upgrading the CRDs
+3. Upgrading the Helm deployment
We will cover these steps in detail in the next sections.
@@ -51,16 +52,18 @@ backwards-compatible with the previous minor version of the
operator.
### 2. Upgrading the CRD
-The first step of the upgrade process is upgrading the CRDs for
`FlinkDeployment` and `FlinkSessionJob` resources.
+The first step of the upgrade process is upgrading the CRDs for
`FlinkDeployment`, `FlinkSessionJob` and `FlinkStateSnapshot` resources.
This step must be completed manually and is not part of the helm installation
logic.
```sh
kubectl replace -f
helm/flink-kubernetes-operator/crds/flinkdeployments.flink.apache.org-v1.yml
kubectl replace -f
helm/flink-kubernetes-operator/crds/flinksessionjobs.flink.apache.org-v1.yml
+kubectl replace -f
helm/flink-kubernetes-operator/crds/flinkstatesnapshots.flink.apache.org-v1.yml
```
{{< hint danger >}}
Please note that we are using the `replace` command here which ensures that
running deployments are unaffected.
+If the CRD does not exist yet, you will get an error and you should try
`kubectl apply` instead.
{{< /hint >}}
### 3. Upgrading the Helm deployment
@@ -148,7 +151,7 @@ Here is a reference example of upgrading a
`basic-checkpoint-ha-example` deploym
```
5. Restore the job:
- Deploy the previously deleted job using this
[FlinkDeployemnt](https://raw.githubusercontent.com/apache/flink-kubernetes-operator/main/examples/basic-checkpoint-ha.yaml)
with `v1beta1` and explicitly set the `job.initialSavepointPath` to the
savepoint location obtained from the step 1.
+ Deploy the previously deleted job using this
[FlinkDeployment](https://raw.githubusercontent.com/apache/flink-kubernetes-operator/main/examples/basic-checkpoint-ha.yaml)
with `v1beta1` and explicitly set the `job.initialSavepointPath` to the
savepoint location obtained from the step 1.
```
spec:
