Setting up a containerized toolkit environment

To set up the developer toolkit environment by using the Docker Compose script, a developer can download the developer toolkit files and then run the Docker Compose script.

1. Download and extract the developer toolkit files.
   1. Create a specific directory devtoolkit_docker, where you want to set up your developer toolkit environment by using the Docker Compose script.
      Warning: Choose the path where you create the devtoolkit_docker directory wisely. If you intend to upgrade this environment later with a new runtime image, you will not be able to change this directory then.
   2. Copy or download the <runtime>/docker-samples/compose to the devtoolkit_docker directory, where <runtime> is your installation directory that is created when installing Sterling Order Management System Software in Docker mode. Refer Installing Sterling Order Management System Software in Docker mode.
   3. Copy or download the Sterling Order Management System Software Docker image built from your runtime directory that is created when installing Sterling Order Management System Software in Docker mode.
   4. Run the following command to change the directory and be able to run the compose scripts
      cd devtoolkit_docker/compose && chmod +x *.sh
2. Run the following command to set up the developer toolkit environment by using the Docker Compose script.
   ./om-compose.sh setup <optional: full_path_to_customization_package>
   Before you run the setup, note the following points:

   • If you are retrying the setup, to start with a clean slate, ensure that all your old container or volume data are cleaned up using the following command:
     ./om-compose.sh wipe-clean
     Note: Since the command erases all existing data and configurations, do not run this if you are upgrading your developer toolkit environment by using the Docker Compose script.
   • If you have a customization package, provide the full path as the argument to the command as mentioned in step 2, to include the customizations as part of the setup.
   • By default, the command assumes that you are setting up the developer toolkit environment by using the Docker Compose script from scratch with the default configurations. If you want to change or override the default configurations, update the om-compose.properties file as required. For information about the properties, refer the following table:

     Table 1. om-compose.properties

     Property	Default Value	Description
     AP_WAR_FILES	smcfs,sbc,sma,isccs,wsc,sfs	The applications that are installed by default. By default, all applications are part of your EAR. Remove any application that is not part of your EAR.
     OM_INSTALL_LOCALIZATION	false	Set it to true, if you need to install locales and localization packages.
     OM_LOCALES	blank	The following locales are supported: zh_CN, zh_TW, fr_FR, ja_JP, pt_BR, ko_KR, ru_RU, tr_TR, it_IT, es_ES, de_DE, pl_PL Set the property value to only those locales that you want to install.
     *_PORT		All properties containing _PORT. Change the value of these properties, if other services are running on the same port. Ideally, you must stop any natively running Db2, Websphere Application Server, Liberty or MQ application services, before running the setup. Therefore, you need not change the values of these properties.
     MQ_JNDI_DIR	/var/oms/jndi	Local directory to store the MQ .bindings file, which stores JNDI mapping of all MQ objects. If default value is retained, make sure that this directory is created and has write permissions. Otherwise, override this value to a local directory. For example, /home/user/jndi

     Note:

     The table only lists properties from om-compose.properties file. These are the properties that customers may likely override. However, the full list of properties including the above properties are provided in the docker/docker-compose.properties file. Customers can override any property from this file as well in the om-compose.properties file.

     There are a bunch of properties related to using external database, which are commented in the om-compose.properties file . You can un-comment and override them to set up an external database (Oracle/Db2) for your use.

   Notes:

   • Every file or command mentioned in the Docker documentation is relative to the compose directory.
   • Run logs are available in the logs directory.
3. After running the setup command, you are prompted to read and accept multiple licenses. To accept the licenses that are displayed on the screen, press Enter or type accept as required.
4. The setup finishes in approximately 30 minutes to 1 hour. All logs are generated in the logs directory.
   Once setup finishes, verify your installation by accessing the applications.

   1. Access the URL: http://<IP>:<Port>/sbc/sbc/login.do to verify the deployment of Sterling Business Center. Similarly, you can try accessing other applications.

      Here, IP is the IP address of the machine where environments are deployed (localhost if deployed locally), and port is either 9080(http) or 9443(https), unless they are overridden by you.

   2. Access the API tester using the URL: http://<IP>:<Port>/smcfs/yfshttpapi/yantrahttpapitester.jsp