Skip to content

Updating IQ

This section explains how to update IQ and its integration with an HCL Digital Experience (DX) container deployment using Helm.

Important

  • IQ is deployed with the separate hcl-dx-iq Helm chart. The DX integration is configured with the hcl-dx-deployment Helm chart. Update the IQ chart and the DX chart independently.
  • IQ and DX do not need to be on the same version. The supported version difference is up to two releases in either direction, and versions more than two releases apart are not supported.

Prerequisites

  • Obtain the hcl-dx-iq Helm chart for the IQ version you want to upgrade to. The chart provides the corresponding IQ images. For more information on the Helm chart and IQ version, refer to Installing IQ and Downloading and deploying HCL products from a Harbor Repository.

  • Confirm that the IQ and DX versions are no more than two releases apart:

    1. List the Helm releases in the namespace:

      helm list --namespace <YOUR_NAMESPACE>

      <YOUR_NAMESPACE>: The Kubernetes namespace.

    2. Use the Helm chart and CF versions table to identify the CF version associated with each chart version.

    3. Confirm that the target IQ chart is available in your repository. For instructions, refer to Deploying the IQ backend components.

  • Back up IQ data and the database associated with the Core deployment before applying an update. For more information, refer to Backing up and restoring data.

Note

Keep all existing deployment settings in your custom-iq-values.yaml file. An upgrade applies the values supplied with the command and can overwrite settings that are omitted or changed.

Recovering missing values files

If the original values files were not received or are no longer available, retrieve the current values stored in the IQ Helm release before upgrading:

helm get values dx-iq --namespace <YOUR_NAMESPACE> --all > current-iq-values.yaml

<YOUR_NAMESPACE>: The Kubernetes namespace.

  • Review and update this file rather than starting with an empty values file.
  • Preserve environment-specific settings, credentials references, networking, database, image, and storage values.
  • Redact secrets before sharing the file.

Updating the IQ chart

  1. Update your custom-iq-values.yaml file with the supported IQ chart configuration.

    Note

    Do not change IQ image tags. The selected chart supplies the compatible images.

  2. Upgrade the separate IQ release:

    helm upgrade dx-iq \
  <IQ_CHART_URL_OR_PATH> \
  --namespace <YOUR_NAMESPACE> \
  --values custom-iq-values.yaml
    • <YOUR_NAMESPACE>: The Kubernetes namespace.
    • <IQ_CHART_URL_OR_PATH>: The location of the IQ Helm chart package.

  3. Verify both IQ services:

    helm status dx-iq --namespace <YOUR_NAMESPACE>
kubectl rollout status deployment/dx-iq-integrator --namespace <YOUR_NAMESPACE>
kubectl rollout status deployment/dx-mcp-server --namespace <YOUR_NAMESPACE>

Verifying the IQ deployment

  1. After the upgrade, confirm that the IQ services are healthy and responding:

    helm status dx-iq --namespace <YOUR_NAMESPACE>
kubectl rollout status deployment/dx-iq-integrator --namespace <YOUR_NAMESPACE>
kubectl rollout status deployment/dx-mcp-server --namespace <YOUR_NAMESPACE>

    <YOUR_NAMESPACE>: The Kubernetes namespace.

  2. Confirm that IQ opens, connects to the backend, and returns a response.

Cross-version support

IQ and DX Core are delivered through separate Helm charts and can be upgraded independently. To support this deployment model, IQ and DX Core support each other within a two cumulative fix (CF) release window (the current release and the two preceding releases). This support applies to both DX Core and DX Compose (WebEngine) deployments.

The DX Model Context Protocol (MCP) Server detects the underlying DX Core version and uses a tools matrix to expose only the MCP tools supported by that version. This enables an IQ deployment to adapt its available operations to the connected DX Core version. The IQ user interface also resolves web component interface-property changes across supported versions. This supports adding, renaming, and removing properties when the UI and DX Core versions differ.

Important

Keep the IQ and DX Core versions within two CF releases of each other. Combinations outside this n-2 support window are not supported.

Related information