Modifying the CR to customize your IBM Master Data Management installation

A custom resource (CR) enables you to configure how the IBM Master Data Management service is installed in your environment. You can tune and customize the installation by modifying the properties of the CR.

This topic documents a subset of the configuration options that you can include in the spec section of the IBM Master Data Management CR (mdm-cr). If you do not specify a value for a property, the default value is used.

IBM Master Data Management provides t-shirt sizing to enable you to scale the service installation up or down. For information about scaling IBM Master Data Management and other services, see Scaling services.

For each IBM Master Data Management microservice, you can change CR options related to resource allocation. When you specify custom values for resource allocation options, those values are applied after any service-level scaling configuration that is in place (such as small, medium, or large). The custom values specified here override the scaling default values.

Important: Changing the default resource configuration has an impact on the performance of the service. Only modify the configuration options if you are certain of your changes. Be prepared to revert your changes if necessary.
Custom resource details
Kind: mdm
Default CR name: mdm-cr

Modifying the CR after installation

You can edit the IBM Master Data Management CR after installing the service.

To edit the value of a single property in the IBM Master Data Management CR (mdm-cr) spec, use the oc patch command.
oc patch mdm mdm-cr --namespace ${PROJECT_CPD_INST_OPERANDS} -p '{"spec":{"parameterName":"parameterValue"}}' --type=merge
To edit the values of multiple properties in the IBM Master Data Management CR (mdm-cr) spec, use the oc edit command. 
oc edit mdm mdm-cr --namespace ${PROJECT_CPD_INST_OPERANDS}

Configuration options

The available configuration options in the CR spec are separated into the sections. There is one section for each IBM Master Data Management microservice.

Data microservice

The following mdm_data CR spec configuration options pertain to the Data microservice of IBM Master Data Management.
Important: Changing the default resource configuration has an impact on the performance of the service. Only use these options if you are certain of your changes. Be prepared to revert your changes if necessary.
Spec field Type Default value Description
mdm_data.autoscaler.behavior.scaleDown.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling down the Data microservice. For example, for the default value Pods, autoscaling down decreases the number of mdm_data pods.
mdm_data.autoscaler.behavior.scaleDown.policies.value Integer 1 The number of resources (such as pods, by default) that are decreased in a single scale-down action for the Data microservice.
mdm_data.autoscaler.behavior.scaleDown.policies.periodSeconds Integer 60 The length of time set aside for the scale-down period for the Data microservice.
mdm_data.autoscaler.behavior.scaleUp.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling up the Data microservice. For example, for the default value Pods, autoscaling up increases the number of mdm_data pods.
mdm_data.autoscaler.behavior.scaleUp.policies.value Integer 1 The number of resources (such as pods, by default) that are increased in a single scale-up action for the Data microservice.
mdm_data.autoscaler.behavior.scaleUp.policies.periodSeconds Integer 60 The length of time set aside for the scale-up period for the Data microservice.
mdm_data.autoscaler.metrics.type String Resource If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the type of metrics that are used to trigger a scale-up or scale-down for the Data microservice.
mdm_data.autoscaler.metrics.resource.name String cpu The type of resource that is measured as the metric of whether to trigger a scale-up or scale-down for the Data microservice.
mdm_data.autoscaler.metrics.resource.target.type String Utilization Defines the measurement target, such as the default, utilization. If the default is also used for the resource.name property, then the measurement target is the percentage of CPU utilization. The threshold to trigger a change is defined in the resource.target.averageUtilization property.
mdm_data.autoscaler.metrics.resource.target.averageUtilization Integer 50 The average Data microservice CPU utilization percentage that:
  • When surpassed, triggers a scale-up.
  • When fallen beneath, triggers a scale-down.
