UIM cloud native package does not provide scripts to install or remove the WebLogic Kubernetes operator. See WKO Documentation for Installing and uninstalling Weblogic Operator.

See "UIM Software Compatibility" in UIM Compatibility Matrix for WKO recommended version.

For example, to download and install the WKO version:

1. See https://github.com/oracle/weblogic-kubernetes-operator/releases/.
2. Choose a namespace for the operator and set the WLSKO_NS environment variable to the Kubernetes namespace in which WKO will be deployed.

   Note:

   Oracle recommends you use --version=<version> while installing. See "UIM Software Compatibility" UIM Compatibility Matrix for the corresponding WKO version.

   Oracle recommends you set the label to the same as namespace using --set "domainNamespaceLabelSelector=<namespace>=enabled" instead of the default label "weblogic-operator=enabled" as having multiple operators installed with the same label is not recommended.

3. After successful installation of WKO, validate that the operator is installed by running the following command:

   kubectl get pods -n $WLSKO_NS

If you are using a version older than 3.1.0, the operator is supported to specify the namespaces that can be managed only through a list. Currently, the operator supports a list of namespaces, a label selector, or a regular expression matching namespace names.

You can use any Ingress Controller that conforms to the standard Kubernetes ingress API and that supports annotations required for UIM. See "Working with Ingress, Ingress Controller, and External Load Balancer" for more information.

WebLogic Kubernetes Operator describes the installation and the usage of the NGINX Ingress controller. See https://github.com/oracle/weblogic-kubernetes-operator/blob/release/4.1/kubernetes/samples/charts/nginx/README.md for more information.

While UIM cloud native supports using Traefik as Ingress Controller, Oracle recommends to use an Ingress Controller that supports the generic Kubernetes ingress API. See "Installing the Ingress Controller" for more information.

To leverage the UIM cloud native samples that integrate with Traefik, the Kubernetes environment must have the Traefik ingress controller installed and configured.

If you are working in an environment where the Kubernetes cluster is shared, confirm whether Traefik has already been installed and configured for UIM cloud native. If Traefik is already installed and configured, set your TRAEFIK_NS environment variable to the appropriate namespace.

The instance of Traefik that you installed to validate your cloud environment must be removed as it does not leverage the UIM cloud native samples. Ensure that you have removed this installation in addition to purging the Helm release. Check that any roles and rolebindings created by Traefik are removed. There could be a clusterrole and clusterrolebinding called "traefik-operator". There could also be a role and rolebinding called "traefik-operator" in the $TRAEFIK_NS namespace. Delete all of these before you set up Traefik.

To download and install the Traefik container image:

1. Ensure that Docker in your Kubernetes cluster can pull images from Docker Hub. See "UIM Software Compatibility" in UIM Compatibility Matrix for the required and supported versions of the Traefik image.
2. Run the following command to create a namespace ensuring that it does not already exist:

   Note:

   You might want to add the traefik namespace to the environment setup like .bashrc.

   kubectl get namespaces
   export TRAEFIK_NS=traefik   
   kubectl create namespace $TRAEFIK_NS

3. Run the following commands to install Traefik using the $UIM_CNTK/samples/charts/traefik/values.yaml file in the samples:

   Note:

   • Set kubernetes.namespaces and the chart version specifically using command line.
   • For details about the required chart version of Traefik, see "UIM Software Compatibility" in UIM Compatibility Matrix. The following is a sample to install Traefik chart of version 15.1.0.
   • $UIM_CNTK/samples/charts/traefik/values.yaml that is used to install Traefik has an argument "--serversTransport.insecureSkipVerify=true" to skip verification of self-signed certificates. This argument should be enabled to trust self-signed certificates. Uncomment the argument to disable the verification of these certificates between Traefik and the back-end server.

   helm repo add traefik https://helm.traefik.io/traefik
   helm install traefik-operator traefik/traefik \
   --namespace $TRAEFIK_NS \
   --version 15.1.0 \
   --values $UIM_CNTK/samples/charts/traefik/values.yaml \
   --set "providers.kubernetesCRD.namespaces={$TRAEFIK_NS}" \
   --set "providers.kubernetesIngress.namespaces={$TRAEFIK_NS}"

After the installation, Traefik monitors the namespaces listed in its kubernetes.namespaces field for Ingress objects. The scripts in the toolkit manage this namespace list as part of creating and tearing down UIM cloud native projects.

When the values.yaml Traefik sample in the UIM cloud native toolkit is used as is, Traefik is exposed to the network outside of the Kubernetes cluster through port 30305. To use a different port, edit the YAML file before installing Traefik. Traefik metrics are also available for Prometheus to scrape from the standard annotations.

