Helm chart configuration parameters
Parameters with possible values that are relevant for the configuration of your container environment.
Global parameter
The following variables are used in multiple places. Run a global search and replace with the correct information (for example, in vi - :%s/$REGISTRY_NAME/docker-registry.default.svc:5000\/sp/g):
| Name | Description | Note |
|---|---|---|
| $REGISTRY_NAME | Refers to the name of the local registry where Business Automation Content Analyzer images are loaded, in the format <registry>/<namespace> (for example, docker-registry.default.svc:5000/sp or mycluster.icp:8500/baca). There are 18 occurrences of this tag in the values.yaml that need to be updated. | |
| $VERSION_TAG | Refers to the version tag of the docker images loaded into the registry (for example, 1.0.1-gm). There are also 18 occurrences of this value in values.yaml that need to be updated. | |
| $CELERY_REPLICAS | Determines the number of celery pods to start. Recommended value is 1 per worker node. 11 occurrences of this value. | |
| $NON_CELERY_REPLICAS | Determines the number of pods for non-celery. Recommended value is 1 per worker node. 2 occurrences of this value. | |
| $KUBE_NAME_SPACE | The Kubernetes namespace or OpenShift project where Content Analyzer is to be deployed. 5 occurrences of this value. | |
| claimname | Change the values of the PVC claim name if you did not use the default values in common.sh. 3 occurrences of this value. | Optional |
Resource limit parameters
Use the sample installation script generateMemoryValues.sh to determine the appropriate values for each of the following values based on your environment:
| Name | Description | Note |
|---|---|---|
| $CALLERAPI_LIMITED_MEMORY | ||
| $SETUP_LIMITED_MEMORY | ||
| $OCR_EXTRACTION_LIMITED_MEMORY | ||
| $CLASSIFY_LIMITED_MEMORY | ||
| $PROCESSING_EXTRACTION_LIMITED_MEMORY | ||
| $POST_PROCESS_LIMITED_MEMORY | ||
| $INTER_PROCESSING_LIMITED_MEMORY | ||
| $PDF_PROCESS_LIMITED_MEMORY | ||
| $UTF8_PROCESS_LIMITED_MEMORY | ||
| $REANALYZE_LIMITED_MEMORY | ||
| $UPDATEFILE_LIMITED_MEMORY | ||
| $FRONTEND_LIMITED_MEMORY | ||
| $BACKEND_LIMITED_MEMORY | ||
| $MINIO_LIMITED_MEMORY | ||
| $REDIS_LIMITED_MEMORY | ||
| $RABBITMQ_LIMITED_MEMORY | ||
| $MONGO_WIREDTIGER_LIMIT | This value must be entered as a number only in GB. For example, 0.3 and not 0.3Gi or 300Mi. | |
| $MONGO_LIMITED_MEMORY | ||
| $MONGO_ADMIN_LIMITED_MEMORY |
LDAP parameters
When you integrate with an LDAP repository to log in, you need to set the optional parameters. Note that if you do not use LDAP, then the ldap setting under spbackend and spfrontend must be set to FALSE and the rest of the values left blank.
| Name | Description | Note |
|---|---|---|
| spfrontend | ||
| ldap | TRUE OR FALSE depending on whether you are using LDAP. | |
| spbackend | ||
| ldap | TRUE OR FALSE depending on whether you are using LDAP. | |
| ldapFilter | search filter to find user. Use ‘{{username}}’ as substitution variable, for example (&(cn={{username}})(objectClass=person)) | |
| ldapDn | dn of bind user (for example, cn=root) | |
| ldapURL | URL of ldap server (for example, ldap://xx.xx.xx.xx | |
| ldapPort | ldap port (for example, 389) | |
| ldapBase | ldap search base | |
| userName | User name of initial user | |
| ldapCrtName | If using LDAPS, specify certificate from LDAP server | |
| ldapSelfSignedCert | Y if using a self-signed certificate. N otherwise |
Db2 parameters
Set the following parameters on spbackend to tell Business Automation Content Analyzer how to connect to the BaseDB on Db2®:
| Name | Description | Note |
|---|---|---|
| baseDB | Name of the base database created on Db2 (for example, CABASEDB) | |
| baseDBServer | Host name of the Db2 server | |
| baseDBPort | Listener port for the Db2 server | |
| baseDBUser | User to log in to Db2 and access Base DB | The password for the user is stored in the secret baca-basedb, which is created by the init_deployment.sh script or manually. |
| Parameters | Description |
|---|---|
| bxDomainName | Domain name or IP used to access the fronted or backend. |
| backendHost | Domain name or IP used in URL to access backend. Usually, the same as BXDOMAINNAME. If using ingress with non-default port (80 or 443), then include port in host name (for example, my.domain.com:444). |
| backendPath | Specify the path for the backend (for example, in http://my.domain.com/backendsp the path is backendsp). |
| frontendHost | Domain name or IP used in URL to access the frontend. Usually, the same as BXDOMAINNAME. If you use ingress with non-default port (80 or 443), then include the port with the host name (for example, my.domain.com:444). |
| frontendPath | Specify the path for the frontend (for example, in http://my.domain.com/frontendsp the path is frontendsp). |
| $HOST_NAME | Specify the host name or IP used to access ingress. |