Prerequisites

Before you begin, complete the following steps:

1. Review the Domain resource documentation.
2. Review the requirements and limitations.
3. Ensure that you have executed all the preliminary steps in Prepare your environment.
4. Ensure that the database and the WebLogic Kubernetes Operator are running.

Prepare to use the create domain script

The sample scripts for Oracle SOA Suite domain deployment are available at ${WORKDIR}/create-soa-domain. You must edit create-domain-inputs.yaml (or a copy of it) to provide the details for your domain. Refer to the configuration parameters below to understand the information that you must provide in this file.

Supported deployment modes:

• Development mode (set productionModeEnabled to false)
• Production mode (set productionModeEnabled to true and secureEnabled to false)
• Secured production mode (set productionModeEnabled to true and secureEnabled to true)

Refer Using Secured Production Mode for details.

Configuration parameters

The following parameters can be provided in the inputs file.

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-domain-inputs.yaml file. Those properties include the adminServerName, soaClusterName, and soaManagedServerNameBase etc. 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 an Oracle SOA Suite domain home and associated Kubernetes resources for the domain. 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.

Run the create domain script

Run the create domain script, specifying your inputs file and an output directory to store the generated artifacts:

./create-domain.sh \
  -i create-domain-inputs.yaml \
  -o <path to output-directory>

The script will perform the following steps:

• Create a directory for the generated Kubernetes YAML files for this domain if it does not already exist. The path name is <path to output-directory>/weblogic-domains/<domainUID>. If the directory already exists, its contents must be removed before using this script.
• Create a Kubernetes job that will start up a utility Oracle SOA Suite container and run offline WLST scripts to create the domain on the shared storage.
• Run and wait for the job to finish.
• Create a Kubernetes domain YAML file, domain.yaml, in the “output” directory that was created above.
• Create a convenient utility script, delete-domain-job.yaml, to clean up the domain home created by the create script.

Start the domain

The domain.yaml created by create-domain.sh script above has details about the Oracle SOA Suite Domain and Cluster Kubernetes resources. You can create Oracle SOA Suite Domain using the kubectl create -f or kubectl apply -f command:

```
kubectl apply -f <path to output-directory>/weblogic-domains/<domainUID>/domain.yaml
```

The default domain created by the script has the following characteristics:

• An Administration Server named AdminServer listening on port 7001.
• A configured cluster named soa_cluster of size 5.
• Managed Server, named soa_server1 listening on port 7003.
• Log files that are located in /shared/logs/<domainUID>.
• SOA Infra, SOA Composer, and WorklistApp applications deployed.

Verify the results

The create domain script verifies that the domain was created, and reports failure if there is an error. However, it may be desirable to manually verify the domain, even if just to gain familiarity with the various Kubernetes objects that were created by the script.

Generated YAML files with the default inputs

Sample content of the generated `domain.yaml` for `soaosb` domainType that creates SOA and Oracle Service Bus clusters.

cat output/weblogic-domains/soainfra/domain.yaml
# Copyright (c) 2020, 2023, Oracle and/or its affiliates.
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
#
# This is an example of how to define a Domain resource.
#
apiVersion: "weblogic.oracle/v9"
kind: Domain
metadata:
  name: soainfra
  namespace: soans
  labels:
    weblogic.domainUID: soainfra
