To build OHS image:

1. Go to WORKSPACEDIR that is created in "Unified Inventory and Topology Toolkit".
2. Download V983369-01.zip: Oracle Fusion Middleware 12c (12.2.1.4.0) HTTP Server for Linux x86-64, 1.9 GB file from Oracle E-Delivery by searching for the file from Oracle HTTP Server 12.2.1.4.0 for (Linux x86-64) and copy them to the $WORKSPACEDIR/ohs-builder/staging/downloads/ folder.
3. Modify ohsBaseImage.package.path in $WORKSPACEDIR/ohs-builder/bin/ohs_manifest.yaml with the filename of the downloaded OHS archive file.
4. Download jdk-<version>_linux-x64_bin.tar.gz and copy to the $WORKSPACEDIR/ohs-builder/staging/downloads/java folder.

   Note:

   See UIM Compatibility Matrix for the latest versions of software.
5. Modify the ohsBaseImage.jdk.path in $WORKSPACEDIR/ohs-builder/bin/ohs_manifest.yaml file with the name of the downloaded JDK file.
6. Run build-all-images.sh in bin directory to build all images on OHS.

Before deploying OAM using the COMMON CNTK scripts, ensure the following:

• WebLogic Operator is deployed and configured as per UIM_CNTK. See "Setting Up Oracle WebLogic Server Kubernetes Operator" in UIM Cloud Native Deployment Guide for more information.
• Namespace is registered with WebLogic Operator using the UIM_CNTK script. See "Registering the Namespace" in UIM Cloud Native Deployment Guide for more information.
• Traefik (ingress-based) load balancer is installed as per UIM_CNTK script. See "Installing the Traefik Container Image" in UIM Cloud Native Deployment Guide for more information.
• Pull the Oracle Access Manager Image or latest cpu image from Oracle Container Registry as follows:
  1. Launch a browser and access the "Oracle Container Registry".
  2. Click Sign In and enter your username and password.
  3. In the Search field, enter Oracle Access Manager and press Enter.
  4. Click oam_cpu for the latest CPU patch image of Oracle Access Manager.
  5. In the Terms and Conditions box, select the language as English.
  6. Click Continue and accept Terms and Restrictions.
  7. On your Podman environment, log in to the Oracle Container Registry and enter your Oracle SSO username and password when prompted:

     $ podman login container-registry.oracle.com
     Username: <username>
     Password: <password>
     $ podman pull <oam-cpu-image-name>

  8. Pull the Oracle Access Manager Image or latest CPU image from Oracle Container Registry as follows.

     For example: Use the following command to pull OAM CPU image from Oracle Container Registry:

     docker pull container-registry.oracle.com/middleware/oam_cpu:12.2.1.4-jdk8-ol7-221014
     

• Download Oracle Communications Unified Inventory Management Common Toolkit from Oracle Software Delivery Cloud.

To deploy OAM using COMMON_CNTK scripts:

1. Go to the $WORKSPACEDIR/common_cntk folder created in Unified Inventory and Topology Toolkit and export the path to a variable COMMON_CNTK. See "Unified Inventory and Topology Toolkit" for more information.
2. Modify the parameters in the $SPEC_PATH/sr/quick/applications.yaml file as follows:
   • inventory.host: Provide the inventory host IP or address where UIM traditional application is installed. This is a mandatory parameter. For UIM cloud native instance, the value is: <uimproject>-<uiminstance>-cluster-uimcluster.<uimproject>.svc.cluster.local
   • inventory.port: Provide the inventory host port where the UIM on-perm is installed. This is a mandatory parameter. For UIM cloud native instance, the value is 8502.
   • inventory.isSSL: If traditional UIM has the SSL port used, change the value to true, for Cloud Native Inventory always false.
   • imagePullSecret: Provide the Kubernetes secret name containing the Docker secrets to pull images. This is a mandatory parameter. This secret should be accessible, which means that it must be created in the same namespace as OAM.
   • persistentVolumeClaimName: Provide the existing pvc name for storage of OAM domain. This is a mandatory parameter.
   • hostSuffix: By default it is .uim.org.
   • loadBalancerPort: The load balancer port exposed by Traefik or external load balancer. Enter the Secure/SSL port.
   • gcLogs: To enable GC logs for OAM, set enabled to true and configure the number of files and size of each file. You can uncomment values inside oam-server to override common values for gcLogs.

     For example:

     gcLogs:
       enabled: true
       fileSize: 10M
       noOfFiles: 10

   • tls.enabled: Flag to enable tls or ssl. By default, it is true. If true, create the certificate and the key mentioned in next step. Oracle recommends not to disable SSL in production environment.
