Merge branch 'add-logging-pv-42' into 'release/4.2'

Add support for persisting log files in WKO.

See merge request weblogic-cloud/weblogic-kubernetes-operator!4987

Author: rjeberhard

deployment/scripts/logstash.properties

@@ -5,6 +5,6 @@ java.util.logging.ConsoleHandler.level=INFO
 java.util.logging.ConsoleHandler.formatter=oracle.kubernetes.operator.logging.OperatorLoggingFormatter
 java.util.logging.FileHandler.level=INFO
 java.util.logging.FileHandler.formatter=oracle.kubernetes.operator.logging.OperatorLoggingFormatter
-java.util.logging.FileHandler.pattern=/logs/operator%g.log
+java.util.logging.FileHandler.pattern=LOGGING_DIR/operator%g.log
 java.util.logging.FileHandler.limit=JAVA_LOGGING_MAXSIZE
 java.util.logging.FileHandler.count=JAVA_LOGGING_COUNT

deployment/scripts/operator.sh

@@ -70,13 +70,14 @@ fi
 
 sed -i -e "s|JAVA_LOGGING_MAXSIZE|${JAVA_LOGGING_MAXSIZE:-20000000}|g" $LOGGING_CONFIG
 sed -i -e "s|JAVA_LOGGING_COUNT|${JAVA_LOGGING_COUNT:-10}|g" $LOGGING_CONFIG
+sed -i -e "s|LOGGING_DIR|${OPERATOR_LOGDIR:-/logs}|g" $LOGGING_CONFIG
 
 if [ "${MOCK_WLS}" == 'true' ]; then
   MOCKING_WLS="-DmockWLS=true"
 fi
 
 LOGGING="-Djava.util.logging.config.file=${LOGGING_CONFIG}"
-mkdir -m 777 -p /logs
+mkdir -m 777 -p ${OPERATOR_LOGDIR:-/logs}
 # assumption is that we have mounted a volume on /logs which is also visible to
 # the logstash container/pod.
 

deployment/scripts/webhook.sh

@@ -66,11 +66,12 @@ fi
 
 sed -i -e "s|JAVA_LOGGING_MAXSIZE|${JAVA_LOGGING_MAXSIZE:-20000000}|g" $LOGGING_CONFIG
 sed -i -e "s|JAVA_LOGGING_COUNT|${JAVA_LOGGING_COUNT:-10}|g" $LOGGING_CONFIG
+sed -i -e "s|LOGGING_DIR|${OPERATOR_LOGDIR:-/logs}|g" $LOGGING_CONFIG
 
 LOGGING="-Djava.util.logging.config.file=${LOGGING_CONFIG}"
 # assumption is that we have mounted a volume on /logs which is also visible to
 # the logstash container/pod.
-mkdir -m 777 -p /logs
+mkdir -m 777 -p ${OPERATOR_LOGDIR:-/logs}
 
 # Container memory optimization flags
 HEAP="-XshowSettings:vm"

kubernetes/charts/weblogic-operator/templates/_operator-dep.tpl

@@ -2,6 +2,7 @@
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 {{- define "operator.operatorDeployment" }}
+
 ---
 {{- if not .webhookOnly }}
 apiVersion: "apps/v1"
@@ -91,6 +92,13 @@ spec:
           value: {{ .javaLoggingFileCount | default 10 | quote }}
         - name: "JVM_OPTIONS"
           value: {{ .jvmOptions | default "-XshowSettings:vm -XX:MaxRAMPercentage=70" | quote }}
+        {{- if and .operatorLogDir .operatorLogMount }}
+           {{- if not (hasPrefix (toString .operatorLogMount) (toString .operatorLogDir)) }}
+            {{- fail (printf "Error: Invalid Configuration: operatorLogDir %s must start with operatorlogMount %s" .operatorLogDir .operatorLogMount) }}
+          {{- end }}
+        - name: "OPERATOR_LOGDIR"
+          value: {{ .operatorLogDir | quote }}
+        {{- end }}
         {{- if .remoteDebugNodePortEnabled }}
         - name: "REMOTE_DEBUG_PORT"
           value: {{ .internalDebugHttpPort | quote }}
@@ -133,10 +141,16 @@ spec:
         - name: "weblogic-operator-secrets-volume"
           mountPath: "/deployment/secrets"
           readOnly: true
