Chapter 3. Service brokers

Procedure

1. Enable the service catalog API server.

   1. Use the following command to edit the service catalog 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 the service catalog API server component. As of OpenShift Container Platform 4, this component is installed into the openshift-service-catalog-apiserver namespace.

2. Enable the service catalog controller manager.

   1. Use the following command to edit the service catalog 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 the service catalog controller manager component. As of OpenShift Container Platform 4, this component is installed into the openshift-service-catalog-controller-manager namespace.

1. Create a namespace.

   1. Navigate in the web console to Administration Namespaces and click Create Namespace.

   2. Enter openshift-template-service-broker in the Name field and click Create.

      Note

      The namespace must start with openshift-.

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. 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 New for Template Service Broker.
4. Review the default YAML and click Create.

5. Verify that the Template Service Broker has started.

   After the Template Service Broker has started, you can view the available template applications by navigating to Catalog Developer Catalog and selecting the Service Class checkbox. Note that 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 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.

Procedure

1. Create a project.

   1. Navigate in the web console to Home Projects and click Create Project.
   2. Enter test-postgresql in the Name field and click Create.

2. Create a service instance.

   1. Navigate to the Catalog Developer Catalog page.
   2. Select the PostgreSQL (Ephemeral) template application and click Create Service Instance.
   3. Review the default selections and set any other required fields, and click Create.

   4. Go to Catalog Provisioned Services and verify that the postgresql-ephemeral service instance is created and has a status of Ready.

      You can check the progress on the Home Events page. After a few moments, you should see an event for postgresql-ephemeral with the message "The instance was provisioned successfully".

3. Create a service binding.

   1. From the Provisioned Services page, click postgresql-ephemeral and click Create Service Binding.

   2. Review the default service binding name and click Create.

      This creates a new secret for binding using the name provided.

4. Review the secret that was created.

   1. Navigate to Workloads Secrets and verify that a secret named postgresql-ephemeral was created.
   2. Click postgresql-ephemeral and review the key-value pairs in the Data section, which are used for binding to other apps.

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.

1. A user requests the list of available applications from the service catalog using the OpenShift Container Platform web console.
2. The service catalog requests the list of available applications from the OpenShift Ansible Broker.
3. The OpenShift Ansible Broker communicates with a defined container image registry to learn which APBs are available.
4. The user issues a request to provision a specific APB.
5. The OpenShift Ansible Broker fulfills the user’s provision request by invoking the provision method on the APB.

1. Create a namespace.

   1. Navigate in the web console to Administration Namespaces and click Create Namespace.

   2. Enter openshift-ansible-service-broker in the Name field and openshift.io/cluster-monitoring=true in the Labels field and click Create.

      Note

      The namespace must start with openshift-.

2. Create a cluster role binding.

   1. Navigate to Administration Role Bindings and click Create Binding.
   2. For the Binding Type, select Cluster-wide Role Binding (ClusterRoleBinding).
   3. For the Role Binding, enter ansible-service-broker in the Name field.
   4. For the Role, select admin.
   5. For the Subject, choose the Service Account option, select the openshift-ansible-service-broker namespace, and enter openshift-ansible-service-broker-operator in the Subject Name field.
   6. Click Create.

3. Create a secret to connect to the Red Hat Container Catalog.

   1. Navigate to Workloads Secrets. Verify that the openshift-ansible-service-broker project is selected.
   2. Click Create Key/Value Secret.
   3. Enter asb-registry-auth as the Secret Name.
   4. Add a Key of username and a Value of your Red Hat Container Catalog user name.
   5. Click Add Key/Value and add a Key of password and a Value of your Red Hat Container Catalog password.
   6. Click Create.
4. Navigate to the Operators OperatorHub page. Verify that the openshift-ansible-service-broker project is selected.
5. Select OpenShift Ansible Service Broker Operator.
6. Read the information about the Operator and click Install.
7. Review the default selections and click Subscribe.

