[flink-kubernetes-operator] branch main updated: [hotfix][docs] Minor doc improvements/corrections

[gy...@apache.org]

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 766c5fb7 [hotfix][docs] Minor doc improvements/corrections
766c5fb7 is described below

commit 766c5fb74e28fcca1a57b2bcd4a1cfbd16447732
Author: Gyula Fora <g_...@apple.com>
AuthorDate: Tue Aug 2 17:39:54 2022 +0200

    [hotfix][docs] Minor doc improvements/corrections
---
 docs/content/docs/development/guide.md          |  3 ++-
 docs/content/docs/operations/metrics-logging.md | 14 ++++++++++++++
 docs/content/docs/operations/upgrade.md         | 22 ++++++++++++++--------
 3 files changed, 30 insertions(+), 9 deletions(-)

diff --git a/docs/content/docs/development/guide.md b/docs/content/docs/development/guide.md
index b5b579dc..4bf7f647 100644
--- a/docs/content/docs/development/guide.md
+++ b/docs/content/docs/development/guide.md
@@ -75,7 +75,7 @@ docker@minikube:~$ exit
 helm install flink-kubernetes-operator helm/flink-kubernetes-operator --set image.repository=<repo>/flink-kubernetes-operator --set image.tag=latest
 ```
 ### Running the operator locally
-You can run or debug the `FlinkOperator` from your preferred IDE. The operator itself is accessing the deployed Flink clusters through the REST interface. When running locally the `rest.port` and `rest.address` Flink configuration parameters must be modified to a locally accessible value.
+You can run or debug the `FlinkOperator` from your preferred IDE. The operator itself is accessing the deployed Flink clusters through the REST interface. When running locally the `rest.port`, `rest.address` and `kubernetes.rest-service.exposed.type` Flink configuration parameters must be modified.
 
 When using `minikube tunnel` the rest service is exposed on `localhost:8081`
 ```bash
@@ -91,6 +91,7 @@ The operator picks up the default log and flink configurations from `/opt/flink/
 cat /opt/flink/conf/flink-conf.yaml
 rest.port: 8081
 rest.address: localhost
+kubernetes.rest-service.exposed.type: LoadBalancer
 ```
 
 ### Uninstalling the operator locally
diff --git a/docs/content/docs/operations/metrics-logging.md b/docs/content/docs/operations/metrics-logging.md
index 186cd419..89cfcab0 100644
--- a/docs/content/docs/operations/metrics-logging.md
+++ b/docs/content/docs/operations/metrics-logging.md
@@ -180,3 +180,17 @@ See the [Java Operator SDK docs](https://javaoperatorsdk.io/docs/features#contex
 {{< /hint >}}
 
 To learn more about accessing the job logs or changing the log level dynamically check the corresponding [section](https://nightlies.apache.org/flink/flink-docs-master/docs/deployment/resource-providers/native_kubernetes/#logging) of the core documentation.
+
+### FlinkDeployment Logging Configuration
+
+Users have the freedom to override the default `log4j-console.properties` settings on a per-deployment level by simply putting the entire log configuration into `spec.logConfiguration`:
+
+```yaml
+spec:
+  ...
+  logConfiguration:
+    "log4j-console.properties": |
+      rootLogger.level = DEBUG
+      rootLogger.appenderRef.file.ref = LogFile
+      ...
+```
diff --git a/docs/content/docs/operations/upgrade.md b/docs/content/docs/operations/upgrade.md
index 14b6b108..53d2edbd 100644
--- a/docs/content/docs/operations/upgrade.md
+++ b/docs/content/docs/operations/upgrade.md
@@ -26,7 +26,7 @@ under the License.
 
 # Operator Upgrade Process
 
-This page details the process of upgrading the operator to a new version. 
+This page details the process of upgrading the operator to a new version.
 
 Please check the [compatibility page]({{< ref "docs/operations/compatibility" >}}) for the complete overview of the backward compatibility guarantees before upgrading to new versions.
 
@@ -35,7 +35,7 @@ Upgrading from the preview/experimental `v1alpha1` release to `v1beta1` requires
 Please check the [related section](#upgrading-from-v1alpha1---v1beta1).
 {{< /hint >}}
 
-## Normal Upgrade Process 
+## Normal Upgrade Process
 
 Normally upgrading the operator to a new release or development version consists of the following two steps:
 1. Upgrading the CRDs
@@ -59,15 +59,22 @@ Please note that we are using the `replace` command here which ensures that runn
 
 ### 2. Upgrading the Helm deployment
 
-Once we have the new CRDs versions we can upgrade the Helm deployment.
+Once we have the new CRDs versions we can upgrade the Helm deployment:
+
+
+```sh
+helm upgrade flink-kubernetes-operator <helm-repo>/flink-kubernetes-operator <custom settings>
+```
+
+or
 
 ```sh
-# Uninstall running Helm deployment
+# Uninstall running Helm deployment and install new version
 helm uninstall flink-kubernetes-operator
-helm install ...
+helm install flink-kubernetes-operator <helm-repo>/flink-kubernetes-operator <custom settings>
 ```
 
-The exact installation command depends on your current environment and settings. Please see the [helm page]({{< ref "docs/operations/helm" >}}) for details.
+The exact installation/upgrade command depends on your current environment and settings. Please see the [helm page]({{< ref "docs/operations/helm" >}}) for details.
 
 ## Upgrading from v1alpha1 -> v1beta1
 
@@ -142,5 +149,4 @@ The following steps demonstrate the CRD upgrade process from `v1alpha1` to `v1be
 There are some changes or improvement of default values in the fields of the FlinkDeployment in `v1beta1`:
 1. Default value of `crd.spec.Resource#cpu` is `1.0`.
 2. Default value of `crd.spec.JobManagerSpec#replicas` is `1`.
-3. No default value of `crd.spec.FlinkDeploymentSpec#serviceAccount` and users must specify its value explicitly. 
-
+3. No default value of `crd.spec.FlinkDeploymentSpec#serviceAccount` and users must specify its value explicitly.