IBM Business Automation Navigator parameters

Update the custom YAML file to provide the details that are relevant to your IBM Business Automation Navigator and your decisions for the deployment of the container.

If you plan to use logging and monitoring with your IBM Business Automation Navigator, check the lists of parameters for those components to compile the required values:
Table 1. Business Automation Navigator configuration parameters (navigator_configuration)
Parameter name Description Default/Example Values Required
ban_secret_name Contains the information about the LDAP user and password for components. ibm-ban-secret No
route_ingress_annotations If needed, use to create a custom annotation. An example of an Ingress route: - haproxy.router.openshift.io/balance: roundrobin No
ban_ext_tls_secret_name Optional: Use an existing certificate for automatic creation of OpenShift routes. Set this key if you have an external TLS certificate. Leave this empty if you don't have an external TLS certificate and the operator generates one for you. None No
ban_auth_ca_secret_name Optional. The Certificate Authority (CA) used to sign the external TLS secret for automatic creation of OpenShift routes. Set this key if you have a CA to sign the external TLS certificate. Leave this parameter empty if you don't have the CA of your external TLS certificate. None No
arch.amd64 The architecture of the cluster. This value is the default for Linux® on x86. Do not change it. "3 - Most preferred" No
replica_count The number of IBM Business Automation Navigator replicas to deploy. The default is 1 replica. For high availability in a production environment, 2 or more replicas are recommended. 2 No
image.repository Specifies the image to be used. The image default repository, IBM Entitled Registry, that corresponds to the image registry, which is where the image is pulled. cp.icr.io/cp/cp4a/ban/navigator No
image.tag The image tag that corresponds to the image registry. ga-309-icn No
image.pull_policy This pull policy overrides 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. 512Mi No
resources.limits.cpu Specify a CPU limit for the container. 1 No
resources.limits.memory Specify a memory limit for the container. 3072Mi 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. The maximum allowed is 3. 3 No
auto_scaling.min_replicas The lower limit for the number of pods is 1. If it is not specified or negative, the server will apply a default value of 1. 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
java_mail.host Specify the host of the mail session. "fncm-exchange1.ibm.com" No
java_mail.port Specify the port to use with the mail session host. 25 No
java_mail.sender For sender, enter a user that has access to the email server to log on. "MailAdmin@fncmexchange.com" No
java_mail.ssl_enabled Specify whether SSL is enabled. false 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
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
icn_production_setting.time_zone The time zone for the container deployment. Etc/UTC No
icn_production_setting.gdfontpath

Customized font path for multi-language support. After you include it in the CR, log in to the OCP portal and switch to target project and copy the default fonts under /opt/ibm/java/jre/lib/fonts and custom fonts to ICN container.

/opt/ibm/wlp/usr/servers/defaultServer/configDropins/overrides/fonts No
icn_production_setting.jvm_initial_heap_percentage The initial use of available memory. 40 No
icn_production_setting.jvm_max_heap_percentage The maximum percentage of available memory to use. 66 No
icn_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
icn_production_setting.icn_jndids_name Name for the Navigator JNDI datasource. ECMClientDS No
icn_production_setting.icn_schema Schema for IBM Business Automation Navigator. If you plan to use Task Manager with Business Automation Navigator, this value must be ICNDB. ICNDB No
icn_production_setting.icn_table_space Table space for IBM Business Automation Navigator. ICNDB No
icn_production_setting.allow_remote_plugins_via_http It is recommended not to change this setting. false No
icn_production_setting.copy_files_to_war You can enable and use this setting to add files to the Navigator WAR file. This might be needed for a customization, such as a workflow step processor. custom-dir/navigator_war_filesources.xml No
icn_production_setting.custom_configmap.name The name of the custom configmap.
Note: This parameter is available starting from 21.0.3-IF024.
custom-navigator-config-files Yes
icn_production_setting.custom_configmap.volume_path The location you want to hold files in.
Note: This parameter is available starting from 21.0.3-IF024.
  No
icn_production_setting.custom_configmap.is_env Specify whether the config map holds environment variables.
Note: This parameter is available starting from 21.0.3-IF024.
false 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_icn_cfgstore The persistent volume claim for IBM Business Automation Navigator configuration. "icn-cfgstore" No
datavolume.existing_pvc_for_icn_logstore The persistent volume claim for IBM Business Automation Navigator logs. "icn-logstore" No
datavolume.existing_pvc_for_icn_pluginstore The persistent volume claim for the plug-ins. "icn-pluginstore" No
datavolume.existing_pvc_for_icnvw_cachestore The persistent volume claim for the viewer cache. "icn-vw-cachestore" No
datavolume.existing_pvc_for_icnvw_logstore The persistent volume claim for the viewer log. "icn-vw-logstore" No
datavolume.existing_pvc_for_icn_aspera The persistent volume claim for Aspera®. "icn-asperastore" No
probe.readiness.initial_delay_seconds The initial delay of the readiness probe. 120 No
probe.readiness.period_seconds The period of the readiness probe. 5 No
probe.readiness.timeout_seconds The timeout of the readiness probe. 10 No
probe.readiness.failure_threshold The failure threshold of the readiness probe. 6 No
probe.liveness.initial_delay_seconds The initial delay of the liveness probe. 600 No
probe.liveness.period_seconds The period of the liveness probe. 5 No
probe.liveness.timeout_seconds The timeout of the liveness probe. 5 No
probe.liveness.failure_threshold The failure threshold of the liveness probe. 6 No
image_pull_secrets.name The secrets to be able to pull images. Use this parameter if you want to override the image_pull_secrets setting in the shared_configuration. "admin.registrykey" No