Traefik function can be viewed using the Traefik dashboard. Create the Traefik dashboard by running the instructions provided in the $UIM_CNTK/samples/charts/traefik/traefik-dashboard.yaml file. To access this dashboard, the URL is: http://traefik.uim.org. This is if you use the values.yaml file provided with the UIM cloud native toolkit; it is possible to change the hostname as well as the port to your desired values.

To set the environment variables:

After you set the environment variables, register the namespace. If you are working with wlsko as the targetNamespace, then RegisterNamespace script offers an additional -l option that enables you to include the label selector used during the operator installation.

If a label selector is not added while installing the operator:

By default the weblogic-enabled=true label is added to your $WLSKO_NS namespace so that the operator can monitor it.

If a label selector is added while installing the operator:

Ensure that you include the same label using the -l option, as follows.

#if you have defined labelselector while installing operator Example: wlsko=enabled
 $UIM_CNTK/scripts/register-namespace.sh -p <project> -t targets -l <label-Selector>
#For example, $UIM_CNTK/scripts/register-namespace.sh -p sr -t wlsko -l wlsko=enabled
 
#if LabelSelector is not used while installing WKO then
$UIM_CNTK/scripts/register-namespace.sh -p sr -t targets
#For example, $UIM_CNTK/scripts/register-namespace.sh -p sr -t wlsko

To register the namespace for traefik:

$UIM_CNTK/scripts/register-namespace.sh -p <project> -t targets
# For example, $UIM_CNTK/scripts/register-namespace.sh -p sr -t traefik

'wlsko' and 'traefik' are the names of the targets for namespace registration. The script utilizes WLSKO_NS and TRAEFIK_NS to locate these targets. If you are not using Traefik, there is no need to specify the "traefik" target.

The toolkit provides sample scripts for this purpose. However, they are not pipeline-friendly. The scripts should be used for creating an instance manually and quickly, but not for any automated process for creating instances. The scripts also illustrate both the naming of the secret and the layout of the data within the secret that UIM cloud native requires. You must create secrets prior to running the install-uimdb.sh or create-instance.sh scripts.

$UIM_CNTK/scripts/manage-instance-credentials.sh -p sr -i quick create wlsadmin,opssWP,wlsRTE,rcudb,uimdb

where:

• uimdb specifies the connectivity details and the credentials for connecting to the UIM PDB (UIM schema). This is consumed by the UIM DB installer and UIM runtime.

  Note:

  The uimdb secrets contain PDB sysdba user and uim main schema user. The names of these must be unique.
• rcudb specifies the connectivity details and the credentials for connecting to the UIM PDB (RCU schema). This is consumed by the UIM database installer and UIM and Fusion MiddleWare runtime.
• wlsadmin is the credential for the intended user that will be created with administrative access to the WebLogic domain.
• opssWP is the password for encrypting and decrypting the ewallet contents.
• wlsRTE is the password used to encrypt the operator artifacts for this instance. The merged domain model and the domain ZIP are available in the operator config map and are encoded using this password.

sr-quick-database-credentials
sr-quick-embedded-ldap-credentials
sr-quick-weblogic-credentials
sr-quick-rcudb-credentials
sr-quick-opss-wallet-password-secret
sr-quick-runtime-encryption-secret

This procedure configures an empty PDB. Depending on the database strategy for your team, you may have already performed this procedure as described in "Planning Your Cloud Native Environment". Before continuing, confirm whether the PDB being used for creating the UIM instance has been cloned from a Master PDB that includes the schema installation. If the PDB already has the schema installed, skip this procedure and proceed to the Creating UIM Users and Groups topic.

After the PDB is created, it is configured with the UIM schema, the RCU schema, and the cluster leasing table.

To generate encrypted WebLogic administrator's password:

1. Run the following command to start the UIM DB installer, which initiates a Kubernetes Pod resource. The pod resource is available until the DB installation completes.

   $UIM_CNTK/scripts/install-uimdb.sh -p sr -i quick -s $SPEC_PATH -c 8

   Note:

   To see further options available, use -h command.
2. Check the WebLogic console for successful DB installation. If the installation failed, run the following command to view the error message from the log:

   kubectl logs -n sr sr-quick-dbinstaller

3. Clean up the failed pod using the following command:

   helm uninstall sr-quick-dbinstaller -n sr

4. Verify the new secret that is created as follows:

   kubectl get secrets -n sr | grep encrypted
   sr-quick-weblogic-encrypted-credentials Opaque 1 5m32s

The project specification is a Helm override file that contains values that are scoped to a project. The values specified in the specification are shared by all the instances of a project, unless they are overridden in an instance specification. Review the content about Helm chart layering in "Overview of the UIM Cloud Native Deployment".

The instance specification is a Helm override file that contains values that are specific to a single instance. These values feed into the WDT model developed for the UIM WebLogic domain.

