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.

Procedure

  1. 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.

      For more information about the properties, see Overriding the default Docker Compose properties.

  2. 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

  3. 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.
    1. Access the URL: http://IP address: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 system 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 by using the URL: http://IP address: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.
    Tip: Your runtime directory on the host machine is full path to devtoolkit_docker/runtime.

What to do next

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