Add role specific information to the service template
[apex-tripleo-heat-templates.git] / puppet / services / logging / fluentd-config.yaml
1 heat_template_version: ocata
2
3 description: Fluentd logging configuration
4
5 parameters:
6   ServiceNetMap:
7     default: {}
8     description: Mapping of service_name -> network name. Typically set
9                  via parameter_defaults in the resource registry.  This
10                  mapping overrides those in ServiceNetMapDefaults.
11     type: json
12   DefaultPasswords:
13     default: {}
14     type: json
15   RoleName:
16     default: ''
17     description: Role name on which the service is applied
18     type: string
19   RoleParameters:
20     default: {}
21     description: Parameters specific to the role
22     type: json
23   EndpointMap:
24     default: {}
25     description: >
26       Mapping of service endpoint -> protocol. Typically set
27       via parameter_defaults in the resource registry.
28     type: json
29   LoggingDefaultFormat:
30     description: >
31       Default format used to parse messages from log files.
32     type: string
33     default: >-
34       /(?<time>\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d+)
35       (?<pid>\d+)
36       (?<priority>\S+)
37       (?<message>.*)$/
38   LoggingPosFilePath:
39     description: >
40       Directory in which to place fluentd pos_file files (used to track
41       file position for the 'tail' input type).
42     type: string
43     default: /var/cache/fluentd
44   LoggingDefaultGroups:
45     description: >
46       Make fluentd user a member of these groups. Only override this parameter
47       if you want to modify the default list of groups.  Use
48       LoggingExtraGroups to add the fluentd user to additional groups.
49     type: comma_delimited_list
50     default:
51       - root
52   LoggingExtraGroups:
53     description: >
54       Make fluentd user a member of these groups (in addition to
55       LoggingDefaultGroups and the groups provided by individual
56       composable services).
57     type: comma_delimited_list
58     default: []
59   LoggingServers:
60     description: |
61       A list of destinations to which fluentd will forward log messages.  Expects
62       a list of dictionaries of the form:
63
64           - host: loghost1.example.com
65             port: 24224
66           - host: loghost2.example.com
67             port: 24224
68     type: json
69     default: []
70   LoggingDefaultFilters:
71     description: >
72       A list of fluentd default filters. This will be passed verbatim
73       to the 'filter' key of a fluentd::config resource.  Only override this
74       if you do not want the default set of filters; use LoggingExtraFilters
75       if you just want to add additional servers.
76     type: json
77     default:
78       - tag_pattern: '**'
79         type: record_transformer
80         record:
81           host: '${hostname}'
82
83       - tag_pattern: 'openstack.**'
84         type: record_transformer
85         record:
86           component: '${tag_parts[1]}'
87   LoggingExtraFilters:
88     description: >
89       A list of additional fluentd filters. This will be passed
90       verbatim to the 'filter' key of a fluentd::config resource.
91     type: json
92     default: []
93   LoggingUsesSSL:
94     description: >
95       A boolean value indicating whether or not we should forward log messages
96       use the secure_forward plugin.
97     type: boolean
98     default: false
99   LoggingSSLCertificate:
100     description: >
101       PEM-encoded SSL CA certificate for fluentd.
102     type: string
103     default: ""
104   LoggingSSLKey:
105     description: >
106       PEM-encoded key for fluentd CA certificate (used by in_secure_forward).
107     type: string
108     default: ""
109   LoggingSSLKeyPassphrase:
110     description: >
111       Passphrase for LoggingSSLKey (used by in_secure_forward).
112     type: string
113     default: ""
114   LoggingSharedKey:
115     description: >
116       Shared secret for fluentd secure-forward plugin.
117     type: string
118     default: ""
119   LoggingDefaultSources:
120     description: >
121       A list of default logging sources for fluentd.  You should only override
122       this parameter if you wish to disable the default logging sources.  Use
123       LoggingExtraSources to define additional source configurations.
124     type: json
125     default: []
126   LoggingExtraSources:
127     description: >
128       A list of additional logging sources for fluentd.  These will be combined
129       with the LoggingDefaultSources and any logging sources defined by
130       composable services.
131     type: json
132     default: []
133
134 outputs:
135   LoggingDefaultFormat:
136     value: {get_param: LoggingDefaultFormat}
137   LoggingDefaultFilters:
138     value: {get_param: LoggingDefaultFilters}
139   LoggingExtraFilters:
140     value: {get_param: LoggingExtraFilters}
141   LoggingDefaultGroups:
142     value: {get_param: LoggingDefaultGroups}
143   LoggingExtraGroups:
144     value: {get_param: LoggingExtraGroups}
145   LoggingPosFilePath:
146     value: {get_param: LoggingPosFilePath}
147   LoggingSSLCertificate:
148     value: {get_param: LoggingSSLCertificate}
149   LoggingSSLKey:
150     value: {get_param: LoggingSSLKey}
151   LoggingSSLKeyPassphrase:
152     value: {get_param: LoggingSSLKeyPassphrase}
153   LoggingServers:
154     value: {get_param: LoggingServers}
155   LoggingSharedKey:
156     value: {get_param: LoggingSharedKey}
157   LoggingUsesSSL:
158     value: {get_param: LoggingUsesSSL}
159   LoggingDefaultSources:
160     value: {get_param: LoggingDefaultSources}
161   LoggingExtraSources:
162     value: {get_param: LoggingExtraSources}