IBM Content Collector for SAP Applications parameters

Update the custom YAML file to provide the details that are relevant to your IBM Content Collector for SAP Applications and your decisions for the deployment of the container.

Default instance configuration

Use the iccsap_configuration section to configure the default ICCSAP instance that is deployed automatically when ICCSAP is enabled.

Table 1. Configuration parameters: iccsap_configuration
Parameters Description Default Values Required
iccsap_secret_name The name of the secret that contains the keystore password for the deployment. "ibm-iccsap-secret" Yes
arch.amd64 The architecture for your environment. 3 - Most preferred Yes, leave default
replica_count Contains information about how many CPE replicas to deploy. 2 No
image.repository The repository to use. cp.cir.io/cp/cp4a/iccsap/iccsap No
image.tag The specific tag for your release. 26.0.0 No
image.pull_policy The pull policy for the image. IfNotPresent No
log.format The format for workload logging. json No
tolerations Tolerations are specified in the pod specification to allow the pod to be scheduled on tainted nodes. For example: tolerations: - key: "component", operator: "Equal", value: "iccsap", effect: "NoSchedule" [] (empty list) No
resources.requests.cpu Specifies a CPU request for the container. 1 No
resources.requests.memory Specify a memory request for the container. 1024Mi No
resources.requests.ephemeral_storage Specifies an ephemeral storage request for the container. 2Gi 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 Specifies an ephemeral storage limit for the container. 2Gi No
rolling_update.max_unavailable Maximum number of pods that can be unavailable during a rolling update. Can be specified as a percentage (e.g., '25%') or an absolute number (e.g., 1). '25%' No
rolling_update.max_surge Maximum number of pods that can be created above the desired number during a rolling update. Can be specified as 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. 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 specified, HPA scales the deployment based on average memory utilization. <Required> No
auto_scaling.scaleup
  • policies_pods_value
  • policies_pods_period_seconds
  • stabilization_window_seconds
 Controls how fast and how often HPA can scale up pods. These settings are optional; if not defined, default values are used.
  • Maximum number of pods HPA can add during each period (default: 1)
  • How often HPA can apply scaling action in seconds (default: 15)
  • Cooldown window before applying scaleup action in seconds (default: 30)
  • <Optional>
  • <Optional>
  • <Optional>
 No
auto_scaling.scaledown
  • policies_pods_value
  • policies_pods_period_seconds
  • stabilization_window_seconds
 Controls how fast and how often HPA can scale down pods. These settings are optional; if not defined, default values are used.
  • Maximum number of pods HPA can remove during each period (default: 1)
  • How often HPA can apply scaling action in seconds (default: 15)
  • Cooldown window before applying scaledown action in seconds (default: 300)
  • <Optional>
  • <Optional>
  • <Optional>
 No
enable_pdb Enable or disable Pod Disruption Budget (PDB) creation for the ICCSAP component. This flag overrides the shared_configuration.sc_enable_pdb flag. A PDB for ICCSAP is created with minAvailable: 1 only if the ICCSAP replica count is greater than 1. Otherwise, if the replica is 1, the PDB has minAvailable: 0. true No
node_affinity.custom_node_selector_match_expression Added in node selector match expressions. It accepts array list inputs. You can assign multiple selector match expressions except (kubernetes.io/arch). 
- key: kubernetes.io/hostname
  operator: In
  values:
    - worker0
    - worker1
    - worker3
 No
custom_annotations Values in this field are used as annotations in all generated pods. They must be valid annotation key-value pairs. customAnnotationKey: customAnnotationValue No
custom_labels Values in this field are used as labels in all generated pods. They must be valid label key-value pairs. customLabelKey: customLabelValue No
iccsap_production_setting.custom_configmap.name The name of the custom configmap.

Note that, a configmap can hold files or environment data but it cannot a mix of both. The volume_path is optional for a configmap that holds files as its data. If a volume_path is not specified, the files is mounted to the Liberty configuration (cfgstore) mapped location. If the configmap data holds environment variables then must set is_env to true.

   Yes
iccsap_production_setting.custom_configmap.volume_path The location you want to hold files in.   No
iccsap_production_setting.custom_configmap.is_env Specify whether the config map holds environment variables. false No
iccsap_production_setting.timezone The time zone for the container deployment. Etc/UTC No
iccsap_production_setting.license The license must be set to accept in order for the component to install. accept Yes
monitor_enabled Specify whether to enable monitoring. false No
logging_enabled Specify whether to use the built-in logging capability. false No
datavolume.existing _pvc_for_iccsap_instance
  • name
  • size
 The persistent volume claim for IBM Content Collector for SAP Applications configuration.
  • iccsap-instance
  • 1Gi
  • Yes, if you want to use existing PVC
  • No
datavolume.existing_pvc_for_iccsap_logs
  • name
  • size
 The persistent volume claim for IBM Content Collector for SAP Applications logs.
  • iccsap-logstore
  • 1Gi
  • Yes, if you want to use existing PVC
  • No
datavolume.existing_pvc_for_tsm_setup
  • name
  • size
 The persistent volume claim for IBM Content Collector for SAP Applications TSM.
  • tsm-setup
  • 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.
  • 240
  • 30
  • 10
  • 16
 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.
  • 5
  • 10
  • 6
 No
probe.liveness
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of liveness probes to know when the containers are ready to start accepting traffic.
  • 5
  • 5
  • 6
 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.

Multi-instance configuration

Use the iccsap_configuration_multi section to deploy additional ICCSAP instances beyond the default instance configured in iccsap_configuration. Each entry in this section represents an individual ICCSAP instance with its own configuration.

