Docker Compose commands reference

You can run the ./om-compose.sh command with arguments to suit your requirements. For example, ./om-compose.sh <arguments>.

The following table provides the list of commands and arguments to run om-compose.sh:
Commands Description
./om-compose.sh setup
<optional: full_path_to_custom jar>
Sets up containerized developer toolkit environment for the first time. Additionally, it deploys the customization JAR provided, though it is optional. For more information, see Setting up the containerized developer toolkit environment.
./om-compose.sh setup-upg
<optional: full_path_to_custom_jar>

Upgrades an existing containerized developer toolkit environment with new images (upgrade). Additionally, it deploys the customization JAR provided, though its optional. This is similar to the setup argument, but runs load factory data and load views in the ‘upgrade’ mode.

Before you run setup-upg to upgrade to the next drop, it is recommended that you create a backup of your configuration by running Configuration Deployment Tool (CDT) export from your host runtime.

For more information, see Upgrading an existing containerized developer toolkit environment.

./om-compose.sh update-extn
<optional: full_path_to_custom_jar>
Updates an existing environment with just the customization package, without fetching new images.

Also, integrates developer toolkit with Cloud services, such as Sterling Intelligent Promising Inventory Visibility and Store Engagement.

For more information, see Update custom extensions in containerized developer toolkit environment.
./om-compose.sh check-services Tests connectivity to integrated Cloud services, such as Sterling Intelligent Promising Inventory Visibility and Store Engagement.
./om-compose.sh extract-rt

Extracts runtime contents to the devtoolkit_docker/runtime directory in the host machine.

You can create a copy of your Sterling Order Management System runtime on your host machine from your om-runtime Docker image. This runtime directory can be used to develop customizations, access Javadoc, run agents and scripts like CDT, and so on. You need not enter the Docker container to perform any of these tasks.

./om-compose.sh start <optional: service name>
./om-compose.sh stop <optional: service name>
./om-compose.sh restart <optional: service name>
Starts, stops, and restarts all Docker Compose services. If no service name is passed to the command, all the services are either started, stopped or restarted. Otherwise, the command works only on the service passed. The service names for different services are omruntime, appserver, mqserver and db2server.
./om-compose.sh wipe-clean Destroys all containers and deletes all volumes corresponding to your Docker Compose environment. Resets your environment so that you can run the setup again. Optionally, you can keep a backup of your configuration using the CDT.
Note: Running the compose script with this argument completely removes the setup.
./om-compose.sh add-queue
<new_queue_name_in_all_caps> <queue length>
Adds a new local queue on the MQ server and also updates the MQ .bindings file. You can also provide a custom queue length, default is 5000.
./om-compose.sh delete-queue
<queue_name_to be deleted_in_all_caps>
Deletes the specified local queue on the MQ server and also updates the MQ .bindings file.
./om-compose.sh import-cert <arg1> <arg2> Imports third-party certificates.
It considers the following arguments:
  • The first argument is the path relative to the devtoolkit_docker/certificates directory.
  • The second argument is the alias.
./om-compose.sh remove-cert <arg1> Removes third-party certificates.

The first argument is the alias to be removed.

./om-compose.sh start-agent "<server args,
starting with servername>" <optional:debug port>
<optional:suspend option, Y or y>
Run agent server in debug mode.
  • First and second arguments are mandatory.
  • If the <debug port> argument is not provided, debugging is not enabled.
  • If debug port is provided, but suspend option argument (Y or y) is not provided, debugging is enabled with suspend=n.
  • If debug port is provided and suspend option is provided as Y or y, debugging is enabled with suspend=y.
For example, to run ScheduleOrder server with additional parameter -jvminstance schedOrdL1, with debug enabled on port 8384, and suspend for debug enabled, run the following command:
./om-compose.sh start-agent "ScheduleOrder 
-jvminstance schedOrdL1" 8384 Y
./om-compose.sh start-intg "<server args,
starting with servername>" <optional:debug port>
<optional:suspend option, Y or y>
Run integration server in debug mode.
  • First and second arguments are mandatory.
  • If the <debug port> argument is not provided, debugging is not enabled.
  • If debug port is provided, but suspend option argument (Y or y) is not provided, debugging is enabled with suspend=n.
  • If debug port is provided and suspend option is provided as Y or y, debugging is enabled with suspend=y.
Note: The logs for each command that is run are present in the compose/logs directory.

Docker Compose command references for IBM Sterling Call Center

If you want to use Sterling Call Center, you can run the ./cc-compose.sh command with arguments to suit your requirements. For example, ./cc-compose.sh <arguments>

The following table provides the list of commands and arguments to run cc-compose.sh:
Command Description
./ cc-compose.sh start
./ cc-compose.sh stop
./ cc-compose.sh restart
Starts, stops, and restarts Sterling Call Center containers.

The Sterling Call Center containers are:

  • om-call-center-ext and
  • om-call-center-base

Steps to follow if your host machine is restarted or rebooted

  1. After the host machine is restarted, make sure Docker and Docker Compose are running. Run the following command to make sure that Docker is running. If it returns your containers in the exit state, follow step 3. Otherwise, follow step 2.
    docker ps -a
  2. If Docker is not running, run the following command as super user:
    systemctl start docker

    Additionally, you can permanently enable Docker by running the following command as super user:
    systemctl enable docker

  3. Go to the devtoolkit_docker/compose/ directory and run the following command:
    ./om-compose.sh start
    Note: If you are using IBM® Sterling Call Center, run the ./cc-compose.sh start command.
    Important: If your developer toolkit is running in a Windows WSL 2 environment, the localhost is your WSL 2 system. Instead of the systemctl command, you must run the following command as super user to start Docker:
    sudo service docker start

    You must either run this command every time your WSL 2 system restarts or you can set this at the fstab level, which will then start and enable Docker every time your WSL 2 system restarts.