spec:
  # The WebLogic Domain Home
  domainHome: /u01/oracle/user_projects/domains/soainfra

  # The domain home source type
  # Set to PersistentVolume for domain-in-pv, Image for domain-in-image, or FromModel for model-in-image
  domainHomeSourceType: PersistentVolume

  # The WebLogic Server image that the Operator uses to start the domain
  image: "soasuite:14.1.2.0"

  # imagePullPolicy defaults to "Always" if image version is :latest
  imagePullPolicy: IfNotPresent

  # Identify which secret contains the credentials for pulling an image
  #imagePullSecrets:
  #- name:

  # Identify which secret contains the WebLogic Admin credentials (note that there is an example of
  # how to create that secret at the end of this topic)
  webLogicCredentialsSecret:
    name: soainfra-domain-credentials

  # Whether to include the server out file into the pod's stdout, default is true
  includeServerOutInPodLog: true

  # Whether to enable log home
  logHomeEnabled: true

  # Whether to write HTTP access log file to log home
  httpAccessLogInLogHome: true

  # The in-pod location for domain log, server logs, server out, introspector out, and Node Manager log files
  logHome: /u01/oracle/user_projects/domains/logs/soainfra
  # An (optional) in-pod location for data storage of default and custom file stores.
  # If not specified or the value is either not set or empty (e.g. dataHome: "") then the
  # data storage directories are determined from the WebLogic domain home configuration.
  dataHome: ""

  # serverStartPolicy legal values are "Never", "IfNeeded", or "AdminOnly"
  # This determines which WebLogic Servers the Operator will start up when it discovers this Domain
  # - "Never" will not start any server in the domain
  # - "AdminOnly" will start up only the administration server (no managed servers will be started)
  # - "IfNeeded" will start all non-clustered servers, including the administration server and clustered servers up to the replica count
  serverStartPolicy: IfNeeded

  serverPod:
    # an (optional) list of environment variable to be set on the servers
    env:
    - name: JAVA_OPTIONS
      value: "-Dweblogic.StdoutDebugEnabled=false"
    - name: USER_MEM_ARGS
      value: "-Djava.security.egd=file:/dev/./urandom -Xms256m -Xmx1024m "
    volumes:
    - name: weblogic-domain-storage-volume
      persistentVolumeClaim:
        claimName: soainfra-domain-pvc
    volumeMounts:
    - mountPath: /u01/oracle/user_projects
      name: weblogic-domain-storage-volume

  # adminServer is used to configure the desired behavior for starting the administration server.
  adminServer:
    # adminService:
    #   channels:
    # The Admin Server's NodePort
    #    - channelName: default
    #      nodePort: 30701
    # Uncomment to export the T3Channel as a service
    #    - channelName: T3Channel

  # References to Cluster resources that describe the lifecycle options for all
  # the Managed Server members of a WebLogic cluster, including Java
  # options, environment variables, additional Pod content, and the ability to
  # explicitly start, stop, or restart cluster members. The Cluster resource
  # must describe a cluster that already exists in the WebLogic domain
  # configuration.
  clusters:
  - name: soainfra-osb-cluster
  - name: soainfra-soa-cluster

---
# This is an example of how to define a Cluster resource.
apiVersion: "weblogic.oracle/v1"
kind: Cluster
metadata:
  name: soainfra-osb-cluster
  # Update this with the namespace your domain will run in:
  namespace: soans
  labels:
    # Update this with the `domainUID` of your domain:
    weblogic.domainUID: soainfra
spec:
  clusterName: osb_cluster
  serverService:
    precreateService: true
  serverPod:
    env:
    # This parameter can be used to pass in new system properties; use the space delimiter to append multiple values.
    # Do not change this value, only append new values to it.
    - name: K8S_REFCONF_OVERRIDES
      value: "-Doracle.sb.tracking.resiliency.MemoryMetricEnabled=false "
  replicas: 1
  # The number of managed servers to start for unlisted clusters
  # replicas: 1
---
# This is an example of how to define a Cluster resource.
apiVersion: "weblogic.oracle/v1"
kind: Cluster
metadata:
  name: soainfra-soa-cluster
  # Update this with the namespace your domain will run in:
  namespace: soans
  labels:
    # Update this with the `domainUID` of your domain:
    weblogic.domainUID: soainfra
spec:
  clusterName: soa_cluster
  serverService:
    precreateService: true
  serverPod:
    env:
    # This parameter can be used to pass in new system properties; use the space delimiter to append multiple values.
    # Do not change this value, only append new values to it.
    - name: K8S_REFCONF_OVERRIDES
      value: "-Doracle.soa.tracking.resiliency.MemoryMetricEnabled=false "
  replicas: 1
  # The number of managed servers to start for unlisted clusters
  # replicas: 1

Verify the domain

To confirm that the domain was created, enter the following command:

kubectl describe domain DOMAINUID -n NAMESPACE

Replace DOMAINUID with the domainUID and NAMESPACE with the actual namespace.

Sample domain description:

