Skip to content

[hotfix][docs] Sync Chinese helm and upgrade with English #1091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmetzger merged 3 commits into from
Apr 23, 2026
+10 −4
Merged

[hotfix][docs] Sync Chinese helm and upgrade with English #1091

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4a1c9c
[hotfix][docs] Sync Chinese helm.md and upgrade.md with English
spuru9 Apr 17, 2026
8998a0a
Merge branch 'main' into docs-zh-sync-helm-upgrade
spuru9 Apr 23, 2026
5a2a26b
removed duplicates after conflicts
spuru9 Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/content.zh/docs/operations/helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ The configurable parameters of the Helm chart and which default values as detail
| 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 |
| operatorServiceAccount.annotations | The annotations of operator service account. | |
Expand All @@ -107,9 +108,11 @@ The configurable parameters of the Helm chart and which default values as detail
| 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.interval: 5 s |
| 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.interval: 5 s |
| 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. | |
Expand Down
11 changes: 7 additions & 4 deletions docs/content.zh/docs/operations/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down