Table 2. Configuration parameters: iccsap_configuration_multi
Parameters Description Default Values Required
instance_id A unique identifier for the ICCSAP instance. This value is used to create artifacts such as routes, persistent volume claims, service names, and pod names.
Important: The value must contain only alphanumeric characters and cannot include special characters.
 iccsap2 Yes
iccsap_secret_name The name of the secret that contains the keystore password for the deployment. "ibm-iccsap-secret" Yes
arch.amd64 The architecture for your environment. 3 - Most preferred Yes, leave default
replica_count Contains information about how many CPE replicas to deploy. 2 No
image.repository The repository to use. cp.cir.io/cp/cp4a/iccsap/iccsap No
image.tag The specific tag for your release. 26.0.0 No
image.pull_policy The pull policy for the image. IfNotPresent No
log.format The format for workload logging. json No
tolerations Tolerations are specified in the pod specification to allow the pod to be scheduled on tainted nodes. For example: tolerations: - key: "component", operator: "Equal", value: "iccsap", effect: "NoSchedule" [] (empty list) No
resources.requests.cpu Specifies a CPU request for the container. 1 No
resources.requests.memory Specify a memory request for the container. 1024Mi No
resources.requests.ephemeral_storage Specifies an ephemeral storage request for the container. 2Gi 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 Specifies an ephemeral storage limit for the container. 2Gi No
rolling_update.max_unavailable Maximum number of pods that can be unavailable during a rolling update. Can be specified as a percentage (e.g., '25%') or an absolute number (e.g., 1). '25%' No
rolling_update.max_surge Maximum number of pods that can be created above the desired number during a rolling update. Can be specified as 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. 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 specified, HPA scales the deployment based on average memory utilization. <Required> No
auto_scaling.scaleup
  • policies_pods_value
  • policies_pods_period_seconds
  • stabilization_window_seconds
 Controls how fast and how often HPA can scale up pods. These settings are optional; if not defined, default values are used.
  • Maximum number of pods HPA can add during each period (default: 1)
  • How often HPA can apply scaling action in seconds (default: 15)
  • Cooldown window before applying scaleup action in seconds (default: 30)
  • <Optional>
  • <Optional>
  • <Optional>
 No
auto_scaling.scaledown
  • policies_pods_value
  • policies_pods_period_seconds
  • stabilization_window_seconds
 Controls how fast and how often HPA can scale down pods. These settings are optional; if not defined, default values are used.
  • Maximum number of pods HPA can remove during each period (default: 1)
  • How often HPA can apply scaling action in seconds (default: 15)
  • Cooldown window before applying scaledown action in seconds (default: 300)
  • <Optional>
  • <Optional>
  • <Optional>
 No
enable_pdb Enable or disable Pod Disruption Budget (PDB) creation for the ICCSAP component. This flag overrides the shared_configuration.sc_enable_pdb flag. A PDB for ICCSAP is created with minAvailable: 1 only if the ICCSAP replica count is greater than 1. Otherwise, if the replica is 1, the PDB has minAvailable: 0. true No
node_affinity.custom_node_selector_match_expression Added in node selector match expressions. It accepts array list inputs. You can assign multiple selector match expressions except (kubernetes.io/arch). 
- key: kubernetes.io/hostname
  operator: In
  values:
    - worker0
    - worker1
    - worker3
 No
custom_annotations Values in this field are used as annotations in all generated pods. They must be valid annotation key-value pairs. customAnnotationKey: customAnnotationValue No
custom_labels Values in this field are used as labels in all generated pods. They must be valid label key-value pairs. customLabelKey: customLabelValue No
iccsap_production_setting.custom_configmap.name The name of the custom configmap.

Note that, a configmap can hold files or environment data but it cannot a mix of both. The volume_path is optional for a configmap that holds files as its data. If a volume_path is not specified, the files is mounted to the Liberty configuration (cfgstore) mapped location. If the configmap data holds environment variables then must set is_env to true.

   Yes
iccsap_production_setting.custom_configmap.volume_path The location you want to hold files in.   No
iccsap_production_setting.custom_configmap.is_env Specify whether the config map holds environment variables. false No
iccsap_production_setting.timezone The time zone for the container deployment. Etc/UTC No
iccsap_production_setting.license The license must be set to accept in order for the component to install. accept Yes
monitor_enabled Specify whether to enable monitoring. false No
logging_enabled Specify whether to use the built-in logging capability. false No
datavolume.existing _pvc_for_iccsap_instance
  • name
  • size
 The persistent volume claim for IBM Content Collector for SAP Applications configuration. Each instance must have unique PVC names.
  • iccsap-instance-iccsap2
  • 1Gi
  • Yes, if you want to use existing PVC
  • No
datavolume.existing_pvc_for_iccsap_logs
  • name
  • size
 The persistent volume claim for IBM Content Collector for SAP Applications logs. Each instance must have unique PVC names.
  • iccsap-logstore-iccsap2
  • 1Gi
  • Yes, if you want to use existing PVC
  • No
datavolume.existing_pvc_for_tsm_setup
  • name
  • size
 The persistent volume claim for IBM Content Collector for SAP Applications TSM. Each instance must have unique PVC names.
  • tsm-setup-iccsap2
  • 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.
  • 240
  • 30
  • 10
  • 16
 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.
  • 5
  • 10
  • 6
 No
probe.liveness
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of liveness probes to know when the containers are ready to start accepting traffic.
  • 5
  • 5
  • 6
 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.