Before you begin

Make sure that you have set up the WebLogic Image Tool. See setup for details. WebLogic Image Tool by default uses docker CLI. To override the default with say podman, set the WLSIMG_BUILDER with full path to the executable. For example, WLSIMG_BUILDER="/usr/bin/podman"

Update the container image

1. Review and update the additionalBuildCmds.txt. The sample additionalBuildCmds.txt is provided for Oracle Linux 8 with the packages required for installing and setting up a VNC session.
2. Update additionalBuildCmds.txt if you want to add additional packages.
3. Run the imagetool.sh.
4. To update the existing Oracle SOA Suite container image soasuite:14.1.2.0 by applying the additionalBuildCmds.txt and tag it as soasuite:14.1.2.0-vnc and run the below command:

   $ cd $WORKDIR/create-soa-domain/domain-upgrade/vncsetup
   $ imagetool update --fromImage soasuite:14.1.2.0 --tag soasuite:14.1.2.0-vnc --chown oracle:root --additionalBuildCommands ./additionalBuildCmds.txt 
   

5. Push the image to remote or local registry

   • Remote registry - Push the updated image soasuite:14.1.2.0-vnc to a container registry so that your Kubernetes Cluster hosting can you pull.

     $ podman tag soasuite:14.1.2.0-vnc  your-registry.com/oracle/soasuite:14.1.2.0-vnc$ podman push your-registry.com/oracle/soasuite:14.1.2.0-vnc

   • Local registry - This requires access to worker nodes.

     First archive the image:

     $ podman save -o soasuite-14.1.2.0-vnc.tar.gz soasuite:14.1.2.0-vnc
     

     Copy the archive soasuite-14.1.2.0-vnc.tar.gz into worker nodes and load the image to local container storage:

     $ podman load < soasuite-14.1.2.0-vnc.tar.gz

Setup the VNC access

1. To create the VNC session in a container environment you can use the script start_vnc.sh:

   $ cd $WORKDIR/create-soa-domain/domain-upgrade/vncsetup/scripts
   $ ./start_vnc.sh -h
   
   This is a helper script for starting VNC session in a container environment.
   
   Please see README.md for more details.
   
   Usage:
   
       start_vnc.sh [-c persistentVolumeClaimName] [-m mountPath]  [-n namespace] [-i image] [-u imagePullPolicy] [-t serviceType] [-d vncpassword] [-k killvnc] [-h]"
   
       [-c | --claimName]                : Persistent volume claim name.
   
       [-m | --mountPath]                : Mount path of the persistent volume in vnchelper deployment.
   
       [-n | --namespace]                : Namespace. Default is 'default'.
   
       [-i | --image]                    : Container image for the vnchelper deployment (optional). Default is 'ghcr.io/oracle/oraclelinux:8'.
   
       [-u | --imagePullPolicy]          : Image pull policy for the vnchelper deployment (optional). Default is 'IfNotPresent'.
   
       [-p | --imagePullSecret]          : Image pull secret for the vnchelper deployment (optional). Default is 'None'.
   
       [-t | --serviceType]              : Kubernetes service type for VNC port. Default is 'NodePort'. Supported values are NodePort and LoadBalancer.
   
       [-d | --vncpassword]              : Password for VNC access. Default is 'vncpassword'.
   
       [-k | --killvnc                   : Removes the Kubernetes resources created in the namespace created for VNC session.
   
       [-h | --help]                     : This help.
   

2. In case you want to invoke GUI based command like Upgrade Assistant (ua) or reconfig.sh to perform release upgrade, use the start_vnc.sh script with same domain home Persistent volume claim name and mount path used by the Domain. Here is an example for Oracle SOASuite domain deployed in soans namespace, using soainfra-domain-pvc Persistent volume claim mounted inside container at mount path /u01/oracle/user_projects, you can start the script with below command:

   $ ./start_vnc.sh -n soans -i soasuite:14.1.2.0-vnc -c soainfra-domain-pvc -t NodePort -d welcome -m /u01/oracle/user_projects
   

   Sample output:

   [2024-11-07T17:45:55.893964348Z][INFO] Creating deployment 'vnchelper' using image 'soasuite:14.1.2.0-vnc', persistent volume claim 'soainfra-domain-pvc' and mount path '/u01/oracle/user_projects'.
   configmap/vnchelper-scripts-cm configured
   Checking the configmap vnchelper-scripts-cm was created
   secret/vnchelper-scripts-secret configured
   Checking the secret vnchelper-scripts-secret was created
   deployment.apps "vnchelper" deleted
   deployment.apps/vnchelper created
   service/vnchelper created
   [2024-11-07T17:46:06.838237729Z][INFO] =========================================== VNC environment details ====================================================
   [2024-11-07T17:46:06.840832397Z][INFO] VNCSERVER started on DISPLAY= <NODE PORT>
   [2024-11-07T17:46:06.842955900Z][INFO] To start using VNC Session ==> connect via VNC viewer with <NODE NAME>:<NODE PORT>
   [2024-11-07T17:46:06.845361778Z][INFO]
   [2024-11-07T17:46:06.847710989Z][INFO] Your data hosted at persistentvolumeClaim soainfra-domain-pvc, are available for access at /u01/oracle/user_projects
   [2024-11-07T17:46:06.850974036Z][INFO] ========================================================================================================================
   [2024-11-07T17:46:06.853056442Z][INFO]
   [2024-11-07T17:46:06.855075115Z][INFO] >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
   [2024-11-07T17:46:06.857105300Z][INFO] >>>>>> To cleanup the Kubernetes resources created for VNC session
   [2024-11-07T17:46:06.859015919Z][INFO] >>>>>> Run: $ ./start_vnc.sh -k -n soans
   [2024-11-07T17:46:06.861045303Z][INFO] >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
   

3. To start using VNC session, connect via VNC viewer with <NODE NAME>:<NODE PORT> obtained from the start_vnc.sh output.
4. Finally to remove the VNC access and cleanup the Kubernetes resources created, run the following command:

   $ ./start_vnc.sh -k -n <namespace>