Skip to content

Commit ec9823a

Browse files
committed
Fix typos, format, phrasing
1 parent 301f28a commit ec9823a

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

services/application-binding.html.md.erb

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ There are two methods developers can use to have their apps consume binding cred
4242
* **Parse the JSON yourself:** See the documentation for [VCAP_SERVICES](../deploy-apps/environment-variable.html#VCAP-SERVICES). Helper libraries are available for some frameworks.
4343
* **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.
4444

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).
4646

4747
<p class="note important">
4848
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
5454

5555
The binding data can be viewed like this:
5656

57-
~~~
57+
```
5858
cf ssh <app_name> -c 'cat $VCAP_SERVICES_FILE_PATH'
59-
~~~
59+
```
6060

6161
<p class="note important">
62-
The vcap_services file content cannot exceed 1 MB, otherwise an `IncompatibleBindings` error is raised.</p>
62+
The vcap_services file content cannot exceed 1 MB, otherwise an <code>IncompatibleBindings</code> error is raised.</p>
6363

6464
#### <a id='service-binding-k8s'></a> Service Binding K8s (experimental)
6565

@@ -69,18 +69,18 @@ This method is fully compatible with the specification on [servicebinding.io](ht
6969

7070
The binding data can be viewed like this:
7171

72-
~~~
72+
```
7373
cf ssh <app_name> -c 'find $SERVICE_BINDING_ROOT -type f -exec bash -c "echo {}: \$(cat {})" \;'
74-
~~~
74+
```
7575

7676
<p class="note important">
77-
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>
7878

7979
Here are some examples outlining the transformation of VCAP_SERVICES to the file structure:
8080

8181
Nested structures inside their value will be serialized as JSON objects. The same applies if the value is a list.
8282

83-
~~~
83+
```
8484
VCAP_SERVICES= {
8585
"foo": [
8686
{
@@ -101,11 +101,11 @@ Service Binding Files:
101101
foo/simple: value
102102
foo/deeply: {"nested":"value"}
103103
foo/list: ["v","a","l","u","e"]
104-
~~~
104+
```
105105

106106
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.
107107

108-
~~~
108+
```
109109
VCAP_SERVICES= {
110110
"foo": [
111111
{
@@ -121,11 +121,11 @@ VCAP_SERVICES= {
121121
Service Binding Files:
122122
foo/name: foo
123123
foo/secret: password
124-
~~~
124+
```
125125

126126
Empty lists or null values are omitted, i.e. no file will be created.
127127

128-
~~~
128+
```
129129
VCAP_SERVICES= {
130130
"foo": [
131131
{
@@ -140,11 +140,11 @@ VCAP_SERVICES= {
140140
Service Binding Files:
141141
foo/name: foo
142142
foo/binding-guid: 45436ca8-0a7c-45e3-9439-ca1b44db7a2b
143-
~~~
143+
```
144144

145145
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.
146146

147-
~~~
147+
```
148148
VCAP_SERVICES= {
149149
"foo": [
150150
{
@@ -159,7 +159,7 @@ Service Binding Files:
159159
foo/name: foo
160160
foo/binding-guid: 45436ca8-0a7c-45e3-9439-ca1b44db7a2b
161161
foo/instance-guid: 83745ca8-0a7c-45e3-9439-ca1b44db7a2b
162-
~~~
162+
```
163163

164164
### <a id='arbitrary-params-binding'></a> Arbitrary parameters
165165

@@ -226,7 +226,7 @@ OK
226226

227227
The provided name is available in the `name` and `binding_name` properties in the [VCAP_SERVICES](../deploy-apps/environment-variable.html) environment variable:
228228

229-
~~~
229+
```
230230
"VCAP_SERVICES": {
231231
"service-name": [
232232
{
@@ -236,7 +236,7 @@ The provided name is available in the `name` and `binding_name` properties in th
236236
}
237237
]
238238
}
239-
~~~
239+
```
240240

241241
## <a id='update-credentials'></a>Update service credentials
242242

services/managing-services.html.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ OK
8282
### <a id='instance-tags-create'></a> Instance tags
8383
_Instance tags require cf CLI v6.12.1+_
8484

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 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.
8686

8787
Example providing a comma-separated list of tags:
8888

services/user-provided.html.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The alias for [cf create-user-provided-service](http://cli.cloudfoundry.org/en-U
2121

2222
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!).
2323

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.
2525

2626
<pre class="terminal">
2727
cf cups SERVICE_INSTANCE -p '{"username":"admin","password":"pa55woRD"}'

0 commit comments

Comments
 (0)