Installing IBM Cloud Pak foundational services by using the CLI

Ensure that your IBM Cloud Pak namespace exists in your cluster. The namespace is needed for the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator.

Usually, the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator is automatically installed in your IBM Cloud Pak namespace when you install your IBM Cloud Pak. If you see the operator in your IBM Cloud Pak namespace, you do not need to manually install it. The Operand Deployment Lifecycle Manager and the foundational services are then, by default, installed in the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs_ns" data-variable="keyword.cs_ns" class="md-conref">keyword.cs_ns</span> namespace.

• If your IBM Cloud Pak namespace exists in your cluster, and you installed your IBM Cloud Pak but you don't see the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator in your IBM Cloud Pak namespace, then you need to create only the subscription for the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator. You do not need to create a namespace and OperatorGroup.
• If your IBM Cloud Pak namespace does not exist in your cluster, then you need to create a namespace for your IBM Cloud Pak, and a OperatorGroup and subscription for the <span data-key-file="/home/jenkins/workspace/workspace/dita-converter/git_repo/conrefs.yml" data-conkeyref="conrefs/keyword.cs" data-variable="keyword.cs" class="md-conref">keyword.cs</span> operator. In the Subscription definition, specify your IBM Cloud Pak namespace as the namespace parameter value.

See the following notes:

• You can set the approval strategy to either Automatic or Manual, as required. By default, the approval strategy is set to Automatic, which automatically installs or upgrades the operator when a new version is available. If you set the strategy to Manual, the operator is not automatically installed or upgraded. Instead, you get an install plan that needs to be manually approved before an upgrade.

• When you set the InstallPlanApproval for the IBM Cloud Pak foundational services operator, it applies to all foundational services installed with this operator.

• If you install the IBM Cloud Pak foundational services operator in a namespace where another operator is installed that already has the installPlanApproval: Manual set in its subscription, then the IBM Cloud Pak foundational services operator inherits this setting. The approval plan is set to Manual and IBM Cloud Pak foundational services operator cannot be automatically installed or upgraded. For more information, see Approval strategy.

Complete these steps to install the resources:

1. Create a YAML file named def.yaml with the resources definitions that you need.

   apiVersion: v1
   kind: Namespace
   metadata:
     name: <your IBM Cloud Pak namespace>
   
   ---
   apiVersion: operators.coreos.com/v1alpha2
   kind: OperatorGroup
   metadata:
     name: operatorgroup
     namespace: <your IBM Cloud Pak namespace>
   spec:
     targetNamespaces:
     - <your IBM Cloud Pak namespace>
   
   ---
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: ibm-common-service-operator
     namespace: <your IBM Cloud Pak namespace>
   spec:
     channel: v4.6
     installPlanApproval: Automatic
     name: ibm-common-service-operator
     source: <your-catalog-source>
     sourceNamespace: <your-catalog-source-namespace>
   
   

2. Create the resources that you specified in the definition file.

   oc apply -f def.yaml
   

   Following is a sample output:

   namespace/cloud-pak-1 created
   operatorgroup.operators.coreos.com/operatorgroup created
   subscription.operators.coreos.com/ibm-common-service-operator created
   

3. If you are using License Service, see Installing License Service.

4. If you are using License Service Reporter, see Installing License Service Reporter with the CLI.

5. If you are using the foundational services certificate manager, see Install the IBM Cert Manager Operator.

You can verify the status of the operators by running the following commands:

oc -n <operator-namespace> get csv

Following is a sample command and output:

oc -n <your IBM Cloud Pak namespace> get csv

NAME                                          DISPLAY                                       VERSION   REPLACES                                      PHASE
ibm-common-service-operator.v4.6.16             IBM Cloud Pak foundational services            v4.6.16       ibm-common-service-operator.v4.6.17            Succeeded

Verify whether the CustomResourceDefinitions (CRDs) are created.

oc get crd | grep operandrequest

Following is a sample output:

NAME                               CREATED AT
operandrequests.operator.ibm.com   2020-09-18T10:10:22Z

• Hardware profile: Set the hardware requirements profile based on the workloads in your cluster. For more information about the profiles, see Hardware requirements and recommendations for foundational services.

  • The default profile is starterset. You can change the profile to small, medium, or large, if required.
  • If you are using the foundational services certificate manager service, see Setting the hardware profile and accepting the license.

• License: Accept the license to use foundational services by adding spec.license.accept: true in the spec section.

Complete these steps:

1. Edit the common-service resource.

   oc -n <your-foundational-services-namespace> edit commonservice common-service
   

2. Update the spec.size parameter to set the hardware profile, and add the spec.license.accept: true parameter to accept the license.

   apiVersion: operator.ibm.com/v3
   kind: CommonService
   metadata:
     name: common-service
     namespace: <your-foundational-services-namespace>
   spec:
     license:
       accept: true
     size: starterset
   

For some topologies, you must authorize the foundational services operators to manage service workload across namespaces. For more information, see Authorizing foundational services to perform operations on workloads in a namespace.

Before you deploy foundational services instance, you can customize the configuration of the foundational services that you are installing.

For more information, see Configuring foundational services .