Customizing images with integrated Developer Toolkit

The integrated Developer Toolkit offers two distinct methods for customization that is with om-runtime container and exploded runtime.

1. Based on the method you choose, complete the following steps to gain shell access inside the running container.
   • Method 1: Using om-runtime container
     1. Run the following command.

        docker exec -it om-runtime /bin/bash

        You now automatically gain shell access inside the running container with the default directory location that is set as /opt/ssfs/runtime.
   • Method 2: Using exploded runtime
     1. Import extensions to the exploded runtime of the integrated Developer Toolkit environment. For more information, see Updating custom extensions in containerized developer toolkit environment and Importing custom extensions into the Developer Toolkit environment.
     2. Deploy customizations to a new om-runtime container. For more information, see Deploying customizations in a new runtime container.
     3. Run the following command.

        docker exec -it om-runtime /bin/bash

        You now automatically gain shell access inside the running container with the default directory location that is set as /opt/ssfs/runtime.
2. Continue to complete the following steps 3 to 10, which are common to both the methods.
3. Enable OIDC support by adding the following property to the /opt/ssfs/runtime/properties/sandbox file. For more information, see Supporting OIDC provider login in Operator.

   ENABLE_IBMID_AUTHENTICATION=true

4. Configure the database properties.

   Multischema mode

   If you want to configure your database, Oracle, Db2, or PostgreSQL with multischema, see Transforming containers for multischema. Then, configure the properties for the database that you are using. The Jdbc schema, URL, user, and password must be metadata information of multischema.

   Single schema mode

   Db2

   Complete the following steps if you are using Db2. By default, the base runtime contains Db2 drivers.

   1. Configure the database connectivity by updating system_overrides.properties.
   2. Go to the /opt/ssfs/runtime/properties folder.
   3. Create the system_overrides.properties file and add the Db2 properties. For more information, see Db2 properties.
   4. Ensure none of the applications or agents are running against the same database when you are performing any database-related operations from the customized runtime.

   Oracle

   Complete the following steps if you are using Oracle.

   1. Copy Oracle jar to the container.
   2. Browse to the <runtime>/bin folder and install the Oracle driver by running the following commands:

      ./install3rdParty.sh <vendorName> <vendorVersion> -d <path to ojdbc8.jar> -targetJVM EVERY

      ./install3rdParty.sh <vendorName> <vendorVersion> -j <path to ojdbc8.jar> -targetJVM EVERY

   3. Browse to the /opt/ssfs/runtime/properties folder.
   4. Add or modify the Oracle properties in sandbox.cfg file. For more information, see Oracle properties.

      For more information about the sandbox.cfg properties, see the Sandbox.cfg properties.

   5. Browse to the <runtime>/bin folder and run the ./setupfiles.sh command.

   PostgreSQL

   1. Download and copy PostgreSQL driver that is postgresql-42.2.24.jar to the container with the name postgresql.jar.
   2. Browse to the <runtime>/bin folder and install the PostgreSQL driver by running the following commands:

      ./install3rdParty.sh <vendorName> <vendorVersion> -d <path to postgresql.jar> -targetJVM EVERY

      ./install3rdParty.sh <vendorName> <vendorVersion> -j <path to postgresql.jar> -targetJVM EVERY

   3. Browse to the /opt/ssfs/runtime/properties folder.
   4. Add or modify the PostgreSQL properties in the sandbox.cfg file. For more information, see PostgreSQL properties.
      Note:

      • If you want to transform your containers to a new database type, setting up the database transformation properties are mandatory.
      • The Sterling Order Management System Software Operator injects database connection properties automatically during deployment. Therefore, if you are using the customization container only to generate custom images, setting up the database connection properties is optional.

      For more information about the sandbox.cfg properties, see the Sandbox.cfg properties.

   5. Browse to the <runtime>/bin folder and run the ./setupfiles.sh command.

5. Verify that the database connection is established by completing the following steps:
   1. Go to <runtime>/bin
   2. Run ./dbverify.sh
6. Load the base factory setup to load the factory setup data.
7. Load the fix pack factory setup present in the om-base image or apply the latest fix pack. For more information, see Installing fix pack for Sterling Order Management System Software containers.
8. Optional: By default, the runtime does not contain Javadoc. If you want to build Javadoc, run the following command.

   ./sci_ant.sh -f ../properties/xapiDeployer.xml alldocs

   For 10.0.0.17 or later om-base image, use generate images script to generate Javadoc and an image that can be deployed. Navigate to /opt/ssfs/runtime/container-scripts/imagebuild folder, and run the following command:

   ./generateImages.sh --MODE=docs --EXPORT=false

   This command generates a new image with the name om-app-docs. You can push this image to the cluster and deploy for accessing Javadoc. For more information about deploying multiple application images, see the Deploying smcfsdocs.
9. Optional: Apply language packs manually only for the images of FP23 or older. The images of FP26 and later comes with language packs applied by default. The supported language packs are available as an archive at /var/opt/ssfs/LP.tgz.

   tar -xf /var/opt/ssfs/LP.tgz -C /opt/ssfs/runtime