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
<pclass="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.
31
32
32
33
### <aid='setup-pcfdev'></a> Setting up <%=vars.product_dev_local%>
Copy file name to clipboardexpand all lines: migrating-credhub-credentials.html.md.erb
+10-5
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,9 @@ The following table lists the Ops Manager credential types you can migrate to Cr
38
38
</tr>
39
39
</table>
40
40
41
-
<pclass="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
+
42
44
43
45
See [Property and template references](./property-template-references.html#secret) for more information about credential types.
44
46
@@ -94,8 +96,11 @@ following the naming conventions discussed in the [Update Values or Property Nam
94
96
type: password
95
97
```
96
98
97
-
<pclass="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
-
<ahref="#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 <ahref="#cred-types">CredHub Credential Types</a> table at the beginning of this topic for more information about credential types.
102
+
103
+
99
104
100
105
1. In your manifest snippet, replace the existing secret value with the new triple-parenthesis syntax.
101
106
* Remove the existing secret from the manifest snippet:
@@ -110,6 +115,6 @@ following the naming conventions discussed in the [Update Values or Property Nam
110
115
secret: ((( SECRET-VARIABLE )))
111
116
```
112
117
113
-
1. Run a [test deploy](./testing.html) of your tile.
118
+
2. Run a [test deploy](./testing.html) of your tile.
114
119
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).
Copy file name to clipboardexpand all lines: migrating-syslog-configuration.html.md.erb
+3-2
Original file line number
Diff line number
Diff line change
@@ -148,5 +148,6 @@ configuration, do one of the following:
148
148
For more information about the `syslog_configuration` API endpoint, see
149
149
[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).
150
150
151
-
<pclass="note"><strong>Note:</strong> In the next version of your product, remove
152
-
the deprecated syslog configuration properties.</p>
Copy file name to clipboardexpand all lines: property-template-references.html.md.erb
+18-9
Original file line number
Diff line number
Diff line change
@@ -440,10 +440,12 @@ The following keys are supported:
440
440
- `name`: The name of the tile required by your tile. This is a required key.
441
441
- `version`: The version range required by your tile. This is a required key.
442
442
- `optional`: This is an optional key that defaults to false.
443
-
<pclass="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
+
447
449
448
450
For example:
449
451
@@ -981,7 +983,8 @@ Jobs require many different settings to function properly. That is the core of w
981
983
982
984
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.
983
985
984
-
<pclass="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 <ahref="#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 <ahref="#ip-ranges">ip_ranges</a>.
985
988
986
989
```
987
990
job_types:
@@ -1259,7 +1262,9 @@ You can give users control of balancing jobs across availability zones (AZs) by
1259
1262
1260
1263
To limit a job to a single AZ, set `single_az_only` to `true`.
1261
1264
1262
-
<pclass="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
+
1263
1268
1264
1269
### <aid='job-max-in-flight'></a> max_in_flight
1265
1270
@@ -1295,7 +1300,8 @@ The resources you can set are:
1295
1300
1296
1301
For examples of supported constraint types, see [integer](#integer).
1297
1302
1298
-
<pclass="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.
@@ -1312,7 +1318,9 @@ For example, your tile uses Amazon Relational Database Service (RDS) instead of
1312
1318
1313
1319
For examples of supported constraint types, see [integer](#integer).
1314
1320
1315
-
<pclass="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
+
1316
1324
1317
1325
### <aid='job-manifest'></a> Manifest
1318
1326
@@ -1417,7 +1425,8 @@ Use the `current_record` property within a collection record to refer to other p
1417
1425
1418
1426
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.
1419
1427
1420
-
<pclass="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>.
1421
1430
1422
1431
After defining a named manifest, you can reference it using a manifest snippet in the following format:
Copy file name to clipboardexpand all lines: ssi-creds-tiledev.html.md.erb
+4-2
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,8 @@ The sections below describe an example implementation of how to add SSI credenti
38
38
39
39
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.
40
40
41
-
<pclass="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 <ahref="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 <ahref="http://docs.pivotal.io/tiledev/1-11/release-notes.html#bosh-links">BOSH Links</a>.
42
43
43
44
### <aid="spec"></a> Update spec file and templates
44
45
@@ -214,4 +215,5 @@ To activate your service broker to store binding credentials in runtime CredHub
214
215
}
215
216
```
216
217
217
-
<pclass="note"><strong>Note:</strong> Java Virtual Machine (JVM) apps can use <ahref="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 <ahref="https://projects.spring.io/spring-credhub">Spring CredHub</a> to access the CredHub API.
Copy file name to clipboardexpand all lines: tile-generator.html.md.erb
+10-9
Original file line number
Diff line number
Diff line change
@@ -97,7 +97,8 @@ For a 7-minute introduction into what Tile Generator is and does, see
97
97
This puts the `tile` and `pcf` commands in your `PATH` when the virtualenv is active.
98
98
To deactivate the virtualenv, run the command `deactivate`.
99
99
100
-
<pclass="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>
101
102
with the virtualenv activated.</p>
102
103
103
104
@@ -106,7 +107,8 @@ For a 7-minute introduction into what Tile Generator is and does, see
106
107
3. From within the root directory of the project for which you want to create a tile,
107
108
initialize the directory as a tile repository by running the following commands:
108
109
109
-
<pclass="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>
110
112
111
113
```
112
114
cd YOUR-PROD-DIRECTORY
@@ -164,7 +166,8 @@ You can build this sample using the following steps:
164
166
tile build
165
167
```
166
168
167
-
<pclass="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,
168
171
sometimes as an app, sometimes as a service broker. One of the deployments (app3)
169
172
uses the sample app inside a Docker image that is modified
170
173
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`:
304
307
enable_global_access_to_plans: true # optional
305
308
```
306
309
307
-
<pclass="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
309
312
broker's services do not appear in the user's Marketplaces.
310
313
Operators have to use the <code>cf enable-service-access</code> command to allow
311
314
specific users, orgs, and spaces to access your services.
@@ -656,10 +659,8 @@ package.
656
659
Service instances provisioned this way survive updates, but are deleted
657
660
when the tile is uninstalled.
658
661
659
-
<pclass="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>
663
664
664
665
If you do not specify a plan, Tile Generator uses the first plan
665
666
listed for the service in the broker catalog. It is a good idea to always
Copy file name to clipboardexpand all lines: tile-reference/property-blueprints/_rsa-cert-credentials.html.erb
+5-5
Original file line number
Diff line number
Diff line change
@@ -25,14 +25,14 @@ This holds SSL certificate generated from root CA.
25
25
list of domain names to use when auto-generating the RSA certificate.
26
26
The first domain listed will be the value of the Common Name text box of the cert.
27
27
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
-
<pclass="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 <ahref="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.
33
29
</tr>
34
30
</table>
35
31
32
+
> Notes
33
+
> This property does not work with a selector property when <code>configurable: false</code> is set. For more information, see <ahref="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.
Copy file name to clipboardexpand all lines: tile-structure.html.md.erb
+6-2
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,8 @@ Each form, or configuration pane, has `label` for the menu text, a `description`
67
67
68
68
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.
69
69
70
-
<pclass="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.
71
72
72
73
#### <aid='appearance'></a> Tile appearance
73
74
@@ -97,7 +98,10 @@ You can include both required and optional product dependencies for tiles.
97
98
98
99
* **Required Dependencies**: Required dependencies are always required. To deploy the dependent tile, you must also deploy the dependency.
99
100
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.<pclass="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.
101
105
102
106
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:
0 commit comments