SpringCloud/spring-cloud-connectors
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

minor revisions to CF Connector doc

Browse Source
This commit is contained in:
Ben Klein
2015-08-24 17:06:49 -07:00
parent c688f76cb2
commit a42be8337c
1 changed files with 6 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/src/main/asciidoc/spring-cloud-cloud-foundry-connector.adoc
View File

@@ -17,7 +17,7 @@ This connector checks for the presence of a `VCAP_APPLICATION` environment varia
== Service Detection
The connector inspects Cloud Foundry’s `VCAP_SERVICES` environment variable to detect available services. This variable stores connection and identification information for service instances that are bound to Cloud Foundry applications.
The connector inspects Cloud Foundry's `VCAP_SERVICES` environment variable to detect available services. This variable stores connection and identification information for service instances that are bound to Cloud Foundry applications.
Below is an example of a `VCAP_SERVICES` entry (edited for brevity).
@@ -48,20 +48,20 @@ Below is an example of a `VCAP_SERVICES` entry (edited for brevity).
For each service, the connector will consider the following fields:
[cols="3,7", width="100%"]
|================================================================================================================================================================================
|===========================================================================================================================================================================
|`tags` |Attributes or names of backing technologies behind the service.
|`label` |The service offering’s name (not to be confused with a service _instance’s_ name).
|`label` |The service offering’s name (not to be confused with a service _instance’s_ name).
|`credentials.uri` |A URI pertaining to the service instance.
|`credentials.uris` |URIs pertaining to the service instance.
|================================================================================================================================================================================
|===========================================================================================================================================================================
If they are present, it will also consider the following fields:
[cols="3,7", width="100%"]
|================================================================================================================================================================================
|===========================================================================================================================================================================
|`credentials.jdbcUrl` |A JDBC connection string.
|`credentials.${SCHEME}${URL}` |A service URL, where `${SCHEME}` is a URI scheme used by the service and `${URL}` is one of `Url`, `url`, `Uri`, and `uri`.
|================================================================================================================================================================================
|===========================================================================================================================================================================
=== Supported Services
@@ -155,10 +155,3 @@ The connector will check for:
* `uri` or `uris` using the scheme `sqlserver`
* `jdbcUrl` field in `credentials` using the scheme `sqlserver`
* `sqlserverUri`, `sqlserveruri`, `sqlserverUrl`, or `sqlserverurl` fields in `credentials`
== Supporting New Service Types
Extend `CloudFoundryServiceInfoCreator` with a creator for <<_adding_service_discovery,your service's `ServiceInfo` class>>.
Add the fully-qualified class name for your creator to `META-INF/service/org.springframework.cloud.cloudfoundry.CloudFoundryServiceInfoCreator`.