Add Spring Insight documentation

Glyn Normington · Glyn Normington · commit de20ca3e3f16 · 2013-10-28T16:43:58.000Z
[#59671032]
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ The buildpack supports configuration and extension through the use of Git reposi
 	* [Play Auto Reconfiguration](docs/framework-play-auto-reconfiguration.md) ([Configuration](docs/framework-play-auto-reconfiguration.md#configuration))
 	* [Play JPA Plugin](docs/framework-play-jpa-plugin.md) ([Configuration](docs/framework-play-jpa-plugin.md#configuration))
 	* [Spring Auto Reconfiguration](docs/framework-spring-auto-reconfiguration.md) ([Configuration](docs/framework-spring-auto-reconfiguration.md#configuration))
+	* [Spring Insight](docs/framework-spring-insight.md) ([Configuration](docs/framework-spring-insight.md#configuration))
 * Standard JREs
 	* [OpenJDK](docs/jre-openjdk.md) ([Configuration](docs/jre-openjdk.md#configuration))
 * [Extending](docs/extending.md)
diff --git a/docs/framework-spring-insight.md b/docs/framework-spring-insight.md
@@ -0,0 +1,29 @@
+# Spring Insight Framework
+The Spring Insight Framework causes an application to be automatically configured to work with a bound [Spring Insight Service][].
+
+<table>
+  <tr>
+    <td><strong>Detection Criterion</strong></td><td>Existence of a single bound Spring Insight service. The existence of a Spring Insight service defined by the <a href="http://docs.cloudfoundry.com/docs/using/deploying-apps/environment-variable.html#VCAP_SERVICES"><code>VCAP_SERVICES</code></a> payload containing a service name-version, name, label or tag with <code>insight</code> as a substring.
+</td>
+  </tr>
+  <tr>
+    <td><strong>Tags</strong></td><td><tt>spring-insight=&lt;version&gt;</tt></td>
+  </tr>
+</table>
+Tags are printed to standard output by the buildpack detect script
+
+## User-Provided Service
+When binding Spring Insight as a user-provided service, it must have name, label, or tag with <code>insight</code> as a substring.  The credential payload contains the following entries:
+
+| Name | Description
+| ---- | -----------
+| `dashboard_url` | The URL via which users access the Spring Insight dashboard.
+
+## Configuration
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
+The framework is configured entirely via <code>VCAP_SERVICES</code>. It is not configurable via the buildpack (although an empty configuration file [`config/springinsight.yml`][] is present).
+
+[`config/springinsight.yml`]: ../config/springinsight.yml
+[Spring Insight Service]: http://gopivotal.com/pivotal-products/apps/pivotal-tc-server
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