mdm_data.autoscaler.max_replicas Integer 12 The maximum number of replicas for the Data microservice deployment.
mdm_data.autoscaler.min.replicas Integer 3 The minimum number of replicas for the Data microservice deployment.
mdm_data.instrumentation.enabled Boolean false Specifies whether instrumentation is enabled for the Data microservice.
mdm_data.java.heap_memory String 2g The amount of heap memory allocated for the web container of the Data microservice.
mdm_data.log_levels List    
mdm_data.deployment.replicas Integer 3 The number of replicas for the Data microservice deployment.
mdm_data.deployment.resources.limits.cpu Integer 2 The maximum number of CPUs for each main Data microservice container.
mdm_data.deployment.resources.limits.memory String 3Gi The maximum amount of memory for each main Data microservice container.
mdm_data.deployment.resources.requests.cpu String 2 The initial number of CPUs requested for each main Data microservice container.
mdm_data.deployment.resources.requests.memory String 3Gi The initial amount of memory requested for each main Data microservice container.
mdm_data.sample_data_job.directory_limit Integer 4 The maximum amount of directories for each main sample data job container.
mdm_data.sample_data_job.resources.limit.cpu String 1 The maximum number of CPUs for each main sample data job container.
mdm_data.sample_data_job.resources.limit.memory String 2Gi The maximum amount of memory for each main sample job container.
mdm_data.sample_data_job.resources.requests.cpu String 1 The initial number of CPUs requested for each main sample data job container.
mdm_data.sample_data_job.resources.requests.memory String 2Gi The maximum amount of memory for each main sample data job container.
mdm_data.secret_cleanup_cron.date_string_retention_policy String "7 days ago" A mostly free form, human readable date string that specifies how long secrets should be retained. A date string might contain items indicating calendar date, time of day, time zone, day of week, relative time, relative date, and numbers. An empty string indicates the beginning of the day. The date string format is more complex than is easily documented here but is fully described in the info documentation.
mdm_data.secret_cleanup_cron.enabled Boolean false Specifies whether the secret cleanup cron job should be run.
mdm_data.secret_cleanup_cron.schedule String "0 17 * * *" A cron job string signifying how often the cleanup cron job should run.
mdm_data.spark.driver.cpu String "" The number of CPUs requested for the driver pod. The empty string signifies that there is no hard CPU limit for the driver pod.
mdm_data.spark.driver.memory String 2Gi The amount of memory requested for the driver pod.
mdm_data.spark.executor.cpu Integer 1 The number of CPUs requested for each executor pod.
mdm_data.spark.executor.instances Integer 4 The number of executor instances for each Data microservice job.
mdm_data.spark.executor.memory String 2048m The amount of memory requested for each executor pod.
mdm_data.spark.memory_overhead_factor Decimal 0.1 The Memory Overhead Factor that allocates memory to non-JVM memory, including off-heap memory allocations, non-JVM tasks, and various system processes.

Matching microservice

The following mdm_matching CR spec configuration options pertain to the Matching microservice of IBM Master Data Management.
Important: Changing the default resource configuration has an impact on the performance of the service. Only use these options if you are certain of your changes. Be prepared to revert your changes if necessary.
Spec field Type Default value Description
mdm_matching.autoscaler.behavior.scaleDown.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling down the Matching microservice. For example, for the default value Pods, autoscaling down decreases the number of mdm_matching pods.
mdm_matching.autoscaler.behavior.scaleDown.policies.value Integer 1 The number of resources (such as pods, by default) that are decreased in a single scale-down action for the Matching microservice.
mdm_matching.autoscaler.behavior.scaleDown.policies.periodSeconds Integer 60 The length of time set aside for the scale-down period for the Matching microservice.
mdm_matching.autoscaler.behavior.scaleUp.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling up the Matching microservice. For example, for the default value Pods, autoscaling up increases the number of mdm_matching pods.
mdm_matching.autoscaler.behavior.scaleUp.policies.value Integer 1 The number of resources (such as pods, by default) that are increased in a single scale-up action for the Matching microservice.
mdm_matching.autoscaler.behavior.scaleUp.policies.periodSeconds Integer 60 The length of time set aside for the scale-up period for the Matching microservice.
mdm_matching.autoscaler.metrics.type String Resource If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the type of metrics that are used to trigger a scale-up or scale-down for the Matching microservice.
mdm_matching.autoscaler.metrics.resource.name String cpu The type of resource that is measured as the metric of whether to trigger a scale-up or scale-down for the Matching microservice.
mdm_matching.autoscaler.metrics.resource.target.type String Utilization Defines the measurement target, such as the default, utilization. If the default is also used for the resource.name property, then the measurement target is the percentage of CPU utilization. The threshold to trigger a change is defined in the resource.target.averageUtilization property.
mdm_matching.autoscaler.metrics.resource.target.averageUtilization Integer 50 The average Matching microservice CPU utilization percentage that:
  • When surpassed, triggers a scale-up.
  • When fallen beneath, triggers a scale-down.
