Setting up the containerized developer toolkit environment

An SI can perform a clean setup of the containerized developer toolkit environment on a local system.

Before you begin

Every file or command that is mentioned in the Docker Compose documentation is relative to the devtoolkit_docker/compose directory unless mentioned otherwise.
Run logs are available in the logs directory. Older logs are backed up in the logs/backups directory.
Review the values in the default Docker Compose properties file and modify values as needed. For more information, see Overriding the default docker compose properties.
To add developer toolkit-specific functional properties, see Overriding functional properties with developer toolkit-specific values.

Procedure

Setting up the developer toolkit environment video

Watch this video to understand the developer toolkit environment in a snapshot.

After you extract the developer toolkit, you can proceed to set up the developer toolkit environment. This procedure is applicable to users who are setting up the developer toolkit for the first time or want to set up a clean developer toolkit after getting rid of the existing developer toolkit environments completely.

If you want to upgrade your existing developer toolkit environment, the following procedure is not applicable. For more information about upgrading, see Upgrading an existing containerized developer toolkit environment.

Attention: Review the following points before you run the command to set up the developer toolkit environment:

This command also performs a wipe-clean to erase any existing Docker container or volume data.
By default, the command assumes that you are setting up the developer toolkit environment from scratch with the default configurations. You need not override or change any property in the om-compose.properties file for general use cases. Each property already assumes a default value. For advanced usage, you can uncomment a property and change the default value to override it as required.
However, if you are setting up the developer toolkit on macOS, you must override the HOST_OS and JAVA_HOME properties.

For more information about the properties, see Overriding the default Docker Compose properties.
If you have installed the devtoolkit_extras.tar file as explained, the setup process by default installs the Sterling™ Intelligent Promising Inventory Visibility adapter phase 2.
If you want to enable V2 APIs in the developer toolkit Inventory Visibility tenant, ensure that the V2 APIs are enabled in your Inventory Visibility tenant. To enable the V2 APIs in the developer toolkit, set the IV_V2_ENABLE=Y property in the om-compose.properties file.

To install Sterling Intelligent Promising Inventory Visibility adapter phase 1 instead, see Installing developer toolkit with Sterling Intelligent Promising Inventory Visibility phase 1 adapter. For more information, see Inventory service.

Run the following command to set up the developer toolkit environment:
```
./om-compose.sh setup optional: full_path_to_customization_package
```
After you run the setup command you are prompted to read and accept the developer toolkit license. To accept the license that is displayed on the screen, press Enter and type accept.
If you have already read and accepted the license, and want to run the setup without any prompt, you can add the following property to om-compose.properties:
DTK_LICENSE=accept
The setup finishes in approximately 1 hour. All logs are generated in the logs directory. After the setup is complete, verify your installation by accessing the applications. The default login name is admin and password is password.
1. Access the following URL to verify the deployment of IBM® Sterling Business Center:
```
http://<HOST>:<Port>/sbc/sbc/login.do
```
  - <HOST> is localhost, or the host on which the containers are running.
  - Port is either 9080(http) or 9443(https), unless you set the port in the om-compose.properties file.
2. Access the API tester by using the following URL:
```
http://<HOST>:<Port>/smcfs/yfshttpapi/yantrahttpapitester.jsp
```
The setup command also copies the runtime from the om-runtime Docker container to your devtoolkit_docker directory on the host system. Any existing runtime directory is renamed with a timestamp and not deleted.
Note: Your runtime directory on the host machine is full path to devtoolkit_docker/runtime.

Important: If you have set up your developer toolkit in a Windows environment, in the URLs to access various UI applications, such as Applications Manager, IBM MQ console and so on from your Windows system, instead of localhost, you must use the IP address of your WSL 2 system. To use localhost, you must forward the relevant ports on which these services are running to the IP address of your WSL2 system. For more information, see Prerequisites for setting up containerized developer toolkit on a Windows environment.
Optionally, you can check the connectivity to your Sterling Intelligent Promising Inventory Visibility and Sterling Intelligent Promising Inventory Visibility instances on cloud from your developer toolkit at any time by running the following command:
./om-compose.sh check-services
Start the following integration servers from the <extracted runtime directory>/bin directory so that your inventory updates can flow from your local instance to the Sterling Intelligent Promising Inventory Visibility instance on cloud:
- bash ./startIntegrationServer.sh IV_ADJUST_IS
- bash ./startIntegrationServer.sh IV_ADJUST_ID
Note: The integration servers use the IV_DEMAND_EVENT_Q and IV_SUPPLY_EVENT_Q messaging queues. It is recommended to use these queues only for integration purposes.

What to do next

If you want to import CDT data after the setup, see Importing configurations by using Configuration Deployment Tool (CDT)Importing configurations by using Configuration Deployment Tool (CDT).