Release notes and Cluster resource documentation changes for 4.0 (#3099)

* Release notes and Cluster resource documentation changes for 4.0

Co-authored-by: Tom Barnes <[email protected]>
Co-authored-by: Anil Kedia <[email protected]>

Author: 3 people

README.md

@@ -9,16 +9,16 @@ The operator takes advantage of the [Kubernetes operator pattern](https://kubern
 You can:
 * Deploy an operator that manages all WebLogic domains in all namespaces in a Kubernetes cluster, or that only manages domains in a specific subset of the namespaces, or that manages only domains that are located in the same namespace as the operator. At most, a namespace can be managed by one operator.
 * Supply WebLogic domain configuration using:
-  * _Domain in PV_: Locates WebLogic domain homes in a Kubernetes PersistentVolume (PV). This PV can reside in an NFS file system or other Kubernetes volume types.
-  * _Domain in Image_: Includes a WebLogic domain home in a container image.
   * _Model in Image_: Includes [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling) models and archives in a container image.
-* Configure deployment of WebLogic domains as a Kubernetes resource (using a Kubernetes custom resource definition).
+  * _Domain in Image_: Includes a WebLogic domain home in a container image.
+  * _Domain in PV_: Locates WebLogic domain homes in a Kubernetes PersistentVolume (PV). This PV can reside in an NFS file system or other Kubernetes volume types.
+* Configure deployment of WebLogic domains as Kubernetes resources (using Kubernetes custom resource definitions).
 * Override certain aspects of the WebLogic domain configuration; for example, use a different database password for different deployments.
 * Start and stop servers and clusters in the domain based on declarative startup parameters and desired states.
-* Scale WebLogic domains by starting and stopping Managed Servers on demand, or by integrating with a REST API to initiate scaling based on the WebLogic Diagnostics Framework (WLDF), Prometheus, Grafana, or other rules.
+* Scale WebLogic domains by starting and stopping Managed Servers on demand, Kubernetes scale commands, setting up a Kubernetes Horizontal Pod Autoscaler, or by integrating with a REST API to initiate scaling based on the WebLogic Diagnostics Framework (WLDF), Prometheus, Grafana, or other rules.
+* Expose HTTP paths on a WebLogic domain outside the Kubernetes domain with load balancing, and automatically update the load balancer when Managed Servers in the WebLogic domain are started or stopped.
 * Expose the WebLogic Server Administration Console outside the Kubernetes cluster, if desired.
 * Expose T3 channels outside the Kubernetes domain, if desired.
-* Expose HTTP paths on a WebLogic domain outside the Kubernetes domain with load balancing, and automatically update the load balancer when Managed Servers in the WebLogic domain are started or stopped.
 * Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana.
 
 
@@ -94,7 +94,7 @@ Please be aware that pull requests that seek to introduce a new dependency will
 
 ## License
 
-Copyright (c) 2017, 2021 Oracle and/or its affiliates.
+Copyright (c) 2017, 2022 Oracle and/or its affiliates.
 
 Released under the Universal Permissive License v1.0 as shown at
-<https://oss.oracle.com/licenses/upl/>.
+<https://oss.oracle.com/licenses/upl/>.

documentation/domains/Cluster.json

@@ -162,7 +162,7 @@
           "minimum": 1
         },
         "replicas": {
-          "description": "The number of cluster member Managed Server instances to start for this WebLogic cluster. The operator will sort cluster member Managed Server names from the WebLogic domain configuration by normalizing any numbers in the Managed Server name and then sorting alphabetically. This is done so that server names such as \"managed-server10\" come after \"managed-server9\". The operator will then start Managed Server instances from the sorted list, up to the `replicas` count, unless specific Managed Servers are specified as starting in their entry under the `managedServers` field. In that case, the specified Managed Server instances will be started and then additional cluster members will be started, up to the `replicas` count, by finding further cluster members in the sorted list that are not already started. If cluster members are started because of their related entries under `managedServers`, then this cluster may have more cluster members running than its `replicas` count. Defaults to `spec.replicas`, which defaults 1.",
+          "description": "The number of cluster member Managed Server instances to start for this WebLogic cluster. The operator will sort cluster member Managed Server names from the WebLogic domain configuration by normalizing any numbers in the Managed Server name and then sorting alphabetically. This is done so that server names such as \"managed-server10\" come after \"managed-server9\". The operator will then start Managed Server instances from the sorted list, up to the `replicas` count, unless specific Managed Servers are specified as starting in their entry under the `managedServers` field. In that case, the specified Managed Server instances will be started and then additional cluster members will be started, up to the `replicas` count, by finding further cluster members in the sorted list that are not already started. If cluster members are started because of their related entries under `managedServers`, then this cluster may have more cluster members running than its `replicas` count. Defaults to `domain.spec.replicas`, which defaults 1.",
           "type": "integer",
           "minimum": 0
         },
@@ -192,7 +192,7 @@
           ]
         },
         "maxConcurrentStartup": {
-          "description": "The maximum number of Managed Servers instances that the operator will start in parallel for this cluster in response to a change in the `replicas` count. If more Managed Server instances must be started, the operator will wait until a Managed Server Pod is in the `Ready` state before starting the next Managed Server instance. A value of 0 means all Managed Server instances will start in parallel. Defaults to 0.",
+          "description": "The maximum number of Managed Servers instances that the operator will start in parallel for this cluster in response to a change in the `replicas` count. If more Managed Server instances must be started, the operator will wait until a Managed Server Pod is in the `Ready` state before starting the next Managed Server instance. A value of 0 means all Managed Server instances will start in parallel. Defaults to `domain.spec.maxClusterConcurrentStartup`, which defaults to 0.",
           "type": "integer",
           "minimum": 0
         },
