You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by gy...@apache.org on 2022/11/09 08:38:31 UTC
[flink-kubernetes-operator] branch main updated: [hotfix][docs] Typo fix in doc pages
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 4280e35a [hotfix][docs] Typo fix in doc pages
4280e35a is described below
commit 4280e35a42061475893bd6c69095a373f566f331
Author: yangjf2019 <54...@users.noreply.github.com>
AuthorDate: Wed Nov 9 16:38:25 2022 +0800
[hotfix][docs] Typo fix in doc pages
---
docs/content/docs/concepts/overview.md | 2 +-
.../content/docs/custom-resource/job-management.md | 2 +-
docs/content/docs/custom-resource/reference.md | 26 +++++++++++-----------
docs/content/docs/operations/compatibility.md | 2 +-
docs/content/docs/operations/configuration.md | 2 +-
docs/content/docs/operations/helm.md | 18 +++++++--------
docs/content/docs/operations/ingress.md | 10 ++++-----
.../operator/api/docs/CrdReferenceDoclet.java | 2 +-
8 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/docs/content/docs/concepts/overview.md b/docs/content/docs/concepts/overview.md
index d1aeb6b9..2320ec67 100644
--- a/docs/content/docs/concepts/overview.md
+++ b/docs/content/docs/concepts/overview.md
@@ -58,7 +58,7 @@ Flink Kubernetes Operator aims to capture the responsibilities of a human operat
- Pluggable metrics reporters
- Detailed resources and kubernetes api access metrics
- Fully-customizable [Logging]({{< ref "docs/operations/metrics-logging#logging" >}})
- - Default log configuration
+ - Default log configuration
- Per job log configuration
- Sidecar based log forwarders
- Flink Web UI and REST Endpoint Access
diff --git a/docs/content/docs/custom-resource/job-management.md b/docs/content/docs/custom-resource/job-management.md
index cf26ea87..54013478 100644
--- a/docs/content/docs/custom-resource/job-management.md
+++ b/docs/content/docs/custom-resource/job-management.md
@@ -95,7 +95,7 @@ The `upgradeMode` setting controls both the stop and restore mechanisms as detai
*\* When Kubernetes HA is enabled the `savepoint` upgrade mode may fall back to the `last-state` behaviour in cases where the job is in an unhealthy state.*
-The three upgrade modes are intended to support different scenarios:
+The three upgrade modes are intended to support different scenarios:
1. **stateless**: Stateless application upgrades from empty state
2. **last-state**: Quick upgrades in any application state (even for failing jobs), does not require a healthy job as it always uses the latest checkpoint information. Manual recovery may be necessary if HA metadata is lost.
diff --git a/docs/content/docs/custom-resource/reference.md b/docs/content/docs/custom-resource/reference.md
index ad158903..543f67aa 100644
--- a/docs/content/docs/custom-resource/reference.md
+++ b/docs/content/docs/custom-resource/reference.md
@@ -46,17 +46,17 @@ This page serves as a full reference for FlinkDeployment custom resource definit
| Parameter | Type | Docs |
| ----------| ---- | ---- |
| job | org.apache.flink.kubernetes.operator.api.spec.JobSpec | Job specification for application deployments/session job. Null for session clusters. |
-| restartNonce | java.lang.Long | Nonce used to manually trigger restart for the cluster/session job. In order to trigger restart, change the number to anything other than the current value. |
+| restartNonce | java.lang.Long | Nonce used to manually trigger restart for the cluster/session job. In order to trigger restart, change the number to anything other than the current value. |
| flinkConfiguration | java.util.Map<java.lang.String,java.lang.String> | Flink configuration overrides for the Flink deployment or Flink session job. |
| image | java.lang.String | Flink docker image used to start the Job and TaskManager pods. |
| imagePullPolicy | java.lang.String | Image pull policy of the Flink docker image. |
| serviceAccount | java.lang.String | Kubernetes service used by the Flink deployment. |
| flinkVersion | org.apache.flink.kubernetes.operator.api.spec.FlinkVersion | Flink image version. |
| ingress | org.apache.flink.kubernetes.operator.api.spec.IngressSpec | Ingress specs. |
-| podTemplate | io.fabric8.kubernetes.api.model.Pod | Base pod template for job and task manager pods. Can be overridden by the jobManager and taskManager pod templates. |
+| podTemplate | io.fabric8.kubernetes.api.model.Pod | Base pod template for job and task manager pods. Can be overridden by the jobManager and taskManager pod templates. |
| jobManager | org.apache.flink.kubernetes.operator.api.spec.JobManagerSpec | JobManager specs. |
| taskManager | org.apache.flink.kubernetes.operator.api.spec.TaskManagerSpec | TaskManager specs. |
-| logConfiguration | java.util.Map<java.lang.String,java.lang.String> | Log configuration overrides for the Flink deployment. Format logConfigFileName -> configContent. |
+| logConfiguration | java.util.Map<java.lang.String,java.lang.String> | Log configuration overrides for the Flink deployment. Format logConfigFileName -> configContent. |
| mode | org.apache.flink.kubernetes.operator.api.spec.KubernetesDeploymentMode | Deployment mode of the Flink cluster, native or standalone. |
### FlinkSessionJobSpec
@@ -67,7 +67,7 @@ This page serves as a full reference for FlinkDeployment custom resource definit
| Parameter | Type | Docs |
| ----------| ---- | ---- |
| job | org.apache.flink.kubernetes.operator.api.spec.JobSpec | Job specification for application deployments/session job. Null for session clusters. |
-| restartNonce | java.lang.Long | Nonce used to manually trigger restart for the cluster/session job. In order to trigger restart, change the number to anything other than the current value. |
+| restartNonce | java.lang.Long | Nonce used to manually trigger restart for the cluster/session job. In order to trigger restart, change the number to anything other than the current value. |
| flinkConfiguration | java.util.Map<java.lang.String,java.lang.String> | Flink configuration overrides for the Flink deployment or Flink session job. |
| deploymentName | java.lang.String | The name of the target session cluster deployment. |
@@ -112,13 +112,13 @@ This page serves as a full reference for FlinkDeployment custom resource definit
| Parameter | Type | Docs |
| ----------| ---- | ---- |
-| jarURI | java.lang.String | Optional URI of the job jar within the Flink docker container. For example: local:///opt/flink/examples/streaming/StateMachineExample.jar. If not specified the job jar should be available in the system classpath. |
+| jarURI | java.lang.String | Optional URI of the job jar within the Flink docker container. For example: local:///opt/flink/examples/streaming/StateMachineExample.jar. If not specified the job jar should be available in the system classpath. |
| parallelism | int | Parallelism of the Flink job. |
| entryClass | java.lang.String | Fully qualified main class name of the Flink job. |
| args | java.lang.String[] | Arguments for the Flink job main class. |
| state | org.apache.flink.kubernetes.operator.api.spec.JobState | Desired state for the job. |
-| savepointTriggerNonce | java.lang.Long | Nonce used to manually trigger savepoint for the running job. In order to trigger a savepoint, change the number to anything other than the current value. |
-| initialSavepointPath | java.lang.String | Savepoint path used by the job the first time it is deployed. Upgrades/redeployments will not be affected. |
+| savepointTriggerNonce | java.lang.Long | Nonce used to manually trigger savepoint for the running job. In order to trigger a savepoint, change the number to anything other than the current value. |
+| initialSavepointPath | java.lang.String | Savepoint path used by the job the first time it is deployed. Upgrades/redeployments will not be affected. |
| upgradeMode | org.apache.flink.kubernetes.operator.api.spec.UpgradeMode | Upgrade mode of the Flink job. |
| allowNonRestoredState | java.lang.Boolean | Allow checkpoint state that cannot be mapped to any job vertex in tasks. |
@@ -139,7 +139,7 @@ This page serves as a full reference for FlinkDeployment custom resource definit
| Value | Docs |
| ----- | ---- |
-| NATIVE | Deploys Flink using Flinks native Kubernetes support. Only supported for newer versions of Flink |
+| NATIVE | Deploys Flink using Flinks native Kubernetes support. Only supported for newer versions of Flink |
| STANDALONE | Deploys Flink on-top of kubernetes in standalone mode. |
### Resource
@@ -170,7 +170,7 @@ This page serves as a full reference for FlinkDeployment custom resource definit
| Value | Docs |
| ----- | ---- |
-| SAVEPOINT | Job is upgraded by first taking a savepoint of the running job, shutting it down and restoring from the savepoint. |
+| SAVEPOINT | Job is upgraded by first taking a savepoint of the running job, shutting it down and restoring from the savepoint. |
| LAST_STATE | Job is upgraded using any latest checkpoint or savepoint available. |
| STATELESS | Job is upgraded with empty state. |
@@ -184,8 +184,8 @@ This page serves as a full reference for FlinkDeployment custom resource definit
| Parameter | Type | Docs |
| ----------| ---- | ---- |
| reconciliationTimestamp | long | Epoch timestamp of the last successful reconcile operation. |
-| lastReconciledSpec | java.lang.String | Last reconciled deployment spec. Used to decide whether further reconciliation steps are necessary. |
-| lastStableSpec | java.lang.String | Last stable deployment spec according to the specified stability condition. If a rollback strategy is defined this will be the target to roll back to. |
+| lastReconciledSpec | java.lang.String | Last reconciled deployment spec. Used to decide whether further reconciliation steps are necessary. |
+| lastStableSpec | java.lang.String | Last stable deployment spec according to the specified stability condition. If a rollback strategy is defined this will be the target to roll back to. |
| state | org.apache.flink.kubernetes.operator.api.status.ReconciliationState | Deployment state of the last reconciled spec. |
### FlinkDeploymentStatus
@@ -210,8 +210,8 @@ This page serves as a full reference for FlinkDeployment custom resource definit
| Parameter | Type | Docs |
| ----------| ---- | ---- |
| reconciliationTimestamp | long | Epoch timestamp of the last successful reconcile operation. |
-| lastReconciledSpec | java.lang.String | Last reconciled deployment spec. Used to decide whether further reconciliation steps are necessary. |
-| lastStableSpec | java.lang.String | Last stable deployment spec according to the specified stability condition. If a rollback strategy is defined this will be the target to roll back to. |
+| lastReconciledSpec | java.lang.String | Last reconciled deployment spec. Used to decide whether further reconciliation steps are necessary. |
+| lastStableSpec | java.lang.String | Last stable deployment spec according to the specified stability condition. If a rollback strategy is defined this will be the target to roll back to. |
| state | org.apache.flink.kubernetes.operator.api.status.ReconciliationState | Deployment state of the last reconciled spec. |
### FlinkSessionJobStatus
diff --git a/docs/content/docs/operations/compatibility.md b/docs/content/docs/operations/compatibility.md
index d7d1d49e..0b226777 100644
--- a/docs/content/docs/operations/compatibility.md
+++ b/docs/content/docs/operations/compatibility.md
@@ -44,7 +44,7 @@ For example when in the future we upgrade from `v1beta1 -> v1`, while it is guar
## Contents of the resource status
-Currently, the `FlinkDeployment` and `FlinkSessionJob` resources contain a very detailed status information that contains everything necessary for the operator to manage the resources.
+Currently, the `FlinkDeployment` and `FlinkSessionJob` resources contain a very detailed status information that contains everything necessary for the operator to manage the resources.
Most of this information should be considered ***internal*** to operator logic and is subject to change/disappear in the future.
In general, we are aiming to slim down the status to only contain information that is relevant to users/client for the next major CRD version (`v1`).
diff --git a/docs/content/docs/operations/configuration.md b/docs/content/docs/operations/configuration.md
index 81a2464c..9a77b697 100644
--- a/docs/content/docs/operations/configuration.md
+++ b/docs/content/docs/operations/configuration.md
@@ -52,7 +52,7 @@ To learn more about metrics and logging configuration please refer to the dedica
## Dynamic Operator Configuration
-The Kubernetes operator supports dynamic config changes through the operator ConfigMaps. Dynamic operator configuration is enabled by default, and can be disabled by setting `kubernetes.operator.dynamic.config.enabled` to false. Time interval for checking dynamic config changes is specified by `kubernetes.operator.dynamic.config.check.interval` of which default value is 5 minutes.
+The Kubernetes operator supports dynamic config changes through the operator ConfigMaps. Dynamic operator configuration is enabled by default, and can be disabled by setting `kubernetes.operator.dynamic.config.enabled` to false. Time interval for checking dynamic config changes is specified by `kubernetes.operator.dynamic.config.check.interval` of which default value is 5 minutes.
Verify whether dynamic operator configuration updates is enabled via the `deploy/flink-kubernetes-operator` log has:
diff --git a/docs/content/docs/operations/helm.md b/docs/content/docs/operations/helm.md
index 73089ceb..491a1bae 100644
--- a/docs/content/docs/operations/helm.md
+++ b/docs/content/docs/operations/helm.md
@@ -79,18 +79,18 @@ The configurable parameters of the Helm chart and which default values as detail
| 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 |
+| 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. | |
+| 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.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.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.log4j-operator.properties | The default configuration of log4j-operator.properties. | |
| defaultConfiguration.log4j-console.properties | The default configuration of log4j-console.properties. | |
@@ -99,10 +99,10 @@ The configurable parameters of the Helm chart and which default values as detail
| 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. | |
+| 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. | |
For more information check the [Helm documentation](https://helm.sh/docs/helm/helm_install/).
diff --git a/docs/content/docs/operations/ingress.md b/docs/content/docs/operations/ingress.md
index 252c9c3e..ab3c94f0 100644
--- a/docs/content/docs/operations/ingress.md
+++ b/docs/content/docs/operations/ingress.md
@@ -51,9 +51,9 @@ apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
annotations:
- nginx.ingress.kubernetes.io/rewrite-target: /$2
+ nginx.ingress.kubernetes.io/rewrite-target: /$2
name: advanced-ingress
- namespace: default
+ namespace: default
spec:
ingressClassName: nginx
rules:
@@ -80,7 +80,7 @@ Beyond the example above the Operator understands other template formats too:
**Simple domain based routing:**
```yaml
ingress:
- template: "{{name}}.{{namespace}}.flink.k8s.io"
+ template: "{{name}}.{{namespace}}.flink.k8s.io"
```
This example requires that anything `*.flink.k8s.io` must be routed to the Ingress Controller with a wildcard DNS entry:
```shell
@@ -93,7 +93,7 @@ The Flink Web UI can be accessed at https://sample-job.default.flink.k8s.io
**Simple path based routing:**
```yaml
ingress:
- template: "/{{namespace}}/{{name}}(/|$)(.*)"
+ template: "/{{namespace}}/{{name}}(/|$)(.*)"
annotations:
nginx.ingress.kubernetes.io/rewrite-target: "/$2"
```
@@ -105,5 +105,5 @@ NAMESPACE NAME CLASS HOSTS ADDRESS PORTS AGE
default sample-job nginx * localhost 80 54m
```
The Flink Web UI can be accessed at https://localhost/default/sample-job/
->Note: All the examples were created on a minikube cluster. Check the [description](https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/) for enabling the NGINX Ingress Controller on minikube.
+>Note: All the examples were created on a minikube cluster. Check the [description](https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/) for enabling the NGINX Ingress Controller on minikube.
diff --git a/flink-kubernetes-operator-api/src/main/java/org/apache/flink/kubernetes/operator/api/docs/CrdReferenceDoclet.java b/flink-kubernetes-operator-api/src/main/java/org/apache/flink/kubernetes/operator/api/docs/CrdReferenceDoclet.java
index ac487f3e..2a684fd2 100644
--- a/flink-kubernetes-operator-api/src/main/java/org/apache/flink/kubernetes/operator/api/docs/CrdReferenceDoclet.java
+++ b/flink-kubernetes-operator-api/src/main/java/org/apache/flink/kubernetes/operator/api/docs/CrdReferenceDoclet.java
@@ -146,7 +146,7 @@ public class CrdReferenceDoclet implements Doclet {
}
private String cleanDoc(String doc) {
- return doc.replaceAll("[\\t\\n\\r]+", " ");
+ return doc.replaceAll("[\\t]+", " ").replaceAll("[\\n\\r]+", "");
}
private Set<? extends Element> sortedByName(Set<? extends Element> elements) {