Managing a service broker resource from the management console

Register a service broker resource to create an instance of your services and plans.

Creating a cluster service broker resource

To create a service broker from the management console, complete the following steps:

  1. Log in to your IBM Cloud Private cluster.
  2. From the navigation menu, click Manage > Service Brokers.
  3. On the Cluster Service Broker tab, click the Add ClusterServiceBroker button to add a cluster service broker resource.

  4. In the Add ClusterServiceBroker dialog box, provide the following details:

    • Name: The name of your cluster service broker resource.
    • Url: The service broker end-point.
    • CA bundle: The name of the CA bundle that is trusted by the TLS server.
    • insecureSkipTLSVerify: Check the insecureSkipTLSVerify check box to skip the TLS verification.
    • Secret namespace: The namespace location for the Secret.
    • Secret: The name of the associated Secret.

    Note: You must provide a value for the Name and Url fields.

  5. When you finish customizing your cluster service broker resource, you can click the JSON mode slider to view the JSON mode of your resource. Your service broker resource might resemble the following output: 

     {
   "kind": "ClusterServiceBroker",
   "apiVersion": "servicecatalog.k8s.io/v1beta1",
   "metadata": {
     "name": "ups-broker"
   },
   "spec": {
     "url": "http://ups-broker-ups-broker.ups-broker.svc.cluster.local"
   }
 }

  6. Click Create.

A cluster service broker is created from the management console.

Creating a namespace service broker resource

  1. Log in to your IBM Cloud Private cluster.
  2. From the navigation menu, click Manage > Service Brokers.
  3. On the Namespace Service Broker tab, click Add NamespaceServiceBroker to add a namespace service broker resource.

  4. In the Add NamespaceServiceBroker dialog box, provide the following details:

    • Name: The name of your namespace service broker resource.
    • Namespace: The namespace for the service broker resource.
    • Url: The service broker end-point.
    • CA bundle: The name of the CA bundle that is trusted by the TLS server.
    • insecureSkipTLSVerify: Check the insecureSkipTLSVerify check box to skip the TLS verification.
    • Secret namespace: The namespace location for the Secret.
    • Secret: The name of the associated Secret.

    Note: You must provide a value for the Name, Namespace, and Url fields.

  5. When you finish customizing your namespace service broker resource, you can click the JSON mode slider to view the JSON mode of your resource. Your service broker resource might resemble the following output: 

     {
   "kind": "ServiceBroker",
   "apiVersion": "servicecatalog.k8s.io/v1beta1",
   "metadata": {
     "name": "ups-ns-broker"
     "namespace": <namespace-name>
   },
   "spec": {
     "url": "http://ns-broker-ns-broker.ns-broker.svc.cluster.local"
   }
 }

  6. Click Create.

A namespace service broker resource is created.

Creating a ServiceInstance

  1. Log in to your IBM Cloud Private cluster.
  2. Click Catalog.
  3. Click the example-service Helm chart.
  4. From the Plans section, select a service plan to configure.
  5. Click Configure.
  6. Enter a value for the Instance name field.
  7. Select a custom namespace from the Namespace field.
  8. (Optional) Add a service binding for your server instance by selecting the Add Service Binding check box.
    1. Enter a value for the Binding name field, and the Binding secret name field.
    2. Select a custom namespace from the Binding namespace field.Note: The Binding namespace field is disabled because the binding namespace must match the service instance namespace.
  9. Click Install.

Viewing a brokered service

After you created an instance for a particular broker service and plan, that brokered service instance can be viewed.

  1. From the navigation menu, click Workloads > Brokered Services.
  2. Select a specific broker service instance to view the binding object that is created for the service instance.
  3. (Optional) Add a service binding to your brokered service.
    1. Click Add ServiceBinding to open the Create ServiceBinding.
    2. You must enter a value for the following fields: Binding name, Binding namespace, Service Instance name, and Binding secret name.
    3. When you finish customizing your namespace service broker resource, you can click the JSON mode slider to view the JSON mode of your resource.
    4. Click Create.

Note: Before you delete a broker service instance, you must remove the binding resources.

Dashboard URL

If a broker service instance defines a dashboard URL, you can click Launch, to launch the URL.

For more information about using service brokers, see Managing Service Catalog resources.

Unbinding a ServiceInstance

You must delete the ServiceBinding that you created before you delete an instance from your application. Complete the following steps to unbind a service instance:

  1. Log in to your IBM Cloud Private cluster.
  2. From the navigation menu, click Workloads > Brokered Services.
  3. Click the service instance that you want to unbind from your application.
  4. From the ServiceBindings section, click the Options icon (Options icon) to delete the service binding.
  5. Click Delete.
  6. From the ServiceBinding dialog box, click Delete ServiceBinding.

Your service instance is unbound from your application.

Deleting a ServiceInstance

  1. Log in to your IBM Cloud Private cluster.
  2. From the navigation menu, click Workloads > Brokered Services.
  3. Locate a specific service instance that you want to delete. Click the Options icon (Options icon).
  4. Click Delete.
  5. From the ServiceInstance dialog box, click Delete ServiceInstance.

Your service instance is deleted.

Deleting a ServiceBroker

View the following sections to delete a cluster-level service broker or a namespace-level service broker.

Deleting a cluster-level service broker

  1. Log in to your IBM Cloud Private cluster.
  2. From the navigation menu, click Manage > Service Brokers.
  3. From the Cluster Service Brokers tab, locate a service broker that you want to delete.
  4. Click the Options icon (Options icon).
  5. Click Delete.
  6. From the ClusterServiceBroker dialog box, click Delete ClusterServiceBroker.

Deleting a namespace-level service broker

  1. Log in to your IBM Cloud Private cluster.
  2. From the navigation menu, click Manage > Service Brokers.
  3. Click the Namespace Service Brokers tab.
  4. From the Namespace Service Brokers tab, locate a service broker that you want to delete.
  5. Click the Options icon (Options icon).
  6. Click Delete.
  7. From the NamespaceServiceBroker dialog box, click Delete NamespaceServiceBroker.

Your service broker is deleted.

Deleting a Helm deployment

You must delete the Helm deployment when you clean up the service broker server. Delete the Helm deployment from the management console with the following steps:

  1. From the navigation menu. click Workloads > Helm Releases.
  2. Search for the Helm release you want to delete.
  3. Click the Options icon (Options icon).
  4. Click Delete.
  5. From the response modal, click Delete.

Your Helm release is deleted.

Important: You must complete the deletion process in the following order: unbind your service instance, delete your service instance, delete your service broker, and delete your Helm deployment.