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