Overriding the default docker compose properties

You need not override or change the default developer toolkit property for general use cases. This is because, each property already assumes a default value.

For advanced usage or requirements, such as enabling Order Service deployment, create a copy of the om-compose.properties.sample file, name it as om-compose.properties, uncomment one or more properties and change the default value to override it as required.

For information about the properties, refer the following table:

Table 1. om-compose.properties
Property Default value Description
DTK_LICENSE blank Set this to accept if you have already read the license and accepted it and want to run the setup without any prompt.
DB_CHOICE db2 To install the developer toolkit on your PostgreSQL database, set the value to postgres.
AP_WAR_FILES smcfs,sbc,sma,isccs,isf The list of applications that you want to build.

For the default value, the Sterling Application Console, Sterling Business Center, System Management Administrator, and IBM® Sterling™ Call Center, and Sterling Store Engagement 2.0 applications are built one after another.

To build the WAR file for the IBM Sterling Call Center next-generation application, add icc to the list of default values.
DB_PORT
  • 50000 for Db2
  • 5432 for postgres

Change the value of these properties, if other services are running on the same port. Ideally, you must stop any natively running Db2, postgres, Websphere Application Server, Liberty or MQ application services before running the setup. In that case, you need not change the values of these properties.
MQ_PORT 1414
AP_HTTP_PORT 9080
AP_HTTPS_PORT 9443
AP_DEBUG_PORT 8383 By default, you can debug the application server in the compose environment through the 8383 port. If the default port is already in use, or for any other reason, you can enable debugging through a different port.
To enable debugging through a different port, complete the following steps:
  1. Set the value of the AP_DEBUG_PORT property to the required port.
  2. Navigate to the /docker/appserver/ directory and open the jvm.options file to edit.
  3. Change the value of address in the -Xrunjdwp JVM option to the port set for AP_DEBUG_PORT.
ORDERHUB_ENABLE Y For Sterling Order Management System Software (On Premises), set to N if you do not want to deploy a local instance of the Order Hub user interface.
Important: If you are subscribed to Sterling Order Management System (SaaS), see Overriding the default Docker Compose properties (SaaS). Configurations for SaaS are different.
ORDERHUB_MODE oms Set to oms to enable the Sterling Order Management System Software (On Premises) version of Order Hub.
Important: If you are subscribed to Sterling Order Management System (SaaS), see Overriding the default Docker Compose properties (SaaS). Configurations for SaaS are different.
AP_HOST localhost This property is applicable to Sterling Order Management System Software (On Premises) only.
Change the value if your application server is not running on localhost. For example, 
AP_HOST=mymachine.mydomain.com
Note: If you previously ran om-compose setup or om-compose setup-upg before changing the AP_HOST property, then update the property and run the following command.
om-compose.sh setup-orderhub

HOST_ARCH

amd64

The architecture platform for images that are used in the DTK. If you are installing the DTK on a machine with arm64-based Apple Silicone chipset, such as Apple M1, set the value to arm64.
OH_EXT_HTTPS_PORT 8443 Change the value if other services are running on the same port.
OH_BASE_HTTPS_PORT 7443 This property is applicable to Sterling Order Management System Software (On Premises) only.

Change the value if other services are running on the same port.
SBA_ENABLE N This property is applicable to Sterling Order Management System Software (On Premises) only.
Set the value to Y if you want Workspaces, Node, and Store Manager Dashboard Metrics enabled (SBA).
Note: If you previously ran om-compose setup or om-compose setup-upg before changing the property to Y, then update the property and run the following command.
om-compose.sh update-extn
MULTISCHEMA_ENABLE N Set this property to Y to enable multischema mode in developer toolkit environment.
Table 2. om-compose.properties, to be set particularly for Order Service
Property Default value Description
ORDERSERVICE_ENABLE N

This property is applicable only for Sterling Order Management System Software (On Premises).

Set the value to Y to deploy a local Order Service instance in the developer toolkit environment.

If you want to deploy Order Service along with Sterling Order Management System Software, set the value to Y before deploying developer toolkit.

However, you can set this later, as well, and deploy Order Service using the setup upgrade command on om-compose script. Similarly, if you ran the setup command or setup upgrade command before changing the property to Y, then update the property and run the setup upgrade command again to deploy Order Service.

You can run the following setup upgrade command on om-compose scripts:

./om-compose.sh setup-upg
SIM_IV_ENABLE Y The default value of this property is not applicable for Sterling Order Management System Software (On Premises). Set the value to N for proper functioning of the Order Service instance.
Table 3. devtoolkit_docker/compose-orderservice/docker/orderservice-docker-compose.properties
Property Default value Description
ORDERSERVICE_PORT 8080 This property is applicable for Sterling Order Management System Software (On Premises) only. If any other services are running on the default port, then change the value.
ELASTICSEARCH_IMAGE_NAME docker.elastic.co/elasticsearch/elasticsearch:7.17.9 This property is applicable only for Sterling Order Management System Software (On Premises). The other version of Elasticsearch server that the Order Service application supports is 8.14.3. If there is any requirement to deploy Order Service with Elasticsearch server 8.14.3, set the property to the image tag of 8.14.3, which is docker.elastic.co/elasticsearch/elasticsearch:8.14.3