kubectl describe domain soainfra -n soans
bash-4.2# kubectl describe domain soainfra -n soans
Name:         soainfra
Namespace:    soans
Labels:       weblogic.domainUID=soainfra
Annotations:  <none>
API Version:  weblogic.oracle/v9
Kind:         Domain
Metadata:
  Creation Timestamp:  2023-02-03T13:12:56Z
  Generation:          1
  Managed Fields:
    API Version:  weblogic.oracle/v9
    Fields Type:  FieldsV1
    fieldsV1:
      f:metadata:
        f:labels:
          .:
          f:weblogic.domainUID:
      f:spec:
        .:
        f:clusters:
        f:dataHome:
        f:domainHome:
        f:domainHomeSourceType:
        f:failureRetryIntervalSeconds:
        f:failureRetryLimitMinutes:
        f:httpAccessLogInLogHome:
        f:image:
        f:imagePullPolicy:
        f:includeServerOutInPodLog:
        f:logHome:
        f:logHomeEnabled:
        f:logHomeLayout:
        f:maxClusterConcurrentShutdown:
        f:maxClusterConcurrentStartup:
        f:maxClusterUnavailable:
        f:replicas:
        f:serverPod:
          .:
          f:env:
          f:volumeMounts:
          f:volumes:
        f:serverStartPolicy:
        f:webLogicCredentialsSecret:
          .:
          f:name:
    Manager:      kubectl-create
    Operation:    Update
    Time:         2023-02-03T13:12:56Z
    API Version:  weblogic.oracle/v9
    Fields Type:  FieldsV1
    fieldsV1:
      f:status:
        .:
        f:clusters:
        f:conditions:
        f:observedGeneration:
        f:servers:
        f:startTime:
    Manager:         Kubernetes Java Client
    Operation:       Update
    Subresource:     status
    Time:            2023-02-03T13:21:29Z
  Resource Version:  39889912
  UID:               141ec231-dbcf-4afe-8912-e142278f9a79
Spec:
  Clusters:
    Name:                           soainfra-osb-cluster
    Name:                           soainfra-soa-cluster
  Data Home:                        
  Domain Home:                      /u01/oracle/user_projects/domains/soainfra
  Domain Home Source Type:          PersistentVolume
  Failure Retry Interval Seconds:   120
  Failure Retry Limit Minutes:      1440
  Http Access Log In Log Home:      true
  Image:                            soasuite:14.1.2.0
  Image Pull Policy:                IfNotPresent
  Include Server Out In Pod Log:    true
  Log Home:                         /u01/oracle/user_projects/domains/logs/soainfra
  Log Home Enabled:                 true
  Log Home Layout:                  ByServers
  Max Cluster Concurrent Shutdown:  1
  Max Cluster Concurrent Startup:   0
  Max Cluster Unavailable:          1
  Replicas:                         1
  Server Pod:
    Env:
      Name:   JAVA_OPTIONS
      Value:  -Dweblogic.StdoutDebugEnabled=false
      Name:   USER_MEM_ARGS
      Value:  -Djava.security.egd=file:/dev/./urandom -Xms256m -Xmx1024m
    Volume Mounts:
      Mount Path:  /u01/oracle/user_projects
      Name:        weblogic-domain-storage-volume
    Volumes:
      Name:  weblogic-domain-storage-volume
      Persistent Volume Claim:
        Claim Name:     soainfra-domain-pvc
  Server Start Policy:  IfNeeded
  Web Logic Credentials Secret:
    Name:  soainfra-domain-credentials
Status:
  Clusters:
    Cluster Name:  osb_cluster
    Conditions:
      Last Transition Time:  2023-02-03T13:21:25.985058Z
      Status:                True
      Type:                  Available
      Last Transition Time:  2023-02-03T13:21:25.985176Z
      Status:                True
      Type:                  Completed
    Label Selector:          weblogic.domainUID=soainfra,weblogic.clusterName=osb_cluster
    Maximum Replicas:        5
    Minimum Replicas:        0
    Observed Generation:     1
    Ready Replicas:          1
    Replicas:                1
    Replicas Goal:           1
    Cluster Name:            soa_cluster
    Conditions:
      Last Transition Time:  2023-02-03T13:21:25.985247Z
      Status:                True
      Type:                  Available
      Last Transition Time:  2023-02-03T13:21:25.985324Z
      Status:                True
      Type:                  Completed
    Label Selector:          weblogic.domainUID=soainfra,weblogic.clusterName=soa_cluster
    Maximum Replicas:        5
    Minimum Replicas:        0
    Observed Generation:     1
    Ready Replicas:          1
    Replicas:                1
    Replicas Goal:           1
  Conditions:
    Last Transition Time:  2023-02-03T13:21:25.984952Z
    Status:                True
    Type:                  Available
    Last Transition Time:  2023-02-03T13:21:29.921800Z
    Status:                True
    Type:                  Completed
  Observed Generation:     1
  Servers:
    Health:
      Activation Time:  2023-02-03T13:17:40.865000Z
      Overall Health:   ok
      Subsystems:
        Subsystem Name:  ServerRuntime
        Symptoms:
    Node Name:     devhost
    Pod Phase:     Running
    Pod Ready:     True
    Server Name:   AdminServer
    State:         RUNNING
    State Goal:    RUNNING
    Cluster Name:  osb_cluster
    Health:
      Activation Time:  2023-02-03T13:20:24.163000Z
      Overall Health:   ok
      Subsystems:
        Subsystem Name:  ServerRuntime
        Symptoms:
    Node Name:     devhost
    Pod Phase:     Running
    Pod Ready:     True
    Server Name:   osb_server1
    State:         RUNNING
    State Goal:    RUNNING
    Cluster Name:  osb_cluster
    Server Name:   osb_server2
    State:         SHUTDOWN
    State Goal:    SHUTDOWN
    Cluster Name:  osb_cluster
    Server Name:   osb_server3
    State:         SHUTDOWN
    State Goal:    SHUTDOWN
    Cluster Name:  osb_cluster
    Server Name:   osb_server4
    State:         SHUTDOWN
    State Goal:    SHUTDOWN
    Cluster Name:  osb_cluster
    Server Name:   osb_server5
    State:         SHUTDOWN
    State Goal:    SHUTDOWN
    Cluster Name:  soa_cluster
    Health:
      Activation Time:  2023-02-03T13:21:18.284000Z
      Overall Health:   ok
      Subsystems:
        Subsystem Name:  ServerRuntime
        Symptoms:
    Node Name:     devhost
    Pod Phase:     Running
    Pod Ready:     True
    Server Name:   soa_server1
    State:         RUNNING
    State Goal:    RUNNING
    Cluster Name:  soa_cluster
    Server Name:   soa_server2
    State:         SHUTDOWN
    State Goal:    SHUTDOWN
    Cluster Name:  soa_cluster
    Server Name:   soa_server3
    State:         SHUTDOWN
    State Goal:    SHUTDOWN
    Cluster Name:  soa_cluster
    Server Name:   soa_server4
    State:         SHUTDOWN
    State Goal:    SHUTDOWN
    Cluster Name:  soa_cluster
    Server Name:   soa_server5
    State:         SHUTDOWN
    State Goal:    SHUTDOWN
  Start Time:      2023-02-03T13:13:28.055432Z
