Skip to content

Commit adbee8f

Browse files
committed
Name change for Ops Manager
1 parent ed58170 commit adbee8f

35 files changed

+310
-185
lines changed

brokered.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can achieve the first real improvement in your <%= vars.platform_name %> use
1010

1111
A brokered service runs external to <%= vars.platform_name %>, but it has a tile
1212
on [VMware Tanzu Network](http://network.pivotal.io). You install, configure, and upgrade the tile through the
13-
Ops Manager Installation Dashboard.
13+
Tanzu Operations Manager Installation Dashboard.
1414

1515
The service broker eliminates the need for you to know the URLs and
1616
credentials for your services. They are managed automatically by the broker.

cf-concepts.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ use the following links:
2323

2424
Cloud Foundry is primarily a cloud-native application platform. To understand how to integrate your services with Cloud Foundry, you must understand how your customers are using the platform to develop, deploy, and operate their applications.
2525

26-
- [Tanzu Operations Manager Tile Developer guide](https://docs.vmware.com/en/Tile-Developer-Guide/3.0/tile-dev-guide/index.html) explains how to push an app to run on <%= vars.platform_name %> and use services.
26+
- [Tanzu Operations Manager Tile Developer Guide](https://docs.vmware.com/en/Tile-Developer-Guide/3.0/tile-dev-guide/index.html) explains how to push an app to run on <%= vars.platform_name %> and use services.
2727
- [Overview of logging and metrics](https://docs.vmware.com/en/Tile-Developer-Guide/3.0/tile-dev-guide/cf-concepts.html) describes how <%= vars.app_runtime_abbr %> aggregates and streams logs and metrics from the apps it hosts and from internal system components.
2828

2929
## <a id="services"></a> Services

concourse.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ For new tiles, this can take up to an hour.
7474
After the stage and scan tasks, you must configure your tile on the Tile Dashboard.
7575
The configuration specfies how the tile is installed on the test environment.
7676

77-
Configuring your tile through the Tile Dashboard is equivalent to configuring the tile on Ops Manager
77+
Configuring your tile through the Tile Dashboard is equivalent to configuring the tile on Tanzu Operations Manager
7878
after you download it from the VMware Tanzu Network.
7979

8080
There are two ways that you can configure the tile on the Tile Dashboard:

create-credhub-vars.html.md.erb

+99-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ owner: CredHub
55

66
You can use CredHub to manage variables in the context of a larger deployment, and create new variables.
77

8-
When a tile author defines a top-level `variables` section in the product template, Ops Manager passes
8+
When a tile author defines a top-level `variables` section in the product template, Tanzu Operations Manager passes
99
the `variables` section to the
1010
product manifest.
1111

@@ -23,12 +23,12 @@ You can reference these variables in the manifest snippets in their tile metadat
2323
((( EXAMPLE-CREDHUB-PASSWORD )))
2424
```
2525

26-
When you use triple parentheses, use Ops Manager to identify CredHub variables while still supporting the BOSH double
26+
When you use triple parentheses, use Tanzu Operations Manager to identify CredHub variables while still supporting the BOSH double
2727
parentheses syntax. A variable that is referenced
2828
within triple parentheses is replaced by double parentheses in the generated manifest. After contacting CredHub,
2929
BOSH populates that variable value internally.
3030

31-
The benefit of this approach is that the Ops Manager YAML file does not contain sensitive credentials when the metadata
31+
The benefit of this approach is that the Tanzu Operations Manager YAML file does not contain sensitive credentials when the metadata
3232
manifest snippets have triple parentheses. The resulting manifest file contains variables within double
3333
parentheses, rather than unobscured credentials.
3434

@@ -39,7 +39,7 @@ For example, a tile author adds credentials to a manifest snippet in the followi
3939
key: prefix-((( ANOTHER-CREDHUB-PASSWORD )))-suffix
4040
```
4141

42-
Ops Manager then evaluates the preceding example to generate the following section in the product manifest:
42+
Tanzu Operations Manager then evaluates the preceding example to generate the following section in the product manifest:
4343

4444
```
4545
(( EXAMPLE-CREDHUB-PASSWORD ))
@@ -48,7 +48,7 @@ Ops Manager then evaluates the preceding example to generate the following secti
4848

4949
## <a id='how-it-works'></a> How CredHub works within a deployment
5050

51-
CredHub is distributed as a BOSH release. As part of this installation, Ops Manager co-locates the
51+
CredHub is distributed as a BOSH release. As part of this installation, Tanzu Operations Manager co-locates the
5252
CredHub release on the BOSH Director, including the CredHub job configurations, and the BOSH Director is configured to point
5353
to the CredHub API.
5454

@@ -84,7 +84,7 @@ instance_groups:
8484
private_key: ((EXAMPLE-TLS.private_key))
8585
```
8686

87-
Ops Manager configures the BOSH Director to generate a credential if it does not exist. The manifest includes generation
87+
Tanzu Opertions Manager configures the BOSH Director to generate a credential if it does not exist. The manifest includes generation
8888
parameters that define how the
8989
credential must be generated. These generation parameters are defined in the variables section.
9090

@@ -135,3 +135,96 @@ Here is an example of a precisely typed variable:
135135
```
136136
((/EXAMPLE-PASSWORD))
137137
```
138+
139+
## <a id='credhub-ca-refs'></a> Reference existing CAs in CredHub variables
140+
141+
This section describes how to reference existing CAs stored in CredHub correctly in your tile's property configuration.
142+
143+
In Tanzu Operations Manager v2.9 and later, you can perform a bulk rotation of all CAs and certificates in a foundation, which might include leaf certificates used by individual service tiles. Tanzu Operations Manager invokes CredHub Maestro to perform this operation.
144+
145+
CredHub Maestro requires that any triple parentheses references to CAs that sign leaf certificates must return a concatenated version of the CA. The concatenated version, which includes the older and newer CA, ensures that jobs using leaf certificates do not lose trusted state during CA rotation. This translates to the least amount of downtime of your tile's services during certificate rotation.
146+
147+
When referencing a CA stored in CredHub, use the format `LEAF-CERTIFICATE-NAME.ca` to ensure that a concatenated version of the CA is returned. Do not reference the CA directly with the format `CA-CERTIFICATE-NAME.certificate`.
148+
149+
The following table presents examples of the correct and incorrect way to reference CAs and leaf certificates in order to support certificate rotation by CredHub Maestro.
150+
151+
<div>
152+
<table class="nice">
153+
<style>
154+
main table {
155+
table-layout: fixed;
156+
}
157+
</style>
158+
<col width="50%">
159+
<col width="50%">
160+
<tr>
161+
<th> Correct Format </th>
162+
<th> Incorrect Format </th>
163+
</tr>
164+
<tr>
165+
<td>
166+
<pre>
167+
templates:
168+
- name: bpm
169+
release: bpm
170+
- manifest: |
171+
...
172+
.properties.routing_backends_client_cert_with_san.cert_pem ))
173+
private_key: (( .properties.routing_backends_client_cert_with_san.private_key_pem ))
174+
ca_certs: |
175+
(( .properties.routing_custom_ca_certificates.value ))
176+
(( $ops_manager.ca_certificate ))
177+
<span style="font-weight: bold;background-color: #98FB98;">((( /cf/some-diego-leaf-cert.ca )))</span>
178+
<span style="font-weight: bold;background-color: #98FB98;">((( /cf/some-diego-leaf-2-6.ca)))</span>
179+
forwarded_client_cert: (( .properties.routing_tls_termination.selected_option.parsed_manifest(gorouter_forwarded_client_cert) ))
180+
variables:
181+
- name: /cf/diego-instance-identity-root-ca
182+
options:
183+
common_name: Diego Instance Identity Root CA
184+
duration: 1095
185+
is_ca: true
186+
type: certificate
187+
- name: /cf/diego-instance-identity-root-ca-2-6
188+
options:
189+
common_name: Diego Instance Identity Root CA
190+
duration: 1095
191+
is_ca: true
192+
type: certificate
193+
<span style="font-weight:bold; background-color: #98FB98;">- name: /cf/some-diego-leaf-cert.ca</span>
194+
options:
195+
ca: /cf/diego-instance-identity-root-ca
196+
type: certificate
197+
<span style="font-weight:bold; background-color: #98FB98;">- name: /cf/some-diego-leaf-2-6.ca</span>
198+
options:
199+
ca: /cf/diego-instance-identity-root-ca-2-6
200+
type: certificate </pre></td>
201+
<td valign="top">
202+
<pre>
203+
templates:
204+
- name: bpm
205+
release: bpm
206+
- manifest: |
207+
...
208+
.properties.routing_backends_client_cert_with_san.cert_pem ))
209+
private_key: (( .properties.routing_backends_client_cert_with_san.private_key_pem ))
210+
ca_certs: |
211+
(( .properties.routing_custom_ca_certificates.value ))
212+
(( $ops_manager.ca_certificate ))
213+
<span style="font-weight: bold;background-color: #FFCCCB;">((( /cf/diego-instance-identity-root-ca.certificate )))</span>
214+
<span style="font-weight: bold;background-color: #FFCCCB;">((( /cf/diego-instance-identity-root-ca-2-6.certificate )))</span>
215+
forwarded_client_cert: (( .properties.routing_tls_termination.selected_option.parsed_manifest(gorouter_forwarded_client_cert) ))
216+
variables:
217+
- name: /cf/diego-instance-identity-root-ca
218+
options:
219+
common_name: Diego Instance Identity Root CA
220+
duration: 1095
221+
is_ca: true
222+
type: certificate
223+
- name: /cf/diego-instance-identity-root-ca-2-6
224+
options:
225+
common_name: Diego Instance Identity Root CA
226+
duration: 1095
227+
is_ca: true
228+
type: certificate</pre></td>
229+
</tr>
230+
</table>

