Prerequisite install parameters
Parameters with possible values that are relevant for the installation.
| Parameters | Description | Possible values | Required |
|---|---|---|---|
| SERVER_MEMORY | The total amount of memory for Content Analyzer worker node pods. | 16, 32, etc. | Yes |
| MONGO_SERVER_MEMORY | The total amount of memory for Content Analyzer Mongo node pods. | 16, 32, etc. | Yes |
| MONGO_ADMIN_SERVER_MEMORY | The total amount of memory for Content Analyzer Mongo Admin node pods. | 16, 32, etc. | Yes |
| USING_HELM | Indicates whether you want to deploy Content Analyzer with Helm Chart. If the value is n, Content Analyzer is deployed with Kubernetes YAML files. | y or n | Yes |
| HELM_INIT_BEFORE | This field indicates whether you want the script to install the Helm client. Set it to n if you are not installing Content Analyzer by using Helm, if helm is already installed, or you want to install helm manually. | y or n | Yes |
| ICP_VERSION or OCP_VERSION |
ICP version is 3.1.2. OCP version is 3.11. |
3.1.2 or 3.11 | Yes |
| KUBE_NAME_SPACE | The Kubernetes namespace that Content Analyzer is installed on. | Any valid namespace. | Yes |
| DOCKER_REG_FOR_SERVICES |
This parameter is the Content Analyzer domain that is used in the ICP and OCP cluster, docker registry port, and your namespace. An ICP example: mycluster.icp:8500/sp mycluster.icp: is the Content Analyzer domain. 8500: is the docker registry port. sp: is the namespace where you want to install Content Analyzer. An OCP example: docker-registry.default.svc:5000/sp docker-registry.default.svc: is the Content Analyzer domain. 5000: is the docker registry port. sp: is the namespace where you want to install Content Analyzer on. |
ICP example: mycluster.icp:8500/sp OCP example:docker-registry.default.svc:5000/sp |
Yes |
| LABEL_NODE |
Content Analyzer is installed on nodes with the following labels:
Content Analyzer processing components are deployed on a node or nodes with label
Mongo db is deployed on a node with label
Mongo Admin db is deployed on a node with label
Example: The node names are concatenated with the namespace. If the namespace is
sp:
You must manually label your nodes based on the guidelines if LABEL_NODE = n. |
y or n | Yes |
| CA_WORKERS | A list of comma-separated IP addresses (ICP) or hostnames (OCP) of worker nodes to be labeled
as celery<KUBE_NAME_SPACE>=baca. NOTE: You can share
the nodes with |
Yes, if LABEL_NODE = y. | |
| MONGO_WORKERS | A list of comma-separated IP addresses (ICP) or hostnames (OCP) of worker nodes to be labeled
as mongo<KUBE_NAME_SPACE>=baca.NOTE: You can share the nodes with worker pods if you have a small cluster for development purposes. |
Yes, if LABEL_NODE = y. | |
| MONGO_ADMIN_WORKERS | A list of comma-separated IP addresses (ICP) or hostnames (OCP) of worker nodes to be labeled
as mongo-admin<KUBE_NAME_SPACE>=baca.NOTE: You can share the nodes with worker pods if you have a small cluster for development purposes. |
Yes, if LABEL_NODE = y. | |
| ICP_USER or OCP_USER | ICP username (ICP_USER) or OpenShift username (OCP_USER) with enough permission to deploy Content Analyzer. | Yes | |
| ICP_USER_PASSWORD or OCP_USER_PASSWORD |
The ICP or OCP username password. It must be encoded with base 64. For example, you run this command if the password is admin: echo 'admin' |base64 |
Yes | |
| BXDOMAINNAME | IP address of the proxy node for your ICPs or the etcd node for your OCPs. | Yes | |
| MASTERIP | IP address of the master node for your ICPs or OCPs. | Yes | |
| PVCCHOICE | Set PVCCHOICE=1 if you want the script to create directories, PVs, and
PVCs that are needed for Content Analyzer. The script does the following tasks: 1. Create the following directories on the NFS server. a.
b.
c.
2.
Change the owners to 3. Append all the worker IP addresses to
the content in the If PVCCHOICE=2, you must create the directories, PVs, and PVCs manually. For more information, see DATAPVC, LOGPVC, and CONFIGPVC. |
1 or 2 | No, if you create the PVs and PVCs manually. |
| SSH_USER | The user that is used in a script to log in (SSH) to the NFS server (NFS_IP) to create the necessary folders. This user must have sudo privilege. | No, if PVCCHOICE=2 (create manually). | |
| NFS_IP | The NFS Server IP address. | No, if PVCCHOICE=2 (create manually). | |
| DATAPVC | Name of the data PVC. If you use a different name, you must change it in values.yaml. | sp-data-pvc | Yes |
| LOGPVC | Name of the log PVC. If you use a different name, you must change it in values.yaml. | sp-log-pvc | Yes |
| CONFIGPVC | Name of the config PVC. If you use a different name, you must change it in values.yaml. | sp-config-pvc | Yes |
| BASE_DB_PWD | This base-64 encoded password is for the Content Analyzer base database. For example: you run
this command if the password is admin: echo 'admin' |base64 |
Yes | |
| LDAP | Indicate whether you want to integrate Content Analyzer with an external LDAP provider. | y or n | Yes |
| LDAP_PASSWORD | This base-64 encoded password is for the LDAP bind user. For example, you run this command if
the password is admin: echo 'admin' |base64 |
Yes, if LDAP=y. | |
| LDAP_URL |
The LDAP URL such as ldap://192.168.10.10 for non-SSL. For SSL, you can use ldaps://192.168.10.10. |
Yes, if LDAP=y. | |
| LDAP_CRT_NAME | The name of the LDAP server client certificate when ldaps is used in the LDAP_URL. For more information on how to generate the required certificate, see the LDAP vendor documentation. | Yes, if you are using ldaps. | |
| New in 19.0.2 DB_SSL | Indicate whether the backend of Content Analyzer is to communicate to the database through SSL or not. | y or n | Yes |
| New in 19.0.2 DB_CRT_NAME | The name of the private certificate that is created from the database server. The private
certificate must be created from the database server, and copied to the folder where
init_deployments.sh is located. For more information on how to set up SSL for Db2®, see the Db2 documentation. |
The certificate name. | No, if DB_SSL=n. |