Content Platform Engine parameters

Update the custom YAML file to provide the details that are relevant to your Content Platform Engine and your decisions for the deployment of the container.
Table 1. Configuration parameters: spec.ecm_configuration.cpe
Parameters Description Default or Example Values Required
arch.amd64 The architecture for your environment. This is the default for Linux® on x86 and should not be changed. 3 - Most preferred Yes, leave default
auto_scaling.enabled Specify whether to enable auto scaling. false No
auto_scaling.max_replicas The upper limit for the number of pods that can be set by the autoscaler. Required. 3 No
auto_scaling.min_replicas The lower limit for the number of pods that can be set by the autoscaler. If it is not specified or negative, the server will apply a default value. 2 No
auto_scaling.target_cpu_utilization_percentage The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it is not specified or negative, a default autoscaling policy is used. 80 Required if using CPU metrics
auto_scaling.target_memory_utilization_percentage The target average memory utilization (represented as a percent of requested memory) over all the pods. If it is not specified or negative, a default autoscaling policy is used. N/A Required if using memory metrics
auto_scaling.scaleup
  • policies_pods_value
  • policies_pods_period_seconds
  • stabilization_window_seconds
  • The maximum number of pods that the HPA is allowed to add during each periodSeconds interval.
  • Defines how often the HPA can apply a scaling action.
  • Cooldown window before applying scaleUp action.
  • 1
  • 15 (seconds)
  • 30 (seconds)
 No
auto_scaling.scaledown
  • policies_pods_value
  • policies_pods_period_seconds
  • stabilization_window_seconds
  • The maximum number of pods that the HPA is allowed to remove during each periodSeconds interval.
  • Defines how often the HPA can apply a scaling action.
  • Cooldown window before applying scaleDown action.
  • 1
  • 15 (seconds)
  • 300 (seconds)
 No
collectd_enable_plugin_write_graphite If you use Graphite database for metrics or use IBM Cloud monitoring, set to true. false No
cpe_production_setting.custom_configmap
  • is_env
  • name
  • volume_path
  • Specify whether the config map holds environment variables.
  • The name of the custom configmap.
  • The location you want to hold files in.
  • false
  • custom-navigator-config-files
  • path/to/files
  • No
  • Yes
  • No
cpe_production_setting.gcd_jndi_name JNDI name for the Global Configuration Database. FNGCDDS No
cpe_production_setting.gcd_jndixa_name JNDI XA name for the Global Configuration Database FNGCDDSXA No
cpe_production_setting.gcd_schema Schema name for the tables created in the Global Configuration Database. none No
cpe_production_setting.jvm_customize_options Optionally specify JVM arguments using comma separation. For example:

jvm_customize_options: "-Dmy.test.jvm.arg1=123,-Dmy.test.jvm.arg2=abc,-XX:+SomeJVMSettings,XshowSettings:vm"

If needed, you can use DELIM to change the character that is used to separate multiple JVM arguments. In this example, a semi-colon is used to separate the JVM arguments:

jvm_customize_options: "DELIM=;-Dcom.filenet.authentication.wsi.AutoDetectAuthToken=true;-Dcom.filenet.authentication.providers=ExShareUmsInternal,ExShareIbmId,ExShareGID"

 None No
cpe_production_setting.jvm_initial_heap_percentage The initial use of available memory. 18 No
cpe_production_setting.jvm_max_heap_percentage The maximum percentage of available memory to use. 33 No
cpe_production_setting.license To deploy, the value must be set to accept. accept Yes
cpe_production_setting.time_zone The time zone for the container deployment. Etc/UTC No
datavolume.existing_pvc_for_cpe_bootstrapstore
  • name
  • size
 The name and size of persistent volume claim for upgrade and startup.
  • cpe-bootstrapstore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing_pvc_for_cpe_cfgstore
  • name
  • size
 The name and size of persistent volume claim for Content Platform Engine configuration.
  • cpe-cfgstore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing_pvc_for_cpe_filestore
  • name
  • size
 The name and size of persistent volume claim for the Content Platform Engine files.
  • cpe-filestore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing_pvc_for_cpe_fnlogstore
  • name
  • size
 The name and size of the persistent volume claim for Content Cortex logs.
  • cpe-fnlogstore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing_pvc_for_cpe_icmrulestore
  • name
  • size
 The name and size of persistent volume claim for the IBM Case Manager rules.
  • cpe-icmrulestore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing_pvc_for_cpe_logstore
  • name
  • size
 The name and size of persistent volume claim for Content Platform Engine logs.
  • cpe-logstore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing_pvc_for_cpe_textextstore
  • name
  • size
 The name and size of persistent volume claim for text extraction
  • cpe-textextstore
  • 3Gi
  • Yes if you want to use existing PVC
  • No