3. If SSL is enabled that is, tls.enabled is true, create the certificate as follows:
   1. Create certs folder in $COMMON_CNTK.
   2. Copy your signed certificate and key into certs folder by renaming the certificate name as commoncert.pem and renaming the key file name as commonkey.pem.

      Note:

      OAM supports wild card certificates. Your certificate can be updated with the *.<hostSuffix>. By default, the hostSuffix value is uim.org from applications.yaml. See "Using Wild Card Certificates" for more information.

   3. (Optional) Run the following command to create Single Certificate and Key for OAM, messaging-bus, UIM, and ATA:

      openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout $COMMON_CNTK/certs/commonkey.pem -out $COMMON_CNTK/certs/commoncert.pem -subj "/CN=<instance>.<project>.admin.uim.org" -extensions san -config <(echo '[req]'; echo 'distinguished_name=req'; echo '[san]';echo 'subjectAltName=@alt_names'; \echo '[alt_names]'; \
      echo 'DNS.1=<instance>.<project>.admin.uim.org'; \
      echo 'DNS.2=<instance>.<project>.oam.uim.org'; \
      echo 'DNS.3=<instance>.<project>.ohs.uim.org'; \
      echo 'DNS.4=uim.org'; \
      echo 'DNS.5=<instance>.<project>.topology.uim.org'; \
      echo 'DNS.6=localhost'; \
      echo 'DNS.7=svc.cluster.local'; \
      echo 'DNS.8=<instance>.<project>.uim.org'; \
      echo 'DNS.9=admin.<instance>.<project>.uim.org'; \
      echo 'DNS.10=t3.<instance>.<project>.uim.org'; \
      )

      An example for project:sr and instance: quick:

      openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout $COMMON_CNTK/certs/commonkey.pem -out $COMMON_CNTK/certs/commoncert.pem -subj "/CN=quick.sr.admin.uim.org" -extensions san -config <(echo '[req]'; echo 'distinguished_name=req'; echo '[san]';echo 'subjectAltName=@alt_names'; \echo '[alt_names]'; \
      echo 'DNS.1=quick.sr.admin.uim.org'; \
      echo 'DNS.2=quick.sr.oam.uim.org'; \
      echo 'DNS.3=quick.sr.ohs.uim.org'; \
      echo 'DNS.4=uim.org'; \
      echo 'DNS.5=quick.sr.topology.uim.org'; \
      echo 'DNS.6=localhost'; \
      echo 'DNS.7=svc.cluster.local'; \
      echo 'DNS.8=quick.sr.uim.org'; \
      echo 'DNS.9=admin.quick.sr.uim.org'; \
      echo 'DNS.10=t3.quick.sr.uim.org'; \
      )

      Note:

      Ensure that commoncert.pem and commonkey.pem files are present in the $COMMON_CNTK/certs folder.

      OAM, UIM, ATA, and Message Bus support wildcard certificates. See "Using Wild Card Certificates" for more information.

   4. (Optional) To generate your own self-signed certificates, see "SSL Certificates".
