@@ -5,18 +5,18 @@ 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
8
+ This topic explains how to migrate existing syslog properties that are defined by a tile into the
9
9
syslog form provided by Ops Manager in Pivotal Cloud Foundry (PCF) v2.5 and later.
10
10
11
- By enabling the Ops Manager syslog feature, Ops Manager:
11
+ By enabling the Ops Manager syslog feature, Ops Manager:
12
12
13
13
* Provides your tile with its own syslog form
14
14
* Ensures that the syslog BOSH release is automatically injected into the instance groups of your product
15
15
* Includes syslog configuration properties when Ops Manager injects the syslog release into your product
16
16
17
17
## < a id ="syslog-data-model "> </ a > Syslog Data Model
18
18
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
20
20
configurations to.
21
21
22
22
< table class ="nice ">
@@ -48,7 +48,7 @@ By enabling the Ops Manager syslog feature, Ops Manager:
48
48
< td > < code > transport_protocol</ code > </ td >
49
49
< td > string</ td >
50
50
< 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.
52
52
< br > Valid values are < code > tcp</ code > and < code > udp</ code > . Defaults to < code > tcp</ code > </ td >
53
53
</ tr >
54
54
< tr >
@@ -67,14 +67,14 @@ By enabling the Ops Manager syslog feature, Ops Manager:
67
67
< td > < code > ssl_ca_certificate</ code > </ td >
68
68
< td > string</ td >
69
69
< 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 >
71
71
Defaults to < code > null</ code > .</ td >
72
72
</ tr >
73
73
< tr >
74
74
< td > < code > queue_size</ code > </ td >
75
75
< td > integer</ td >
76
76
< 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
78
78
might overload the system. Defaults to < code > 100000</ code > </ td >
79
79
</ tr >
80
80
< tr >
@@ -96,11 +96,14 @@ By enabling the Ops Manager syslog feature, Ops Manager:
96
96
97
97
## < a id ="javascript "> </ a > Use the JavaScript Migration Process
98
98
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
101
101
migrated syslog properties in the Syslog form of the tile.
102
102
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:
104
107
105
108
106
109
```js
@@ -115,33 +118,33 @@ migrated syslog properties in the Syslog form of the tile.
115
118
};
116
119
```
117
120
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
119
122
file, such as `properties`.
120
123
For more information about migrating properties, see [Tile Upgrades](./tile-upgrades.html#import).
121
124
* `EXAMPLE-ADDRESS`: Replace with the property name of the address.
122
125
* `EXAMPLE-PORT`: Replace with the property name of the port.
123
126
* `EXAMPLE-PROTOCOL`: Replace with the property name of the transport protocol.
124
-
127
+
125
128
1. Save the JavaScript file to the `PRODUCT/migrations/v1` directory of your `.pivotal` file.
126
129
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.
129
132
* From your deployment manifest, syslog configuration properties.
130
133
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.
133
136
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
135
138
longer used to configure the syslog.
136
139
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).
138
141
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
140
143
configuration, do one of the following:
141
144
* 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
144
147
[Retrieving syslog configuration for a product](https://docs.pivotal.io/pivotalcf/opsman-api/#retrieving-syslog-configuration-for-a-product).
145
148
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
147
150
the deprecated syslog configuration properties.</ p >
0 commit comments