Task Manager parameters

Update the custom YAML file to provide the details that are relevant to your Task Manager and your decisions for the deployment of the container.
Table 1. Task Manager configuration parameters: spec.ecm_configuration.tm
Parameters Description Default or Example Values  
arch.amd64 The architecture for your environment. 3 - Most preferred Yes, leave default
replica_count How many Content Platform Engine replicas to deploy. 2 No
rolling_update.max_unavailable

Rolling update settings for Task Manager 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 Task Manager 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 The repository to use. cp.icr.io/cp/cp4a/fncm/taskmgr No
image.tag The specific tag for your release. ga-310-tm No
image.pull_policy The pull policy for the image. IfNotPresent No
tolerations Tolerations are specified in the pod specification to allow the pod to be scheduled on tainted nodes. For example, if you want to schedule the pod on a node with taints, you can add tolerations to the pod specification.
tolerations:
  - key: "component"
    operator: "Equal"
    value: "tm"
    effect: "NoSchedule"
 [] (empty list) No
resources.requests.cpu Specifies a CPU request for the container. 500m No
resources.requests.memory Specify a memory request for the container. 512Mi 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. 80 No
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
tm_production_setting.time_zone The time zone for the container deployment. Etc/UTC No
tm_production_setting.jvm_initial_heap_percentage The initial use of available memory. 40 No
tm_production_setting.jvm_max_heap_percentage The maximum percentage of available memory to use. 66 No
tm_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"

 "-Dcom.ibm.ecm.task.StartUpListener.defaultLogLevel=FINE" No
tm_production_setting.license The value must be set to accept to deploy. accept Yes
tm_production_setting.custom_configmap.name The name of the custom configmap. custom-navigator-config-files Yes
tm_production_setting.custom_configmap.volume_path The location you want to hold files in.   No
tm_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_tm_cfgstore
  • name
  • size
 The name and size of persistent volume claim for Task Manager configuration.
  • tm-cfgstore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing _pvc_for_tm_logstore
  • name
  • size
 The name and size of persistent volume claim for Task Manager logs.
  • tm-logstore
  • 1Gi
  • Yes if you want to use existing PVC
  • No
datavolume.existing_pvc_for_tm_pluginstore
  • name
  • size
 The name and size of persistent volume claim for the Task Manager plug in.
  • tm-pluginstore
  • 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.
  • 120
  • 10
  • 10
  • 6
 No
image_pull_secrets.name The secrets to be able to pull images. ibm-entitlement-key No
tm_production_setting.security_roles_to_group_mapping.task_admins

groups

users

 The names of customizable admin user roles and groups. Defining both groups and users is not necessary as long as at least one is defined.

taskAdmins

admin1, admin2

 If you do not define values, the default values of taskAdmins will be assigned.
tm_production_setting.security_roles_to_group_mapping.task_users

groups

users

 The names of customizable user roles and groups. Defining both groups and users is not necessary as long as at least one is defined.

task_users

user1, user2

If you do not define values, the default values of task_users will be assigned.
tm_production_setting.security_roles_to_group_mapping.task_auditors

groups

users

 The names of customizable auditor user roles and groups. Defining both groups and users is not necessary as long as at least one is defined.

task_auditors

auditor1, auditor2

 If you do not define values, the default values of task_auditors will be assigned.