Generating the custom resource

Depending on the capabilities that you want to install, the deployment script generates a custom resource file with the selected automation containers.

About this task

The script creates a custom resource (CR) file to deploy by the Cloud Pak operator. The deployment script prompts the user to enter values to get access to the container images and to select what is installed with the deployment.

Note: The deployment script uses a custom resource (CR) template file for each pattern. The pattern template names include "enterprise" and are found in the descriptors/patterns folder. The CR files are configured by the deployment script.

Procedure

  1. Log in to the cluster with the cluster administrator used in Preparing for an Enterprise deployment or a non-administrator user who has access to the project.

    Using the OpenShift CLI:

    oc login https://<cluster-ip>:<port> -u <cluster-admin> -p <password> 
  2. Download the appropriate repository to a Linux® based machine (RHEL, CentOS, and macOS) and go to the cert-kubernetes directory.

    For more information about downloading cert-kubernetes, see Preparing for an Enterprise deployment.

  3. Run the deployment script from the local directory where you downloaded the cert-kubernetes repository, and follow the prompts in the command window.
    Note:

    Multiple capabilities can be selected and deployed in the same namespace. The script proposes new options each time you select a capability. Some capabilities are mutually exclusive, so these combinations are never proposed. For more information about the capabilities and their dependencies, see Capabilities for Enterprise deployments.

    If you select Workflow Runtime and Workstreams two server instances are created, one server for each capability. If you want to install both capabilities into one server instance, you need to create the CR by hand and use the fully customizable (FC) template (ibm_cp4a_cr_enterprise_FC_workflow-workstreams.yaml).

    cd scripts
    ./cp4a-deployment.sh
    1. Accept the license. You must agree to the license that is found in cert-kubernetes/LICENSE.
    2. Select a new installation type.
    3. Select the enterprise deployment type.
    4. Select the platform type: ROKS (1) or OCP (2).

      Select Other (3), only if you want to install a standalone deployment of FNCM or BAW.

    5. Choose the capabilities and optional components that you want to install.
      Tip: When prompted, press the Enter key to skip optional components.
    6. For 21.0.1 Enter the route hostname.
    7. Enter the storage class for your dynamic storage provisioner.

Results

A custom resource file is created scripts/generated-cr/ibm_cp4a_cr_final.yaml.

Tip: You can rename the file and move it to another folder, or you can continue to use the file from this location. Because the maximum length of labels in Kubernetes is 63 characters, be careful with the lengths of your CR name and instance names. Some components can configure multiple instances, each instance must have a different name. The total length of the CR name and an instance name must not exceed 24 characters, otherwise some component deployments fail. When your deployment contains Workflow Authoring, the total length of the CR name cannot exceed 22 characters.

What to do next

If you completed this task, you can skip the step to manually compile the custom resource file and go directly to Checking and completing your custom resource.