mdm_matching.autoscaler.max_replicas Integer 12 The maximum number of replicas for the Matching microservice deployment.
mdm_matching.autoscaler.min_replicas Integer 3 The minimum number of replicas for the Matching microservice deployment.
mdm_matching.deployment.replicas Integer 3 The number of replicas for the Matching microservice deployment.
mdm_matching.deployment.resources.limits.cpu String 2 The maximum number of CPUs for each main Matching microservice container.
mdm_matching.deployment.resources.limist.memory String 4Gi The maximum amount of memory for each main Matching microservice container.
mdm_matching.deployment.resources.requests.cpu String 2 The initial number of CPUs requested for each main Matching microservice container.
mdm_matching.deployment.resources.requests.memory String 4Gi The initial amount of memory requested for each main Matching microservice container.
mdm_matching.java.heap_memory String 2g The amount of heap memory allocated for the web container of the Matching microservice.
mdm_matching.performance_tracker.enabled Boolean false Specifies whether performance tracking is enabled.
mdm_matching.performance_tracker.service_time_max Integer 10000 The maximum expected service response time in milliseconds.
mdm_matching.performance_tracker.time_window_start String "00:00:00" The start time for performance tracking during a specified time period.
mdm_matching.performance_tracker.time_window_end String "23:59:59" The end time for performance tracking during a specified time period.

Model microservice

The following mdm_model CR spec configuration options pertain to the Model microservice of IBM Master Data Management.
Important: Changing the default resource configuration has an impact on the performance of the service. Only use these options if you are certain of your changes. Be prepared to revert your changes if necessary.
Spec field Type Default value Description
mdm_model.autoscaler.behavior.scaleDown.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling down the Model microservice. For example, for the default value Pods, autoscaling down decreases the number of mdm_model pods.
mdm_model.autoscaler.behavior.scaleDown.policies.value Integer 1 The number of resources (such as pods, by default) that are decreased in a single scale-down action for the Model microservice.
mdm_model.autoscaler.behavior.scaleDown.policies.periodSeconds Integer 60 The length of time set aside for the scale-down period for the Model microservice.
mdm_model.autoscaler.behavior.scaleUp.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling up the Model microservice. For example, for the default value Pods, autoscaling up increases the number of mdm_model pods.
mdm_model.autoscaler.behavior.scaleUp.policies.value Integer 1 The number of resources (such as pods, by default) that are increased in a single scale-up action for the Model microservice.
mdm_model.autoscaler.behavior.scaleUp.policies.periodSeconds Integer 60 The length of time set aside for the scale-up period for the Model microservice.
mdm_model.autoscaler.metrics.type String Resource If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the type of metrics that are used to trigger a scale-up or scale-down for the Model microservice.
mdm_model.autoscaler.metrics.resource.name String cpu The type of resource that is measured as the metric of whether to trigger a scale-up or scale-down for the Model microservice.
mdm_model.autoscaler.metrics.resource.target.type String Utilization Defines the measurement target, such as the default, utilization. If the default is also used for the resource.name property, then the measurement target is the percentage of CPU utilization. The threshold to trigger a change is defined in the resource.target.averageUtilization property.
mdm_model.autoscaler.metrics.resource.target.averageUtilization Integer 50 The average Model microservice CPU utilization percentage that:
  • When surpassed, triggers a scale-up.
  • When fallen beneath, triggers a scale-down.
