DIY model

Docker Compose command arguments

Various Docker Compose command arguments are supported in the development environment.

For the advanced use of developer toolkit environment by using the Docker Compose script, run the ./om-compose.sh command with appropriate arguments as needed for your business. For example, ./om-compose.sh <arguments>

The following table describes the supported command arguments:
Table 1. Docker Compose command arguments
Arguments Description
./om-compose.sh setup <full_path_to_custom jar> To set up a the developer toolkit environment by using the Docker Compose script for the first time. Optionally, it deploys the customization JAR.
./om-compose.sh setup-upg <full_path_to_custom_jar> To upgrade an existing the developer toolkit environment by using the Docker Compose script with new images (upgrade). Additionally, it deploys the customization JAR provided, though its optional. This is similar to the setup argument, but runs load FC and load views in the ‘upgrade’ mode.

Before you run the 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.

./om-compose.sh update-extn <full_path_to_cust_jar> To update an existing environment with just the customization package, without fetching new images. For more information, see Updating custom extensions in the developer toolkit environment by using the Docker Compose script.
./om-compose.sh extract-rt <full_path_to_host_runtime_parent_directory> Extracts runtime to the host machine directory passed in the argument. You can create a copy of your 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>
Start, stop and restart 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 dangling volumes. 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 application setup.
./om-compose.sh update-mq-bindings <queue_name> Update MQ bindings file for the queue that you recently created.
./om-compose.sh import-cert <arg1> <arg2> Imports third-party certificates that considers the following arguments:
  • The first argument is the full path to the certificate.
  • The second argument is the alias.
Note: The Run logs for each command are present in the compose/logs directory.