credhub-index.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ Here are resources for using CredHub.
99
* [Creating new variables in CredHub](/docs-tiledev/create-credhub-vars.html)
1010
* [Migrating existing credentials to CredHub](/docs-tiledev/migrating-credhub-credentials.html)
1111
* [Fetching variable names and values](/docs-tiledev/get-credhub-vars.html)
12-
* [Securing service credentials with runtime CredHub](/docs-tiledev/ssi-creds-tiledev.html)
12+
* [Securing service credentials with Runtime CredHub](/docs-tiledev/ssi-creds-tiledev.html)

credhub.html.md.erb

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ See the [CredHub documentation](https://docs.cloudfoundry.org/credhub/index.html
1717
Many <%= vars.platform_name %> components use credentials to authenticate connections, and <%= vars.platform_name %> installations often have hundreds of active credentials. Secure credential management is essential to prevent data and security breaches.
1818

1919
In <%= vars.platform_name %> v1.11.0 and later, CredHub runs on the BOSH VM, alongside the
20-
BOSH Director and UAA. Ops Manager v1.11 and later stores its credentials in CredHub,
20+
BOSH Director and UAA. Tanzu Operations Manager v1.11 and later stores its credentials in CredHub,
2121
and you can retrieve them using the CredHub API or the **Credentials** tab of the BOSH Director tile.
2222
You can embed CredHub calls in [manifest snippets](#snippets) and <%= vars.app_runtime_abbr %> apps can retrieve credentials using the CredHub API.ile developers
2323

@@ -49,7 +49,7 @@ For more information on how to create new varaiables in Credhub, see <a href="./
4949
## <a id="migrate-creds"></a>Migrating credentials
5050

5151
To migrate existing non-configurable credentials to CredHub, such as blobstore secrets and backup encryption keys,
52-
use the JavaScript migration process. After a successful migration, Ops Manager deletes the migrated credentials from installation.yml file.
52+
use the JavaScript migration process. After a successful migration, Tanzu Operations Manager deletes the migrated credentials from installation.yml file.
5353

5454
For more information about migrating Credhub credentials, see [Migrating existing credentials to CredHub](./migrating-credhub-credentials.html).
5555

environments.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ for Pivotal Technical Partnership Program (PTPP) program members to develop thei
1818

1919
To use your assigned PIE environment:
2020

21-
1. Log on to the <%= vars.company_name %> Tile Dashboard using the credentials that you use for [Partners Slack](https://pivotalpartners.slack.com/).
21+
1. Log in to <%= vars.company_name %> Tile Dashboard using the credentials that you use for [Partners Slack](https://pivotalpartners.slack.com/).
2222

2323
1. Click the `pie-xx` environment assigned to you.
2424

get-credhub-vars.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The API endpoints perform these functions:
1414

1515
### <a id="use-api-endpoints"></a> Using the API endpoints
1616

17-
You can Use endpoints to view variables for any product in Ops Manager, except the BOSH Director. These
17+
You can Use endpoints to view variables for any product in Tanzu Operations Manager, except the BOSH Director. These
1818
endpoints are read-only. You
1919
cannot use them to add, remove, or rotate variables.
2020

index.html.md.erb

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Ops Manager Tile Developer guide
2+
title: Tanzu Operations Manager Tile Developer Guide
33
owner: Services
44
---
55

66
You can use the following VMware Tanzu Partners information to learn how to build and publish processes for an
7-
Ops Manager tile on [VMware Tanzu Network](https://network.pivotal.io/).
7+
Tanzu Operations Manager tile on [VMware Tanzu Network](https://network.pivotal.io/).
88

99
For advanced developers with previous experience building tiles, see [Property and template references](./property-template-references.html) and [Development workflow reference](./dev-workflow.html).
1010

migrating-credhub-credentials.html.md.erb

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

6-
You can migrate non-configurable secrets from Ops Manager into CredHub.
6+
You can migrate non-configurable secrets from Tanzu Operations Manager into CredHub.
77

8-
## <a id="cred-types"></a>CredHub credential types
8+
CredHub uses BOSH credential types, which can have different names than Tanzu Operations Manager credential types.
99

10-
CredHub uses BOSH credential types, which can have different names than Ops Manager credential types.
11-
12-
The following table lists the Ops Manager credential types you can migrate to CredHub and the
10+
The following table lists the Tanzu Operations Manager credential types you can migrate to CredHub and the
1311
corresponding CredHub credential types:
1412

1513
<table>
1614
<tr>
17-
<th>Ops Manager Credential Type</th>
15+
<th>Tanzu Operations Manager Credential Type</th>
1816
<th>CredHub Credential Type</th>
19-
<th>Supported Ops Manager Version</th>
17+
<th>Supported Tanzu Operations Manager Version</th>
2018
</tr>
2119
<tr>
2220
<td><code>secret</code></td>
@@ -46,7 +44,7 @@ See [Property and template references](./property-template-references.html#secre
4644

4745
## <a id="javascript"></a> Use the javaScript migration process
4846

49-
Tile authors can write a JavaScript migration to move their existing non-configurable secrets into CredHub. After a successful migration, Ops Manager deletes credentials from the `installation.yml` file.
47+
You can write a JavaScript migration to move their existing non-configurable secrets into CredHub. After a successful migration, Tanzu Operations Manager deletes credentials from the `installation.yml` file.
5048

5149
1. Use the following example to write the JavaScript migration.
5250
Save the JavaScript file to the `PRODUCT/migrations/v1` directory of your `.pivotal` tile,

migrating-syslog-configuration.html.md.erb

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: Migrating existing syslog configuration to Ops Manager
2+
title: Migrating existing Syslog configuration to Tanzu Operations Manager
33
owner: Ops Manager
44
---
55

66
You can migrate existing syslog properties that are defined by a tile into a syslog form that
7-
is provided in Ops Manager v2.9 and later.
7+
is provided in Tanzu Operations Manager v2.9 and later.
88

9-
When you enable the Ops Manager syslog feature, Ops Manager:
9+
When you enable the Tanzu Operations Manager syslog feature, Tanzu Operations Manager:
1010

1111
* Provides your tile with its own syslog form.
1212
* Ensures that the syslog BOSH release is automatically injected into the instance groups of your product.
13-
* Includes syslog configuration properties when Ops Manager injects the syslog release into your product.
13+
* Includes syslog configuration properties when Tanzu Operations Manager injects the syslog release into your product.
1414

1515
## <a id="syslog-data-model"></a>Syslog data model
1616

17-
The following table lists the Ops Manager syslog parameters that you can use to migrate your existing
17+
The following table lists the Tanzu Operations Manager syslog parameters that you can use to migrate your existing
1818
configurations:
1919

2020
<table class="nice">
@@ -95,8 +95,8 @@ When you enable the Ops Manager syslog feature, Ops Manager:
9595
## <a id="javascript"></a> Use the JavaScript migration process
9696

9797
Tile authors can write a JavaScript migration to move their existing syslog properties into the
98-
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.
98+
syslog form provided by Tanzu Operations Manager. After a successful migration, Tanzu Operations Manager presents the
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` file.
102102
For more information, see [opsmanager_syslog](./property-template-references.html#syslog-flag).
@@ -140,11 +140,12 @@ longer used to configure the syslog.
140140

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

143-
1. Verify that your syslog properties are migrated into the Ops Manager syslog
143+
1. Verify that your syslog properties are migrated into the Tanzu Operations Manager syslog
144144
configuration:
145145

146-
* View the configurations in the **Syslog** pane in Ops Manager **Settings** page.
147-
* View your syslog properties using the `syslog_configuration` Ops Manager API endpoint.
146+
* View the configurations in the **Syslog** pane in Tanzu Operations Manager **Settings** page.
147+
* View your syslog properties using the `syslog_configuration` Tanzu Operations Manager API endpoint.
148+
148149
For more information about the `syslog_configuration` API endpoint, see
149150
[Retrieving syslog configuration for a product](https://docs.pivotal.io/platform/2-10/opsman-api/#tag/Syslog-Configuration/paths/~1api~1v0~1staged~1products~1{product_guid}~1syslog_configuration/get).
150151

nozzle.html.md.erb

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: How to integrate services with Cloud Foundry's logging system
2+
title: Logs, metrics, and nozzles
33
owner: Services
44
---
55
You can integrate services with Cloud Foundry's logging system, _Loggregator_, by writing to and
@@ -71,7 +71,7 @@ do the following:
7171

7272
Where `CERTIFICATE` and `KEY` are the values used for mutual TLS communication. For example, `.properties.agent_certificate.cert_pem` and `.properties.agent_certificate.private_key_pem`.
7373

74-
1. Generate the Ops Manager CA certificate and sign the certificate that is needed for mutual TLS communication,
74+
1. Generate the Tanzu Operations Manager CA certificate and sign the certificate that is needed for mutual TLS communication,
7575
with the following properties:
7676

7777
```

odb-resource-defaults.html.md.erb

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ On-Demand service tiles have a configuration pane for each service plan.
99
You can use the drop-down menu on the configuration pane to set the VM type and persistent disk type for
1010
each instance of that plan.
1111

12-
Ops Manager populates the menu with options that are based on the VM and disk options available
12+
Tanzu Operations Manager populates the menu with options that are based on the VM and disk options available
1313
on the current IaaS.
1414
When you set default values for VMs and disk types, it helps you to select the right
1515
resources for on-demand service
1616
broker (ODB) services when you use on-demand plans.
1717

1818
<p class="note">
1919
<span class="note__title">Note</span>
20-
Ops Manager 2.9 and later supports defining VM and disk type defaults and constraints.
20+
Tanzu Operations Manager 2.9 and later supports defining VM and disk type defaults and constraints.
2121
</p>
2222

2323
## <a id="defaults"></a>VM and Persistent disk types
@@ -27,12 +27,12 @@ disk type come from the `disk_type_dropdown` property.
2727

2828
Tile authors do not specify the menu items in the product template.
2929

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

3434
If a tile developer does not include a default value for a VM or disk resource, and then you configure the tile and do not choose a value from
35-
the drop-down menu, Ops Manager by default sets the resource to the smallest option available on the IaaS.
35+
the drop-down menu, Tanzu Operations Manager by default sets the resource to the smallest option available on the IaaS.
3636

3737
### <a id="vm-type"></a>Set VM type defaults
3838

0 commit comments

Comments
 (0)