IBM Content Cortex for Microsoft Office parameters

Update the custom YAML file with the details of your Content Cortex for Microsoft Office deployment.
Table 1. Content Cortex for Microsoft Office configuration parameters: spec.ccxmo_configuration
Parameters Description Default values Required
route_ingress_annotations By default all the components create ingress and routes with required annotations. In case any custom annotation is needed for the environment, use this parameter to specify the annotations. - haproxy.router.openshift.io/balance: roundrobin No
arch.amd64 The architecture of the cluster. This is the default for Linux® and should not be changed. 3 - Most preferred Yes
replica_count The number of replicas or pods to be deployed. For high availability in a production environment, it is recommended to have 2 or more. 2 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/ban/ccxmo No
image.tag Specifies the tag for the image. 26.0.0 No
image.pull_policy Specify your pull policy. If specified, this value overrides the image pull policy in the shared_configuration. IfNotPresent No
log.format The format for workload logging. json No
resources.requests.cpu Specify a CPU request for the container. 500m No
resources.requests.memory Specify a memory request for the container. 512Mi No
resources.requests.ephemeral_storage Specify an ephemeral storage request for the container. 500Mi No
resources.limits.cpu Specify a CPU limit for the container. 1 No
resources.limits.memory Specify a memory limit for the container. 1024Mi No
resources.limits.ephemeral_storage Specify an ephemeral storage limit for the container. 1Gi No
rolling_update.max_unavailable Rolling update settings for Content Cortex for Microsoft Office deployment. By default, maxUnavailable is set to '25%'. The values can be defined as either a percentage (e.g., '25%') or an absolute number (e.g., 1). 25% No
rolling_update.max_surge Rolling update settings for Content Cortex for Microsoft Office deployment. By default, maxSurge is set to 1. The value can be defined as either a percentage (e.g., '25%') or an absolute number (e.g., 1). 1 No
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 if auto_scaling is enabled. <Required> No
auto_scaling.min_replicas The lower limit for the number of pods that can be set by the autoscaler. Required if auto_scaling is enabled. <Required> No
auto_scaling.target_cpu_utilization_percentage The target average CPU utilization (represented as a percent of requested CPU) over all the pods. Required if auto_scaling is enabled. <Required> No
auto_scaling.target_memory_utilization_percentage Set this parameter (in percentage) if you want HPA scales a deployment based on the average memory utilization. Required if auto_scaling is enabled. <Required> No
auto_scaling.scaleup.policies_pods_value The maximum number of pods that the HPA is allowed to add during each periodSeconds interval. <Optional> No
auto_scaling.scaleup.policies_pods_period_seconds Defines how often the HPA can apply a scaling action for scale up. <Optional> No
auto_scaling.scaleup.stabilization_window_seconds Cooldown window before applying scaleUp action. <Optional> No
auto_scaling.scaledown.policies_pods_value The maximum number of pods that the HPA is allowed to remove during each periodSeconds interval. <Optional> No
auto_scaling.scaledown.policies_pods_period_seconds Defines how often the HPA can apply a scaling action for scale down. <Optional> No
auto_scaling.scaledown.stabilization_window_seconds Cooldown window before applying scaleDown action. <Optional> No
node_affinity.deploy_arch Value in this field will be used as kubernetes.io/arch selector values. By default all support arch will be included.
  • amd64
  • s390x
  • ppc64le
 No
node_affinity.custom_node_selector_match_expression Custom node selector match expressions will be added in node selector match expressions. It accepts array list inputs. You can assign multiple selector match expressions except (kubernetes.io/arch). [] No
custom_annotations Values in this field will be used as annotations in all generated pods and it must be valid annotation key value pairs. {} No
custom_labels Values in this field will be used as labels in all generated pods and it must be valid label key value pairs. {} No
tolerations Optional setting for tolerations for Content Cortex for Microsoft Office containers. If there are component-specific tolerations defined, then the component-specific tolerations will take precedence over the shared tolerations defined in shared_configuration.sc_tolerations.

Example:

- key: "component"
  operator: "Equal"
  value: "ccxmo"
  effect: "NoSchedule"
 [] No
zen_performance.proxy_connect_timeout Timeout for establishing a connection with a proxy server. This parameter is optional. 300 No
zen_performance.proxy_send_timeout Timeout for transmitting a request to the proxy server. The timeout is set only between two successive write operations, not for the transmission of the whole request. 300 No
zen_performance.proxy_read_timeout Timeout for reading a response from the proxy server. The timeout is set only between two successive read operations, not for the transmission of the whole response. 300 No
security_context.supplemental_groups Controls which group IDs containers add. Empty No
security_context.selinux_options This can take an array of key value pairs to assign SELinux labels to a Container. Empty No
ccxmo_production_setting.timezone The time zone for the container deployment. Etc/UTC No
ccxmo_production_setting.jvm_initial_heap_percentage The initial use of available memory. 40 No
ccxmo_production_setting.jvm_max_heap_percentage The maximum percentage of available memory to use. 66 No
ccxmo_production_setting.jvm_customize_options Use this parameter to specify JVM arguments using comma separation. If your JVM option contains comma then you have to include 'DELIM=;' to use a different separator. If your JVM option contains double quotes then you need to escape it. Empty No
monitor_enabled Specify whether to use the built-in monitoring capability. false No
logging_enabled Specify whether to use the built-in logging capability. false No
datavolume.existing_pvc_for_ccxmo_cfgstore
  • name
  • size
 The name and size of persistent volume claim for Content Cortex for Microsoft Office configuration store.
  • ccxmo-cfgstore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing_pvc_for_ccxmo_logstore
  • name
  • size
 The name and size of persistent volume claim for Content Cortex for Microsoft Office logs.
  • ccxmo-logstore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
probe.startup
  • initial_delay_seconds
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of startup probes to know when the container is started.
  • 100
  • 10
  • 10
  • 12
 No
probe.readiness
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of readiness probes to know when the containers are ready to start accepting traffic.
  • 10
  • 10
  • 3
 No
probe.liveness
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of liveness probes to know when to restart a container.
  • 30
  • 5
  • 3
 No
image_pull_secrets.name The secrets to be able to pull images. Only use this parameter if you want to override the image_pull_secrets setting in the shared_configuration. ibm-entitlement-key No