4. Create the secrets for OAM as follows:
   1. Create the mandatory secrets according to the system prompts as follows:

      $COMMON_CNTK/scripts/manage-app-credentials.sh -p sr -i quick -f $SPEC_PATH/sr/quick/applications.yaml -a oam create database,wlsadmin,ingressTLS
      Applications specified - oam
      
      ====create database,wlsadmin,ingressTLS secret for oam Application====
      Provide Database credentials for 'sr-quick-oam' ...
      OAM DB Admin(sys) Username: <PDB-ADMIN-USER>
      OAM DB Admin(sys) Password: <PDB-ADMIN-PWD>
      OAM Schema Username: <OAM_SCHEMA_USER>
      OAM Schema Password: <OAM_SCHEMA_PWD>
      OAM DB Host: <DB_HOSTNAME>
      OAM DB Port: <DB_PORT>
      OAM DB Service Name: <SERVICE-NAME>
      
      Provide Weblogic Admin credentials for 'sr-quick-oam' ...
      Weblogic Admin Username: <WL_ADMIN_USER>
      Weblogic Admin Password: <WL_ADMIN_PWD>
      
      Provide Ingress TLS Credentials for OAM application 'sr-quick-oam' ...
      Ingress TLS Certificate Path (PEM file): $COMMON_CNTK/certs/commoncert.pem
      Ingress TLS Key file Path (PEM file): $COMMON_CNTK/certs/commonkey.pem
      
      secret/sr-quick-oam-rcu-credentials created
      secret/sr-quick-oam-wls-credentials created
      secret/sr-quick-oam-ingress-tls-cert-secret created
      Execution status of secrets for command - create:
      OAM MICROSERVICE...........Ok

      Note:

      The RCU Schema password guideline specifies that a valid password must be specified. The password should be alpha numeric only and can contain the following special characters: # , _ . The password should not start with a number or a special character.

      <OAM_SCHEMA_USER> should be less 12 characters and <OAM_SCHEMA_PWD> is the RCU Schema password.

   2. Ensure the following secrets are created:
      • Database secret : Contains the details of OAM database schema. For example, sr-quick-oam-rcu-credentials.
      • wlsadmin secret: Contains the credentials for WebLogic and oamconsole. For example, sr-quick-oam-wls-credentials.
      • ingressTLS: Contains certificate and key for OAM. For example, sr-quick-oam-ingress-tls-cert-secret.
   3. For traditional UIM, if SSL port is used, you must create additional configmap to pass the inventory certificate.

      $COMMON_CNTK/scripts/manage-app-credentials.sh -p sr -i quick -f $SPEC_PATH/sr/quick/applications.yaml -a oam create inventorySSL
      Provide Inventory SSL Credentials for OAM application 'sr-quick-oam' ...
      On-prem Inventory SSL Certificate Path (PEM file): <provide inventory certificate>

5. Configure Ingress and Ingress Controller for OAM. See "Configuring Ingress and Ingress Controller for OAM" for more information.
6. Create schema by running the following commands to install OAM DB and ensure that database secret and image name for database.yaml are correct:

   $COMMON_CNTK/scripts/install-database.sh -p sr -i quick -f $SPEC_PATH/sr/quick/database.yaml -a oam -c 1

7. Create OAM by running the following command to install OAM and ensure that you updated applications.yaml file:

   $COMMON_CNTK/scripts/create-applications.sh -p sr -i quick -f $SPEC_PATH/sr/quick/applications.yaml -a oam

To upgrade OAM, you can use following command:

$COMMON_CNTK/scripts/upgrade-applications.sh -p sr -i quick -f $SPEC_PATH/sr/quick/applications.yaml -a oam

To uninstall OAM:

1. Delete OAM as follows:

   $COMMON_CNTK/scripts/delete-applications.sh -p sr -i quick -f $SPEC_PATH/sr/quick/applications.yaml -a oam

2. Delete OAM db schema as follows:

   $COMMON_CNTK/scripts/install-database.sh -p sr -i quick -f $SPEC_PATH/sr/quick/database.yaml -a oam -c 2

