Document java17Compatability

trifork · Feb 2, 2024 · cef5986 · cef5986
1 parent 66a5ec1
commit cef5986
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 14 deletions.
diff --git a/charts/flink-job/README.md b/charts/flink-job/README.md
@@ -230,7 +230,7 @@ Read more about Flink and highly available job-managers [here](https://nightlies
 | dnsForKubernetesHost | bool | `true` | Whether to set KUBERNETES_SERVICE_HOST=kubernetes.default.svc.cluster.local instead of relying on the kubernetes provided value For use in an environment where egress to kubeAPI is managed via DNS rather than IP addresses |
 | localNetworkConfiguration.enabled | bool | `false` | Whether to generate Netic LocalNetworkConfig allowing traffic between job and taskmanager. For use in a deny-all environment |
 | image-automation.enabled | bool | `false` | Whether to enable the image-automation subchart. Image-automation is not possible when using image-sha as a tagging strategy. Any other configuration given here, is passed to it |
-| java17Compatability.enabled | bool | `false` | Whether to enable Java 17 compatibility |
+| java17Compatability | bool | `true` | Whether to add Java 17 compatability options. For details see https://nightlies.apache.org/flink/flink-docs-release-1.18/docs/deployment/java_compatibility/#jdk-modularization and https://github.com/apache/flink/blob/release-1.18/flink-dist/src/main/resources/flink-conf.yaml#L19-L21 |
 
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
diff --git a/charts/flink-job/templates/_helpers.tpl b/charts/flink-job/templates/_helpers.tpl
@@ -242,7 +242,7 @@ Add necessary java 17 compatibility configuration
 */}}
 {{- define "flink-job.java17CompatibilityConfiguration" -}}
   {{- $configs := .configs -}}
-  {{- if .global.java17Compatability.enabled -}}
+  {{- if .global.java17Compatability -}}
       {{- $configs = fromJson (include "flink-job._dictSet" (list $configs "env.java.opts.all" "--add-exports=java.base/sun.net.util=ALL-UNNAMED --add-exports=java.rmi/sun.rmi.registry=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED --add-exports=java.security.jgss/sun.security.krb5=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.base/java.nio=ALL-UNNAMED --add-opens=java.base/sun.nio.ch=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.text=ALL-UNNAMED --add-opens=java.base/java.time=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.util.concurrent=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.locks=ALL-UNNAMED")) -}}
   {{- end -}}
   {{- $configs | toJson -}}

diff --git a/charts/flink-job/values.schema.json b/charts/flink-job/values.schema.json
@@ -682,15 +682,8 @@
       }
     },
     "java17Compatability": {
-      "type": "object",
-      "properties": {
-        "enabled": {
-          "type": "boolean"
-        }
-      },
-      "required": [
-        "enabled"
-      ]
+      "description": "Whether to add Java 17 compatability options. For details see https://nightlies.apache.org/flink/flink-docs-release-1.18/docs/deployment/java_compatibility/#jdk-modularization and https://github.com/apache/flink/blob/release-1.18/flink-dist/src/main/resources/flink-conf.yaml#L19-L21",
+      "type": "boolean"
     },
     "dnsForKubernetesHost": {
       "type": "boolean"

diff --git a/charts/flink-job/values.yaml b/charts/flink-job/values.yaml
@@ -473,6 +473,7 @@ image-automation:
   # Any other configuration given here, is passed to it
   enabled: false
 
-java17Compatability:
-  # -- Whether to enable Java 17 compatibility
-  enabled: false
+# -- Whether to add Java 17 compatability options.
+# For details see https://nightlies.apache.org/flink/flink-docs-release-1.18/docs/deployment/java_compatibility/#jdk-modularization
+# and https://github.com/apache/flink/blob/release-1.18/flink-dist/src/main/resources/flink-conf.yaml#L19-L21
+java17Compatability: true