You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: services/application-binding.html.md.erb
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ There are two methods developers can use to have their apps consume binding cred
42
42
* **Parse the JSON yourself:** See the documentation for [VCAP_SERVICES](../deploy-apps/environment-variable.html#VCAP-SERVICES). Helper libraries are available for some frameworks.
43
43
* **Auto-configuration:** Some buildpacks create a service connection for you by creating additional environment variables, updating config files, or passing system parameters to the JVM.
44
44
45
-
For checking the binding data manually app devlopers can use `cf env`. See [View Env](../deploy-apps/environment-variable.html#view-env).
45
+
For checking the binding data manually app developers can use `cf env`. See [View Env](../deploy-apps/environment-variable.html#view-env).
46
46
47
47
<pclass="note important">
48
48
The maximum size of content of the VCAP_SERVICES environment variable is 130 KB. If you want to bind more services to the app or the services you want to bind provide lots of data, you can use one of the other methods.</p>
@@ -54,12 +54,12 @@ The environment variable [VCAP_SERVICES_FILE_PATH](../deploy-apps/environment-va
The bytesize of all files and their content combined cannot exceed 1 MB, otherwise an `IncompatibleBindings` error is raised.</p>
77
+
The bytesize of all files and their content combined cannot exceed 1 MB, otherwise an <code>IncompatibleBindings</code> error is raised.</p>
78
78
79
79
Here are some examples outlining the transformation of VCAP_SERVICES to the file structure:
80
80
81
81
Nested structures inside their value will be serialized as JSON objects. The same applies if the value is a list.
82
82
83
-
~~~
83
+
```
84
84
VCAP_SERVICES= {
85
85
"foo": [
86
86
{
@@ -101,11 +101,11 @@ Service Binding Files:
101
101
foo/simple: value
102
102
foo/deeply: {"nested":"value"}
103
103
foo/list: ["v","a","l","u","e"]
104
-
~~~
104
+
```
105
105
106
106
Existing credential keys can be overwritten by other attributes, that are [VCAP_SERVICES](../deploy-apps/environment-variable.html#VCAP-SERVICES) attributes plus type and provider. The full list of reserved file names is: binding-guid, binding-name, instance-guid, instance-name, name, label, tags, plan, syslog-drain-url, volume-mounts, type, and provider. Overwriting an existing key does not result in an error.
107
107
108
-
~~~
108
+
```
109
109
VCAP_SERVICES= {
110
110
"foo": [
111
111
{
@@ -121,11 +121,11 @@ VCAP_SERVICES= {
121
121
Service Binding Files:
122
122
foo/name: foo
123
123
foo/secret: password
124
-
~~~
124
+
```
125
125
126
126
Empty lists or null values are omitted, i.e. no file will be created.
Binding names and keys resulting in filenames must match [a-z0-9\-.]{1,253}. Invalid binding names and keys will result in IncompatibleBindings error. VCAP_SERVICES attributes are transformed to comply to this schema, i.e. underscores are replaced by hyphens, so that e.g. VCAP_SERVICES attribute binding_guid becomes file name binding-guid.
The provided name is available in the `name` and `binding_name` properties in the [VCAP_SERVICES](../deploy-apps/environment-variable.html) environment variable:
228
228
229
-
~~~
229
+
```
230
230
"VCAP_SERVICES": {
231
231
"service-name": [
232
232
{
@@ -236,7 +236,7 @@ The provided name is available in the `name` and `binding_name` properties in th
236
236
}
237
237
]
238
238
}
239
-
~~~
239
+
```
240
240
241
241
## <aid='update-credentials'></a>Update service credentials
Some services provide a list of tags that Cloud Foundry delivers to the app when the service is bound. These are included in the [VCAP_SERVICES environment variable](../deploy-apps/environment-variable.html#VCAP-SERVICES) or the file system epending on the chosen [Credential Delivery Method](./application-binding.html#credential-delivery-methods). These tags provide developers with a more generic way for apps to parse the service binding data for credentials. Developers might provide their own tags when creating a service instance by including the `-t` flag followed by a comma-separated list of tags.
85
+
Some services provide a list of tags that Cloud Foundry delivers to the app when the service is bound. These are included in the [VCAP_SERVICES environment variable](../deploy-apps/environment-variable.html#VCAP-SERVICES) or the file system depending on the chosen [Credential Delivery Method](./application-binding.html#credential-delivery-methods). These tags provide developers with a more generic way for apps to parse the service binding data for credentials. Developers might provide their own tags when creating a service instance by including the `-t` flag followed by a comma-separated list of tags.
Copy file name to clipboardExpand all lines: services/user-provided.html.md.erb
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ The alias for [cf create-user-provided-service](http://cli.cloudfoundry.org/en-U
21
21
22
22
Suppose a developer obtains a URL, port, user name, and password for communicating with an Oracle database managed outside of Cloud Foundry. The developer can manually create custom environment variables to configure their app with these credentials (of course you never hard code these credentials in your app!).
23
23
24
-
User-provided service instances allow developers to configure their apps with these using the familiar [App binding](application-binding.html) operation and the same [Credential Delivery Methods](./application-binding.html#credential-delivery-methods) used by Cloud Foundry to deliver credentials for Marketplace services.
24
+
User-provided service instances allow developers to inject credentials into the app container using the familiar [App binding](application-binding.html) operation and the same [Credential Delivery Methods](./application-binding.html#credential-delivery-methods) used by Cloud Foundry to deliver credentials for Marketplace services.
0 commit comments