Merge pull request #1199 from oracle/owls-74699

OWLS-74699 Add serverPod resources requests and limits input values to create domain samples

Author: rjeberhard

docs-source/content/samples/simple/domains/domain-home-in-image/_index.md

@@ -149,6 +149,7 @@ The following parameters can be provided in the inputs file.
 | `t3ChannelPort` | Port for the T3 channel of the NetworkAccessPoint. | `30012` |
 | `t3PublicAddress` | Public address for the T3 channel.  This should be set to the public address of the Kubernetes cluster.  This would normally be a load balancer address. <p/>For development environments only: In a single server (all-in-one) Kubernetes deployment, this may be set to the address of the master, or at the very least, it must be set to the address of one of the worker nodes. |  If not provided, the script will attempt to set it to the IP address of the kubernetes cluster |
 | `weblogicCredentialsSecretName` | Name of the Kubernetes secret for the Administration Server's user name and password. | `domain1-weblogic-credentials` |
+| `serverPodCpuRequest`, `serverPodMemoryRequest`, `serverPodCpuCLimit`, `serverPodMemoryLimit` |  The maximum amount of compute resources allowed, and minimum amount of compute resources required, for each server pod. Please refer to the Kubernetes documentation on `Managing Compute Resources for Containers` for details. | Resource requests and resource limits are not specified. |
 
 Note that the names of the Kubernetes resources in the generated YAML files may be formed with the value of some of the properties specified in the `create-inputs.yaml` file. Those properties include the `adminServerName`, `clusterName` and `managedServerNameBase`. If those values contain any characters that are invalid in a Kubernetes service name, those characters are converted to valid values in the generated YAML files. For example, an uppercase letter is converted to a lowercase letter and an underscore `("_")` is converted to a hyphen `("-")`.
 

docs-source/content/samples/simple/domains/domain-home-on-pv/_index.md

@@ -106,7 +106,7 @@ The following parameters can be provided in the inputs file.
 | `t3PublicAddress` | Public address for the T3 channel.  This should be set to the public address of the Kubernetes cluster.  This would normally be a load balancer address. <p/>For development environments only: In a single server (all-in-one) Kubernetes deployment, this may be set to the address of the master, or at the very least, it must be set to the address of one of the worker nodes. | If not provided, the script will attempt to set it to the IP address of the Kubernetes cluster |
 | `weblogicCredentialsSecretName` | Name of the Kubernetes secret for the Administration Server's user name and password. If not specified, the value is derived from the `domainUID` as `<domainUID>-weblogic-credentials`. | `domain1-weblogic-credentials` |
 | `weblogicImagePullSecretName` | Name of the Kubernetes secret for the Docker Store, used to pull the WebLogic Server image. | `docker-store-secret` |
-
+| `serverPodCpuRequest`, `serverPodMemoryRequest`, `serverPodCpuCLimit`, `serverPodMemoryLimit` |  The maximum amount of compute resources allowed, and minimum amount of compute resources required, for each server pod. Please refer to the Kubernetes documentation on `Managing Compute Resources for Containers` for details. | Resource requests and resource limits are not specified. |
 Note that the names of the Kubernetes resources in the generated YAML files may be formed with the value of some of the properties specified in the `create-inputs.yaml` file. Those properties include the `adminServerName`, `clusterName` and `managedServerNameBase`. If those values contain any characters that are invalid in a Kubernetes service name, those characters are converted to valid values in the generated YAML files. For example, an uppercase letter is converted to a lowercase letter and an underscore `("_")` is converted to a hyphen `("-")`.
 
 The sample demonstrates how to create a WebLogic domain home and associated Kubernetes resources for a domain that only has one cluster. In addition, the sample provides the capability for users to supply their own scripts to create the domain home for other use cases. The generated domain YAML file could also be modified to cover more use cases.

docs-source/content/samples/simple/domains/fmw-domain/_index.md

