Docker Compose commands reference
You can run the ./om-compose.sh command with arguments to suit your requirements. For example, ./om-compose.sh <arguments>.
||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.|
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
For more information, see Upgrading an existing containerized developer toolkit environment.
||Updates an existing environment with just the customization package, without fetching new
Also, integrates developer toolkit with Cloud services, such as Sterling Inventory Visibility and Store Engagement.For more information, see Update custom extensions in containerized developer toolkit environment.
||Tests connectivity to integrated Cloud services, such as Sterling Inventory Visibility and Store Engagement.|
Extracts runtime contents to the devtoolkit_docker/runtime directory in the host machine.
You can create a copy of your Sterling Order Management 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.
||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
||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 Order Management setup.
||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.|
||Deletes the specified local queue on the MQ server and also updates the MQ .bindings file.|
||Imports third-party certificates.
It considers the following arguments:
||Removes third-party certificates.
The first argument is the alias to be removed.
||Run agent server in debug mode.
For example, to run
||Run integration server in debug mode.
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>
||Starts, stops, and restarts Sterling Call Center containers.
The Sterling Call Center containers are:
Steps to follow if your host machine is restarted or rebooted
- 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
- If Docker is not running, run the following command as super
systemctl start docker
Additionally, you can permanently enable Docker by running the following command as super user:
systemctl enable docker
- Go to the devtoolkit_docker/compose/ directory and run the following
./om-compose.sh startNote: 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
localhostis your WSL 2 system. Instead of the
systemctlcommand, 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
fstablevel, which will then start and enable Docker every time your WSL 2 system restarts.