Chapter 3. Service brokers

Procedure

1. Enable Service Catalog’s API server.

   1. Use the following command to edit Service Catalog’s API server resource.

      $ oc edit servicecatalogapiservers

   2. Under spec, set the managementState field to Managed:

      spec:
        logLevel: Normal
        managementState: Managed

   3. Save the file to apply the changes.

      The Operator installs Service Catalog’s API server component. As of OpenShift Container Platform 4, this component is installed into the openshift-service-catalog-apiserver namespace.

2. Enable Service Catalog’s controller manager.

   1. Use the following command to edit Service Catalog’s controller manager resource.

      $ oc edit servicecatalogcontrollermanagers

   2. Under spec, set the managementState field to Managed:

      spec:
        logLevel: Normal
        managementState: Managed

   3. Save the file to apply the changes.

      The Operator installs Service Catalog’s controller manager component. As of OpenShift Container Platform 4, this component is installed into the openshift-service-catalog-controller-manager namespace.

3. Verify that the installation is completed successfully by checking that Service Catalog appears in the left navigation of the web console.

Procedure

1. Using an account with cluster-admin privileges, edit the servicecatalogcontrollermanagers resource:

   $ oc edit servicecatalogcontrollermanagers

2. Change the managementState parameter from Managed back to the default Removed, and save your changes.

3. Edit the servicecatalogapiservers resource:

   $ oc edit servicecatalogapiservers

4. Change the managementState parameter from Managed back to the default Removed, and save your changes.
5. Verify that the removal is completed successfully by checking that Service Catalog is removed from the left navigation of the web console.

1. Create a namespace.

   1. Using the Administrator perspective, navigate in the web console to Administration Namespaces and click Create Namespace.

   2. Enter the following:

      • openshift-template-service-broker in the Name field

        Note

        The namespace must start with openshift-.

      • openshift.io/cluster-monitoring=true in the Labels field
   3. Click Create.
2. Navigate to the Operators OperatorHub page. Verify that the openshift-template-service-broker project is selected.
3. Select Template Service Broker Operator.
4. Read the information about the Operator and click Install.
5. Review the default selections and click Subscribe.

Procedure

1. Using the Administrator perspective, navigate in the web console to Operators Installed Operators and select the openshift-template-service-broker project.
2. Select the Template Service Broker Operator.
3. Under Provided APIs, click Create Instance for Template Service Broker.
4. Review the default YAML and click Create.

5. Verify that the Template Service Broker starts correctly by checking that the template applications are available.

   • To check from the web console, navigate to Service Catalog Broker Management Service Classes to view the list of template application service classes.

   • To check from the CLI:

     $ oc get ClusterServiceClasses -n openshift-template-service-broker

   Note

   It may take a few minutes for the Template Service Broker to start and the template applications to be available.

   If you do not yet see these service classes, you can check the status of the following items:

   • Template Service Broker Pod status

     • From the Workloads Pods page for the openshift-template-service-broker project, verify that the Pod that starts with apiserver- has a status of Running and readiness of Ready.

   • Cluster service broker status

     • From the Service Catalog Broker Management Service Brokers page, verify that the template-service-broker service broker has a status of Ready.

   • Service Catalog controller manager Pod logs

     • From the Workloads Pods page for the openshift-service-catalog-controller-manager project, review the logs for each of the Pods and verify that you see a log entry with the message Successfully fetched catalog entries from broker.

1. Uninstall the Template Service Broker.

   1. Navigate to Operators Installed Operators and select the openshift-template-service-broker project from the drop-down menu.
   2. Click Template Service Broker Operator.
   3. Select the Template Service Broker tab.
   4. Click template-service-broker.
   5. From the Actions drop-down menu, select Delete Template Service Broker.

   6. Click Delete from the confirmation pop-up window.

      The Template Service Broker is now uninstalled, and template applications will soon be removed from the Developer Catalog.

2. Uninstall the Template Service Broker Operator.

   1. From the Operators Installed Operators page, scroll or type a keyword into the Filter by name to find the Template Service Broker Operator, then click on it.
   2. On the right-hand side of the Operator Details page, select Uninstall Operator from the Actions drop-down menu.
   3. When prompted by the Remove Operator Subscription window, optionally select the Also completely remove the Operator from the selected namespace check box if you want all components related to the installation to be removed. This removes the CSV, which in turn removes the Pods, Deployments, CRDs, and CRs associated with the Operator.
   4. Select Remove. This Operator will stop running and no longer receive updates. The Template Service Broker Operator is no longer installed in your cluster.