-        {{- if .elkIntegrationEnabled }}
+        {{- if and .elkIntegrationEnabled .operatorLogPVC }}
+            {{- fail "Error: elkIntegrationEnabled and opeatorLogPVC cannot be set at the same time."}}
+        {{- else if .elkIntegrationEnabled }}
         - mountPath: "/logs"
           name: "log-dir"
           readOnly: false
+        {{- else if .operatorLogPVC }}
+        - mountPath: {{ .operatorLogMount | quote }}
+          name: "log-dir"
+          readOnly: false
         {{- end }}
         {{- if not .remoteDebugNodePortEnabled }}
         livenessProbe:
@@ -207,6 +221,13 @@ spec:
         secret:
           secretName: "logstash-certs-secret"
           optional: true
+      {{- else if .operatorLogPVC }}
+      {{- if not (and .operatorLogMount .operatorLogDir) }}
+        {{- fail "Must provide operatorLogMount and operatorLogDir when using operatorLogPVC" }}
+      {{- end }}
+      - name: "log-dir"
+        persistentVolumeClaim:
+         claimName: {{ .operatorLogPVC }}
       {{- end }}
 {{- end }}
 ---
@@ -318,6 +339,13 @@ spec:
               value: {{ int64 .javaLoggingFileSizeLimit | default 20000000 | quote }}
             - name: "JAVA_LOGGING_COUNT"
               value: {{ .javaLoggingFileCount | default 10 | quote }}
+            {{- if and .operatorLogDir .operatorLogMount }}
+              {{- if not (hasPrefix (toString .operatorLogMount) (toString .operatorLogDir)) }}
+                {{- fail (printf "Error: Invalid Configuration: operatorLogDir %s must start with operatorlogMount %s" .operatorLogDir .operatorLogMount) }}
+              {{- end }}
+            - name: "OPERATOR_LOGDIR"
+              value: {{ .operatorLogDir | quote }}
+            {{- end }}
             {{- if .remoteDebugNodePortEnabled }}
             - name: "REMOTE_DEBUG_PORT"
               value: {{ .webhookDebugHttpPort | quote }}
@@ -354,10 +382,16 @@ spec:
             - name: "weblogic-webhook-secrets-volume"
               mountPath: "/deployment/secrets"
               readOnly: true
-            {{- if .elkIntegrationEnabled }}
+            {{- if and .elkIntegrationEnabled .operatorLogPVC }}
+                {{- fail "Error: elkIntegrationEnabled and opeatorLogPVC cannot be set at the same time."}}
+            {{- else if .elkIntegrationEnabled }}
             - mountPath: "/logs"
               name: "log-dir"
               readOnly: false
+            {{- else if .operatorLogPVC }}
+            - mountPath: {{ .operatorLogMount | quote }}
+              name: "log-dir"
+              readOnly: false
             {{- end }}
             {{- if not .remoteDebugNodePortEnabled }}
             livenessProbe:
@@ -423,6 +457,13 @@ spec:
             secret:
               secretName: "logstash-certs-secret"
               optional: true
+          {{- else if .operatorLogPVC }}
+          {{- if not (and .operatorLogMount .operatorLogDir) }}
+            {{- fail "Must provide operatorLogMount and operatorLogDir when using operatorLogPVC" }}
+          {{- end }}
+          - name: "log-dir"
+            persistentVolumeClaim:
+             claimName: {{ .operatorLogPVC }}
           {{- end }}
   {{- end }}
   {{- end }}

kubernetes/charts/weblogic-operator/values.yaml

@@ -278,3 +278,13 @@ clusterSizePaddingValidationEnabled: true
 # that will be allocated.
 #jvmOptions: -XshowSettings:vm -XX:MaxRAMPercentage=70
 
+# operatorLogPVC specifies the PVC name for persistent storage for operator log files.  You must also specify
+# operatorLogDir and operatorLogMount
+#operatorLogPVC:
+
+# operatorLogDir specifies the operator logging directory.  The operator will create the directory but the default uid
+# (oracle:1000) must have permission to do so. It must be prefixed by operatorLogMount.
+#operatorLogDir:
+
+# operatorLogMount specifies the operator logging volumeMount.  The operator will mount this path with the operatorLogPVC
+#operatorLogMount: