Installing OpenSearch

A cluster administrator can install OpenSearch on OpenShift for IBM® watsonx.data to provide distributed search and analytics capabilities.

Before you begin

This task assumes that the following prerequisites are met:

  • A version of IBM watsonx.data 2.3.1 patch 3 (IBM Software Hub 5.3.1 patch 3) and above is installed.

  • For environments that use a private container registry, such as air-gapped environments, the watsonx.data and OpenSearch images are mirrored to the private container registry.

  • The workstation from which you will run the installation is set up as a client workstation and includes the following command-line interfaces: OpenShift CLI: oc and Helm CLI: helm.

  • You have cluster administrator privileges on the OpenShift cluster.

Procedure

To install an OpenSearch service on the OpenShift cluster, complete the following steps:

  1. Download CASE packages to a client workstation. 
    cpd-cli manage case-download   \
  --release=${VERSION}   \
  --components=ibm_wxd_opensearch   \
  --cluster_resources=true   \
  --operator_ns=$CPD_INST_OPERATORS
  2. Apply cluster-scoped resources 
    oc apply --server-side -f $WORKDIR/cluster_scoped_resources.yaml
  3. Install the OpenSearch service. 
    cpd-cli manage install-components \
--license_acceptance=true \
--components=ibm_wxd_opensearch \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
  4. Grant the privileged Security Context Constraint (SCC) to the OpenSearch service account.
    OpenSearch contains init containers that require elevated privileges to properly bootstrap the OpenSearch cluster.
    oc adm policy add-scc-to-user privileged -z wxd-opensearch-sa -n $PROJECT_CPD_INST_OPERANDS
  5. For watsonx.data on IBM Power OpenShift environments, run the following command to assign the Security Context Constraints (SCC) UID range: 
    oc edit namespace cpd-instance
openshift.io/sa.scc.uid-range: 1000/10000