@@ -249,7 +249,7 @@
           }
         },
         "observedGeneration": {
-          "description": "The generation observed by the WebLogic operator.",
+          "description": "The Cluster resource generation observed by the WebLogic operator. If the Cluster resource exists, then this value will match the \u0027cluster.metadata.generation\u0027  when the \u0027cluster.status\u0027 correctly reflects the latest cluster resource changes.",
           "type": "integer"
         }
       }
@@ -569,7 +569,7 @@
           "type": "string"
         },
         "observedGeneration": {
-          "description": "The generation observed by the WebLogic operator.",
+          "description": "The Domain resource generation observed by the WebLogic operator. This value will match the \u0027domain.metadata.generation\u0027  when the \u0027domain.status\u0027 correctly reflects the latest resource changes.",
           "type": "integer"
         },
         "clusters": {

documentation/domains/Cluster.md

@@ -19,9 +19,9 @@ The specification of the operation of the WebLogic cluster. Required.
 | `clusterName` | string | The name of the cluster. This value must match the name of a WebLogic cluster already defined in the WebLogic domain configuration. Required. |
 | `clusterService` | [Cluster Service](#cluster-service) | Customization affecting Kubernetes Service generated for this WebLogic cluster. |
 | `maxConcurrentShutdown` | integer | The maximum number of WebLogic Server instances that will shut down in parallel for this cluster when it is being partially shut down by lowering its replica count. A value of 0 means there is no limit. Defaults to `spec.maxClusterConcurrentShutdown`, which defaults to 1. |
-| `maxConcurrentStartup` | integer | The maximum number of Managed Servers instances that the operator will start in parallel for this cluster in response to a change in the `replicas` count. If more Managed Server instances must be started, the operator will wait until a Managed Server Pod is in the `Ready` state before starting the next Managed Server instance. A value of 0 means all Managed Server instances will start in parallel. Defaults to 0. |
+| `maxConcurrentStartup` | integer | The maximum number of Managed Servers instances that the operator will start in parallel for this cluster in response to a change in the `replicas` count. If more Managed Server instances must be started, the operator will wait until a Managed Server Pod is in the `Ready` state before starting the next Managed Server instance. A value of 0 means all Managed Server instances will start in parallel. Defaults to `domain.spec.maxClusterConcurrentStartup`, which defaults to 0. |
 | `maxUnavailable` | integer | The maximum number of cluster members that can be temporarily unavailable. Defaults to 1. |
-| `replicas` | integer | The number of cluster member Managed Server instances to start for this WebLogic cluster. The operator will sort cluster member Managed Server names from the WebLogic domain configuration by normalizing any numbers in the Managed Server name and then sorting alphabetically. This is done so that server names such as "managed-server10" come after "managed-server9". The operator will then start Managed Server instances from the sorted list, up to the `replicas` count, unless specific Managed Servers are specified as starting in their entry under the `managedServers` field. In that case, the specified Managed Server instances will be started and then additional cluster members will be started, up to the `replicas` count, by finding further cluster members in the sorted list that are not already started. If cluster members are started because of their related entries under `managedServers`, then this cluster may have more cluster members running than its `replicas` count. Defaults to `spec.replicas`, which defaults 1. |
+| `replicas` | integer | The number of cluster member Managed Server instances to start for this WebLogic cluster. The operator will sort cluster member Managed Server names from the WebLogic domain configuration by normalizing any numbers in the Managed Server name and then sorting alphabetically. This is done so that server names such as "managed-server10" come after "managed-server9". The operator will then start Managed Server instances from the sorted list, up to the `replicas` count, unless specific Managed Servers are specified as starting in their entry under the `managedServers` field. In that case, the specified Managed Server instances will be started and then additional cluster members will be started, up to the `replicas` count, by finding further cluster members in the sorted list that are not already started. If cluster members are started because of their related entries under `managedServers`, then this cluster may have more cluster members running than its `replicas` count. Defaults to `domain.spec.replicas`, which defaults 1. |
 | `restartVersion` | string | Changes to this field cause the operator to restart WebLogic Server instances. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#restarting-servers. |
 | `serverPod` | [Server Pod](#server-pod) | Customization affecting the generation of Pods for WebLogic Server instances. |
 | `serverService` | [Server Service](#server-service) | Customization affecting the generation of ClusterIP Services for WebLogic Server instances. |
@@ -36,7 +36,7 @@ The specification of the operation of the WebLogic cluster. Required.
 | `labelSelector` | string | Label selector that can be used to discover Pods associated with WebLogic managed servers belonging to this cluster. Must be set to work with HorizontalPodAutoscaler. |
 | `maximumReplicas` | integer | The maximum number of cluster members. |
 | `minimumReplicas` | integer | The minimum number of cluster members. |
-| `observedGeneration` | integer | The generation observed by the WebLogic operator. |
+| `observedGeneration` | integer | The Cluster resource generation observed by the WebLogic operator. If the Cluster resource exists, then this value will match the 'cluster.metadata.generation'  when the 'cluster.status' correctly reflects the latest cluster resource changes. |
 | `readyReplicas` | integer | The number of ready cluster members. |
 | `replicas` | integer | The number of currently running cluster members. |
 | `replicasGoal` | integer | The requested number of cluster members. Cluster members will be started by the operator if this value is larger than zero. |

documentation/domains/Domain.json

@@ -168,7 +168,7 @@
           }
         },
         "observedGeneration": {
-          "description": "The generation observed by the WebLogic operator.",
+          "description": "The Cluster resource generation observed by the WebLogic operator. If the Cluster resource exists, then this value will match the \u0027cluster.metadata.generation\u0027  when the \u0027cluster.status\u0027 correctly reflects the latest cluster resource changes.",
           "type": "integer"
         }
       }
@@ -488,7 +488,7 @@
           "type": "string"
         },
         "observedGeneration": {
-          "description": "The generation observed by the WebLogic operator.",
+          "description": "The Domain resource generation observed by the WebLogic operator. This value will match the \u0027domain.metadata.generation\u0027  when the \u0027domain.status\u0027 correctly reflects the latest resource changes.",
           "type": "integer"
         },
         "clusters": {

documentation/domains/Domain.md

@@ -60,7 +60,7 @@ The current status of the operation of the WebLogic domain. Updated automaticall
 | `introspectJobFailureCount` | integer | Non-zero if the introspector job fails for any reason. You can configure an introspector job retry limit for jobs that log script failures using the Operator tuning parameter 'domainPresenceFailureRetryMaxCount' (default 5). You cannot configure a limit for other types of failures, such as a Domain resource reference to an unknown secret name; in which case, the retries are unlimited. |
 | `lastFailureTime` | DateTime | RFC 3339 date and time at which a currently failing domain last experienced a Severe failure. |
 | `message` | string | A human readable message indicating details about why the domain is in this condition. |
-| `observedGeneration` | integer | The generation observed by the WebLogic operator. |
+| `observedGeneration` | integer | The Domain resource generation observed by the WebLogic operator. This value will match the 'domain.metadata.generation'  when the 'domain.status' correctly reflects the latest resource changes. |
 | `reason` | string | A brief CamelCase message indicating details about why the domain is in this state. |
 | `replicas` | integer | The number of running cluster member Managed Servers in the WebLogic cluster if there is exactly one cluster defined in the domain configuration and where the `replicas` field is set at the `spec` level rather than for the specific cluster under `clusters`. This field is provided to support use of Kubernetes scaling for this limited use case. |
 | `servers` | Array of [Server Status](#server-status) | Status of WebLogic Servers in this domain. |
@@ -169,7 +169,7 @@ The current status of the operation of the WebLogic domain. Updated automaticall
 | `labelSelector` | string | Label selector that can be used to discover Pods associated with WebLogic managed servers belonging to this cluster. Must be set to work with HorizontalPodAutoscaler. |
 | `maximumReplicas` | integer | The maximum number of cluster members. |
 | `minimumReplicas` | integer | The minimum number of cluster members. |
-| `observedGeneration` | integer | The generation observed by the WebLogic operator. |
+| `observedGeneration` | integer | The Cluster resource generation observed by the WebLogic operator. If the Cluster resource exists, then this value will match the 'cluster.metadata.generation'  when the 'cluster.status' correctly reflects the latest cluster resource changes. |
 | `readyReplicas` | integer | The number of ready cluster members. |
 | `replicas` | integer | The number of currently running cluster members. |
 | `replicasGoal` | integer | The requested number of cluster members. Cluster members will be started by the operator if this value is larger than zero. |

documentation/domains/index.html

@@ -1084,7 +1084,7 @@
           }
         },
         "observedGeneration": {
-          "description": "The generation observed by the WebLogic operator.",
+          "description": "The Cluster resource generation observed by the WebLogic operator. If the Cluster resource exists, then this value will match the \u0027cluster.metadata.generation\u0027  when the \u0027cluster.status\u0027 correctly reflects the latest cluster resource changes.",
           "type": "integer"
         }
       }
@@ -1404,7 +1404,7 @@
           "type": "string"
         },
         "observedGeneration": {
-          "description": "The generation observed by the WebLogic operator.",
+          "description": "The Domain resource generation observed by the WebLogic operator. This value will match the \u0027domain.metadata.generation\u0027  when the \u0027domain.status\u0027 correctly reflects the latest resource changes.",
           "type": "integer"
         },
         "clusters": {