Content Management Interoperability Services parameters

Update the custom YAML file to provide the details that are relevant to your Content Management Interoperability Services and your decisions for the deployment of the container.
Table 1. CMIS configuration parameters: spec.ecm_configuration.cmis
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
replica_count How many replicas to deploy. 2 No
rolling_update.max_unavailable

Rolling update settings for CMIS 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 CMIS 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
image.repository Specifies the image to be used cp.icr.io/cp/cp4a/fncm/cmis Yes
image.tag Specifies the tag for the image to be used. ga-307-cmis-la502 Yes
image.pull_policy If specified, this setting will override the image pull policy in the shared_configuration. IfNotPresent No
log.format The format for workload logging. json No
resources.requests.cpu Specifies a CPU request for the container. 500m No
resources.requests.memory Specify a memory request for the container. 256Mi No
resources.limits.cpu Specify a CPU limit for the container. 1 No
resources.limits.memory Specify a memory limit for the container. 1536Mi No
resources.requests.ephemeral_storage Specifies an ephemeral storage request for the container. 1 Gi No
resources.limits.ephemeral_storage Specifies an ephemeral storage limit for the container. 1 Gi 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. 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 No
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
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=cmis:NoSchedule) add tolerations to the tolerations parameter that match the taint.

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

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

 tolerations: [] No
cmis_production_setting.cpe_url The URL for accessing the Content Platform Engine container.   No
cmis_production_setting.time_zone The time zone for the container deployment. Etc/UTC No
cmis_production_setting.jvm_initial_heap_percentage The initial use of available memory. 40 No
cmis_production_setting.jvm_max_heap_percentage The maximum percentage of available memory to use. 66 No
cmis_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
cmis_production_setting.ws_security_enabled Enable or disable Web Service security.
Note that Web Service and Basic Authentication cannot be enabled at the same time; enabling Web Service security also disables Basic Authentication, and similarly enabling Basic Authentication disables Web Service security.		 false No
cmis_production_setting.checkout_copycontent Determines whether the content-stream of the Private Working Copy should be copied from the Document that was checked out. true No
cmis_production_setting.default_maxitems The default value for the optional maxItems input argument on paging-related services. 25 No
cmis_production_setting.cvl_cache Determines whether ChoiceLists will be cached once for all users. true No
cmis_production_setting.secure_metadata_cache Determines the security of the metadata cache. false No
cmis_production_setting.filter_hidden_properties Determines whether hidden Content Cortex domain properties should appear in CMIS type definitions and folder or document instance data. true No
cmis_production_setting.querytime_limit Timeout in seconds for the queries that specify timeout. 180 No
cmis_production_setting.resumable_queries_forrest If true, then a faster response time for REST next line. If false, the next link for REST will re-issue query. true No
cmis_production_setting.escape_unsafe_string_characters Specifies whether to escape characters that are not valid for XML unicode as specified by the XML 1.0 standard. false No
cmis_production_setting.max_soap_size Limits the maximum allowable Web Service SOAP message request size. 180 No
cmis_production_setting.print_pull_stacktrace Prints the full stack trace in the response. false No
cmis_production_setting.folder_first_search Configures the sequence in which CMIS tries to identify objects (folder or document first). false No
cmis_production_setting.ignore_root_documents To ignore reading or writing contents in root folder, set ignoreRootDocuments to true. false No
cmis_production_setting.supporting_type_mutability Determines whether to support type mutability. false No
cmis_production_setting.license The value must be set to accept to deploy. accept Yes
cmis_production_setting.custom_configmap.name The name of the custom configmap. custom-navigator-config-files Yes
cmis_production_setting.custom_configmap.volume_path The location you want to hold files in.   No
cmis_production_setting.custom_configmap.is_env Specify whether the config map holds environment variables. false Required only when configmap holds data information.
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
collectd_enable_plugin_write_graphite If you use Graphite database for metrics or use IBM Cloud® monitoring, set to true. false No
datavolume.existing_pvc_for_cmis_cfgstore
  • name
  • size
 The name and size of persistent volume claim for Content Management Interoperability configuration.
  • cmis-cfgstore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing_pvc_for_cmis_logstore
  • name
  • size
 The name and size of persistent volume claim for Content Management Interoperability logs.
  • cmis-logstore
  • 1Gi
  • Yes if you want to use existing PVC
  • 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
  • 6
 No
probe.liveness
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of liveness probes to know when to restart a container.
  • 10
  • 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.
  • 90
  • 10
  • 10
  • 6
 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  
audit_logging Audit logging configuration for CMIS. false No
audit_logging.enabled Enable or disable audit logging for CMIS. false No
audit_logging.audit_log_dir_size The audit log directory size. ​The value must be in the format of <number><unit>. The valid units are Ki, Mi, Gi, Ti, Pi, and Ei. The directory is mounted as an ephemeral storage volume in the CMIS pods. 150Mi No
audit_logging.rolling_max_files The number of audit log files to keep. Increasing this value, increases the number of audit log files kept. You might need to increase the audit_log_dir_size if you increase this value. 5 No
audit_logging.rolling_max_size ​The value must be in the format of <number><unit>. The valid units are: Ki, Mi, Gi, Ti, Pi, Ei. You might need to increase the audit_log_dir_size if you increase this value. 20Mi 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=cmis:No Schedule) add tolerations to the tolerations parameter that match the taint.

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

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

 tolerations: [] No