@@ -132,6 +132,7 @@ The following parameters can be provided in the inputs file.
 | `t3PublicAddress` | Public address for the T3 channel.  This should be set to the public address of the Kubernetes cluster.  This would normally be a load balancer address. <p/>For development environments only: In a single server (all-in-one) Kubernetes deployment, this may be set to the address of the master, or at the very least, it must be set to the address of one of the worker nodes. | If not provided, the script will attempt to set it to the IP address of the Kubernetes cluster |
 | `weblogicCredentialsSecretName` | Name of the Kubernetes secret for the Administration Server's user name and password. If not specified, then the value is derived from the `domainUID` as `<domainUID>-weblogic-credentials`. | `domain1-weblogic-credentials` |
 | `weblogicImagePullSecretName` | Name of the Kubernetes secret for the Docker Store, used to pull the WebLogic Server image. | `docker-store-secret` |
+| `serverPodCpuRequest`, `serverPodMemoryRequest`, `serverPodCpuCLimit`, `serverPodMemoryLimit` |  The maximum amount of compute resources allowed, and minimum amount of compute resources required, for each server pod. Please refer to the Kubernetes documentation on `Managing Compute Resources for Containers` for details. | Resource requests and resource limits are not specified. |
 | `rcuSchemaPrefix` | The schema prefix to use in the database, for example `SOA1`.  You may wish to make this the same as the domainUID in order to simplify matching domains to their RCU schemas. | `domain1` |
 | `rcuDatabaseURL` | The database URL. | `database:1521/service` |
 | `rcuCredentialsSecret` | The Kubernetes secret containing the database credentials. | `domain1-rcu-credentials` |

kubernetes/samples/scripts/common/domain-template.yaml

@@ -63,6 +63,7 @@ spec:
       value: "%JAVA_OPTIONS%"
     - name: USER_MEM_ARGS
       value: "-XX:+UseContainerSupport -Djava.security.egd=file:/dev/./urandom "
+    %OPTIONAL_SERVERPOD_RESOURCES%
     %LOG_HOME_ON_PV_PREFIX%volumes:
     %LOG_HOME_ON_PV_PREFIX%- name: weblogic-domain-storage-volume
     %LOG_HOME_ON_PV_PREFIX%  persistentVolumeClaim:

kubernetes/samples/scripts/common/utility.sh

@@ -213,6 +213,40 @@ function getKubernetesClusterIP {
 
 }
 
+#
+# Function to set the serverPodResources variable for including into the generated
+# domain.yaml, base on the serverPod resource requests and limits input values,
+# if specified.
+# The serverPodResources variable remains unset if none of the input values are provided.
+#
+function buildServerPodResources {
+
+  if [ -n "${serverPodMemoryRequest}" ]; then
+    local memoryRequest="        memory\: \"${serverPodMemoryRequest}\"\n"
+  fi
+  if [ -n "${serverPodCpuRequest}" ]; then
+    local cpuRequest="       cpu\: \"${serverPodCpuRequest}\"\n"
+  fi
+  if [ -n "${memoryRequest}" ] || [ -n "${cpuRequest}" ]; then
+    local requests="      requests\: \n$memoryRequest $cpuRequest"
+  fi
+
+  if [ -n "${serverPodMemoryLimit}" ]; then
+    local memoryLimit="        memory\: \"${serverPodMemoryLimit}\"\n"
+  fi
+  if [ -n "${serverPodCpuLimit}" ]; then
+    local cpuLimit="       cpu\: \"${serverPodCpuLimit}\"\n"
+  fi
+  if [ -n "${memoryLimit}" ] || [ -n "${cpuLimit}" ]; then
+    local limits="      limits\: \n$memoryLimit $cpuLimit"
+  fi
+
+  if [ -n "${requests}" ] || [ -n "${limits}" ]; then
+    # build resources element and remove last '\n'
+    serverPodResources=$(echo "resources\:\n${requests}${limits}" | sed -e 's/\\n$//')
+  fi
+}
+
 #
 # Function to generate the properties and yaml files for creating a domain
 #
