IBM Enterprise Records parameters

Update the custom YAML file with the details of your Enterprise Records deployment.

For a more focused YAML file that contains the default value for each Enterprise Records parameter, see the ier_sample_cr.yaml file. You can use this shorter sample resource file to compile all the values you need for your Enterprise Records environment, then copy the sections into the ier_v1_ier_cr_template.yaml file before you deploy.

The following is a list of Enterprise Records configuration parameters:

Table 1. Configuration parameters
Parameters Description Default values Required
Replica count
  • replica_count
 How many IBM Enterprise Records replicas to deploy.

  • 1
 No
Image
  • repository
  • tag
  • pull_policy
 Specifies the image to be used.

  • cp.icr.io/cp/cp4a/ier/ier
  • ga-5218-if003-ier-2202
  • IfNotPresent
 No
Secrets
  • ier_secret_name
  • ier_ext_tls_secret_name
  • ier_auth_ca_secret_name
 Contains information about the keystore password, the Transport Layer Socket (TLS) certificate, and the Certificate Authority (CA) certificate.

Set the TLS key if you have an external TLS certificate. Leave it empty if you do not have an external TLS certificate, and the operator generates one for you.

Set the CA key if you have a CA to sign the external TLS certificate. Leave the parameter empty if you do not have the CA of your external TLS certificate, and the operator generates one for you.

 ibm-ier-secret

{{ meta.name}}-ier-ext-tls-secret

{{ meta.name}}-ier-auth-ca-secret

 No
Log
  • format
 The format for workload logging.

  • json
 No
Resources > requests
  • cpu
  • memory

  • Specify a CPU request for the container.
  • Specify a memory request for the container.

  • 500m
  • 512Mi
 No
Resources > limits
  • cpu
  • memory

  • Specify a CPU limit for the container.
  • Specify a memory limit for the container.

  • 1
  • 1536Mi
 No
Auto scale
  • enabled
  • max_replicas
  • min_replicas
  • target_cpu_utilization_percentage

enabled: Specify whether to enable auto scaling.

max_replicas: The upper limit for the number of pods that can be set by the autoscaler.

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.

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.

  • false
  • 3
  • 1
  • 80
 No
Route public hostname
  • hostname
 Provide a hostname that the operator uses to create an OpenShift route definition to access the application, most often the host name of the infrastructure node in Open Shift.

This parameter does not apply for non-OpenShift platforms.

 <hostname> No

ier_production_setting

  • license

The value must be set to 'accept' to deploy.

accept

 No
Storage license

dba_license

 The value must be set to 'accept' to deploy.

accept

 No
License

license

 The value must be set to 'accept' to deploy. accept No
Run as user
  • run_as_user
 User to run the deployment. If run_as_user is commented out, the deployment uses a UID auto-assigned by Open Shift.   No
Logs PVC name

datavolume

  • existing_pvc_for_ier_instance

  • The persistent volume claim for IBM Enterprise Records logs.

  • ier-instance
 No
probe > readiness
  • initial_delay_seconds
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of readiness probes to know when the containers are ready to start accepting traffic.

  • 180
  • 5
  • 10
  • 6
 No
probe > liveness
  • initial_delay_seconds
  • period_seconds
  • timeout_seconds
  • failure_threshold
 The behavior of liveness probes to know when to restart a container.

600

5

5

6

 No
ier_configuration.storage.size_for_logstore Specify the size for Enterprise Records log store. 1Gi No
ier_configuration.storage.storage_class Specify the storage class for Enterprise Records log store persistent volume claim (PVC).   No