3. Run the file $COMMON_CNTK/scripts/uninstall.sh.

   Note:

   Ensure the domain folder and its contents on the PV_SHARED_PATH or Path sharedDomainPath on NFS are deleted after the uninstallation. That is, delete <project>-<instance>-oam and <project>-<instance>-oam-ohs folders.

Enter the following proxy settings:

• In the browser, go to network no-proxy settings and include the *<hostSuffix> value from $SPEC_PATH/sr/quick/applications.yaml. By default, it is .uim.org that is, *.uim.org.
• In /etc/hosts the following may changed based on the <instance>, <project>, and hostSuffix values in $SPEC_PATH/sr/quick/applications.yaml.

etc/hosts:

<k8s cluster ip>  <instance>.<project>.oam.<hostSuffix>  <instance>.<project>.admin.<hostSuffix>  <instance>.<project>.policy.<hostSuffix> <instance>.<project>.ohs.<hostSuffix>
for example:
<k8s cluster ip> quick.sr.oam.uim.org quick.sr.admin.uim.org quick.sr.policy.uim.org traefik.uim.org quick.sr.ohs.uim.org

You need to complete the proxy settings for accessing the WebLogic Server Administration console and the OAM console. The credentials for accessing WebLogic console or OAM console are stored in the wlsadmin secret.

https://<instance>.<project>.admin.<hostSuffix>:<loadBalancerPort>/console

https://quick.sr.admin.uim.org:30443/console

https://<instance>.<project>.admin.<hostSuffix>:<loadBalancerPort>/oamconsole

https://quick.sr.admin.uim.org:30443/console

To configure OAM before using it for SSO authentication:

1. Log in to Oracle Access Management (OAM) Console:

   https://<instance>.<project>.admin.<hostSuffix>:<loadBalancerPort>/oamconsole

2. Click Configuration at the top right corner of the Console to show Configuration Launch Pad.
3. Click on Available Services and then click Enable Service for OAuth and OpenIDConnect Service.
4. From Configuration Launch Pad, select Access Manager from the View menu in the Settings section:
   1. Under Load Balancing and WebGate Traffic Load Balancer, modify OAM Server Host with <instance>.<project>.ohs.<hostSuffix >. The hostSuffix value is taken from $SPEC_PATH/sr/quick/applications.yaml. By default, it is .uim.org.
   2. Modify OAM Server Protocol to https.
   3. Modify OAM Server Port to <loadBalancerPort>. This value is from $SPEC_PATH/sr/quick/applications.yaml.
   4. Secure the load balancer port.
   5. Click Apply to save.

   Figure A-1 Access Manager Settings

   
   

   
   Description of "Figure A-1 Access Manager Settings"

   
   
5. From Configuration Launch Pad, select User Identity Stores to create an ID store for using the embedded LDAP of UIM:
   1. Click Create under the IDS Profiles section for creating an IDS profile.
   2. Specify Name as UIMEmbeddedLDAP.
   3. (Optional) Provide Description.
   4. Configure the Repository properties under Repository:
      1. Choose Repository Options by selecting Create New.
      2. Provide Directory Type as Weblogic Server Embedded LDAP.
      3. Provide Host Name as <Inventory's AdminHost> and Port as <Inventory's AdminPort> under Hosts.

         Note:

         In case of UIM Cloud Native Environment, provide AdminServer service name and port for <Inventory's AdminHost>:<Inventory's AdminPort> as <uim-project>-<uim-instance>-admin:8501 (sample: sr-quick-admin:8501).
      4. If UIM onPrem admin server is SSL enabled, select SSL Enabled, for UIM Cloud Native environment not required.
      5. Provide the Bind DN as cn=Admin.
      6. Specify Bind Password provided for the embedded LDAP in the WebLogic admin console. Ensure that the following steps are performed in WebLogic console where UIM is deployed. In the WebLogic Server admin console, change the credential for the embedded LDAP server as follows:

         Note:

         In case of UIM Cloud Native environment, enter your WebLogic password in the Password field.
         • Expand Domain > Security > Embedded LDAP.
         • In the Credential field, enter the new credential.
         • In the Confirm Credential field, enter the new credential again.
         • Click Save.
         • Reboot the WebLogic server.
      7. Provide Base DN as follows:

         ou=myrealm,dc=<inventory application domain name>

         Note:

         In case of UIM Cloud Native Environment, provide <inventory application domain name> as domain. On UIM CN, WebLogic domain name is set to domain by default.
   5. Configure the user properties to configure the LDAP user object under User section:
      1. Provide Base DN as ou=people,ou=myrealm,dc=<inventory application domain name>.
      2. Provide Login ID Attribute as uid.
   6. Configure the Group properties to configure the LDAP group object under Group section:
   7. Provide Base DN as ou=groups,ou=myrealm,dc=<inventory application domain name>.
   8. Click Test Connection on the top-right corner to ensure the connection to embedded LDAP is successful.
   9. Click OK to close the Connection Status dialog box.
   10. Click Create to create IDS profile.

       Entries with the profile name are displayed in the IDS Profiles and IDS Repositories table.

   11. Click Sync IDS Profiles button on right side of OAM ID Stores section to see the IDSPROFILE-UIMEmbeddedLDAP entry displayed under OAM ID Stores table.
