forked from cloudfoundry/docs-services
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmanaging-service-brokers.html.md.erb
190 lines (137 loc) · 8.92 KB
/
managing-service-brokers.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
---
title: Managing Service Brokers
owner: Core Services
---
<strong><%= modified_date %></strong>
This page assumes you are using cf CLI v6.16 or later.
In order to run many of the commands below, you must be authenticated with Cloud
Foundry as an admin user or as a space developer.
## <a id='quick-start'></a>Quick Start ##
Given a service broker that has implemented the [Service Broker API](api.html), two steps are required to make its services available to end users in all organizations or a limited number of organizations by service plan.
1. [Register a Broker](#register-broker)
1. [Make Plans Public](#make-plans-public)
As of cf-release 229, CC API 2.47.0, Cloud Foundry supports both standard brokers and space-scoped private brokers. Standard private brokers can offer service plans privately or publish them to specific organizations or to all users. Space-scoped private brokers publish services only to users within the space they are registered to.
## <a id='register-broker'></a>Register a Broker ##
Registering a broker causes Cloud Controller to fetch and validate the catalog
from your broker, and save the catalog to the Cloud Controller database.
The basic auth username and password which are provided when adding a broker are
encrypted in Cloud Controller database, and used by the Cloud Controller to
authenticate with the broker when making all API calls.
Your service broker should validate the username and password sent in every
request; otherwise, anyone could curl your broker to delete service instances.
### Standard Private Brokers ###
<pre class="terminal">
$ cf create-service-broker mybrokername someuser somethingsecure http://mybroker.example.com/
</pre>
### Space-Scoped Private Brokers ###
<pre class="terminal">
$ cf create-service-broker mybrokername someuser somethingsecure http://mybroker.example.com/ --space-scoped
</pre>
### <a id='make-plans-public'></a>Make Plans Public ###
New service plans from standard brokers are private by default. To make plans available to end users, see [Make Plans Public](./access-control.html#enable-access). Instances of a private plan cannot be provisioned until either the plan is made public or is made available to an organization.
New service plans from space-scoped private brokers are automatically published to all users in the broker's space. It is not possible to manage visibility of a space-scoped private broker at the Cloud Foundry instance or organization level.
### <a id='multiple-brokers'></a>Multiple Brokers, Services, Plans ###
Many service brokers may be added to a Cloud Foundry instance, each offering
many services and plans.
The following constraints should be kept in mind:
- It is not possible to have multiple brokers with the same name
- It is not possible to have multiple brokers with the same base URL
- The service ID and plan IDs of each service advertised by the broker must be unique across Cloud Foundry. GUIDs are recommended for these fields.
See [Possible Errors](#possible-errors) below for error messages and what do to
when you see them.
## <a id='list-brokers'></a> List Service Brokers ##
<pre class="terminal">
$ cf service-brokers
Getting service brokers as admin...Cloud Controller
OK
Name URL
my-service-name http://mybroker.example.com
</pre>
## <a id='update-broker'></a>Update a Broker ##
Updating a broker is how to ingest changes a broker author has made into Cloud
Foundry.
Similar to adding a broker, update causes Cloud Controller to fetch the catalog
from a broker, validate it, and update the Cloud Controller database with any
changes found in the catalog.
Update also provides a means to change the basic auth credentials cloud
controller uses to authenticate with a broker, as well as the base URL of the
broker's API endpoints.
<pre class="terminal">
$ cf update-service-broker mybrokername someuser somethingsecure http://mybroker.example.com/
</pre>
## <a id='rename-broker'></a>Rename a Broker ##
A service broker can be renamed with the `rename-service-broker`
command.
This name is used only by the Cloud Foundry operator to identify brokers, and
has no relation to configuration of the broker itself.
<pre class="terminal">
$ cf rename-service-broker mybrokername mynewbrokername
</pre>
## <a id='remove-broker'></a>Remove a Broker ##
Removing a service broker will remove all services and plans in the broker's catalog from the Cloud Foundry Marketplace.
<pre class="terminal">
$ cf delete-service-broker mybrokername
</pre>
<p class="note"><strong>Note</strong>: Attempting to remove a service broker will fail if there are service instances for any service plan in its catalog. When planning to shut down or delete a broker, make sure to remove all service instances first. Failure to do so will leave <a href="./api.html#orphans">orphaned service instances</a> in the Cloud Foundry database. If a service broker has been shut down without first deleting service instances, you can remove the instances with the CLI; see <a href="#purge-service">Purge a Service</a>.
### <a id='purge-service'></a>Purge a Service ###
If a service broker has been shut down or removed without first deleting service instances from Cloud Foundry, you will be unable to remove the service broker or its services and plans from the Marketplace. In development environments, broker authors often destroy their broker deployments and need a way to clean up the Cloud Controller database.
The following command will delete a service offering, all of its plans, as well as all associated service instances and bindings from the Cloud Controller database, without making any API calls to a service broker. For services from v1 brokers, you must provide a provider with `-p PROVIDER`. Once all services for a broker have been purged, the broker can be removed normally.
<pre class="terminal">
$ cf purge-service-offering v1-test -p pivotal-software
Warning: This operation assumes that the service broker responsible for this
service offering is no longer available, and all service instances have been
deleted, leaving orphan records in Cloud Foundry's database. All knowledge of
the service will be removed from Cloud Foundry, including service instances and
service bindings. No attempt will be made to contact the service broker; running
this command without destroying the service broker will cause orphan service
instances. After running this command you may want to run either
delete-service-auth-token or delete-service-broker to complete the cleanup.
Really purge service offering v1-test from Cloud Foundry? y
OK
</pre>
### <a id='purge-service-instance'></a>Purge a Service Instance###
The following command will delete a single service instance, its service bindings and its service keys from the Cloud Controller database, without making any API calls to a service broker.
This can be helpful in instances a Service Broker is not conforming to the Service Broker API and not returning a 200 or 410 to requests to delete the service instance.
<pre class="terminal">
$ cf purge-service-instance mysql-dev
WARNING: This operation assumes that the service broker responsible for this
service instance is no longer available or is not responding with a 200 or 410,
and the service instance has been deleted, leaving orphan records in Cloud
Foundry's database. All knowledge of the service instance will be removed from
Cloud Foundry, including service bindings and service keys.
Really purge service instance mysql-dev from Cloud Foundry?> y
Purging service mysql-dev...
OK
</pre>
`purge-service-instance` requires cf-release v218 and cf CLI 6.14.0.
## <a id='possible-errors'></a>Possible Errors ##
If incorrect basic auth credentials are provided:
<pre class="terminal">
Server error, status code: 500, error code: 10001, message: Authentication
failed for the service broker API.
Double-check that the username and password are correct:
http://github-broker.a1-app.example.com/v2/catalog
</pre>
If you receive the following errors, check your broker logs.
You may have an internal error.
<pre class="terminal">
Server error, status code: 500, error code: 10001, message:
The service broker response was not understood
Server error, status code: 500, error code: 10001, message:
The service broker API returned an error from
http://github-broker.a1-app.example.com/v2/catalog: 404 Not Found
Server error, status code: 500, error code: 10001, message:
The service broker API returned an error from
http://github-broker.primo.example.com/v2/catalog: 500 Internal Server Error
</pre>
If your broker's catalog of services and plans violates validation of presence,
uniqueness, and type, you will receive meaningful errors.
<pre class="terminal">
Server error, status code: 502, error code: 270012, message: Service broker catalog is invalid:
Service service-name-1
service id must be unique
service description is required
service "bindable" field must be a boolean, but has value "true"
Plan plan-name-1
plan metadata must be a hash, but has value [{"bullets"=>["bullet1", "bullet2"]}]
</pre>