Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 7f97186

Browse files
committed
v3(services)(docs) Updated description of service route bindings
[#175559034](https://www.pivotaltracker.com/story/show/175559034)
1 parent e84c645 commit 7f97186

5 files changed

Lines changed: 13 additions & 7 deletions

File tree

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
## Service Route Binding
22

3-
An instantiation of a service route binding.
3+
Service route bindings are relations between a service instance and a route.
4+
5+
Not all service instances support route binding.
6+
In order to bind to a managed service instance, the service instance should be created from a service offering that has requires route forwarding (`requires=[route_forwarding]`).
7+
In order to bind to a user-provided service instance, the service instance must have `route_service_url` set.

docs/v3/source/includes/resources/service_offerings/_object.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Name | Type | Description
1616
**description** | _string_ | Description of the service offering
1717
**available** | _boolean_ | Whether or not the service offering is available
1818
**tags** | _list of strings_ | Descriptive tags for the service offering
19-
**requires** | _list of strings_ | A list of permissions that the user would have to give the service, if they provision it; the only permissions currently supported are syslog_drain, route_forwarding and volume_mount
19+
**requires** | _list of strings_ | A list of permissions that the user would have to give the service, if they provision it; the only permissions currently supported are `syslog_drain`, `route_forwarding` and `volume_mount`
2020
**shareable** | _boolean_ | Whether or not service Instances of this service offering can be shared across organizations and spaces
2121
**documentation_url** | _string_ | Url that points to a documentation page for the service offering, if provided by the service broker as part of the metadata field
2222
**broker_catalog** | _[broker catalog object](#the-service-offering-broker-catalog)_ | This object contains information obtained from the service broker Catalog

docs/v3/source/includes/upgrade_guide/changed_resources/_service_instance_routes_in_v3.md renamed to docs/v3/source/includes/upgrade_guide/changed_resources/_service_instance_route_bindings_in_v3.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
### Service Instance routes in V3
1+
### Service Instance Route Bindings in V3
22

3-
There is a new resource `service route binding` that represents a binding between a route and a service instance.
3+
In v2, binding a service instance to a route was done as a relationship request for the service instance.
4+
5+
In v3, there is a new resource `service route binding` that represents a binding between a route and a service instance.
46

57
Creation/Deletion of bindings is therefore done via that endpoint in v3.
68

docs/v3/source/includes/upgrade_guide/new_resources/_service_route_bindings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
### Service Route Bindings
22

3-
There is a new resource `service route binding` that represents a binding between a route and a service instance.a
3+
There is a new resource `service route binding` that represents a binding between a route and a service instance.
44

5-
Creation/Deletion of bindings is therefore done via that endpoint in v3.
5+
Creation/Deletion of these bindings is therefore done via that endpoint in v3.
66

77
This resource also supports metadata both in create and update requests.
88

docs/v3/source/index.html.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ includes:
418418
- upgrade_guide/changed_resources/routes_in_v3
419419
- upgrade_guide/changed_resources/security_groups_in_v3
420420
- upgrade_guide/changed_resources/service_brokers_in_v3
421-
- upgrade_guide/changed_resources/service_instance_routes_in_v3
421+
- upgrade_guide/changed_resources/service_instance_route_bindings_in_v3
422422
- upgrade_guide/changed_resources/service_offerings_in_v3
423423
- upgrade_guide/changed_resources/service_plans_in_v3
424424
- upgrade_guide/changed_resources/service_plan_visibility_in_v3

0 commit comments

Comments
 (0)