mdm_model.autoscaler.max_replicas Integer 12 The maximum number of replicas for the Model microservice deployment.
mdm_model.autoscaler.min_replicas Integer 3 The minimum number of replicas for the Model microservice deployment.
mdm_model.deployment.replicas Integer 3 The number of replicas for the Model microservice deployment.
mdm_model.deployment.resources.limits.cpu String 2 The maximum number of CPUs for each main Model microservice container.
mdm_model.deployment.resources.limits.memory String 4Gi The maximum amount of memory for each main Model microservice container.
mdm_model.deployment.resources.requests.cpu String 2 The initial number of CPUs requested for each main Model microservice container.
mdm_model.deployment.resources.requests.memory String 4Gi The initial amount of memory requested for each main Model microservice container.
mdm_model.java.heap_memory String 2g The amount of heap memory allocated for the web container of the Model microservice.

Configuration microservice

The following mdm_configuration CR spec configuration options pertain to the Configuration microservice of IBM Master Data Management.
Important: Changing the default resource configuration has an impact on the performance of the service. Only use these options if you are certain of your changes. Be prepared to revert your changes if necessary.
Spec field Type Default value Description
mdm_configuration.deployment.replicas Integer 1 The number of replicas for the Configuration microservice deployment.
mdm_configuration.deployment.resources.requests.cpu String 2 The initial number of CPUs requested for each main Configuration microservice container.
mdm_configuration.deployment.resources.requests.memory String 4Gi The initial amount of memory requested for each main Configuration microservice container.
mdm_configuration.deployment.resources.limits.cpu String 2 The maximum number of CPUs for each main Configuration microservice container.
mdm_configuration.deployment.resources.limits.memory String 4Gi The maximum amount of memory requested for each main Configuration microservice container.
mdm_configuration.deployment.termination_grace_period_seconds Integer 90 The length of time, in seconds, taken to shut down a Configuration microservice container gracefully.
mdm_configuration.deployment.strategy.type String RollingUpdate The strategy used to replace old Configuration microservice pods with new ones.
mdm_configuration.deployment.strategy.rolling_update.max_unavailable Integer 25% The maximum percentage of Configuration microservice pods that can be unavailable at any given moment during the update process.
mdm_configuration.deployment.strategy.rolling_update.max_surge Integer 25% The maximum percentage of Configuration microservice pods that can be created beyond the configured number of pods.
mdm_configuration.deployment.progress_deadline_seconds Integer 240 The length of time, in seconds, that the deployment controller waits before indicating that the deployment's progress has stalled.
mdm_configuration.java.heap_memory String 512 The amount of heap memory allocated for the web container of the Configuration microservice.

Job microservice

The following mdm_job CR spec configuration options pertain to the Job microservice of IBM Master Data Management.
Important: Changing the default resource configuration has an impact on the performance of the service. Only use these options if you are certain of your changes. Be prepared to revert your changes if necessary.
Spec field Type Default value Description
mdm_job.autoscaler.behavior.scaleDown.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling down the Job microservice. For example, for the default value Pods, autoscaling down decreases the number of mdm_job pods.
mdm_job.autoscaler.behavior.scaleDown.policies.value Integer 1 The number of resources (such as pods, by default) that are decreased in a single scale-down action for the Job microservice.
mdm_job.autoscaler.behavior.scaleDown.policies.periodSeconds Integer 60 The length of time set aside for the scale-down period for the Job microservice.
mdm_job.autoscaler.behavior.scaleUp.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling up the Job microservice. For example, for the default value Pods, autoscaling up increases the number of mdm_job pods.
mdm_job.autoscaler.behavior.scaleUp.policies.value Integer 1 The number of resources (such as pods, by default) that are increased in a single scale-up action for the Job microservice.
mdm_job.autoscaler.behavior.scaleUp.policies.periodSeconds Integer 60 The length of time set aside for the scale-up period for the Job microservice.
mdm_job.autoscaler.metrics.type String Resource If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the type of metrics that are used to trigger a scale-up or scale-down for the Job microservice.
mdm_job.autoscaler.metrics.resource.name String cpu The type of resource that is measured as the metric of whether to trigger a scale-up or scale-down for the Job microservice.
mdm_job.autoscaler.metrics.resource.target.type String Utilization Defines the measurement target, such as the default, utilization. If the default is also used for the resource.name property, then the measurement target is the percentage of CPU utilization. The threshold to trigger a change is defined in the resource.target.averageUtilization property.
mdm_job.autoscaler.metrics.resource.target.averageUtilization Integer 50 The average Job microservice CPU utilization percentage that:
  • When surpassed, triggers a scale-up.
  • When fallen beneath, triggers a scale-down.