6. Click Application Security at the top right corner of the Console to show the Application Security Launch Pad.
7. Click Agents and then Search to show the UnifiedWebgate in the table.
8. Select UnifiedWebgate from the table and click Edit to modify the Webgate settings:
   1. Modify Logout Redirect URL as:

      https://<instance>.<project>.ohs.<hostSuffix>:<loadBalancerPort/oam/server/logout

   2. Modify the Access Server and Host Name under Primary Server List as Other and <domainUID> -oam-server1 ' where domainUID is the <project>-<instance>-oam. By default, it is sr-quick-oam-oam-server1.
   3. Click Apply to save.
9. From the Application Security Launch Pad, select Authentication Modules from Plug-ins to create 'UIM Embedded LDAP Module' authentication module.
   1. Click Create LDAP Authentication Module in the Create dropdown, under Search Results section.
   2. Provide Name as UIM Embedded LDAP Module.
   3. Choose User Identity Store as IDSPROFILE-UIMEmbeddedLDAP that is created above.
   4. Click Apply to save.
10. From the Application Security Launch Pad, select Authentication schemas from Access Manager to create 'UIM Embedded LDAP Schema' authentication schema.
    1. Click Create under Search Results section.
    2. Provide Name as UIM Embedded LDAP Schema.
    3. Provide Description as UIM Embedded LDAP Schema.
    4. Modify the Authentication Level as 2.
    5. Provide Challenge Method as FORM.
    6. Provide Challenge Redirect URL as /oam/server/.
    7. Choose Authentication Module as UIM Embedded LDAP Module.
    8. Provide Challenge URL as /login.jsp.
    9. Choose Context Type as customwar.
    10. Provide Context Value as /customConsent.
    11. Click Apply to save.
11. From the Application Security Launch Pad, select Application Domains from Access Manager to edit UnifiedWebgate application domain.
    1. Click Search to show the UnifiedWebgate in the table.
    2. Select UnifiedWebgate from the table and click Edit to modify the Application Domain settings.
    3. Select Authentication Policies tab and select the Protected Resource Policy table item.
    4. Click Edit button to open Protected Resource Policy authentication policy settings.
    5. Choose Authentication Schema as UIM Embedded LDAP Schema from the drop down.
    6. Click Apply to save.

Complete the proxy settings as mentioned in the above section.

Ensure environment variable NO_PROXY is set with <hostSuffix>.

Run the following commands from the machine on which the proxy settings are done:

export CREDS=`echo -n "<OAM_Domain_Username>:<password>" | base64 -w 0`
export OAMHOST=<instance>.<project>.admin.<hostSuffix> (example,  quick.sr.admin.uim.org)
export OAMPORT=<loadBalancerPort> (the value provided in $SPEC_PATH/sr/quick/applications.yaml)

The following are some common issues.