Skip to content

Commit 789e42f

Browse files
Note change
1 parent 732e1c1 commit 789e42f

13 files changed

+76
-45
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ This repo is for Tile Developer Guide content.
44

55
## Which branch to use?
66

7-
**Note**: Provide instructions in your PRs to indicate which branches you want Docs to apply your commits to.
7+
>**Note**
8+
>If you are using the Provide instructions in your PRs to indicate which branches you want Docs to apply your commits to.
89
910
| Branch name | Use for… |
1011
|-------------| ------|

environments.html.md.erb

+2-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ tiles, except for Ops Manager. But if you followed the workflow in [Building You
2727

2828
- [Install BOSH-Lite](https://github.com/cloudfoundry/bosh-lite)
2929

30-
<p class="note"><strong>Note:</strong> For this type of development environment, you only need BOSH-Lite itself to deploy managed service releases. You do not need to follow the instructions to Deploy Cloud Foundry in BOSH-Lite, as Cloud Foundry is provided by the <%= vars.product_dev_local %> installation above.</p>
30+
>**Note**
31+
>For this type of development environment, you only need BOSH-Lite itself to deploy managed service releases. You do not need to follow the instructions to Deploy Cloud Foundry in BOSH-Lite, as Cloud Foundry is provided by the <%= vars.product_dev_local %> installation above.
3132

3233
### <a id='setup-pcfdev'></a> Setting up <%= vars.product_dev_local %>
3334

migrating-credhub-credentials.html.md.erb

+10-5
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ The following table lists the Ops Manager credential types you can migrate to Cr
3838
</tr>
3939
</table>
4040

41-
<p class="note"><strong>Note</strong>: CredHub does not retain the salt when migrating <code>salted_credentials</code>.</p>
41+
>**Note**
42+
>CredHub does not retain the salt when migrating <code>salted_credentials
43+
4244

4345
See [Property and template references](./property-template-references.html#secret) for more information about credential types.
4446

@@ -94,8 +96,11 @@ following the naming conventions discussed in the [Update Values or Property Nam
9496
type: password
9597
```
9698

97-
<p class="note"><strong>Note</strong>: While the property blueprint refers to the above type as <code>secret</code>, BOSH refers to the type as <code>password</code>. See the
98-
<a href="#cred-types">CredHub Credential Types</a> table at the beginning of this topic for more information about credential types.</p>
99+
100+
>**Note**
101+
>While the property blueprint refers to the above type as <code>secret</code>, BOSH refers to the type as <code>password</code>. See the <a href="#cred-types">CredHub Credential Types</a> table at the beginning of this topic for more information about credential types.
102+
103+
99104

100105
1. In your manifest snippet, replace the existing secret value with the new triple-parenthesis syntax.
101106
* Remove the existing secret from the manifest snippet:
@@ -110,6 +115,6 @@ following the naming conventions discussed in the [Update Values or Property Nam
110115
secret: ((( SECRET-VARIABLE )))
111116
```
112117

113-
1. Run a [test deploy](./testing.html) of your tile.
118+
2. Run a [test deploy](./testing.html) of your tile.
114119

115-
1. Use an API endpoint to confirm that the credential is stored in the variable. For more information about the endpoint, see [Fetching Variable Names and Values](./get-credhub-vars.html).
120+
3. Use an API endpoint to confirm that the credential is stored in the variable. For more information about the endpoint, see [Fetching Variable Names and Values](./get-credhub-vars.html).

migrating-syslog-configuration.html.md.erb

+3-2
Original file line numberDiff line numberDiff line change
@@ -148,5 +148,6 @@ configuration, do one of the following:
148148
For more information about the `syslog_configuration` API endpoint, see
149149
[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).
150150

151-
<p class="note"><strong>Note:</strong> In the next version of your product, remove
152-
the deprecated syslog configuration properties.</p>
151+
>**Note**
152+
>In the next version of your product, remove
153+
the deprecated syslog configuration properties.<

odb-resource-defaults.html.md.erb

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Configuring disk and VM type defaults for on-demand service tiles
33
owner: Ops Manager
44
---
55

6-
<p class="note"><strong>Note</strong>: Ops Manager 2.0 and later supports defining VM and disk type defaults and constraints.</p>
6+
>**Note**
7+
>Ops Manager 2.0 and later supports defining VM and disk type defaults and constraints.
8+
79

810
Here you will find how tile authors can configure the dropdown menu items for VM types and persistent disk types in their tile.
911

property-template-references.html.md.erb

+18-9
Original file line numberDiff line numberDiff line change
@@ -440,10 +440,12 @@ The following keys are supported:
440440
- `name`: The name of the tile required by your tile. This is a required key.
441441
- `version`: The version range required by your tile. This is a required key.
442442
- `optional`: This is an optional key that defaults to false.
443-
<p class="note warning"><strong>Warning:</strong> The <code>optional</code> key was introduced in Ops Manager v2.8.
444-
It is ignored in earlier versions.
445-
This means that declared dependencies are required in Ops Manager v2.7 and earlier.
446-
</p>
443+
444+
>**Caution**
445+
>It is ignored in earlier versions.
446+
This means that declared dependencies are required in Ops Manager v2.7 and earlier.
447+
448+
447449

448450
For example:
449451

@@ -981,7 +983,8 @@ Jobs require many different settings to function properly. That is the core of w
981983

982984
Ops Manager does not require tile authors to provide `vm_credentials` in the `property_blueprints` for each `job_type`. This is because `vm_credentials` are generated automatically. You can find them in the release manifest.
983985

984-
<p class="note"><strong>Note:</strong> Ops Manager ignores <code>static_ip</code> and <code>dynamic_ip</code> keys. To configure the static IPs of a <code>job_type</code>, create a property blueprint with <code>name: static_ips</code> and <code>type: ip_ranges</code>.<br><code>static_ips</code> is a special keyword that Ops Manager uses to find static IPs and pass them to the BOSH manifest. For more information about <code>ip_ranges</code>, see <a href="#ip-ranges">ip_ranges</a>.</p>
986+
>**Note**
987+
>Ops Manager ignores <code>static_ip</code> and <code>dynamic_ip</code> keys. To configure the static IPs of a <code>job_type</code>, create a property blueprint with <code>name: static_ips</code> and <code>type: ip_ranges</code>.<br><code>static_ips</code> is a special keyword that Ops Manager uses to find static IPs and pass them to the BOSH manifest. For more information about <code>ip_ranges</code>, see <a href="#ip-ranges">ip_ranges</a>.
985988

986989
```
987990
job_types:
@@ -1259,7 +1262,9 @@ You can give users control of balancing jobs across availability zones (AZs) by
12591262

12601263
To limit a job to a single AZ, set `single_az_only` to `true`.
12611264

1262-
<p class="note warning"><strong>Warning:</strong> If you change the <code>single_az_only</code> setting, your VMs may switch AZs. This change can cause an orphaned disk.</p>
1265+
>**Caution** If you change the <code>single_az_only</code> setting, your VMs may switch AZs. This change can cause an orphaned disk.
1266+
1267+
12631268

12641269
### <a id='job-max-in-flight'></a> max_in_flight
12651270

@@ -1295,7 +1300,8 @@ The resources you can set are:
12951300

12961301
For examples of supported constraint types, see [integer](#integer).
12971302

1298-
<p class="note"><strong>Note:</strong> If you set the <code>default</code> property for <code>persistent_disk</code> to <code>0</code>, users cannot edit this value and the <strong>Resource Config</strong> pane in the Ops Manager tile displays <strong>None</strong> under the persistent disk text box.</p>
1303+
>**Note**
1304+
>If you set the <code>default</code> property for <code>persistent_disk</code> to <code>0</code>, users cannot edit this value and the <strong>Resource Config</strong> pane in the Ops Manager tile displays <strong>None</strong> under the persistent disk text box.
12991305

13001306
### <a id='job-instance-def'></a> instance_definition
13011307

@@ -1312,7 +1318,9 @@ For example, your tile uses Amazon Relational Database Service (RDS) instead of
13121318

13131319
For examples of supported constraint types, see [integer](#integer).
13141320

1315-
<p class="note"><strong>Note:</strong> If you are using the <code>zero_if</code> property, you should not set the <code>may_only_increase</code> constraint to <code>true</code>.</p>
1321+
>**Note**
1322+
>If you are using the <code>zero_if</code> property, you should not set the <code>may_only_increase</code> constraint to <code>true</code>.
1323+
13161324

13171325
### <a id='job-manifest'></a> Manifest
13181326

@@ -1417,7 +1425,8 @@ Use the `current_record` property within a collection record to refer to other p
14171425

14181426
For example, the properties in the `for_routing` named manifest refer to the values for `name`, `private_key`, `public_key`, and `certificate` within this record only.
14191427

1420-
<p class="note"><strong>Note:</strong> The <code>current_record</code> property is reserved. You cannot create a new property named <code>current_record</code>.</p>
1428+
>**Note**
1429+
>If you are using the The <code>current_record</code> property is reserved. You cannot create a new property named <code>current_record</code>.
14211430

14221431
After defining a named manifest, you can reference it using a manifest snippet in the following format:
14231432

ssi-creds-tiledev.html.md.erb

+4-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ The sections below describe an example implementation of how to add SSI credenti
3838

3939
To use runtime CredHub, your service tile needs to retrieve the location of the CredHub server, which is published in the <%= vars.app_runtime_abbr %> tile, through a BOSH link.
4040

41-
<p class="note"><strong>Note</strong>: BOSH Links let multiple jobs share deployment-time configuration properties. This helps to avoid redundant configurations in BOSH releases and deployment manifests. For more information about BOSH Links, see <a href="http://docs.pivotal.io/tiledev/1-11/release-notes.html#bosh-links">BOSH Links</a>.</p>
41+
>**Note**
42+
>If you are using the BOSH Links let multiple jobs share deployment-time configuration properties. This helps to avoid redundant configurations in BOSH releases and deployment manifests. For more information about BOSH Links, see <a href="http://docs.pivotal.io/tiledev/1-11/release-notes.html#bosh-links">BOSH Links</a>.
4243

4344
### <a id="spec"></a> Update spec file and templates
4445

@@ -214,4 +215,5 @@ To activate your service broker to store binding credentials in runtime CredHub
214215
}
215216
```
216217

217-
<p class="note"><strong>Note:</strong> Java Virtual Machine (JVM) apps can use <a href="https://projects.spring.io/spring-credhub">Spring CredHub</a> to access the CredHub API.</p>
218+
>**Note**
219+
>If you are using the Java Virtual Machine (JVM) apps can use <a href="https://projects.spring.io/spring-credhub">Spring CredHub</a> to access the CredHub API.

testing.html.md.erb

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ For <%= vars.platform_name %> tiles, a typical test pyramid progresses as follow
3838
- Confirm manually that the tile wires property blueprints to the expected pane and form controls in the UI.
3939
- Test your environment using one of the environments described in [Development Environments](./environments.html)
4040

41-
<p class="note"><strong>Note</strong>: System tests might incur costs from using third party services, IaaS resources, and others.</p>
41+
>**Note**
42+
>System tests might incur costs from using third party services, IaaS resources, and others.
4243

4344
### <a id="smoke"></a> Smoke tests
4445

tile-errands.html.md.erb

+3-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ To save deployment time, operators can set [errand run rules](#run-rules) that d
2222

2323
## <a id="colocated"></a>Define a co-located errand
2424

25-
<p class="note"><strong>Note</strong>: Ops Manager v2.0 and later supports co-located errands.</p>
25+
>**Note**
26+
>System tests might incur costs from using third party services, IaaS resources, and others.
27+
2628

2729
Instead of deploying a new VM for each errand, co-located errands run on an existing VM.
2830
Errands can run alongside other jobs on a VM, and multiple errands can be co-located on the same VM.

tile-generator.html.md.erb

+10-9
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@ For a 7-minute introduction into what Tile Generator is and does, see
9797
This puts the `tile` and `pcf` commands in your `PATH` when the virtualenv is active.
9898
To deactivate the virtualenv, run the command `deactivate`.
9999

100-
<p class="note"><strong>Note</strong>: To upgrade Tile Generator, run <code>pip install tile-generator --upgrade</code>
100+
>**Note**
101+
>To upgrade Tile Generator, run <code>pip install tile-generator --upgrade</code>
101102
with the virtualenv activated.</p>
102103

103104

@@ -106,7 +107,8 @@ For a 7-minute introduction into what Tile Generator is and does, see
106107
3. From within the root directory of the project for which you want to create a tile,
107108
initialize the directory as a tile repository by running the following commands:
108109

109-
<p class="note"><strong>Note</strong>: <%= vars.company_name %> recommends that you use a git repository.</p>
110+
>**Note**
111+
>If you are using the <%= vars.company_name %> recommends that you use a git repository.</p>
110112

111113
```
112114
cd YOUR-PROD-DIRECTORY
@@ -164,7 +166,8 @@ You can build this sample using the following steps:
164166
tile build
165167
```
166168

167-
<p class="note"><strong>Note</strong>: The sample tile includes a Python app that is re-used in several packages,
169+
>**Note**
170+
>The sample tile includes a Python app that is re-used in several packages,
168171
sometimes as an app, sometimes as a service broker. One of the deployments (app3)
169172
uses the sample app inside a Docker image that is modified
170173
by the CI pipeline. If you edit the sample app, you have to build your own
@@ -304,8 +307,8 @@ of `app` or `docker-app`:
304307
enable_global_access_to_plans: true # optional
305308
```
306309

307-
<p class="note">
308-
<strong>Note</strong>: Unless you specify the <code>enable_global_access_to_plans: true</code> option, your
310+
>**Note**
311+
>Unless you specify the <code>enable_global_access_to_plans: true</code> option, your
309312
broker's services do not appear in the user's Marketplaces.
310313
Operators have to use the <code>cf enable-service-access</code> command to allow
311314
specific users, orgs, and spaces to access your services.
@@ -656,10 +659,8 @@ package.
656659
Service instances provisioned this way survive updates, but are deleted
657660
when the tile is uninstalled.
658661

659-
<p class="note"><strong>Note</strong>: The name is the name of the provided <em>service, not the broker</em>.
660-
In many cases these are not the same, and a single broker might even offer
661-
multiple services. Use <code>cf service-access</code> to see the services and plans
662-
offered by installed service brokers.</p>
662+
>**Note**
663+
>The name is the name of the provided <em>service, not the broker</em>. In many cases these are not the same, and a single broker might even offer multiple services. Use <code>cf service-access</code> to see the services and plans offered by installed service brokers.</p>
663664

664665
If you do not specify a plan, Tile Generator uses the first plan
665666
listed for the service in the broker catalog. It is a good idea to always

tile-reference/property-blueprints/_rsa-cert-credentials.html.erb

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ This holds SSL certificate generated from root CA.
2525
list of domain names to use when auto-generating the RSA certificate.
2626
The first domain listed will be the value of the Common Name text box of the cert.
2727
The full list of domains will be the value of the Alternative Names text box of the cert.
28-
See below for an example.
29-
<p class="note">
30-
<strong>Note:</strong> This property does not work with a selector property when <code>configurable: false</code> is set. For more information, see <a href="https://docs.pivotal.io/tiledev/2-10/release-notes.html#non-configurable-certs">Non-Configurable Certificates Are Invalid Within a Selector</a> in the release notes.
31-
</p>
32-
</td>
28+
See the following for an example.
3329
</tr>
3430
</table>
3531

32+
> Notes
33+
> This property does not work with a selector property when <code>configurable: false</code> is set. For more information, see <a href="https://docs.pivotal.io/tiledev/2-10/release-notes.html#non-configurable-certs">Non-Configurable Certificates Are Invalid Within a Selector</a> in the release notes.
34+
</td>
35+
3636
#### Accessors
3737

3838
<table class="nice">

tile-structure.html.md.erb

+6-2
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ Each form, or configuration pane, has `label` for the menu text, a `description`
6767

6868
For each property, you can combine specifications for `name`, `type`, `default`, `configurable`, `options`, and `constraints`. For more information, see the [Form Properties](./property-template-references.html#form-properties) and [Property Blueprints](./property-template-references.html#property-blueprints) sections of the _Property and Template References_ topic.
6969

70-
<p class="note"><strong>Note:</strong> In the tile installer <code>.yml</code> that Tile Generator creates, form properties appear in two locations: a <code>form_types</code> section that defines the contents and layout of the configuration interface, and a <code>property_blueprints</code> section that defines the corresponding text box value types and constraints.</p>
70+
>**Note**
71+
>In the tile installer <code>.yml</code> that Tile Generator creates, form properties appear in two locations: a <code>form_types</code> section that defines the contents and layout of the configuration interface, and a <code>property_blueprints</code> section that defines the corresponding text box value types and constraints.
7172

7273
#### <a id='appearance'></a> Tile appearance
7374

@@ -97,7 +98,10 @@ You can include both required and optional product dependencies for tiles.
9798

9899
* **Required Dependencies**: Required dependencies are always required. To deploy the dependent tile, you must also deploy the dependency.
99100

100-
* **Optional Dependencies**: Optional dependencies are only required if you upload both the dependent tile and the optional dependency to your environment. For example, a tile may be dependent on either <%= vars.app_runtime_abbr %> or <%= vars.k8s_runtime_full %> (<%= vars.k8s_runtime_abbr %>). If you define <%= vars.app_runtime_abbr %> and <%= vars.k8s_runtime_abbr %> as optional dependecies, you can upload either <%= vars.app_runtime_abbr %> or <%= vars.k8s_runtime_abbr %> to successfully deploy the dependent tile.<p class="note"><strong>Note:</strong> After the dependency is installed, it is mandatory even if marked as optional.</p>
101+
* **Optional Dependencies**: Optional dependencies are only required if you upload both the dependent tile and the optional dependency to your environment. For example, a tile may be dependent on either <%= vars.app_runtime_abbr %> or <%= vars.k8s_runtime_full %> (<%= vars.k8s_runtime_abbr %>). If you define <%= vars.app_runtime_abbr %> and <%= vars.k8s_runtime_abbr %> as optional dependecies, you can upload either <%= vars.app_runtime_abbr %> or <%= vars.k8s_runtime_abbr %> to successfully deploy the dependent tile.
102+
103+
>**Note**
104+
>After the dependency is installed, it is mandatory even if marked as optionaass=l.
101105

102106
Include product dependencies under `requires_product_versions` at the top of the `tile.yml` file. To add an optional dependency, use an `optional` text box under `requires_product_versions`. For example:
103107

0 commit comments

Comments
 (0)