The Docker Compose deployment env.sh configuration file

After HCL Commerce 9.0.1.18, all deployment configuration and environment configuration for the Docker Compose deployment method is made within the env.sh configuration script. Beginning with HCL CommerceThis deployment method can also be used to aid in the deployment of an HCL Commerce Developer installation for development of the Elasticsearch-based search solution, or other HCL Commerce Version 9.1 solution.

The env.sh configuration file

The env.sh configuration script contains all deployment environment and topology configurations for the Docker Compose deployment method.

It is recommended to maintain different copies of the environment file for each deployment configuration. For example, you can have env.sh.auth, env.sh.live, env.sh.data for auth, live and data deployments respectively.

This makes follow-up deployments and tear downs significantly easier.

You must, however, rename the corresponding file for each deployment to env.sh before running the deploy script (step #3 of the deployment). This is also true of the teardown script that is used to bring down a running deployment.

env.sh configuration overview

Deployment section

This section defines the deployment configuration parameters that define the applications that are included.

  • DEPLOY_TYPE controls whether the deployment is for the HCL Commerce application, the Elasticsearch-based Search platform, or the required containers for an HCL Commerce Developer installation.

    Accepted values are commerce, data, or .

  • SEARCH_ENGINE defines the search engine that is used by HCL Commerce.

    Accepted values are solr, or elasticsearch.

    These values define the search infrastructure and search configuration for the deployment. This configuration and infrastructure also depends on the ENV_TYPE parameter.

License section

This section defines the license acceptance requirement, LICENSE_ACCEPTED, that is required for HCL Commerce to operate.

Common section

This section defines the HCL Commerce environment and server host information.

ENV_TYPE defines the HCL Commerce environment type for the deployment. The primary impact of this within the deployment context is the database that is used, as well as how the search infrastructure is configured to be queried.

Accepted values are auth for an authoring environment, and live for a live environment.

You can deploy an authoring environment to explore the full functionality of HCL Commerce, or both an authoring and live environment to explore and experiment with the non-production to production publishing capabilities that this advanced production deployment topology provides.

Database section

This section defines the database connection information that is used by the HCL Commerce deployment.

Application sections

These sections includes application specific configurations. Each Docker image and its tag can be defined within its corresponding application configuration section.

Integration sections

Additional configuration is required. For more information on IBM MQ integration, see Integrating IBM MQ with HCL Commerce.