mdm_job.autoscaler.max_replicas Integer 12 The maximum number of replicas for the Job microservice deployment.
mdm_job.autoscaler.min_replicas Integer 3 The minimum number of replicas for the Job microservice deployment.
mdm_job.deployment.replicas Integer 3 The number of replicas for the Job microservice deployment.
mdm_job.deployment.resources.limits.cpu String 2 The maximum number of CPUs for each main Job microservice container.
mdm_job.deployment.resources.limits.memory String 8Gi The maximum amount of memory for each main Job microservice container.
mdm_job.deployment.resources.requests.cpu String 2 The initial number of CPUs requested for each main Job microservice container.
mdm_job.deployment.resources.requests.memory String 4Gi The initial amount of memory requested for each main Job microservice container.
mdm_job.job_cleanup_cron_job.enabled Boolean true Specifies whether a cron job is used to remove finished jobs.
mdm_job.job_cleanup_cron_job.schedule String @hourly The interval defining how frequently the cleanup cron job runs.
mdm_job.job_cleanup_cron_job.retention_policy.succeeded String now-48 hours The length of time that Kubernetes resources of successful jobs are retained before being cleaned up.
mdm_job.job_cleanup_cron_job.retention_policy.failed String now-48 hours The length of time that Kubernetes resources of failed jobs are retained before being cleaned up.
mdm_job.job_cleanup_cron_job.retention_policy.active String now-7 days The length of time that Kubernetes resources of active jobs are retained before being cleaned up.
mdm_job.job_cleanup_cron_job.resources.limits.cpu String 1 The maximum number of CPUs for each job cleanup container.
mdm_job.job_cleanup_cron_job.resources.limits.memory String 1Gi The maximum amount of memory for each job cleanup container.
mdm_job.job_cleanup_cron_job.resources.requests.cpu String 1 The initial number of CPUs requested for each job cleanup container
mdm_job.job_cleanup_cron_job.resources.requests.memory String 1Gi The initial amount of memory for each job cleanup container.
mdm_job.validations.spark_validation String {"spark_driver_memory_max": "512", "spark.executor.cores_max": "20", "spark.executor.instances_max": "256"} Limitations to Spark job resource usage:
  • Maximum driver memory
  • Maximum executor cores
  • Maximum executor instances

Entity management UI

