Home
Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
Installing and deploying
Learn how to install and deploy HCL Commerce development environments and HCL Commerce production environments.
Updating HCL Commerce
Learn about HCL Commerce release types, and learn how to update your custom HCL Commerce site deployments.
HCL Commerce production environment
Releases for HCL Commerce Version 9.1 production environments are delivered as new Docker images. Releases can include code fixes, security fixes, new features, or enhancements.
Migrate to a new Ingress or gateway controller
Migrate from Community NGINX to F5 NGINX or Envoy Gateway to maintain supported traffic management.

Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
- Getting started
  HCL Commerce has different advantages for business users, administrators and developers. HCL Commerce targets each of these roles with a tailored set of offerings so that each of your users can get maximum benefit.
- Installing and deploying
  Learn how to install and deploy HCL Commerce development environments and HCL Commerce production environments.
  - HCL Commerce eAssemblies
    Verify downloads for completeness and authenticity using the tables that summarize the HCL Commerce electronic assemblies (eAssemblies), file names, and MD5 checksum values.
  - Downloading software
    To set up an HCL Commerce production, development, or test environment, you require the associated product software images.
  - Supported software levels, fixes, and settings
    The following table provides a list of generally available (GA) software levels, fixes, and settings for the latest HCL Commerce Version 9.1 release.
  - Hardware requirements
    The following reference provides a general guideline for the hardware capacity that is required for the HCL Commerce Version 9.1 release. This includes both full development and production environments for sites that are based on different sets of HCL Commerce solutions.
  - Setting up HCL Commerce environments
    Learn how to set up development, testing, and production environments, and how to update the production environment through deploying custom changes and applying maintenance.
  - Deploying custom changes
    With HCL Commerce Version 9.1, you can customize HCL Commerce Docker image with the source code, configurations, and the Docker container start-up logic. Learn how to build Docker images with your customized code and deploy the images (and other changes) to your Docker containers.
  - Updating HCL Commerce
    Learn about HCL Commerce release types, and learn how to update your custom HCL Commerce site deployments.
    - HCL Commerce production environment
      Releases for HCL Commerce Version 9.1 production environments are delivered as new Docker images. Releases can include code fixes, security fixes, new features, or enhancements.
      - Updating Docker images with new HCL Commerce releases
        Updates for HCL Commerce runtime environments are delivered in releases as new Docker images. To update your runtime environment, you must download the new images, rebuild your custom images to include your custom code, and then deploy new containers.
      - Updating the database to the latest database schema
        As part of applying an update package, you need to update your database to ensure that your environment database supports any changes to the database schema.
      - Deploying updated Docker images with Docker Compose
        Updates for HCL Commerce production environments are delivered as Docker images. To update your production environment: download newer release images, and rebuild them as custom images to include your custom code. You then deploy the custom containers.
      - Deploying updated Docker images with Kubernetes
        Updates for HCL Commerce production environments are delivered as Docker images. To update your production environment, download the new images, and rebuild them as custom images to include your custom code. You then deploy the custom containers. Migrate to a new ingress or gateway controller (Version 9.1.20.0 and later) Because standard Nginx is no longer supported, you must migrate to a different ingress or gateway controller to ensure environment stability and security.
      - Migrate to a new Ingress or gateway controller
        Migrate from Community NGINX to F5 NGINX or Envoy Gateway to maintain supported traffic management.
      - Updating IBM software in HCL Commerce images
        Important IBM software updates for HCL Commerce production environments are delivered in new release Docker images. Use the instructions in this section to apply these updates.
    - HCL Commerce development environment
      Releases for HCL Commerce Version 9.1 environments are delivered as compressed .pak archive file that contain new and changed files. Releases can include code fixes, security fixes, new features, or enhancements.
    - wc-server.xml update
      HCL Commerce tracks default changes to the wc-server.xml configuration. This information helps you understand updates to application performance, caching, and request handling.
    - Updating the IBM Installation Manager
      You can update IBM Installation Manager without uninstalling any packages you have already installed.
  - Deploying Orchestration
    The following is an overview of the build and deployment process for the Orchestration service, using Docker, Kubernetes, and Helm, focusing on the specific configurations required during the build process.
- Migrating
  Before you migrate to HCL Commerce Version 9.1, review this information to help plan and execute your migration.
- Operating
  Topics in the Operating category highlight tasks that are typically performed by business users, customer support representatives, to complete their day-to-day tasks in the operation of the HCL Commerce site.
- Integrating
  Topics in the Integrating category highlight the tasks that are commonly performed for using HCL Commerce in combination with other products.
- Administering
  Topics in the Administering category highlight tasks that are typically performed by the Site Administrator, to support daily operations of the HCL Commerce site.
- Customizing
  The topics in the Customizing section describe tasks performed by an application developer to customize HCL Commerce.
- Tutorials
  HCL Commerce provides many tutorials to help you customize and understand your HCL Commerce instance and stores.
- Samples
  Topics in the Samples category highlight the various samples that are provided with HCL Commerce.
- Compliance
  The following section describes how you can leverage HCL Commerce features and functionality to help your site be compliant with different privacy and security standards.
- Securing
  These topics describe the security features of HCL Commerce and how to configure these features.
- Performance
  Topics in the Performance section describe the means by which to plan, implement, test, and re-visit the optimization of HCL Commerce site performance.
- Troubleshooting
  Topics in the Troubleshooting section highlight common issues that are encountered with HCL Commerce, and how they can be addressed or mitigated.
- Reference
  Topics in the Reference section contain all of the HCL Commerce reference documentation.

HCL Commerce Version 9.1.20.0 or later

Migrate to a new Ingress or gateway controller

Migrate from Community NGINX to F5 NGINX or Envoy Gateway to maintain supported traffic management.

Community NGINX is deprecated as of version 9.1.20.0. When you upgrade from an earlier version, you might experience brief downtime for existing Ingress rules because of updated template definitions. To avoid extended outages, run multiple controllers simultaneously during the transition.

Resource naming

To avoid naming conflicts, the Helm chart generates distinct names for each controller:

Community NGINX: Includes community-nginx in the name.
F5 NGINX: Includes f5-nginx in the name.
GKE: Includes gke in the name.

Migration Procedure

Add both the old and new controllers to the ingress.ingressController list.
Verify that traffic shifts to the new controller.
Remove the old controller from the ingress.ingressController list.

Example: Migrating from Community NGINX to F5 NGINX

ingress:
  enabled: true
  ingressController:
    - nginx
    - f5-nginx

  cmc:
    auth:
      domain: cmc.demoqaauth.mycompany.com
      communityNginxClass: ""
      f5NginxClass: ""
    live:
      domain: cmc.demoqalive.mycompany.com
      communityNginxClass: ""
      f5NginxClass: ""

  communityNginxCustomAnnotations: {}
  f5NginxCustomAnnotations: {}

Using Gateway API (Optional): You can also use the Kubernetes Gateway API (such as Envoy Gateway) standalone or alongside Ingress controllers. This configuration uses the Gateway, HTTPRoute, and BackendTLSPolicy resources and is independent of the Ingress section.