An ingress establishes connectivity to the UIM instances.

$UIM_CNTK/scripts/create-ingress.sh -p sr -i quick -s $SPEC_PATH
Project Namespace : sr
Instance Fullname : sr-quick
LB_HOST           : quick.sr.uim.org
Ingress Controller: TRAEFIK
External LB IP    : 192.0.0.8
 
NAME: sr-quick-ingress
LAST DEPLOYED: Wed Jul  1 10:20:27 2020
NAMESPACE: sr
STATUS: deployed
REVISION: 1
TEST SUITE: None
 
Ingress created successfully...

This procedure describes how to create a UIM instance in your environment using the scripts that are provided with the toolkit.

The base hostname required to access this instance using HTTP is quick.sr.uim.org. See "Planning Your Cloud Native Environment" for details about hostname resolution.

The create-instance script prints out the following valuable information that you can use while working with your UIM domain:

• The T3 URL: http://t3.quick.sr.uim.org This is required for external client applications such as JMS and WLST.
• The URL for access to the WebLogic UI, which is provided through the ingress controller at host: http://admin.quick.sr.uim.org:30305/console.
• The URL for access to the UIM UIs, which is provided through the ingress controller that requires the host to be specified as: http://quick.sr.uim.org:30305/Inventory/Login.jsp.

To access UIM Home page, you need to assign roles. You can use EM console for role assignments.

To assign roles:

1. Create uim-user-roles.txt as follows:

   uimdev:uimuser
   cmwsdev:uimuser

2. Run the following command to assign the roles:

   $UIM_CNTK/samples/credentials/assign-role.sh -p sr  -i quick  -f uim-user-roles.txt

After creating an instance, you can validate it by checking the domain configuration and the client UIs.

kubectl describe domain sr-quick -n sr

The command displays the domain configuration information.

Now that your UIM instance is up and running, you can explore the ability to dynamically scale the application cluster.

To scale the UIM application cluster, edit the configuration:

1. In the instance specification, change the value for clusterSize manually. This change would ultimately be performed by an automated CI/CD pipeline.

   vi $SPEC_PATH/sr-quick.yaml
   
   # Change the cluster size to a value not larger than 18
   
   #cluster size
   clusterSize: 2

   Note:

   You can watch the Kubernetes pods in your namespace shrink or grow in real-time. To watch the pods shrink or grow, in a separate terminal window, run the following command:

   kubectl get pods -n sr --watch

2. Upgrade the deployed Helm release:

   $UIM_CNTK/scripts/upgrade-instance.sh -p sr -i quick -s $SPEC_PATH 

   This pushes the new configuration to the deployed Helm release so the operator can take the necessary steps.

The WebLogic operator monitors changes to clusterSize and results in the operator spinning up or tearing down managed servers to align with the requested cluster size.

Deleting Your UIM Instance

$UIM_CNTK/scripts/delete-instance.sh -p sr -i quick

Re-creating Your UIM Instance

When you delete a UIM instance, the database state for that instance still remains unaffected. You can re-create a UIM instance with the same project and the instance names, pointing to the same database.

$UIM_CNTK/scripts/create-instance.sh -p sr -i quick -s $SPEC_PATH

This section provides information about troubleshooting some issues that you may come across when running the scripts.

If you experience issues when running the scripts, do the following:

• Check the operator logs to find out the details about the issue:

  kubectl get pods -n $WLSKO_NS
  # get the operator pod name to be used in the next command
  kubectl logs -n $WLSKO_NS operator_pod

• Check the "Status" section of the domain to see if there is useful information:

  kubectl describe domain -n sr sr-quick 

"Timeout" Issue

In the logs, you may sometimes see the word "timeout" when the create-instance script fails. When you run the create-instance script, it may take a long time to pull the image, if you are doing it for the first time. In such a scenario, the script may fail and display the text "timeout" in the log.

# Modify the timeout value to start introspector pod. Mainly
# when using against slow DB or pulling image first time.
podStartupDeadlineSeconds: 800

After adjusting the parameter, clean up the failed instance and re-create the instance.

Cleanup Failed Instance

When a create-instance script fails, you must clean up the instance before making another attempt at instance creation.

To clean up the failed instance:

1. Delete the instance:

   $UIM_CNTK/scripts/delete-instance.sh -p sr -i quick

2. Delete and recreate the RCU schema:

   $UIM_CNTK/scripts/install-uimdb.sh -p project -i instance -s $SPEC_PATH -c 5
   $UIM_CNTK/scripts/install-uimdb.sh -p project -i instance -s $SPEC_PATH -c 2

Recreating an Instance

$UIM_CNTK/scripts/create-instance.sh -p sr -i quick -s $SPEC_PATH