2017-11-21 22:52:25 +00:00
---
title: Install Service Catalog using SC
2018-02-18 19:29:37 +00:00
reviewers:
2017-11-21 22:52:25 +00:00
- chenopis
2018-05-05 16:00:51 +00:00
content_template: templates/task
2017-11-21 22:52:25 +00:00
---
2018-05-05 16:00:51 +00:00
{{% capture overview %}}
{{< glossary_definition term_id = "service-catalog" length = "all" prepend = "Service Catalog is" > }}
2017-11-21 22:52:25 +00:00
2019-03-27 14:28:59 +00:00
You can use the GCP [Service Catalog Installer ](https://github.com/GoogleCloudPlatform/k8s-service-catalog#installation )
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.
2017-11-21 22:52:25 +00:00
2018-05-05 16:00:51 +00:00
{{% /capture %}}
2017-11-21 22:52:25 +00:00
2018-05-05 16:00:51 +00:00
{{% capture prerequisites %}}
2017-11-21 22:52:25 +00:00
* Understand the key concepts of [Service Catalog ](/docs/concepts/service-catalog/ ).
* Install [Go 1.6+ ](https://golang.org/dl/ ) and set the `GOPATH` .
2017-12-16 01:20:52 +00:00
* Install the [cfssl ](https://github.com/cloudflare/cfssl ) tool needed for generating SSL artifacts.
2017-11-21 22:52:25 +00:00
* Service Catalog requires Kubernetes version 1.7+.
2019-03-20 23:05:05 +00:00
* [Install and setup kubectl ](/docs/tasks/tools/install-kubectl/ ) so that it is configured to connect to a Kubernetes v1.7+ cluster.
2017-11-21 22:52:25 +00:00
* 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 >
2018-05-05 16:00:51 +00:00
{{% /capture %}}
2017-11-21 22:52:25 +00:00
2018-05-05 16:00:51 +00:00
{{% capture steps %}}
2017-11-21 22:52:25 +00:00
## Install `sc` in your local environment
2019-03-27 14:28:59 +00:00
The installer runs on your local computer as a CLI tool named `sc` .
Install using `go get` :
2017-11-21 22:52:25 +00:00
2019-03-27 14:28:59 +00:00
```shell
2017-11-21 22:52:25 +00:00
go get github.com/GoogleCloudPlatform/k8s-service-catalog/installer/cmd/sc
```
2019-03-27 14:28:59 +00:00
`sc` should now be installed in your `GOPATH/bin` directory.
2017-11-21 22:52:25 +00:00
## Install Service Catalog in your Kubernetes cluster
First, verify that all dependencies have been installed. Run:
```shell
sc check
```
2017-12-16 01:20:52 +00:00
If the check is successful, it should return:
2017-11-21 22:52:25 +00:00
```
Dependency check passed. You are good to go.
2017-12-16 01:20:52 +00:00
```
2017-11-21 22:52:25 +00:00
Next, run the install command and specify the `storageclass` that you want to use for the backup:
```shell
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:
```shell
sc uninstall
```
2018-05-05 16:00:51 +00:00
{{% /capture %}}
2017-11-21 22:52:25 +00:00
2018-05-05 16:00:51 +00:00
{{% capture whatsnext %}}
2017-11-21 22:52:25 +00:00
* View [sample service brokers ](https://github.com/openservicebrokerapi/servicebroker/blob/master/gettingStarted.md#sample-service-brokers ).
* Explore the [kubernetes-incubator/service-catalog ](https://github.com/kubernetes-incubator/service-catalog ) project.
2018-05-05 16:00:51 +00:00
{{% /capture %}}