@@ -437,6 +471,13 @@ function createFiles {
   sed -i -e "s:%ISTIO_ENABLED%:${istioEnabled}:g" ${dcrOutput}
   sed -i -e "s:%ISTIO_READINESS_PORT%:${istioReadinessPort}:g" ${dcrOutput}
 
+  buildServerPodResources
+  if [ -z "${serverPodResources}" ]; then
+    sed -i -e "/%OPTIONAL_SERVERPOD_RESOURCES%/d" ${dcrOutput}
+  else
+    sed -i -e "s:%OPTIONAL_SERVERPOD_RESOURCES%:${serverPodResources}:g" ${dcrOutput}
+  fi
+
   if [ "${domainHomeInImage}" == "true" ]; then
 
     # now we know which image to use, update the domain yaml file

kubernetes/samples/scripts/create-fmw-infrastructure-domain/domain-home-in-image/create-domain-inputs.yaml

@@ -135,6 +135,18 @@ domainHomeImageBase: container-registry.oracle.com/middleware/fmw-infrastructure
 # which uses WDT, instead of WLST, to generate the domain configuration.
 domainHomeImageBuildPath: ./docker-images/OracleFMWInfrastructure/samples/12213-domain-home-in-image
 
+# Uncomment and edit value(s) below to specify the maximum amount of
+# compute resources allowed, and minimum amount of compute resources
+# required for each server pod.
+# These are optional.
+# Please refer to the kubernetes documentation on Managing Compute
+# Resources for Containers for details.
+#
+# serverPodMemoryRequest: "64Mi"
+# serverPodCpuRequest: "250m"
+# serverPodMemoryLimit: "1Gi"
+# serverPodCpuLimit: "1000m"
+
 #
 # RCU configuration details
 #

kubernetes/samples/scripts/create-fmw-infrastructure-domain/domain-home-on-pv/create-domain-inputs.yaml

@@ -135,6 +135,17 @@ createDomainScriptName: create-domain-job.sh
 # so that the Kubernetes pod can use the scripts and supporting files to create a domain home.
 createDomainFilesDir: wlst
 
+# Uncomment and edit value(s) below to specify the maximum amount of
+# compute resources allowed, and minimum amount of compute resources
+# required for each server pod.
+# These are optional.
+# Please refer to the kubernetes documentation on Managing Compute
+# Resources for Containers for details.
+#
+# serverPodMemoryRequest: "64Mi"
+# serverPodCpuRequest: "250m"
+# serverPodMemoryLimit: "1Gi"
+# serverPodCpuLimit: "1000m"
 
 #
 # RCU configuration details

kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain-inputs.yaml

@@ -134,3 +134,16 @@ domainHomeImageBase: container-registry.oracle.com/middleware/weblogic:12.2.1.3
 # Another possible value is "./docker-images/OracleWebLogic/samples/12213-domain-home-in-image-wdt",
 # which uses WDT, instead of WLST, to generate the domain configuration.
 domainHomeImageBuildPath: ./docker-images/OracleWebLogic/samples/12213-domain-home-in-image
+
+# Uncomment and edit value(s) below to specify the maximum amount of 
+# compute resources allowed, and minimum amount of compute resources 
+# required for each server pod.
+# These are optional.                
+# Please refer to the kubernetes documentation on Managing Compute
+# Resources for Containers for details.
+#
+# serverPodMemoryRequest: "64Mi"
+# serverPodCpuRequest: "250m"
+# serverPodMemoryLimit: "1Gi"
+# serverPodCpuLimit: "1000m"
+

kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/create-domain-inputs.yaml

@@ -135,10 +135,22 @@ createDomainScriptName: create-domain-job.sh
 # so that the Kubernetes pod can use the scripts and supporting files to create a domain home.
 createDomainFilesDir: wlst
 
+# Uncomment and edit value(s) below to specify the maximum amount of 
+# compute resources allowed, and minimum amount of compute resources
+# required for each server pod.
+# These are optional. 
+# Please refer to the kubernetes documentation on Managing Compute
+# Resources for Containers for details.
+#
+# serverPodMemoryRequest: "64Mi"
+# serverPodCpuRequest: "250m"
+# serverPodMemoryLimit: "1Gi"
+# serverPodCpuLimit: "1000m"
+
 # Istio service mesh support is experimental.
 # istioEnabled specifies whether or not it is deployed under Istio.
 istioEnabled: false
 
 # Istio service mesh support is experimental.
 # istioReadinessPort specifies the WebLogic NAP port for use by the readiness probe
-istioReadinessPort: 8888
+istioReadinessPort: 8888