This section shows the guidance to prepare the mapping of your Operator deployment properties, so you can reuse them in your Helm deployment.
Warning
The Operator-based to Helm-based migration is a strict side-by-side migration.
Note
Operator-based deployments are not supported from CF200 onwards.
This section outlines the needed steps to configure your new Helm-based deployment with your old Operator-based deployment configuration settings. Once you have extracted the needed data, and have shut down your Operator-based deployment, you can apply your exported data in your new Helm-based deployment. Note that you are not migrating your DX Core database as you will reuse the same database instance in your Helm-based deployment.
As with any migration activity, we recommend that you make backups of the data of your current environment before proceeding. See Backup and recovery procedures for more information.
You must have the properties file you used with dxctl in your old Operator deployment. If you do not have the properties file, refer to the dxctl topic to extract the properties file from your existing deployment using the getProperties function.
Ensure to prepare any other needed infrastructure-related items (like persistent volumes, Kubernetes load balancer configuration, etc.) before proceeding with migration to Helm.
Optionally, you can perform a test deployment to make sure that all prerequisites and requirements for the Helm deployment are met. Follow the Helm installation steps and check if all the functionality of the default deployment is accessible. If you do not prefer to do an initial test, you can skip to start with the Core and DAM migration immediately.
Before migrating to Helm, you must migrate the configuration of your Operator-based deployment first. Follow this guidance to prepare the property mappings for your HCL DX 9.5 Operator-based deployment. You can reuse the values from your deployment.properties file in your new custom-values.yaml.
Property mappings
This section lists the mapping of the dxctl deployment.properties file with the custom-values.yaml.
Note
You should only transfer settings that you have adjusted for your Operator deployment. It is not recommended to overwrite all Helm defaults with the defaults of the old Operator deployment. Only migrate settings that are relevant for you, or those that have been adjusted by you prior deploying the Operator with dxctl.
dxctl deployment.properties
custom-values.yaml
Description
dx.namespace
Not applicable
The namespace used for the deployment. This is handed directly to Helm through the command line interface.
dx.name
Not applicable
The deployment name. This is handed directly to Helm through the command line interface.
default.repository
images.repository
Defines the image repository for all container images.
dx.pullpolicy
images.pullPolicy
Defines the image pull policy for all container images.
<application>.image
images.name.<application>
Name of the container image.
<application>.tag
images.tag.<application>
Name of the container tag.
<application>.enabled
applications.<application>
Enables or disables specific applications.
dx.pod.nodeselector
nodeSelector.<application>
NodeSelector used for pods, can now be done per application in Helm
dx.config.authoring
configuration.core.tuning.authoring
Selects if the instance is tuned for authoring or not.
composer.enabled
applications.contentComposer
Selects if Content Composer is deployed or not.
dam.enabled
applications.digitalAssetManagement
Selects if Digital Asset Management is deployed or not.
persist.force-read
Not applicable
Read-only fallback enablement. This is always enabled in Helm.
dxctl deployment.properties
custom-values.yaml
Description
dx.volume
volumes.core.profile.volumeName
The name of the volume used for the DX core profile.
dx.volume.size
volumes.core.profile.requests.storage
Size of the volume used for the DX core profile.
dx.storageclass
volumes.core.profile.storageClassName
StorageClass of the volume used for the DX core profile.
dx.splitlogging: false
Not applicable.
Defines if the log directory uses a separate volume. This is always enabled in Helm.
dx.logging.stgclass
volumes.core.log.storageClassName
StorageClass for the DX core logging volume.
dx.logging.size
volumes.core.log.requests.storage
StorageClass for the DX core logging volume.
dx.tranlogging
Not applicable.
Defines if the transaction log directory uses a separate volume. This is always enabled in Helm.
dx.tranlogging.reclaim
Not applicable.
Reclaim policy for DX core transaction log volume. Determined by PV instead of Helm
dx.tranlogging.stgclass
volumes.core.tranlog.storageClassName
StorageClass for the DX core transaction log volume.
dx.tranlogging.size
volumes.core.tranlog.requests.storage
Size used for the DX core transaction log volume.
remote.search.volume
volumes.remoteSearch.prsprofile.volumeName
Name of the volume used for the DX Remote Search profile.
remote.search.stgclass
volumes.remoteSearch.prsprofile.storageClassName
StorageClass of the volume for the DX Remote Search profile.