You are viewing documentation for Kubernetes version: v1.19

Kubernetes v1.19 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.

Install Service Catalog using SC

Service Catalog is an extension API that enables applications running in Kubernetes clusters to easily use external managed software offerings, such as a datastore service offered by a cloud provider.

It provides a way to list, provision, and bind with external Managed Services from Service Brokers without needing detailed knowledge about how those services are created or managed.

You can use the GCP Service Catalog Installer tool to easily install or uninstall Service Catalog on your Kubernetes cluster, linking it to Google Cloud projects.

Service Catalog itself can work with any kind of managed service, not just Google Cloud.

Before you begin

  • Understand the key concepts of Service Catalog.

  • Install Go 1.6+ and set the GOPATH.

  • Install the cfssl tool needed for generating SSL artifacts.

  • Service Catalog requires Kubernetes version 1.7+.

  • Install and setup kubectl so that it is configured to connect to a Kubernetes v1.7+ cluster.

  • The kubectl user must be bound to the cluster-admin role for it to install Service Catalog. To ensure that this is true, run the following command:

      kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin --user=<user-name>
    

Install sc in your local environment

The installer runs on your local computer as a CLI tool named sc.

Install using go get:

go get github.com/GoogleCloudPlatform/k8s-service-catalog/installer/cmd/sc

sc should now be installed in your GOPATH/bin directory.

Install Service Catalog in your Kubernetes cluster

First, verify that all dependencies have been installed. Run:

sc check

If the check is successful, it should return:

Dependency check passed. You are good to go.

Next, run the install command and specify the storageclass that you want to use for the backup:

sc install --etcd-backup-storageclass "standard"

Uninstall Service Catalog

If you would like to uninstall Service Catalog from your Kubernetes cluster using the sc tool, run:

sc uninstall

What's next

Last modified October 17, 2020 at 3:21 PM PST: update kubernetes-incubator references (a8b6551c2)