Content Platform Engine parameters
Update the custom YAML file to provide the details that are relevant to your Content Platform Engine and your decisions for the deployment of the container.
| Parameters | Description | Default or Example Values | Required |
|---|---|---|---|
| hostname | External hostname for the service. The hostname can consist of lowercase alphanumeric characters or '-', and must start and end with an alphanumeric character. | new-hostname | If not specified, hostname is generated from
shared_configuration.sc_deployment_hostname_suffix . |
| arch.amd64 | The architecture for your environment. This is the default for Linux on x86 and should not be changed. | 3 - Most preferred | Yes, leave default |
| replica_count | The number of replicas for the container. | 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/fncm/cpe | No |
| image.tag | The tag that corresponds to the image registry, where the image is pulled. | ga-55x-p8cpe | 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 | 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. 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 |
|
cpe_production_setting.time_zone |
The time zone for the container deployment. | Etc/UTC | No |
| cpe_production_setting.jvm_initial_heap_percentage | The initial use of available memory. | 18 | No |
| cpe_production_setting.jvm_max_heap_percentage | The maximum percentage of available memory to use. | 33 | No |
| cpe_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 |
| cpe_production_setting.gcd_jndi_name | JNDI name for the Global Configuration Database. | FNGCDDS | No |
| cpe_production_setting.gcd_jndixa_name | JNDI XA name for the Global Configuration Database | FNGCDDSXA | No |
| cpe_production_setting.license_model | Choose the licensing model. Required. The expected values are ICF.PVUNonProd, ICF.PVUProd, ICF.UVU, ICF.CU, FNCM.PVUNonProd, FNCM.PVUProd, FNCM.UVU, or FNCM.CU. | FNCM.PVUNonProd | Yes |
| cpe_production_setting.license | To deploy, the value must be set to accept. | accept | Yes |
| 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_cpe_cfgstore | The persistent volume claim for Content Platform Engine configuration. | cpe-cfgstore | Yes |
| datavolume.existing_pvc_for_cpe_logstore | The persistent volume claim for Content Platform Engine logs. | cpe-logstore | Yes |
| datavolume.existing_pvc_for_cpe_filestore | The persistent volume claim for the Content Platform Engine files. | cpe-filestore | Yes |
| datavolume.existing_pvc_for_cpe_icmrulestore | The persistent volume claim for the IBM Case Manager rules. | cpe-icmrulesstore | Yes |
| datavolume.existing_pvc_for_cpe_textextstore | The persistent volume claim for text extraction | cpe-textextstore | Yes |
| datavolume.existing_pvc_for_cpe_bootstrapstore | The persistent volume claim for upgrade and startup. | cpe-bootstrapstore | Yes |
| datavolume.existing_pvc_for_cpe_fnlogstore | The persistent volume claim for FileNet® logs. | cpe-fnlogstore | Yes |
| probe.readiness.initial_delay_seconds | The behavior of readiness probes to know when the containers are ready to start accepting traffic. | 180 | No |
| probe.readiness.period_seconds | The period in seconds. | 30 | No |
| probe.readiness.timeout_seconds | The timeout setting in seconds. | 10 | No |
| probe.readiness.failure_threshold | The threshold number for failures. | 6 | No |
| probe.liveness.initial_delay_seconds | The behavior of liveness probes to know when to restart a container. | 600 | No |
| probe.liveness.period_seconds | The period in seconds. | 30 | No |
| probe.liveness.timeout_seconds | The timeout setting in seconds. | 10 | No |
| probe.liveness.failure_threshold | The threshold number for failures. | 6 | No |
| image_pull_secrets.name | The secrets to be able to pull images. | admin.registrykey | Yes, only if you want to override the comparable setting in the shared configuration section. |