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

modify table formatting; continue additions to CF Connector doc

Browse Source
This commit is contained in:
Ben Klein
2015-08-07 16:58:09 -05:00
parent 2f67fbeb65
commit 0ea627a77e
1 changed files with 34 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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).
|`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—in the field name, `${SCHEME}` is a URI scheme used by the service and `${URL}` is the string `Url`, `url`, `Uri`, or `uri`.
|===========================================================================================================================================================================
|`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
@@ -114,23 +114,47 @@ The connector will check for:
==== Oracle
Coming soon...
The connector will check for:
* `uri` or `uris` using the scheme `oracle`
* `jdbcUrl` field in `credentials` using the scheme `oracle`
* `oracleUri`, `oracleuri`, `oracleUrl`, or `oracleurl` fields in `credentials`
==== PostgreSQL
Coming soon...
The connector will check for:
* `tags` including `postgresql`
* `label` beginning with the `postgresql` tag
* `uri` or `uris` using the scheme `postgres`
* `jdbcUrl` field in `credentials` using the scheme `postgres`
* `postgresUri`, `postgresuri`, `postgresUrl`, or `postgresurl` fields in `credentials`
==== Redis
Coming soon...
The connector will check for:
* `tags` including `redis`
* `label` beginning with the `redis` tag
* `uri` or `uris` using the scheme `redis`
* `redisUri`, `redisuri`, `redisUrl`, or `redisurl` fields in `credentials`
==== SMTP
Coming soon...
The connector will check for:
* `tags` including `smtp`
* `label` beginning with the `smtp` tag
* `uri` or `uris` using the scheme `smtp`
* `smtpUri`, `smtpuri`, `smtpUrl`, or `smtpurl` fields in `credentials`
==== SQL Server
Coming soon...
The connector will check for:
* `uri` or `uris` using the scheme `sqlserver`
* `jdbcUrl` field in `credentials` using the scheme `oracle`
* `sqlserverUri`, `sqlserveruri`, `sqlserverUrl`, or `sqlserverurl` fields in `credentials`
== Supporting New Service Types