Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
    2. history
×

Installing Service Catalog

Service Catalog is deprecated in OpenShift Container Platform 4. Equivalent and better functionality is present in the Operator Framework and Operator Lifecycle Manager (OLM).

Starting in OpenShift Container Platform 4.4, the service-catalog-controller-manager and service-catalog-apiserver cluster Operators are now set to Upgradeable=false. This means that they will block future cluster upgrades to the next minor version, for example 4.5, if they are still installed at that time. Upgrading to z-stream releases such as 4.4.z, however, are still permitted in this state.

About Service Catalog

When developing microservices-based applications to run on cloud native platforms, there are many ways to provision different resources and share their coordinates, credentials, and configuration, depending on the service provider and the platform.

To give developers a more seamless experience, OpenShift Container Platform includes Service Catalog, an implementation of the Open Service Broker API (OSB API) for Kubernetes. This allows users to connect any of their applications deployed in OpenShift Container Platform to a wide variety of service brokers.

Service Catalog allows cluster administrators to integrate multiple platforms using a single API specification. The OpenShift Container Platform web console displays the cluster service classes offered by service brokers in Service Catalog, allowing users to discover and instantiate those services for use with their applications.

As a result, service users benefit from ease and consistency of use across different types of services from different providers, while service providers benefit from having one integration point that gives them access to multiple platforms.

Service Catalog is not installed by default in OpenShift Container Platform 4.

Installing Service Catalog

If you plan on using any of the services from the Template Service Broker, you must install Service Catalog by completing the following steps.

The custom resources for Service Catalog’s API server and controller manager are created by default in OpenShift Container Platform, but initially have a managementState of Removed. To install Service Catalog, you must change the managementState for these resources to Managed.

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.