Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Clean docs 2 #2620

Merged
merged 2 commits into from
May 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,21 +92,6 @@ and run `helm init --upgrade`.
For more details on installation, see the
[Helm installation instructions](https://github.com/kubernetes/helm/blob/master/docs/install.md).

### Tiller Permissions

Tiller is the in-cluster server component of Helm. By default,
`helm init` installs the Tiller pod into the `kube-system` namespace,
and configures Tiller to use the `default` service account.

Tiller will need to be configured with `cluster-admin` access to properly install
Service Catalog:

```console
kubectl create clusterrolebinding tiller-cluster-admin \
--clusterrole=cluster-admin \
--serviceaccount=kube-system:default
```

## Helm Repository Setup

Service Catalog is easily installed via a
Expand Down
8 changes: 7 additions & 1 deletion docs/tasks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,10 @@ offers available on your cluster.

## [Synchronize a Broker](./sync_broker.md)

When a broker's catalog changes, it may need to be resynchroized with Service Catalog.
When a broker's catalog changes, it may need to be resynchronized with Service Catalog.

## [Remove a Stuck Instance or Binding](./stuck_instance.md)

When a broker stops responding, a user may be unable to delete instances and
bindings belonging to that broker. In such cases, the user may need to
forcefully remove such 'stuck' instances or bindings.
47 changes: 47 additions & 0 deletions docs/tasks/stuck_instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@

---
title: Remove a Stuck Instance or Binding
layout: docwithnav
---

For a variety of reasons, a service broker may stop responding to requests.
A user may still need to remove instances and bindings belonging to that broker,
bypassing the safeguards normally in place. Note that these are are destructive
operations that may leave orphaned state still existing on the broker.

Service Catalog maintains a [finalizer](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#finalizers)
on each of the resources it maintains. This prevents the resource from being
deleted before Service Catalog has a chance to reconcile the resource with
the relevant service broker. In the event that an instance becomes stuck,
manually removing the finalizer will allow the resource to be deleted. The finalizer can
be manualy removed with `kubectl`, or by using the `--abandon` flag in the svcat `deprovision`
and `unbind` commands.

## Abandon an instance
```console
$ svcat deprovision foobar-mysql --abandon
This action is not reversible and may cause you to be charged for the broker resources that are abandoned. If you have any bindings for this instance, please delete them manually with svcat unbind --abandon --name bindingName
Are you sure? [y|n]:
y
deleted foobar-mysql
```
Note that bindings belonging to the instance will not be cleaned up as part of the operation, and should be manually cleaned up before deprovisioning the instance.

## Abandon all bindings belonging to an instance
```console
$ svcat unbind foobar-mysql --abandon
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: this is actually abandoning all bindings for the specified instance (title says "Abandon a binding"). Maybe change the title or add additional example that shows $ svcat unbind --name foobar-binding --abandon

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch

This action is not reversible and may cause you to be charged for the broker resources that are abandoned.
Are you sure? [y|n]:
y
deleted foobar-mysql
deleted other-foobar-mysql-binding
```

## Abandon a specific binding
```console
$ svcat unbind --name other-foobar-mysql --abandon
This action is not reversible and may cause you to be charged for the broker resources that are abandoned.
Are you sure? [y|n]:
y
deleted other-foobar-mysql-binding
```
2 changes: 2 additions & 0 deletions docsite/_data/tasks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ toc:
path: /docs/tasks/install_broker
- title: Sync a Broker
path: /docs/tasks/sync_broker
- title: Remove a stuck instance/binding
path: /docs/tasks/stuck_instance