Events:            <none>

In the Status section of the output, the available servers and clusters are listed. Note that if this command is issued very soon after the script finishes, there may be no servers available yet, or perhaps only the Administration Server but no Managed Servers. The operator will start up the Administration Server first and wait for it to become ready before starting the Managed Servers.

Verify the pods

Enter the following command to see the pods running the servers:

kubectl get pods -n NAMESPACE

Here is an example of the output of this command. You can verify that an Administration Server and a Managed Server for each cluster (SOA and Oracle Service Bus) are running for soaosb domain type.

kubectl get pods -n soans
NAME                                                READY   STATUS      RESTARTS   AGE
soainfra-adminserver                         1/1     Running     0          53m
soainfra-osb-server1                         1/1     Running     0          50m
soainfra-soa-server1                         1/1     Running     0          50m

Verify the services

Enter the following command to see the services for the domain:

kubectl get services -n NAMESPACE

Here is an example of the output of this command. You can verify that services for Administration Server and Managed Servers (for SOA and Oracle Service Bus clusters) are created for soaosb domain type.

Sample list of services:

kubectl get services -n soans
NAME                            TYPE           CLUSTER-IP       EXTERNAL-IP   PORT(S)                       AGE
soainfra-adminserver            ClusterIP      None             <none>        30012/TCP,7001/TCP,7002/TCP   54m
soainfra-cluster-osb-cluster    ClusterIP      10.100.138.57    <none>        8002/TCP,8003/TCP             51m
soainfra-cluster-soa-cluster    ClusterIP      10.99.117.240    <none>        7003/TCP,7004/TCP             51m
soainfra-osb-server1            ClusterIP      None             <none>        8002/TCP,8003/TCP             51m
soainfra-osb-server2            ClusterIP      10.108.50.145    <none>        8002/TCP,8003/TCP             51m
soainfra-osb-server3            ClusterIP      10.108.71.8      <none>        8002/TCP,8003/TCP             51m
soainfra-osb-server4            ClusterIP      10.100.1.144     <none>        8002/TCP,8003/TCP             51m
soainfra-osb-server5            ClusterIP      10.108.57.147    <none>        8002/TCP,8003/TCP             51m
soainfra-soa-server1            ClusterIP      None             <none>        7003/TCP,7004/TCP             51m
soainfra-soa-server2            ClusterIP      10.97.165.179    <none>        7003/TCP,7004/TCP             51m
soainfra-soa-server3            ClusterIP      10.98.160.126    <none>        7003/TCP,7004/TCP             51m
soainfra-soa-server4            ClusterIP      10.105.164.133   <none>        7003/TCP,7004/TCP             51m
soainfra-soa-server5            ClusterIP      10.109.168.179   <none>        7003/TCP,7004/TCP             51m