enable_pdb

Enables or disables a Pod Disruption Budget (PDB) for the CPE component. The parameter overrides the shared_configuration.sc_enable_pdb parameter value.

When PDB is set to true and the replica count for CPE is greater than 1, then a PDB is created with a `minAvailable` value set to 1. If the replica count is 1, then the PDB has a `minAvailable` set to 0.

 true No
image.pull_policy Specify your pull policy. If specified, this value overrides the image pull policy in the shared_configuration. IfNotPresent No
image.repository The image repository that corresponds to the image registry, where the image is pulled. The default repository is the IBM Entitled Registry. cp.icr.io/cp/cp4a/fncm/cpe No
image.tag The tag that corresponds to the image registry, where the image is pulled. ga-2600-p8cpe No
image_pull_secrets.name The secrets to be able to pull images. ibm-entitlement-key Yes, only if you want to override the comparable setting in the shared configuration section.
log.format The format for workload logging. json No
logging_enabled Specify whether to use the built-in logging capability. false No
rolling_update.maxSurge The maximum number (or percentage) of extra temporary pods created when you do a rolling update. 
cpe:
      ## Rolling update settings for CPE deployment.  By default, max_unavailable is set to 99% and max_surge is set to 1.  This will improve the efficiency of the rolling update.
      ## Valid values for max_unavailable are 0-100% or 0-<number of replicas>.
      rolling_update:
        max_unavailable: 99%
        max_surge: 1
 Yes
rolling_update.maxUnavailable The maximum number (or percentage) of pods that be unavailable when you do a rolling update. 
cpe:
      ## Rolling update settings for CPE deployment.  By default, max_unavailable is set to 99% and max_surge is set to 1.  This will improve the efficiency of the rolling update.
      ## Valid values for max_unavailable are 0-100% or 0-<number of replicas>.
      rolling_update:
        max_unavailable: 99%
        max_surge: 1
 Yes
monitor_enabled Specify whether to use the built-in monitoring capability. false No
probe.liveness
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of liveness probes to know when to restart a container.
  • 30
  • 5
  • 6
 No
probe.startup
  • initial_delay_seconds
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of startup probes to know when the container is started.
  • 120
  • 30
  • 10
  • 40
 No
replica_count The number of replicas for the container. 2 No
resources.limits.cpu Specify a CPU limit for the container. 1 No
resources.limits.ephemeral_storage Specifies an ephemeral storage limit for the container. 4Gi No
resources.limits.memory Specify a memory limit for the container. 3072Mi No
resources.requests.cpu Specifies a CPU request for the container. 500m No
resources.requests.ephemeral_storage Specifies an ephemeral storage request for the container. 4Gi No
resources.requests.memory Specify a memory request for the container. 512Mi No
security_context.fs_groupchangepolicy Define the behavior for changing ownership and permission of the volume before being exposed inside a pod. This field has two possible values: "Always" or "OnRootMismatch". An example:

fs_groupchangepolicy: "OnRootMismatch"

   No
security_context.selinux_options Enter an array of key value pairs to assign SELinux labels to a container. An example:
selinux_options:
  level: "s0:c123,c456"
  type: "spc_t"
   No
security_context.supplemental_groups supplemental_groups is an array of group IDs that are defined for the pod. Multiple group IDs are comma-separated. An example:

supplemental_groups: [1000620001,1000620002]

   No
tolerations Tolerations allow a pod to be scheduled on a node with a matching taint. You can have multiple tolerations to handle complex taint scenarios.

For example, to schedule the pod on a node with taints (component=cpe:NoSchedule) add tolerations to the tolerations parameter that match the taint.

ecm_configuration:
    cpe:
      replica_count: 2
      tolerations:
        - key: "component"
          operator: "Equal"
          value: "cpe"
          effect: "NoSchedule"

The default value is an empty list [], which then uses the Kubernetes defaults.

 tolerations: [] No