The following mdm_em_ui CR spec configuration options pertain to the Entity management UI microservice of IBM Master Data Management.
Important: Changing the default resource configuration has an impact on the performance of the service. Only use these options if you are certain of your changes. Be prepared to revert your changes if necessary.
Spec field Type Default value Description
mdm_em_ui.autoscaler.behavior.scaleDown.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling down the Entity management UI microservice. For example, for the default value Pods, autoscaling down decreases the number of mdm_em_ui pods.
mdm_em_ui.autoscaler.behavior.scaleDown.policies.value Integer 1 The number of resources (such as pods, by default) that are decreased in a single scale-down action for the Entity management UI microservice.
mdm_em_ui.autoscaler.behavior.scaleDown.policies.periodSeconds Integer 60 The length of time set aside for the scale-down period for the Entity management UI microservice.
mdm_em_ui.autoscaler.behavior.scaleUp.policies.type String Pods If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the behavior for scaling up the Entity management UI microservice. For example, for the default value Pods, autoscaling up increases the number of mdm_em_ui pods.
mdm_em_ui.autoscaler.behavior.scaleUp.policies.value Integer 1 The number of resources (such as pods, by default) that are increased in a single scale-up action for the Entity management UI microservice.
mdm_em_ui.autoscaler.behavior.scaleUp.policies.periodSeconds Integer 60 The length of time set aside for the scale-up period for the Entity management UI microservice.
mdm_em_ui.autoscaler.metrics.type String Resource If automatic horizontal scaling is enabled (autoScaleConfig=true), this property defines the type of metrics that are used to trigger a scale-up or scale-down for the Entity management UI microservice.
mdm_em_ui.autoscaler.metrics.resource.name String cpu The type of resource that is measured as the metric of whether to trigger a scale-up or scale-down for the Entity management UI microservice.
mdm_em_ui.autoscaler.metrics.resource.target.type String Utilization Defines the measurement target, such as the default, utilization. If the default is also used for the resource.name property, then the measurement target is the percentage of CPU utilization. The threshold to trigger a change is defined in the resource.target.averageUtilization property.
mdm_em_ui.autoscaler.metrics.resource.target.averageUtilization Integer 50 The average Entity management UI microservice CPU utilization percentage that:
  • When surpassed, triggers a scale-up.
  • When fallen beneath, triggers a scale-down.
mdm_em_ui.autoscaler.max_replicas Integer 12 The maximum number of replicas for the Entity Management UI microservice deployment.
mdm_em_ui.autoscaler.min_replicas Integer 3 The minimum number of replicas for the Entity Management UI microservice deployment.
mdm_em_ui.replicas Integer 3 The number of replicas for the Entity Management UI microservice deployment.
mdm_em_ui.resources.limits.cpu String 2 The maximum number of CPUs for each Entity Management UI container.
mdm_em_ui.resources.limits.memory String 4Gi The maximum amount of memory for each Entity Management UI container.
mdm_em_ui.resources.requests.cpu String 2 The initial number of CPUs requested for each Entity Management UI container.
mdm_em_ui.resources.requests.memory String 4Gi The initial amount of memory requested for each Entity Management UI container.

Configuration UI

The following mdm_config_ui CR spec configuration options pertain to the Configuration UI microservice of IBM Master Data Management.
Important: Changing the default resource configuration has an impact on the performance of the service. Only use these options if you are certain of your changes. Be prepared to revert your changes if necessary.
Spec field Type Default value Description
mdm_config_ui.replicas Integer 3 The number of replicas for the Configuration UI microservice deployment.
mdm_config_ui.resources.limits.cpu String 2 The maximum number of CPUs for each main Configuration UI container.
mdm_config_ui.resources.limits.memory String 4Gi The maximum amount of memory for each main Configuration UI container.
mdm_config_ui.resources.requests.cpu String 2 The initial number of CPUs requested for each Configuration UI container.
mdm_config_ui.resources.requests.memory String 4Gi The initial amount of memory requested for each Configuration UI container.
mdm_config_ui.deployment.termination_grace_period_seconds Integer 90 The length of time, in seconds, taken to shut down the Configuration UI container gracefully.

Neo4j graph database

The following neo4j CR spec configuration options pertain to the Neo4j graph database used by IBM Master Data Management. Neo4j configuration is done at the microservice level, meaning that each IBM Master Data Management can have a different configuration setup. The neo4j configuration sections of the CR are found in the following areas of the specification, where <microservice-name> is one of the microservice names: data, matching, model, configuration, and job:
spec
  mdm_<microservice-name>
    neo4j
      connectionProperties
        ...
      generalProperties
        ...
