Owls83995 - Sample scripts to shutdown and start a specific managed server/cluster/domain

docs-source/content/samples/simple/domains/lifecycle/_index.md

@@ -0,0 +1,14 @@
+---
+title: "Domain lifecycle operations"
+date: 2019-02-23T17:32:31-05:00
+weight: 8
+description: "Start and stop Managed Servers, clusters, and domains."
+---
+
+#### Domain lifecycle sample scripts
+
+Beginning in version 3.1.0, the operator provides sample scripts to start up or shut down a specific Managed Server or cluster in a deployed domain, or the entire deployed domain.
+
+**Note**: Prior to running these scripts, you must have previously created and deployed the domain.
+
+The scripts are located in the `kubernetes/samples/scripts/domain-lifecycle` directory. They are helpful when scripting the life cycle of a WebLogic Server domain. For more information, see the [README](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/domain-lifecycle/README.md).

docs-source/content/userguide/managing-domains/domain-lifecycle/startup.md

@@ -11,6 +11,7 @@ started, or restarted. To start, stop, or restart servers, modify these fields o
 
 * [Starting and stopping servers](#starting-and-stopping-servers)
     * [Common starting and stopping scenarios](#common-starting-and-stopping-scenarios)
+    * [Domain lifecycle sample scripts](#domain-lifecycle-sample-scripts)
 * [Shutdown options](#shutdown-options)
 * [Restarting servers](#restarting-servers)
     * [Rolling restarts](#rolling-restarts)
@@ -82,6 +83,13 @@ updates before advancing the server to the running state.
 
 Changes to the `serverStartState` property do not affect already started servers.
 
+### Domain lifecycle sample scripts
+Beginning in version 3.1.0, the operator provides sample scripts to start up or shut down a specific Managed Server or cluster in a deployed domain, or the entire deployed domain.
+
+**Note**: Prior to running these scripts, you must have previously created and deployed the domain.
+
+The scripts are located in the `kubernetes/samples/scripts/domain-lifecycle` directory. They are helpful when scripting the life cycle of a WebLogic Server domain. For more information, see the [README](https://github.com/oracle/weblogic-kubernetes-operator/tree/master/kubernetes/samples/scripts/domain-lifecycle/README.md).
+
 ### Common starting and stopping scenarios
 
 #### Normal running state

integration-tests/src/test/java/oracle/weblogic/kubernetes/utils/CommonTestUtils.java

@@ -19,6 +19,7 @@
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 
 import com.google.gson.JsonObject;
 import io.kubernetes.client.custom.Quantity;
@@ -50,6 +51,7 @@
 import io.kubernetes.client.openapi.models.V1ServiceAccountList;
 import io.kubernetes.client.openapi.models.V1Volume;
 import io.kubernetes.client.openapi.models.V1VolumeMount;
+import oracle.weblogic.domain.Cluster;
 import oracle.weblogic.domain.Domain;
 import oracle.weblogic.kubernetes.TestConstants;
 import oracle.weblogic.kubernetes.actions.TestActions;
@@ -1629,6 +1631,21 @@ public static void checkServiceDoesNotExist(String serviceName, String namespace
                 serviceName, namespace)));
   }
 
+  /**
+   * Check whether cluster replica count matches with input parameter value.
+   * @param clusterName Name of cluster to check
+   * @param domainName Name of domain to which cluster belongs
+   * @param namespace cluster's namespace 
+   * @param replicaCount replica count value to match
+   * @return
+   */
+  public static boolean checkClusterReplicaCountMatches(String clusterName, String domainName,
+                                                        String namespace, Integer replicaCount) throws ApiException {
+    Cluster cluster = TestActions.getDomainCustomResource(domainName, namespace).getSpec().getClusters()
+            .stream().filter(c -> c.clusterName().equals(clusterName)).findAny().orElse(null);
+    return Optional.ofNullable(cluster).get().replicas() == replicaCount;
+  }
+
   /**
    * Create a Docker image for a model in image domain.
    *

kubernetes/samples/scripts/domain-lifecycle/README.md

@@ -0,0 +1,76 @@
+### Domain lifecycle sample scripts
+
+The operator provides sample scripts to start up or shut down a specific Managed Server or cluster in a deployed domain, or the entire deployed domain.
+
+**Note**: Prior to running these scripts, you must have previously created and deployed the domain.
+
+These scripts can be helpful when scripting the life cycle of a WebLogic Server domain. For information on how to start, stop, restart, and scale WebLogic Server instances in your domain, see [Domain Life Cycle](https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle).
+
+#### Scripts to start and stop a Managed Server
+The `startServer.sh` script starts a Managed Server either by increasing the `spec.clusters[<cluster-name>].replicas` value for the Managed Server's cluster by `1` or by updating the `spec.managedServers[<server-name>].serverStartPolicy` attribute of the domain resource or both as necessary. The script provides an option to keep the `spec.clusters[<cluster-name>].replicas` value constant for clustered servers. See the script `usage` information by using the `-h` option.
+
+Use the following command to start the server along with increased replica count:
+```
+$ startServer.sh -d domain1 -n weblogic-domain-1 -s managed-server1
+[INFO] Updating replica count for cluster 'cluster-1' to 1.
+domain.weblogic.oracle/domain1 patched
+[INFO] Successfully updated replica count for cluster 'cluster-1' to 1.
+```
+
+Use the following command to start the server without increasing replica count:
+```
+$ startServer.sh -d domain1 -n weblogic-domain-1 -s managed-server2 -k
+[INFO] Patching start policy for 'managed-server2' to 'ALWAYS'.
+domain.weblogic.oracle/domain1 patched
+[INFO] Successfully patched server 'managed-server2' with 'ALWAYS' start policy.
+```
+
+The `stopServer.sh` script shuts down a running Managed Server either by decreasing the `spec.clusters[<cluster-name>].replicas` value for the Managed Server's cluster by `1` or by patching the `spec.managedServers[<server-name>].serverStartPolicy` attribute of the domain resource or both as necessary. The script provides an option to keep the `spec.clusters[<cluster-name>].replicas` value constant for clustered servers. See the script `usage` information by using the `-h` option.
+
+Use the following command to stop the server along with decreased replica count:
+```
+$ stopServer.sh -d domain1 -n weblogic-domain-1 -s managed-server1
+[INFO] Updating replica count for cluster cluster-1 to 0.
+domain.weblogic.oracle/domain1 patched
+[INFO] Successfully updated replica count for cluster 'cluster-1' to 0.
+```
+
+Use the following command to stop the server without decreasing replica count:
+```
+$ stopServer.sh -d domain1 -n weblogic-domain-1 -s managed-server2 -k
+[INFO] Unsetting the current start policy 'ALWAYS' for 'managed-server2'.
+domain.weblogic.oracle/domain1 patched
+[INFO] Successfully unset policy 'ALWAYS'.
+```
+
+### Scripts to start and stop a cluster
+
+The `startCluster.sh` script starts a cluster by patching the `spec.clusters[<cluster-name>].serverStartPolicy` attribute of the domain resource to `IF_NEEDED`. The operator will start the WebLogic Server instance Pods that are part of the cluster after the `serverStartPolicy` attribute is updated to `IF_NEEDED`. See the script `usage` information by using the `-h` option.
+```
+$ startCluster.sh -d domain1 -n weblogic-domain-1 -c cluster-1
+[INFO]Patching start policy of cluster 'cluster-1' from 'NEVER' to 'IF_NEEDED'.
+domain.weblogic.oracle/domain1 patched
+[INFO] Successfully patched cluster 'cluster-1' with 'IF_NEEDED' start policy!.
+```
+The `stopCluster.sh` script shuts down a cluster by patching the `spec.clusters[<cluster-name>].serverStartPolicy` attribute of the domain resource to `NEVER`. The operator will shut down the WebLogic Server instance Pods that are part of the cluster after the `serverStartPolicy` attribute is updated to `NEVER`. See the script `usage` information by using the `-h` option.
+```
+$ stopCluster.sh -d domain1 -n weblogic-domain-1 -c cluster-1
+[INFO] Patching start policy of cluster 'cluster-1' from 'IF_NEEDED' to 'NEVER'.
+domain.weblogic.oracle/domain1 patched
+[INFO] Successfully patched cluster 'cluster-1' with 'NEVER' start policy!
+```
+### Scripts to start and stop a domain
+The `startDomain.sh` script starts a deployed domain by patching the `spec.serverStartPolicy` attribute of the domain resource to `IF_NEEDED`. The operator will start the WebLogic Server instance Pods that are part of the domain after the `spec.serverStartPolicy` attribute of the domain resource is updated to `IF_NEEDED`. See the script `usage` information by using the `-h` option.
+```
+$ startDomain.sh -d domain1 -n weblogic-domain-1
+[INFO] Patching domain 'domain1' from serverStartPolicy='NEVER' to 'IF_NEEDED'.
+domain.weblogic.oracle/domain1 patched
+[INFO] Successfully patched domain 'domain1' in namespace 'weblogic-domain-1' with 'IF_NEEDED' start policy!
+```
+
+The `stopDomain.sh` script shuts down a domain by patching the `spec.serverStartPolicy` attribute of the domain resource to `NEVER`. The operator will shut down the WebLogic Server instance Pods that are part of the domain after the `spec.serverStartPolicy` attribute is updated to `NEVER`. See the script `usage` information by using the `-h` option.
+```
+$ stopDomain.sh -d domain1 -n weblogic-domain-1
+[INFO] Patching domain 'domain1' in namespace 'weblogic-domain-1' from serverStartPolicy='IF_NEEDED' to 'NEVER'.
+domain.weblogic.oracle/domain1 patched
+[INFO] Successfully patched domain 'domain1' in namespace 'weblogic-domain-1' with 'NEVER' start policy!