From 4289f6b317ae00831aee4e73aafb99d176784e09 Mon Sep 17 00:00:00 2001 From: Ben Klein Date: Fri, 7 Aug 2015 11:54:28 -0500 Subject: [PATCH] Sync docs from master to gh-pages --- spring-cloud-cloud-foundry-connector.html | 697 ++++++++++++++++++++++ spring-cloud-connectors.html | 63 +- 2 files changed, 711 insertions(+), 49 deletions(-) create mode 100644 spring-cloud-cloud-foundry-connector.html diff --git a/spring-cloud-cloud-foundry-connector.html b/spring-cloud-cloud-foundry-connector.html new file mode 100644 index 0000000..4079eee --- /dev/null +++ b/spring-cloud-cloud-foundry-connector.html @@ -0,0 +1,697 @@ + + + + + + + +Spring Cloud Cloud Foundry Connector + + + + + + +
+
+
+
+

The Cloud Foundry Connector is part of the Spring Cloud Connectors project.

+
+
+

This connector discovers services that are bound to an application running in Cloud Foundry. (Since Cloud Foundry enumerates each service in a consistent format, Spring Cloud does not care which service provider is providing it.)

+
+
+
+
+

Cloud Detection

+
+

This connector checks for the presence of a VCAP_APPLICATION environment variable. This is a system-provided environment variable which is specific to Cloud Foundry. If the variable exists, the connector will be activated.

+
+
+
+

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.

+
+
+

Below is an example of a VCAP_SERVICES entry (edited for brevity).

+
+
+
+
"p-rabbitmq": [
+ {
+  "credentials": {
+   "http_api_uri": "http://ca30db57-a396:ddrnu58423q@12.34.567.89:12345/api",
+   "http_api_uris": [
+    "http://ca30db57-a396:ddrnu58423q@12.34.567.89:12345/api"
+   ],
+   "uri": "amqp://ca30db57-a396:ddrnu58423q@12.34.567.89/322e7782-eb1f",
+   "uris": [
+    "amqp://ca30db57-a396:ddrnu58423q@12.34.567.89/322e7782-eb1f"
+   ]
+  },
+  "label": "p-rabbitmq",
+  "name": "bob",
+  "plan": "standard",
+  "tags": [
+   "rabbitmq"
+  ]
+ }
+]
+
+
+
+

For each service, the connector will consider the following fields:

+
+ ++++ + + + + + + + + + + + + + + + + + + +

tags

Attributes or names of backing technologies behind the service.

label

The name of the service.

credentials.uri

A URI pertaining to the service instance.

credentials.uris

URIs pertaining to the service instance.

+
+

The criteria by which it establishes availability of each service are described below.

+
+
+

RabbitMQ

+
+

The connector will check for:

+
+
+
    +
  • +

    tags including rabbitmq

    +
    • +
  • +

    label beginning with the rabbitmq tag

    +
    • +
  • +

    uris using the scheme amqp or amqps

    +
    • +
+
+
+
+

DB2

+
+

Coming soon…​

+
+
+
+

MongoDB

+
+

Coming soon…​

+
+
+
+

Application monitoring (New Relic)

+
+

Coming soon…​

+
+
+
+

MySQL

+
+

Coming soon…​

+
+
+
+

Oracle

+
+

Coming soon…​

+
+
+
+

PostgreSQL

+
+

Coming soon…​

+
+
+
+

Redis

+
+

Coming soon…​

+
+
+
+

SMTP

+
+

Coming soon…​

+
+
+
+

SQL Server

+
+

Coming soon…​

+
+
+
+
+

Supporting New Service Types

+
+

Extend CloudFoundryServiceInfoCreator with a creator for your service’s ServiceInfo class.

+
+
+

Add the fully-qualified class name for your creator to META-INF/service/org.springframework.cloud.cloudfoundry.CloudFoundryServiceInfoCreator.

+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-connectors.html b/spring-cloud-connectors.html index 7cd6375..21f11ae 100644 --- a/spring-cloud-connectors.html +++ b/spring-cloud-connectors.html @@ -548,15 +548,11 @@ table.CodeRay td.code>pre{padding:0} -
  • Spring Cloud Cloud Foundry Connector - -
    • +
  • Spring Cloud Cloud Foundry Connector
  • Spring Cloud Heroku Connector
    • @@ -575,6 +571,7 @@ table.CodeRay td.code>pre{padding:0}
  • Instance ID
    • +
  • Extending Spring Cloud Connectors
    • @@ -1103,47 +1100,7 @@ table.CodeRay td.code>pre{padding:0}

    Spring Cloud Cloud Foundry Connector

    -

    This connector will discover services that are bound to an application running in Cloud Foundry. It currently knows about:

    -
    -
    -
      -
    • -

      PostgreSQL

      -
      • -
    • -

      MySQL

      -
      • -
    • -

      Oracle

      -
      • -
    • -

      Redis

      -
      • -
    • -

      MongoDB

      -
      • -
    • -

      RabbitMQ

      -
      • -
    • -

      SMTP gateway

      -
      • -
    • -

      Application monitoring (New Relic)

      -
      • -
    -
    -
    -

    Since Cloud Foundry enumerates each service in a consistent format, Spring Cloud does not care which service provider is providing it.

    -
    -
    -

    Supporting New Service Types

    -
    -

    Extend CloudFoundryServiceInfoCreator with a creator for your service’s ServiceInfo class.

    -
    -
    -

    Add the fully-qualified class name for your creator to META-INF/service/org.springframework.cloud.cloudfoundry.CloudFoundryServiceInfoCreator.

    -
    +

    See Spring Cloud Cloud Foundry Connector.

    @@ -1179,7 +1136,7 @@ table.CodeRay td.code>pre{padding:0}
    -

    Supporting New Service Types

    +

    Supporting New Service Types

    Extend HerokuServiceInfoCreator with a creator for your service’s ServiceInfo class.

    @@ -1302,10 +1259,18 @@ spring.cloud.database: mysql://user:pass@host:1234/dbname
    +
    +

    Extending Spring Cloud Connectors

    +
    +
    +

    Coming soon…​

    +
    +
    +