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
Copy file name to clipboardexpand all lines: migrating-syslog-configuration.html.md.erb
+64-35
Original file line number
Diff line number
Diff line change
@@ -5,67 +5,80 @@ owner: Ops Manager
5
5
6
6
<strong><%=modified_date%></strong>
7
7
8
-
This topic explains how to migrate existing syslog properties that are defined by a tile into the syslog form provided by OpsManager.
8
+
This topic explains how to migrate existing syslog properties that are defined by a tile into the
9
+
syslog form provided by Ops Manager in Pivotal Cloud Foundry (PCF) v2.5 and later.
10
+
11
+
By enabling the Ops Manager syslog feature, Ops Manager:
12
+
13
+
* Provides your tile with its own syslog form.
14
+
* Ensures that the syslog BOSH release is automatically injected into the instance groups of your product.
15
+
* Includes syslog configuration properties when Ops Manager injects the syslog release into your product
9
16
10
17
## <aid="syslog-data-model"></a>Syslog Data Model
11
18
12
-
<table>
19
+
The following table lists the Ops Manager syslog parameters that you can mirgrate your existing
20
+
configurations to.
21
+
22
+
<tableclass="nice">
13
23
<tr>
14
-
<th>Syslog parameter</th>
24
+
<thwidth="175">Syslog parameter</th>
15
25
<th>Data Type</th>
16
26
<th>Required</th>
17
27
<th>Notes</th>
18
28
</tr>
19
29
<tr>
20
-
<td>enabled</td>
30
+
<td><code>enabled</code></td>
21
31
<td>boolean</td>
22
32
<td>No</td>
23
-
<td>Defaults to false</td>
33
+
<td>Defaults to false</td>
24
34
</tr>
25
35
<tr>
26
-
<td>address</td>
36
+
<td><code>address</code></td>
27
37
<td>string</td>
28
38
<td>Yes</td>
29
-
<td>Must be a valid network address</td>
39
+
<td>The address or host for the syslog server. Must be a valid network address</td>
30
40
</tr>
31
41
<tr>
32
-
<td>port</td>
42
+
<td><code>port</code></td>
33
43
<td>integer</td>
34
44
<td>Yes</td>
35
-
<td></td>
45
+
<td>The port on which the syslog server listens.</td>
36
46
</tr>
37
47
<tr>
38
-
<td>transport_protocol</td>
48
+
<td><code>transport_protocol</code></td>
39
49
<td>string</td>
40
50
<td>No</td>
41
-
<td>Valid values include tcp and udp. Defaults to tcp.</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>
42
52
</tr>
43
53
<tr>
44
-
<td>tls_enabled</td>
54
+
<td><code>tls_enabled</code></td>
45
55
<td>boolean</td>
46
56
<td>No</td>
47
-
<td>Defaults to false.</td>
57
+
<td>Send logs encrypted to syslog server via TLS. Defaults to false.</td>
48
58
</tr>
49
59
<tr>
50
-
<td>ssl_ca_certificate</td>
51
-
<td>string</td>
52
-
<td>No, unless tls_enabled is true</td>
53
-
<td>Defaults to false.</td>
60
+
<td><code>permitted_peer</code></td>
61
+
<td>boolean</td>
62
+
<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>
54
65
</tr>
55
66
<tr>
56
-
<td>permitted_peer</td>
57
-
<td>boolean</td>
58
-
<td>No, unless tls_enabled is true</td>
59
-
<td>Defaults to false.</td>
67
+
<td><code>ssl_ca_certificate</code></td>
68
+
<td>string</td>
69
+
<td>No, unless <code>tls_enabled</code> is <code>true</code></td>
70
+
<td>This certificate will ensure that logs get securely transported to the syslog destination.
71
+
Defaults to false? to null?</td>
60
72
</tr>
61
73
<tr>
62
-
<td>queue_size</td>
74
+
<td><code>queue_size</code></td>
63
75
<td>integer</td>
64
76
<td>No</td>
65
-
<td>Defaults to 100,000.</td>
77
+
<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>
66
79
</tr>
67
80
<tr>
68
-
<td>forward_debug_logs</td>
81
+
<td><code>forward_debug_logs</code></td>
69
82
<td>boolean</td>
70
83
<td>No</td>
71
84
<td>Defaults to false.</td>
@@ -74,10 +87,12 @@ This topic explains how to migrate existing syslog properties that are defined b
74
87
75
88
## <aid="javascript"></a> Use the JavaScript Migration Process
76
89
77
-
Tile authors can write a JavaScript migration to move their existing syslog properties into the syslog form provided by OpsManager. After a successful migration, Ops Manager will present the migrated syslog properties in the Syslog form of the tile.
90
+
Tile authors can write a JavaScript migration to move their existing syslog properties into the
91
+
syslog form provided by OpsManager. After a successful migration, Ops Manager will present the
92
+
migrated syslog properties in the Syslog form of the tile.
93
+
94
+
1. To write your JavaScript migration, use the following example as a template:
78
95
79
-
1. Use the following example to write the JavaScript migration.
80
-
Save the JavaScript file to the `PRODUCT/migrations/v1` directory of your .pivotal tile.
81
96
82
97
```js
83
98
exports.migrate = function(input) {
@@ -91,19 +106,33 @@ Save the JavaScript file to the `PRODUCT/migrations/v1` directory of your .pivot
91
106
};
92
107
```
93
108
In the code block above, replace the example text as follows:
94
-
* `PROPERTY-REFERENCE`: Replace with the property reference that corresponds to the metadata file, such as `properties`. See [Tile Upgrades](./tile-upgrades.html#import) for more information about migrating properties.
109
+
* `PROPERTY-REFERENCE`: Replace with the property reference that corresponds to the metadata
110
+
file, such as `properties`. See [Tile Upgrades](./tile-upgrades.html#import) for more
111
+
information about migrating properties.
95
112
* `EXAMPLE-ADDRESS`: Replace with the property name of the address.
96
113
* `EXAMPLE-PORT`: Replace with the property name of the port.
97
114
* `EXAMPLE-PROTOCOL`: Replace with the property name of the transport protocol.
115
+
116
+
1. Save the JavaScript file to the `PRODUCT/migrations/v1` directory of your `.pivotal` file.
117
+
1. Remove the following:
118
+
* From your product template, `form_types` that allow operators to configure tile-specific syslog configuration
119
+
* From your tile, the syslog BOSH release.
120
+
* From your deployment manifest, syslog configuration properties.
98
121
99
-
1. Remove any form types that allowed operators to configure tile-specific syslog configuration. Enabling the Ops Manager syslog feature will provide your tile with its own form.
100
-
101
-
1. Remove the syslog BOSH release from your tile. Ops Manager will ensure that this release is automatically injected into the instance groups of your product.
102
122
103
-
1. Remove any syslog configuration properties from your deployment manifest. Ops Manager will include those properties when it injects the syslog release into the product.
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.
104
127
105
-
1. Mark all existing syslog configuration properties in your product as non-configurable. This will ensure that operators do not try to update them when they will have no outward functionality. You may want to update the description for these properties to state that they are deprecated and are no longer used to configure syslog.
128
+
1. Run a test deploy of your tile by doing the procedures in [Testing Tiles](./testing.html).
106
129
107
-
1. Run a [test deploy](./testing.html) of your tile. Ensure that the syslog properties that were originally managed by your product are successfully migrated into the Ops Manager syslog configuration. You can see the configuration on the "Syslog" form or by visiting the `/api/v0/staged/products/PRODUCT-GUID/syslog_configuration` API endpoint.
130
+
1. To ensure that your syslog properties were successfully migrated into the Ops Manager syslog
131
+
configuration, do one of the following:
132
+
* View the configurations in the **Syslog** pane in Ops Manager **Settings** page.
133
+
* View your syslog properties using the `syslog_configuration` Ops Manager API endpoint.
134
+
For more information about the `syslog_configuration` API endpoint, see
135
+
[Retrieving syslog configuration for a product](https://docs.pivotal.io/pivotalcf/opsman-api/#retrieving-syslog-configuration-for-a-product).
108
136
109
-
1. At a later point, in a subsequent version of your product, you will want to remove all of the deprecated syslog configuration properties.
137
+
<pclass="note"><strong>Note:</strong> In subsequent version of your product, you should remove all
138
+
of the deprecated syslog configuration properties.</p>
0 commit comments