Installing foundational services by using a script

Edit online

The following procedure guides you through the installation of foundational services by using a script.

The script also installs the IBM NamespaceScope Operator. Hence, use the script only if your cluster has topology types as described in Topologies that need the IBM NamespaceScope operator.

Parameters

Edit online

The script needs the following parameters:

Table 1. Parameters
Parameter Type Optional or Mandatory Description
--oc string optional File path to oc CLI. By default, your current PATH is used.
--enable-licensing Flag optional Set this flag to install ibm-licensing-operator.
--operator-namespace string mandatory Namespace to install foundational services operator.
--services-namespace string optional; Default is the same as operator-namespace. Namespace to install operands of foundational services.
--tethered-namespaces string optional Additional namespaces for a tenant; comma-delimited. For example, ns1,ns2.
--excluded-namespaces string optional Removes namespaces from a tenant; comma-delimited. For example, ns1,ns2.
--license-accept flag mandatory Set this flag to accept the license agreement.
-c, --channel string optional; Default is your version of foundational services, such as v4.15. Subscription channel
-i, --install-mode string optional; Default mode is Automatic. InstallPlan Approval Mode; Set toManual for manual approval mode.
-s, --source string optional; Default is opencloud-operators. CatalogSource name; You must create your catalog source if you want to use this parameter.
-n, --namespace string optional; Default is openshift-marketplace. Namespace of catalog source.
-v, --debug integer optional; Default is 0. Verbosity of logs. Set to 1 for debug logs.
-h, --help string optional Print usage information.

Foundational services installation

Edit online

Complete these steps to run the script and install foundational services.

  1. Download the cp3pt0-deployment folder from the installer_scripts folder in CASE bundle. For information on downloading the scripts, see Downloading scripts for additional configuration from specific version CASE bundle.

    Go to your downloaded installer_scripts directory:

    cd ${installer_scripts}/cp3pt0-deployment

  2. Run the script by passing the parameters. See Table 1. Parameters for the list of optional parameters that you can pass. The script installs the operators, sets up the hardware profile, accepts all licenses, and configures namespace permissions.

    Note: You must provide the --license-accept and --operator-namespace parameters.
    ./setup_tenant.sh --license-accept --operator-namespace <foundational-services-namespace> [--tethered-namespaces|--services-namespace|--excluded-namespaces> <namespace> [OPTIONS]

  3. Proceed with installing foundational services .

Example command parameters for different topologies

Edit online

For information about the topologies, see Topologies that need the IBM NamespaceScope operator.

Example for topology 1

Edit online

For more information about the parameters used here, see the NamespaceScope CR for topology 1.

setup_tenant.sh --license-accept \
--enable-licensing \
--operator-namespace tenant1-services \
--services-namespace tenant1-services \
--tethered-namespaces tenant1-cp4ba,tenant1-cp4i \
-c v4.15 \
-i Automatic \
-s opencloud-operators \
-n openshift-marketplace \
-v 1

Example for topology 2

Edit online

For more information about the parameters used here, see the NamespaceScope CR for topology 2.

setup_tenant.sh --license-accept \
--enable-licensing \
--operator-namespace tenant1-control \
--services-namespace tenant1-data \
-c v4.15 \
-i Automatic \
-s opencloud-operators \
-n openshift-marketplace \
-v 1

Example for topology 3

Edit online

For more information about the parameters used here, see the NamespaceScope CR for topology 3.

setup_tenant.sh --license-accept \
--enable-licensing \
--operator-namespace tenant1-operators \
--services-namespace tenant1-instance \
--tethered-namespaces tenant1-instance-tethered1,tenant1-instance-tethered2 \
-c v4.15 \
-i Automatic \
-s opencloud-operators \
-n openshift-marketplace \
-v 1

What to do next

Edit online

You installed the foundational services operator and you can now apply your entitlement key for online installation. For more information, see Applying your entitlement key for online installation.

If you are using an air-gapped cluster, your entitlement key is already applied as a part of the air-gapped image mirroring process. You do not need to apply your entitlement key again. You can now deploy the foundational services instances. For more information, see Deploying the foundational services instances.