Skip to content

Commit 6ede8a9

Browse files
committed
Add links everywhere [#163918207]
1 parent f364c54 commit 6ede8a9

2 files changed

+42
-21
lines changed

migrating-syslog-configuration.html.md.erb

+24-21
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ owner: Ops Manager
55

66
<strong><%= modified_date %></strong>
77

8-
This topic explains how to migrate existing syslog properties that are defined by a tile into the
8+
This topic explains how to migrate existing syslog properties that are defined by a tile into the
99
syslog form provided by Ops Manager in Pivotal Cloud Foundry (PCF) v2.5 and later.
1010

11-
By enabling the Ops Manager syslog feature, Ops Manager:
11+
By enabling the Ops Manager syslog feature, Ops Manager:
1212

1313
* Provides your tile with its own syslog form
1414
* Ensures that the syslog BOSH release is automatically injected into the instance groups of your product
1515
* Includes syslog configuration properties when Ops Manager injects the syslog release into your product
1616

1717
## <a id="syslog-data-model"></a>Syslog Data Model
1818

19-
The following table lists the Ops Manager syslog parameters that you can migrate your existing
19+
The following table lists the Ops Manager syslog parameters that you can migrate your existing
2020
configurations to.
2121

2222
<table class="nice">
@@ -48,7 +48,7 @@ By enabling the Ops Manager syslog feature, Ops Manager:
4848
<td><code>transport_protocol</code></td>
4949
<td>string</td>
5050
<td>No</td>
51-
<td>The transport protocol used to send syslog messages to the server.
51+
<td>The transport protocol used to send syslog messages to the server.
5252
<br>Valid values are <code>tcp</code> and <code>udp</code>. Defaults to <code>tcp</code></td>
5353
</tr>
5454
<tr>
@@ -67,14 +67,14 @@ By enabling the Ops Manager syslog feature, Ops Manager:
6767
<td><code>ssl_ca_certificate</code></td>
6868
<td>string</td>
6969
<td>No, unless <code>tls_enabled</code> is <code>true</code></td>
70-
<td>Must be a valid certificate<br>
70+
<td>Must be a valid certificate<br>
7171
Defaults to <code>null</code>.</td>
7272
</tr>
7373
<tr>
7474
<td><code>queue_size</code></td>
7575
<td>integer</td>
7676
<td>No</td>
77-
<td>The number of log messages the buffer holds before dropping messages. A larger buffer size
77+
<td>The number of log messages the buffer holds before dropping messages. A larger buffer size
7878
might overload the system. Defaults to <code>100000</code></td>
7979
</tr>
8080
<tr>
@@ -96,11 +96,14 @@ By enabling the Ops Manager syslog feature, Ops Manager:
9696

9797
## <a id="javascript"></a> Use the JavaScript Migration Process
9898

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

103-
1. To write your JavaScript migration, use the following example as a template:
103+
1. Set the `opsmanager_syslog` property to `true` in your `metadata.yml`.
104+
For more information, see [opsmanager_syslog](./property-template-references.html#syslog-flag).
105+
106+
1. To write your JavaScript migration, use the following example as a template:
104107

105108

106109
```js
@@ -115,33 +118,33 @@ migrated syslog properties in the Syslog form of the tile.
115118
};
116119
```
117120
In the code block above, replace the example text as follows:
118-
* `PROPERTY-REFERENCE`: Replace with the property reference that corresponds to the metadata
121+
* `PROPERTY-REFERENCE`: Replace with the property reference that corresponds to the metadata
119122
file, such as `properties`.
120123
For more information about migrating properties, see [Tile Upgrades](./tile-upgrades.html#import).
121124
* `EXAMPLE-ADDRESS`: Replace with the property name of the address.
122125
* `EXAMPLE-PORT`: Replace with the property name of the port.
123126
* `EXAMPLE-PROTOCOL`: Replace with the property name of the transport protocol.
124-
127+
125128
1. Save the JavaScript file to the `PRODUCT/migrations/v1` directory of your `.pivotal` file.
126129
1. Remove the following:
127-
* From your product template, `form_types` that allow operators to configure tile-specific syslog configuration
128-
* From your tile, the syslog BOSH release.
130+
* From your product template, `form_types` that allow operators to configure tile-specific syslog configuration
131+
* From your tile, the syslog BOSH release.
129132
* From your deployment manifest, syslog configuration properties.
130133

131-
1. To ensure that operators do not try to update syslog configuration properties with no outward
132-
functionality, mark all existing syslog configuration properties in your product as non-configurable.
134+
1. To ensure that operators do not try to update syslog configuration properties with no outward
135+
functionality, mark all existing syslog configuration properties in your product as non-configurable.
133136

134-
1. Update the description for the deprecated properties to state that they are deprecated and are no
137+
1. Update the description for the deprecated properties to state that they are deprecated and are no
135138
longer used to configure the syslog.
136139

137-
1. Run a test deploy of your tile by doing the procedures in [Testing Tiles](./testing.html).
140+
1. Run a test deploy of your tile by doing the procedures in [Testing Tiles](./testing.html).
138141

139-
1. To ensure that your syslog properties were successfully migrated into the Ops Manager syslog
142+
1. To ensure that your syslog properties were successfully migrated into the Ops Manager syslog
140143
configuration, do one of the following:
141144
* View the configurations in the **Syslog** pane in Ops Manager **Settings** page.
142-
* View your syslog properties using the `syslog_configuration` Ops Manager API endpoint.
143-
For more information about the `syslog_configuration` API endpoint, see
145+
* View your syslog properties using the `syslog_configuration` Ops Manager API endpoint.
146+
For more information about the `syslog_configuration` API endpoint, see
144147
[Retrieving syslog configuration for a product](https://docs.pivotal.io/pivotalcf/opsman-api/#retrieving-syslog-configuration-for-a-product).
145148

146-
<p class="note"><strong>Note:</strong> In the next version of your product, remove
149+
<p class="note"><strong>Note:</strong> In the next version of your product, remove
147150
the deprecated syslog configuration properties.</p>

release-notes.html.md.erb

+18
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,23 @@ which might be relevant to partner service tiles.
1212

1313
Add text here.
1414

15+
16+
## <a id="syslog-form"></a> Syslog Form Template Available for Tile Authors
17+
Tile authors can insert a templatized Syslog form into their tiles by using the
18+
`opsmanager_syslog` key in their tile’s `metadata.yml`.
19+
The pane that the form creates is identical to the Syslog pane in Ops Manager
20+
and the BOSH Director tile.
21+
This form includes properties for `forward_debug_logs` and `custom_rsyslog_configuration`.
22+
23+
The form template is an opportunity to make tile users’ experience more consistent and secure.
24+
For more information about modifying `metadata.yml`,
25+
see [Property Template References](https://docs.pivotal.io/tiledev/2-4/property-template-references.html#syslog-flag).
26+
27+
Tile authors with an existing form can migrate their syslog parameters to the templatized Syslog form.
28+
For more information about migrating an existing form to the Ops Manager provided syslog form, see
29+
[Migrating Existing Syslog Configuration to Ops Manager](./migrating-syslog-configuration.html).
30+
31+
1532
## <a id="pas-properties"></a> Pivotal Application Service Tile Property Changes
1633

1734
Properties in the Pivotal Application Service (PAS) v2.5 tile have changed.
@@ -37,6 +54,7 @@ The following tables list the properties that Pivotal removed and added in PAS v
3754
</tr>
3855
</table>
3956

57+
4058
## <a id="breaking-changes"></a> Breaking Changes
4159

4260
### <a id="breaking-change-1"></a> Breaking Change 1

0 commit comments

Comments
 (0)