Procedure

1. Navigate in the web console to Operators Installed Operators and select the openshift-ansible-service-broker project.
2. Select the OpenShift Ansible Service Broker Operator.
3. Under Provided APIs, click Create New for Automation Broker.

4. Add the following to the spec field in the default YAML provided:

   registry:
     - name: rhcc
       type: rhcc
       url: https://registry.redhat.io
       auth_type: secret
       auth_name: asb-registry-auth

   This references the secret that was created when installing the OpenShift Ansible Service Broker Operator, which allows you to connect to the Red Hat Container Catalog.

5. Set any additional OpenShift Ansible Broker configuration options and click Create.

6. Verify that the OpenShift Ansible Broker has started.

   After the OpenShift Ansible Broker has started, you can view the available service bundles by navigating to Catalog Developer Catalog and selecting the Service Class checkbox. Note that it may take a few minutes for the OpenShift Ansible Broker to start and the service bundles to be available.

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

   • OpenShift Ansible Broker Pod status

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

   • Cluster service broker status

     • From the Catalog Broker Management Service Brokers page, verify that the ansible-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. Navigate in the web console to Operators Installed Operators and select the ansible-service-broker project.
2. Select the OpenShift Ansible Service Broker Operator.
3. On the Automation Broker tab, select ansible-service-broker.

4. On the YAML tab, add or update any OpenShift Ansible Broker configuration options under the spec field.

   For example:

   spec:
     keepNamespace: true
     sandboxRole: edit

5. Click Save to apply these changes.

Procedure

1. Create the role.

   1. Navigate to Administration Roles and click Create Role.

   2. Replace the YAML in the editor with the following:

      apiVersion: rbac.authorization.k8s.io/v1
      kind: Role
      metadata:
        name: prometheus-k8s
        namespace: openshift-ansible-service-broker
      rules:
      - apiGroups:
        - ""
        resources:
        - services
        - endpoints
        - pods
        verbs:
        - get
        - list
        - watch

   3. Click Create.

2. Create the role binding.

   1. Navigate to Administration Role Bindings and click Create Binding.
   2. For the Binding Type, select Namespace Role Binding (RoleBinding).
   3. For the Role Binding, enter prometheus-k8s in the Name field and openshift-ansible-service-broker in the Namespace field.
   4. For the Role, select prometheus-k8s.
   5. For the Subject, choose the Service Account option, select the openshift-monitoring namespace, and enter prometheus-k8s in the Subject Name field.
   6. Click Create.

Procedure

1. Create a project.

   1. Navigate in the web console to Home Projects and click Create Project.
   2. Enter test-postgresql-apb in the Name field and click Create.

2. Create a service instance.

   1. Navigate to the Catalog Developer Catalog page.
   2. Select the PostgreSQL (APB) service bundle and click Create Service Instance.
   3. Review the default selections and set any other required fields, and click Create.

   4. Go to Catalog Provisioned Services and verify that the dh-postgresql-apb service instance is created and has a status of Ready.

      You can check the progress on the Home Events page. After a few moments, you should see an event for dh-postgresql-apb with the message "The instance was provisioned successfully".

3. Create a service binding.

   1. From the Provisioned Services page, click dh-postgresql-apb and click Create Service Binding.

   2. Review the default service binding name and click Create.

      This creates a new secret for binding using the name provided.

4. Review the secret that was created.

   1. Navigate to Workloads Secrets and verify that a secret named dh-postgresql-apb was created.
   2. Click dh-postgresql-apb and review the key-value pairs in the Data section, which are used for binding to other apps.

1. Uninstall the OpenShift Ansible Broker.

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

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

      The OpenShift Ansible Broker is now uninstalled, and service bundles will soon be removed from the Developer Catalog.

2. Uninstall the OpenShift Ansible Service Broker Operator.

   1. From the Operators Installed Operators page, scroll or type a keyword into the Filter by name to find the OpenShift Ansible 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.