Important: Changing the default resource configuration has an impact on the performance of the service. Only use these options if you are certain of your changes. Be prepared to revert your changes if necessary.
Spec field Type Default value Description
mdm_<microservice-name>.neo4j.connectionProperties.MAX_CONNECTION_POOL_SIZE Integer 100 The maximum allowed number of idle and currently in-use connections by the driver.
mdm_<microservice-name>.neo4j.connectionProperties.IDLE_TIME_BEFORE_CONNECTION_TEST [Long, String] [50, MILLISECONDS] The idle timeout for pooled connections. A connection that has been idle in the connection pool for longer than the given timeout value is stale and will be closed.
The string value of this parameter defines the time unit. Use one of the following values:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
mdm_<microservice-name>.neo4j.connectionProperties.MAX_CONNECTION_LIFETIME [Long, String] [3600000, MILLISECONDS] The maximum connection lifetime for pooled connections. A connection that has been created for longer than the given time will be closed.
The string value of this parameter defines the time unit. Use one of the following values:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
mdm_<microservice-name>.neo4j.connectionProperties.CONNECTION_ACQUISITION_TIMEOUT [Long, String] [60000, MILLISECONDS] The maximum waiting time to either acquire an idle connection from the pool when the connection pool is full or create a new connection when the pool is not full.
The string value of this parameter defines the time unit. Use one of the following values:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
mdm_<microservice-name>.neo4j.connectionProperties.FETCH_SIZE Long 1000 The number of records to pull in each batch.
mdm_<microservice-name>.neo4j.connectionProperties.ROUTING_TABLE_PURGE_DELAY [Long, String] [30, SECONDS] The length of time to wait before purging stale routing tables.
The string value of this parameter defines the time unit. Use one of the following values:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
mdm_<microservice-name>.neo4j.connectionProperties.MAX_TRANSACTION_RETRY_TIME [Long, String] [30000, MILLISECONDS] The maximum length of time that the system attempts to retry managed transactions.
The string value of this parameter defines the time unit. Use one of the following values:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
mdm_<microservice-name>.neo4j.connectionProperties.CONNECTION_TIMEOUT [Long, String] [30000, MILLISECONDS] The length of time that the system waits before timing out when trying to establish a connection with a server.
The string value of this parameter defines the time unit. Use one of the following values:
  • NANOSECONDS
  • MICROSECONDS
  • MILLISECONDS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
mdm_<microservice-name>.neo4j.connectionProperties.EVENT_LOOP_THREADS Integer 0 The event loop thread count.
mdm_<microservice-name>.neo4j.generalProperties.TTL_TRANSACTION_TIMEOUT Long 120 The length of time, in seconds, that the system waits before timing out and closing a composite transaction.

OpenSearch (for history capabilities)

IBM Master Data Management uses OpenSearch to store historical master data. Use this capability to view the history of each entity, record, and relationship in your master data and compare historical attribute values to the current version.

To enable the history capabilities, you must configure and deploy OpenSearch by configuring the mdm_index_store CR spec configuration options.

Enabling OpenSearch deployment

Update the IBM Master Data Management CR (mdm-cr) with the mdm_index_store spec configuration options to enable OpenSearch to be deployed with the IBM Master Data Management service.

Replace the placeholders with values relevant to your deployment.

mdm_index_store:
  nodePools:
    osnodes:
      resources:
        limits:
          cpu: 2
          ephemeral-storage: 5Gi
          memory: 1512Mi
        requests:
          cpu: 250m
          ephemeral-storage: 1Gi
          memory: 32Mi
      storage:
        data:
          sizeLimit: <SIZE>Gi
          useEphemeral: false
        deployment:
          sizeLimit: <SIZE>Gi
          useEphemeral: false
      replicas: <REPLICA-COUNT>
  index_template:
    record_entity:
      priority: 1000
      template:
        settings:
          number_of_shards: <SHARD-COUNT>
          number_of_replicas: <REPLICA-COUNT-FOR-INDEX>
    relationship_linkage:
      priority: 1200
      template:
        settings:
          number_of_shards: <SHARD-COUNT>
          number_of_replicas: <REPLICA-COUNT-FOR-INDEX>
Enabling backup and restore for OpenSearch

Update the IBM Master Data Management CR (mdm-cr) with the following mdm_index_store spec configuration options to enable OpenSearch to be backed up and restored as part of the IBM Master Data Management service.

Use the snapshotWhitelistIndices parameter to list the indices that can be included in snapshots.

mdm_index_store:
  backup:
    enable: true
    sizeLimit: 1Gi
    snapshotPVC: ''
    snapshotWhitelistIndices: ''