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.
An orderhub extensions container is also included in the toolkit. With this container, you can access the Order Hub user interface locally.
An Order Service image is also included in the toolkit. You need to enable Order Service to deploy along with Sterling Order Management System Software. After this, configure both Sterling Order Management System Software and Order Service as per your requirements to save orders automatically in your local Order Service instance and search or access them by using the search and retrieve APIs in Order Service.
Review the values in the default Docker Compose properties file and modify values as needed. For Sterling Order Management System Software (On Prem), you might want to enable or change some additional properties. For more information, see Overriding the default docker compose properties.

Procedure

Extract the developer toolkit environment setup files.
1. Navigate to the directory where the devtoolkit_docker.tar file is downloaded.
2. Run the following command to extract the developer toolkit environment setup files.
```
tar -xf devtoolkit_docker.tar && chmod +x devtoolkit_docker/compose/*.sh
```
Run the following command to set up the developer toolkit environment:
```
./om-compose.sh setup optional: full_path_to_customization_package
```
- 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.
- By default, the Order Service deployment is disabled. If you want to deploy Order Service along with Sterling Order Management System Software applications, you must override the default docker compose properties. However, you can skip Order Service installation at the time of initial setup, and install it later by using the upgrade command.
- By default, Order Hub is enabled. If you want to disable Order Hub, set ORDERHUB_ENABLE to N.
  For more information about the properties, see Overriding the default Docker Compose properties.
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 one 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 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
```
3. Access Order Hub by using the following URL:
```
https://<HOST>:<OH_BASE_HTTPS_PORT>/order-management/
```
  - <HOST> is localhost, or the host on which the containers are running.
  - The default port is 7443 unless you set the OH_BASE_HTTPS_PORT property in the om-compose.properties file.
  - For example,
```
https://localhost:7443/order-management/
```
  Note:
  - To view the features in Order Hub, you need to add users, including admin, to a user group that has permissions to Order Hub. For more information, see Adding users.
  - Some features in Order Hub are not enabled by default. For more information about how to enable these features, see Configuring Order Hub.
4. Access Order Service by using the following URL:
```
http://<HOST>:<ORDERSERVICE_PORT>/default/v1/orderservice
```
  - <HOST> is localhost or the host on which the containers are running.
  - <ORDERSERVICE_PORT> is 8080, unless you override it in the devtoolkit_docker/compose-orderservice/docker/orderservice-docker-compose.properties file.
    
    Note: Order Service does not have a user interface. It is a collection of APIs. These APIs are built on GraphQL, which is an API technology that meets the demanding requirements of contemporary front-end applications. You can use GraphQL Playground, which is an interactive tool to view the documentation for the Order Service schemas, types, and APIs.
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.
- Copies the Order Hub code from the om-orderhub-ext Docker container to your devtoolkit_docker directory on the host system. Any existing Order Hub code directory is renamed with a timestamp and not deleted.
Tip:
- Your runtime directory on the host machine is full path to devtoolkit_docker/runtime.
- Your Order Hub code directory on the host machine is full path to devtoolkit_docker/orderhub-code.
Within the developer toolkit, you also have access to Sterling Store Engagement (Next-generation). If isf or Sterling Store Engagement (Next-generation) is enabled, after the application is successfully deployed you can access Sterling Store Engagement (Next-generation) by using the following URL:
https://<HOST>:<HTTPS_PORT>/isf/store/index.html

What to do next

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