Skip to content

Commit 3325ea6

Browse files
committed
edits [#162775262]
1 parent cd1bb7d commit 3325ea6

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

migrating-syslog-configuration.html.md.erb

+15-14
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@ By enabling the Ops Manager syslog feature, Ops Manager:
2323
<tr>
2424
<th width="175">Syslog parameter</th>
2525
<th>Data Type</th>
26-
<th>Required</th>
26+
<th width="150">Required</th>
2727
<th>Notes</th>
2828
</tr>
2929
<tr>
3030
<td><code>enabled</code></td>
3131
<td>boolean</td>
3232
<td>No</td>
33-
<td> Defaults to false</td>
33+
<td> Defaults to <code>false</code></td>
3434
</tr>
3535
<tr>
3636
<td><code>address</code></td>
3737
<td>string</td>
3838
<td>Yes</td>
39-
<td>The address or host for the syslog server. Must be a valid network address</td>
39+
<td>The address or host for the syslog server. <br>Must be a valid network address</td>
4040
</tr>
4141
<tr>
4242
<td><code>port</code></td>
@@ -48,40 +48,41 @@ 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. Valid values are <code>tcp</code> and <code>udp</code>. Defaults to <code>tcp</code>.</td>
51+
<td>The transport protocol used to send syslog messages to the server.
52+
<br>Valid values are <code>tcp</code> and <code>udp</code>. Defaults to <code>tcp</code>.</td>
5253
</tr>
5354
<tr>
5455
<td><code>tls_enabled</code></td>
5556
<td>boolean</td>
5657
<td>No</td>
57-
<td>Send logs encrypted to syslog server via TLS. Defaults to false.</td>
58+
<td>Send logs encrypted to syslog server via TLS. Defaults to <code>false</code>.</td>
5859
</tr>
5960
<tr>
6061
<td><code>permitted_peer</code></td>
6162
<td>boolean</td>
6263
<td>No, unless <code>tls_enabled</code> is <code>true</code></td>
63-
<td>Either the accepted fingerprint (SHA1) or name of remote peer, e.g. *.example.com. Defaults
64-
to false.</td>
64+
<td>Either the accepted fingerprint (SHA1) or name of remote peer. Defaults
65+
to <code>false</code>.</td>
6566
</tr>
6667
<tr>
6768
<td><code>ssl_ca_certificate</code></td>
6869
<td>string</td>
6970
<td>No, unless <code>tls_enabled</code> is <code>true</code></td>
7071
<td>This certificate will ensure that logs get securely transported to the syslog destination.
71-
Defaults to false? to null?</td>
72+
Defaults to <code>null</code>.</td>
7273
</tr>
7374
<tr>
7475
<td><code>queue_size</code></td>
7576
<td>integer</td>
7677
<td>No</td>
7778
<td>The number of log messages the buffer holds before dropping messages. A larger buffer size
78-
might overload the system. Defaults to 100,000.</td>
79+
might overload the system. Defaults to <code>100000</code>.</td>
7980
</tr>
8081
<tr>
8182
<td><code>forward_debug_logs</code></td>
8283
<td>boolean</td>
8384
<td>No</td>
84-
<td>Defaults to false.</td>
85+
<td>Defaults to <code>false</code>.</td>
8586
</tr>
8687
</table>
8788

@@ -119,11 +120,11 @@ migrated syslog properties in the Syslog form of the tile.
119120
* From your tile, the syslog BOSH release.
120121
* From your deployment manifest, syslog configuration properties.
121122

123+
1. To ensure that operators do not try to update syslog configuration properties with no outward
124+
functionality, mark all existing syslog configuration properties in your product as non-configurable.
122125

123-
1. Mark all existing syslog configuration properties in your product as non-configurable. This
124-
ensures that operators do not try to update them when they have no outward functionality. You may
125-
want to update the description for these properties to state that they are deprecated and are no
126-
longer used to configure syslog.
126+
1. Update the description for the deprecated properties to state that they are deprecated and are no
127+
longer used to configure the syslog.
127128

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

0 commit comments

Comments
 (0)