Skip to content

Commit baabdce

Browse files
[#185085318]
1 parent d38117d commit baabdce

9 files changed

+60
-61
lines changed

get-credhub-vars.html.md.erb

+21-21
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ Use these endpoints to view variables for any product in Ops Manager, except the
1818

1919
## <a id="fetch-variables"></a> Fetching variables
2020

21-
This endpoint returns the list of variables associated with a product that are stored in CredHub<!--฿ There are two CredHubs in PCF v2.0: BOSH CredHub and runtime CredHub. ฿-->. Not all variables are stored in CredHub<!--฿ There are two CredHubs in PCF v2.0: BOSH CredHub and runtime CredHub. ฿-->. If you call a variable that is not stored in CredHub<!--฿ There are two CredHubs in PCF v2.0: BOSH CredHub and runtime CredHub. ฿-->, the call returns an empty value.
21+
This endpoint returns the list of variables associated with a product that are stored in CredHub. Not all variables are stored in CredHub. If you call a variable that is not stored in CredHub, the call returns an empty value.
2222

2323
<pre class="terminal">
24-
$ curl "http<span>s</span>://OPS-MAN-FQDN/api<!--฿ |API| is preferred. ฿-->/v0/deployed/products/product-guid<!--฿ |GUID| is preferred. ฿-->/variables" \
24+
$ curl "http<span>s</span>://OPS-MAN-FQDN/api/v0/deployed/products/product-guid/variables" \
2525
-X GET \
2626
-H "Authorization: Bearer EXAMPLE_UAA_ACCESS_TOKEN"
2727
</pre>
@@ -39,22 +39,22 @@ HTTP/1.1 200 OK
3939
### <a id="query-params"></a> Query parameters
4040

4141
<table class="nice">
42-
<th>Parameter</th>
43-
<th>Description</th>
44-
<tr>
45-
<td>product_guid</td>
46-
<td>The unique product identifier, formatted as a text string</td>
47-
</tr>
42+
<th>Parameter</th>
43+
<th>Description</th>
44+
<tr>
45+
<td>product_guid</td>
46+
<td>The unique product identifier, formatted as a text string</td>
47+
</tr>
4848
</table>
4949

5050
This endpoint returns a variable's name. Use the name in the next endpoint to return the variable's value.
5151

5252
## <a id="fetch-var-values"></a> Fetching variable values
5353

54-
This endpoint returns the value of a variable stored in CredHub<!--฿ There are two CredHubs in PCF v2.0: BOSH CredHub and runtime CredHub. ฿-->. Not all variables are stored in CredHub<!--฿ There are two CredHubs in PCF v2.0: BOSH CredHub and runtime CredHub. ฿-->, so if you call a variable that isn't in CredHub<!--฿ There are two CredHubs in PCF v2.0: BOSH CredHub and runtime CredHub. ฿-->, the call returns an empty value.
54+
This endpoint returns the value of a variable stored in CredHub. Not all variables are stored in CredHub, so if you call a variable that isn't in CredHub, the call returns an empty value.
5555

5656
<pre class="terminal">
57-
$ curl "http<span>s</span>://OPS-MAN-FQDN/api<!--฿ |API| is preferred. ฿-->/v0/deployed/products/product-guid<!--฿ |GUID| is preferred. ฿-->/variables?name=EXAMPLE-VARIABLE-NAME" \
57+
$ curl "http<span>s</span>://OPS-MAN-FQDN/api/v0/deployed/products/product-guid/variables?name=EXAMPLE-VARIABLE-NAME" \
5858
-X GET \
5959
-H "Authorization: Bearer UAA_ACCESS_TOKEN"
6060
</pre>
@@ -65,20 +65,20 @@ $ curl "http<span>s</span>://OPS-MAN-FQDN/api<!--฿ |API| is preferred. ฿-->/
6565
HTTP/1.1 200 OK
6666

6767
{
68-
"credhub<!--฿ The CF component is named |CredHub| ฿-->-password": "EXAMPLE-PASSWORD"
68+
"credhub-password": "EXAMPLE-PASSWORD"
6969
}
7070
</pre>
7171

7272
### <a id="query-params-values"></a> Query parameters
7373
<table>
74-
<th>Parameter</th>
75-
<th>Description</th>
76-
<tr>
77-
<td>variable_name</td>
78-
<td>The name of the variable, formatted as a text string</td>
79-
</tr>
80-
<tr>
81-
<td>product_guid</td>
82-
<td>The unique product identifier, formatted as a text string</td>
83-
</tr>
74+
<th>Parameter</th>
75+
<th>Description</th>
76+
<tr>
77+
<td>variable_name</td>
78+
<td>The name of the variable, formatted as a text string</td>
79+
</tr>
80+
<tr>
81+
<td>product_guid</td>
82+
<td>The unique product identifier, formatted as a text string</td>
83+
</tr>
8484
</table>

index.html.md.erb

+5-5
Original file line numberDiff line numberDiff line change
@@ -59,23 +59,23 @@ Depending on what you build, you must install the following tools:
5959

6060
- [Tile Generator](./tile-generator.html#-how-to-use): Used to package your software into a tile.
6161

62-
- [BOSH Command Line Interface (CLI)](https://bosh.io/docs/cli-v2/): A CLI for running BOSH commands. You need BOSH commands to run Tile Generator.
62+
- [BOSH Command Line Interface (CLI)](https://bosh.io/docs/cli-v2/)<!--฿ Change the link name to |BOSH documentation|. ฿-->: A CLI for running BOSH commands. You need BOSH commands to run Tile Generator.
6363

6464
- [Cloud Foundry Command Line Interface (cf CLI)](https://github.com/cloudfoundry/cli#downloads): A CLI for deploying and managing apps on Cloud Foundry. If you are developing on Cloud Foundry, you use cf CLI when building your tile.
6565

66-
- [Kubernetes Command Line Tool (kubectl)](https://kubernetes.io/docs/tasks/tools/install-kubectl/) A CLI for deploying and managing apps on Kubernetes. If you are developing on Kubernetes, you use kubectl when building your tile.
66+
- [Kubernetes Command Line Tool (kubectl)](https://kubernetes.io/docs/tasks/tools/install-kubectl/)<!--฿ Change the link name to |Kubernetes documentation|. ฿--> A CLI for deploying and managing apps on Kubernetes. If you are developing on Kubernetes, you use kubectl when building your tile.
6767

6868
- [CF Dev](https://github.com/cloudfoundry-incubator/cfdev) (optional): A lightweight <%= vars.app_runtime_full %> installation for deploying and debugging apps locally. You can use Cloud Foundry Dev to run <%= vars.app_runtime_abbr %> on your local workstation.
6969

7070
#### <a id="generate"></a> Step 2: Generate a tile
7171

72-
Tile Generator simplifies building tiles. To use Tile Generator, upload your software components, such as the service broker, buildpack, and Docker image, and the tool generates a base tile.
72+
Tile Generator simplifies building tiles. To use Tile Generator, upload your software components, such as the service broker, buildpack, and Docker image,<!--฿ If a list, maybe reformat it as bullets. If this is a rambling sentence, break it up into smaller sentences. ฿--> and the tool generates a base tile.
7373

7474
For information about setting up Tile Generator and building a base tile, see [Tile Generator](./tile-generator.html).
7575

7676
#### <a id="test"></a> Step 3: Test your tile
7777

78-
Before you publish your tile, you can test it manually using a Partner Integration Environment (PIE). In PIE you can see how the tile functions on an IaaS, such as Amazon Web Services (AWS) or Google Cloud Platform (GCP). You can upload, configure, and install your tile in PIE as an operator does.
78+
Before you publish your tile, you can test it manually using a Partner Integration Environment (PIE). In PIE you can see how the tile functions on an IaaS, such as Amazon Web<!--฿ Capitalize only when you use the term |World Wide Web|. Do not use |WWW|. Do not capitalize |the web|. ฿--> Services (AWS) or Google Cloud Platform <!--฿ Shorten to |GCP| after the first use. ฿-->(GCP). You can upload, configure, and install your tile in PIE as an operator does.
7979

8080
To gain access to your PIE, reach out to your contact at <%= vars.company_name %> or [register as a partner](https://partners.pivotal.io/).
8181

@@ -124,4 +124,4 @@ Contact your <%= vars.company_name %> representative to guide you through upload
124124
For information about the release cycle for Partner tiles, see [Partner Software Release Cycle](./releases.html).
125125

126126
## <a id="contact"></a> Support
127-
To learn more about the VMware Tanzu ISV Partner Program or request help with your integration project, see [Contact Us](./contacts.html).
127+
To learn more about the VMware Tanzu ISV Partner Program or request help with your integration project, see [Contact Us](./contacts.html)<!--฿ If this file is a partial, do not use relative links. ฿-->.

integrations-index.html.md.erb

+18-18
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ owner: Services
55

66
Here is information about service integrations with <%= vars.app_runtime_full %>.
77

8-
* [Types of integration](/docs-tiledev/stages.html)
9-
* [User-provided service](/docs-tiledev/user-provided.html)
10-
* [Creating a brokered service and service tile](/docs-tiledev/brokered.html)
11-
* [**Managed services**](/docs-tiledev/managed-index.html)
12-
* [About managed service](/docs-tiledev/managed.html)
13-
* [BOSH release resources](/docs-tiledev/bosh-release.html)
14-
* [Errands](/docs-tiledev/tile-errands.html)
15-
* [On-demand service](/docs-tiledev/on-demand.html)
16-
* [Resources for deploying your buildpacks](/docs-tiledev/buildpacks.html)
17-
* [Embedded agents](/docs-tiledev/embedded-agents.html)
18-
* [**CredHub**](/docs-tiledev/credhub-index.html)
19-
* [CredHub](/docs-tiledev/credhub.html)
20-
* [Creating new variables in CredHub](/docs-tiledev/create-credhub-vars.html)
21-
* [Migrating existing credentials to CredHub](/docs-tiledev/migrating-credhub-credentials.html)
22-
* [Fetching variable names and values](/docs-tiledev/get-credhub-vars.html)
23-
* [Securing service credentials with Rrntime CredHub](/docs-tiledev/ssi-creds-tiledev.html)
24-
* [How to integrate services with Cloud Foundry's logging system](/docs-tiledev/nozzle.html)
25-
* [Syslog: migrating existing configuration](/docs-tiledev/migrating-syslog-configuration.html)
8+
* [Types of integration](/docs-tiledev/stages.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
9+
* [User-provided service](/docs-tiledev/user-provided.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
10+
* [Creating a brokered service and service tile](/docs-tiledev/brokered.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
11+
* [**Managed services**](/docs-tiledev/managed-index.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
12+
* [About managed service](/docs-tiledev/managed.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
13+
* [BOSH release resources](/docs-tiledev/bosh-release.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
14+
* [Errands](/docs-tiledev/tile-errands.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
15+
* [On-demand service](/docs-tiledev/on-demand.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
16+
* [Resources for deploying your buildpacks](/docs-tiledev/buildpacks.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
17+
* [Embedded agents](/docs-tiledev/embedded-agents.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
18+
* [**CredHub**](/docs-tiledev/credhub-index.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
19+
* [CredHub](/docs-tiledev/credhub.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
20+
* [Creating new variables in CredHub](/docs-tiledev/create-credhub-vars.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
21+
* [Migrating existing credentials to CredHub](/docs-tiledev/migrating-credhub-credentials.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
22+
* [Fetching variable names and values](/docs-tiledev/get-credhub-vars.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
23+
* [Securing service credentials with Rrntime CredHub](/docs-tiledev/ssi-creds-tiledev.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
24+
* [How to integrate services with Cloud Foundry's logging system](/docs-tiledev/nozzle.html)<!--฿ Do not start a relative link with a forward slash. ฿-->
25+
* [Syslog: migrating existing configuration](/docs-tiledev/migrating-syslog-configuration.html)<!--฿ If this file is a partial, do not use relative links. ฿--><!--฿ Do not start a relative link with a forward slash. ฿-->

managed-index.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Integrating your managed services
33
owner: Services
44
---
55

6-
Here's how to integrate your [brokered service](./brokered.html) more closely with <%= vars.platform_name %> to create a managed service and service tile for VMware Tanzu.
6+
Here is how to integrate your [brokered service](./brokered.html) more closely with <%= vars.platform_name %> to create a managed service and service tile for VMware Tanzu.
77

88
* [About managed services](/docs-tiledev/managed.html)
99
* [BOSH release resources](/docs-tiledev/bosh-release.html)

managed.html.md.erb

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: How to integrate your managed services
33
owner: Services
44
---
55

6-
Here's how to integrate your [brokered service](./brokered.html) more closely with <%= vars.platform_name %> to create a managed service and service tile for VMware Tanzu.
6+
Here is how to integrate your [brokered service](./brokered.html) more closely with <%= vars.platform_name %> to create a managed service and service tile for VMware Tanzu.
77

88
## <a id="overview"></a> Managed services overview
99

@@ -23,7 +23,7 @@ To integrate your service at this level, you configure to learn about stemcells,
2323

2424
### <a id="managed-mvp"></a> Minimal viable product
2525

26-
For a Minimal Viable Product (MVP) version of a managed service, you should aim for a single, shared service instance, and don't yet
26+
Minimal Viable Product (MVP) version of a managed service should aim for a single, shared service instance, and don't yet
2727
worry too much about High Availability of this instance. This integration level is mostly about getting the BOSH packaging, deployment, and monitoring working
2828
correctly.
2929

migrating-credhub-credentials.html.md.erb

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Migrating existing credentials to CredHub
33
owner: CredHub
44
---
55

6-
Here's how to migrate non-configurable secrets from Ops Manager into CredHub.
6+
Here is how to migrate non-configurable secrets from Ops Manager into CredHub.
77

88
## <a id="cred-types"></a>CredHub credential types
99

@@ -51,7 +51,7 @@ Tile authors can write a JavaScript migration to move their existing non-configu
5151

5252
1. Use the following example to write the JavaScript migration.
5353
Save the JavaScript file to the `PRODUCT/migrations/v1` directory of your `.pivotal` tile,
54-
following the naming conventions discussed in the [Update Values or Property Names Using JavaScript](./tile-upgrades.html) topic.
54+
following the naming conventionsx in the [Update Values or Property Names Using JavaScript](./tile-upgrades.html) topic.
5555

5656
```js
5757
exports.migrate = function(input) {
@@ -63,7 +63,7 @@ following the naming conventions discussed in the [Update Values or Property Nam
6363
};
6464
```
6565

66-
In the code block above, replace the example text as follows:
66+
Replace the example text as follows:
6767

6868
* `PROPERTY-REFERENCE`: Replace with the property reference that corresponds to the metadata file, such as `properties`. See [Tile Upgrades](./tile-upgrades.html#import) for more information about migrating properties.
6969
* `EXAMPLE-SECRET`: Replace with the name of the key.

migrating-syslog-configuration.html.md.erb

+5-5
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ By enabling the Ops Manager syslog feature, Ops Manager:
5353
<td><code>tls_enabled</code></td>
5454
<td>boolean</td>
5555
<td>No</td>
56-
<td>Send logs encrypted to syslog server via TLS. Defaults to <code>false</code></td>
56+
<td>Send logs encrypted to syslog server through TLS. Defaults to <code>false</code></td>
5757
</tr>
5858
<tr>
5959
<td><code>permitted_peer</code></td>
@@ -72,7 +72,7 @@ By enabling the Ops Manager syslog feature, Ops Manager:
7272
<td><code>queue_size</code></td>
7373
<td>integer</td>
7474
<td>No</td>
75-
<td>The number of log messages the buffer holds before dropping messages. A larger buffer size
75+
<td>The number of log entries the buffer holds before dropping messages. A larger buffer size
7676
might overload the system. Defaults to <code>100000</code></td>
7777
</tr>
7878
<tr>
@@ -96,7 +96,7 @@ By enabling the Ops Manager syslog feature, Ops Manager:
9696

9797
Tile authors can write a JavaScript migration to move their existing syslog properties into the
9898
syslog form provided by Ops Manager. After a successful migration, Ops Manager presents the
99-
migrated syslog properties in the Syslog form of the tile.
99+
migrated syslog properties in the syslog form of the tile.
100100

101101
1. Set the `opsmanager_syslog` property to `true` in your `metadata.yml`.
102102
For more information, see [opsmanager_syslog](./property-template-references.html#syslog-flag).
@@ -116,7 +116,7 @@ For more information, see [opsmanager_syslog](./property-template-references.htm
116116
};
117117
```
118118

119-
In the code block above, replace the example text as follows:
119+
Replace the example text as follows:
120120

121121
* `PROPERTY-REFERENCE`: Replace with the property reference that corresponds to the metadata
122122
file, such as `properties`.
@@ -140,7 +140,7 @@ longer used to configure the syslog.
140140

141141
1. Run a test deploy of your tile by doing the procedures in [Testing Tiles](./testing.html).
142142

143-
1. To ensure that your syslog properties were successfully migrated into the Ops Manager syslog
143+
1. To verify that your syslog properties were migrated into the Ops Manager syslog
144144
configuration, do one of the following:
145145

146146
* View the configurations in the **Syslog** pane in Ops Manager **Settings** page.

nozzle.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Do so with the following properties:
7979
A nozzle is a component dedicated to reading and processing data that streams from Firehose.
8080
A service tile can install a nozzle as either a managed service, with package type `bosh-release`, or as an app pushed to <%= vars.app_runtime_abbr %>, with the package type `app`.
8181

82-
### <a id="develop"></a> Develop a Nozzle
82+
### <a id="develop"></a> Develop a nozzle
8383

8484
You must develop a nozzle in Go to use the
8585
[NOAA library](https://github.com/cloudfoundry/noaa).

odb-resource-defaults.html.md.erb

+4-5
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,17 @@ owner: Ops Manager
88
Ops Manager 2.0 and later supports defining VM and disk type defaults and constraints.
99
</p>
1010

11+
Here is how tile authors can configure the drop-down menu menu items for VM types and persistent disk types in their tile.
1112

12-
Here you find how tile authors can configure the dropdown menu items for VM types and persistent disk types in their tile.
13-
14-
On-demand service tiles have a configuration pane for each service plan.
15-
Operators use dropdown menus on the plan configuration pane to set the VM type and persistent disk type for each instance of that plan.
13+
On-Demand service tiles have a configuration pane for each service plan.
14+
Operators use drop-down menus on the plan configuration pane to set the VM type and persistent disk type for each instance of that plan.
1615

1716
Ops Manager populates the menus with options based on the VM and disk options available on the current IaaS.
1817
Setting default values for VMs and disk types helps operators to select the right resources for on-demand service broker (ODB) services when using on-demand plans.
1918

2019
## <a id="defaults"></a>VM and Persistent disk types
2120

22-
The property that defines the VM type options is `vm_type_dropdown`, and the menu options for disk type come from the `disk_type_dropdown` property.
21+
The property that defines the VM type options is `vm_type_dropdown`, and the menu items for disk type come from the `disk_type_dropdown` property.
2322
Tile authors do not specify the menu items in the product template.
2423

2524
Because VM and disk options differ by IaaS, Ops Manager uses a best-fit algorithm to match defaults to their closest equivalents on the IaaS, similar to how the **Resource Config** pane handles its **VM Type** and **Persistent Disk Type** options.

0 commit comments

Comments
 (0)