Running the Search (OSK) Container Image

To run the container image:

  1. Extract the image zip file, referred to here as FILENAME.zip, in a convenient directory.
  2. Enter this commands to load a single container image:
    podman load -i FILENAME.tgz

    Use this command to list all images:

    podman images -a
  3. Open ./compose.yaml for editing and specify the following values:
    Parameter Value

    hostname

    Enter the mid-tier container hostname.

    This hostname is critical for PeopleTools domain creation processes. The hostname must not contain underscores (_) and should be distinct from the host machine's FQDN. For example, if your container host computer's FQDN is server.example.one.oraclevcn.com then set the container hostname as midtier.oraclevcn.com. This will set the PeopleTools Auth Token Domain to .oraclevcn.com. The PIA URL will be http://server.example.one.oraclevcn.com:8000.

    Resource limit

    Add CPU and memory resource limits for each container. Leave some resources for host.

    
    mem_limit: "8g"
    cpus: "4"
  4. Leave the proxy variable empty.
  5. Update the port mapping for the type of container you are installing.

    Each container must use different ports. The syntax of the port definition is <port on host>:<port on container>. To override the default port mapping, define a PORT_* environment variable, which will be used by the docker-compose-pum.yaml file. For example, to change the default PORT_PIA to 9980 use this command: export PORT_PIA=9980 Then the line ${PORT_PIA:-8000}:8000 will be translated as 9980:8000. With this definition, when you use the PIA URL http://server.example.com:8000/ps/signon.html, the Linux host VM reads it as http://server.example.com:9980/ps/signon.html. Note. "MY_VAR=${NEW_VAR:-DefaultValue}" is a BASH shell syntax to override a default value and assign a new value to MY_VAR.

    Mappings for search container Description

    ${PORT_OSSERVER:-9200}:9200

    OpenSearch port

    ${PORT_OSSERVER_NODE:-9300}:9300

    OpenSearch node port

    ${PORT_LOGSTASH:-9800}:9800

    Logstash port

    ${PORT_OSDASHBOARD:-5601}:5601

    OpenSearch Dashboards port

  6. View and update the ./in/osk/install-osk.rsp file with the appropriate values for your environment.

    The values in the install-osk.rsp response file will be used for the installation.

  7. Enter this command to run the container:
    podman-compose -f compose.yaml up -d

    Note:

    Remove ./in/osk/install-osk.rsp once the OSK container is up and running.
  8. Check the logs with these commands.

    The -f option means follow log output. The -n option outputs container names rather than IDs.

    
    podman logs -fn osk

    Enter CTRL+C to exit the log.

  9. Use this command to view the DPK logs in case of failure:
    podman exec -ti osk vi /in/dpk/setup/OSKInstall.log 
  10. To copy the DPK logs to the current location:
    podman cp -a osk:/in/dpk/setup/OSKInstall.log
  11. The container is up and running when it shows the following message in the container logs:
    =====================
    OSK IS READY TO USE!
    =====================
  12. Stop the services using Podman Compose.
    podman-compose -f compose.yaml down

For information on running the Automated Configuration Manager (ACM) plugins, see the search/readme.md.