forked from theforeman/foreman
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsettings.yml
More file actions
435 lines (435 loc) · 15.6 KB
/
Copy pathsettings.yml
File metadata and controls
435 lines (435 loc) · 15.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
---
attributes1:
name: administrator
settings_type: string
category: Setting::General
default: root@some.host.fqdn
description: The Default administrator email address
attributes2:
name: foreman_url
category: Setting::General
default: http://foreman.some.host.fqdn
description: The URL Foreman should point to in emails etc
attributes3:
name: root_pass
category: Setting::Provisioning
default: "--- \n"
description: Default root password on provisioned hosts
attributes4:
name: safemode_render
category: Setting::Provisioning
default: "true"
description: Enable safe mode config templates rendinging(recommended)
attributes5:
name: ssl_certificate
category: Setting::Auth
default: /var/lib/puppet/ssl/certs/some.host.fqdn
description: SSL Certificate path that foreman would use to communicate with its proxies
attributes6:
name: ssl_ca_file
category: Setting::Auth
default: /var/lib/puppet/ssl/certs/ca.pem
description: SSL CA file that foreman would use to communicate with its proxies
attributes7:
name: ssl_priv_key
category: Setting::Auth
default: /var/lib/puppet/ssl/private_keys/super.some.host.fqdn.pem
description: SSL Private Key file that foreman would use to communicate with its proxies
attributes8:
name: puppet_interval
settings_type: integer
category: Setting::Puppet
default: 30
description: Setting::Puppet interval in minutes
attributes9:
name: default_puppet_environment
category: Setting::Puppet
default: production
description: "The Setting::Puppet environment foreman would default to in case it can't auto detect it"
attributes13:
name: failed_report_email_notification
category: Setting::Puppet
default: "false"
description: Enable Email Alerts per each failed puppet report
attributes14:
name: Default_parameters_Lookup_Path
category: Setting::Puppet
default: ["fqdn", "hostgroup", "os", "domain"]
description: The Default path in which foreman resolves host specific variables
attributes15:
name: manage_puppetca
category: Setting::Provisioning
default: "true"
description: Should Foreman manage host certificates when provisioning hosts
attributes16:
name: entries_per_page
category: Setting::General
default: 20
description: The amount of records shown per page in foreman
attributes17:
name: update_environment_from_facts
category: Setting::Puppet
default: "false"
description: Foreman will update a hosts environment from its facts
attributes18:
name: idle_timeout
category: Setting::General
default: 5
description: idle timeout
attributes19:
name: enc_environment
category: Setting::Puppet
default: "true"
description: Should Foreman provide puppet environment in ENC yaml output? (this avoids the mismatch error between puppet.conf and ENC environment)
attributes20:
name: use_uuid_for_certificates
category: Setting::Puppet
default: "false"
description: "Should Foreman use random UUID's for certificate signing instead of hostnames"
attributes21:
name: query_local_nameservers
category: Setting::Provisioning
default: "false"
description: "Should Foreman query the locally configured name server or the SOA/NS authorities"
attributes23:
name: authorize_login_delegation
category: Setting::General
default: "false"
description: "Setting::Authorize login delegation with REMOTE_USER environment variable"
attributes24:
name: authorize_login_delegation_api
category: Setting::General
default: "false"
description: "Setting::Authorize login delegation with REMOTE_USER environment variable for API calls"
attribute26:
name: token_duration
category: Setting::Provisioning
default: 0
description: "Time in minutes installation tokens should be valid for, 0 to disable"
attribute27:
name: restrict_registered_smart_proxies
category: Setting::Auth
default: "true"
description: "Only known Smart Proxies may access features that use Smart Proxy authentication"
attribute28:
name: require_ssl_smart_proxies
category: Setting::Auth
default: "true"
description: "Client SSL certificates are used to identify Smart Proxies (:require_ssl should also be enabled)"
attribute29:
name: ssl_client_dn_env
category: Setting::Auth
default: "SSL_CLIENT_S_DN"
description: "Environment variable containing the subject DN from a client SSL certificate"
attribute30:
name: ssl_client_verify_env
category: Setting::Auth
default: "SSL_CLIENT_VERIFY"
description: "Environment variable containing the verification status of a client SSL certificate"
attribute31:
name: ssl_client_cert_env
category: Setting::Auth
default: "SSL_CLIENT_CERT"
description: "Environment variable containing a client SSL certificate"
attribute32:
name: trusted_hosts
category: Setting::Auth
default: []
description: "Hosts that will be trusted in addition to Smart Proxies for access to fact/report importers and ENC output"
settings_type: array
attribute37:
name: create_new_host_when_facts_are_uploaded
category: Setting::Puppet
default: "true"
description: "Foreman will create the host when new facts are received"
attribute38:
name: update_ip_from_built_request
category: Setting::Provisioning
default: "true"
description: "Should we use the originating IP of the built request to update the Host's IP?"
attribute40:
name: interpolate_erb_in_parameters
category: Setting::Puppet
default: "true"
description: "Should Foreman parse ERB to return dynamic parameters?"
attribute41:
name: use_shortname_for_vms
category: Setting::Provisioning
default: "false"
description: "Should Foreman use the short hostname instead of the FQDN for creating new virtual machines"
attribute42:
name: create_new_host_when_report_is_uploaded
category: Setting::Puppet
default: "true"
description: "Foreman will create the host when a report is received"
attributes43:
name: unattended_url
category: Setting::Provisioning
default: http://foreman.some.host.fqdn
description: The URL Foreman should point to in templates etc
attributes44:
name: default_organization
category: Setting::Puppet
default: 'Organization 1'
description: 'Default organization when importing hosts'
attributes45:
name: default_location
category: Setting::Puppet
default: 'Location 1'
description: 'Default location when importing hosts'
attributes46:
name: location_fact
category: Setting::Puppet
default: 'foreman_location'
description: 'Fact to set location from when importing hosts'
attributes47:
name: organization_fact
category: Setting::Puppet
default: 'foreman_organization'
description: 'Fact to set organization from when importing hosts'
attributes49:
name: oauth_active
category: Setting::Auth
default: "false"
description: "Foreman will use OAuth for API authorization"
attributes50:
name: oauth_consumer_key
category: Setting::Auth
default: "oauth_key"
description: "OAuth consumer key"
attributes51:
name: oauth_consumer_secret
category: Setting::Auth
default: "oauth_secret"
description: "OAuth consumer secret"
attributes52:
name: oauth_map_users
category: Setting::Auth
default: "true"
description: "Foreman will map users by username in request-header. If this is set to false, OAuth requests will have admin rights."
attributes53:
name: send_welcome_email
category: Setting::Email
default: "false"
description: "Send a welcome email including initial username and password to new users"
attributes54:
name: email_subject_prefix
category: Setting::Email
default: "[foreman]"
description: "Prefix to add to all outgoing email"
attributes55:
name: outofsync_interval
settings_type: integer
category: Setting::Puppet
default: 5
description: "Duration in minutes after the Puppet interval for servers to be classed as out of sync."
attributes56:
name: email_reply_address
category: Setting::Email
default: "foreman-noreply@#{SETTINGS[:domain]}"
description: 'Email reply address for emails that Foreman is sending'
attributes57:
name: clean_up_failed_deployment
category: Setting::Provisioning
default: "true"
description: "Foreman will delete virtual machine if provisioning script ends with non zero exit code"
attributes58:
name: ignored_interface_identifiers
category: Setting::Provisioning
default: "['lo', 'en*v*', 'usb*', 'vnet*', 'macvtap*', '_vdsmdummy_', 'veth*', 'docker*', 'tap*', 'qbr*', 'qvb*', 'qvo*', 'qr-*', 'qg-*', 'vlinuxbr*', 'vovsbr*']"
description: 'Ignore interfaces that match these values during facts importing, you can use * wildcard to match names with indexes e.g. macvtap*'
attributes59:
name: always_show_configuration_status
category: Setting::Puppet
default: "false"
description: 'All hosts will show a configuration status even when a Puppet smart proxy is not assigned'
attributes60:
name: max_trend
category: Setting::General
default: 30
description: 'Max days for Trends graphs'
attributes61:
name: name_generator_type
settings_type: string
category: Setting::Provisioning
default: "Random-based"
description: 'Random gives unique names, MAC-based are longer but stable (and only works with bare-metal)'
attributes62:
name: bmc_credentials_accessible
category: Setting::Auth
default: "true"
description: 'Permits access to BMC interface passwords through ENC YAML output and in templates'
attributes63:
name: password
category: Setting::Puppet
default: nil
description: 'Encrypted password'
encrypted: true
attributes64:
name: access_unattended_without_build
category: Setting::Provisioning
default: "false"
description: 'Allow access to unattended URLs without build mode being used'
full_name: 'Access unattended without build'
settings_type: 'boolean'
attributes65:
name: update_subnets_from_facts
category: Setting::Puppet
default: "none"
description: 'Foreman will update a hosts subnets from its facts'
attributes66:
name: delivery_method
category: Setting::Email
default: :test
description: 'Method used to deliver e-mail'
attributes67:
name: smtp_address
category: Setting::Email
default: 'smtp@example.com'
description: Method used to deliver email'
attributes68:
name: smtp_authentication
category: Setting::Email
default: 'none'
description: 'Specify authentication type, if required'
attributes69:
name: sendmail_arguments
category: Setting::Email
default: 'args'
description: 'Specify additional options to sendmail'
attribute70:
name: ignore_facts_for_operatingsystem
category: Setting::Provisioning
default: "false"
description: 'Stop updating Operating System from facts'
attribute71:
name: ignore_facts_for_domain
category: Setting::Provisioning
default: "false"
description: 'Stop updating domain from facts'
attribute72:
name: host_owner
category: Setting::Provisioning
default: nil
description: 'Default host owner'
attribute73:
name: local_boot_PXELinux
category: Setting::Provisioning
default: PXELinux default local boot
description: 'Set up default local boot template for PXELinux'
attribute74:
name: rss_enable
category: Setting::Notification
default: true
description: 'Whether to enable or not RSS feed notifications'
attribute75:
name: rss_url
category: Setting::Notification
default: "http://theforeman.org/feed.xml"
description: 'Default URL for RSS feed notifications'
attribute76:
name: default_pxe_item_global
category: Setting::Provisioning
default: nil
description: 'Default PXE global template entry'
attribute77:
name: default_pxe_item_local
category: Setting::Provisioning
default: nil
description: 'Default PXE local template entry'
attributes78:
name: excluded_facts
category: Setting::Provisioning
default: "['lo', 'en*v*', 'usb*', 'vnet*', 'macvtap*', '_vdsmdummy_', 'veth*', 'docker*', 'tap*', 'qbr*', 'qvb*', 'qvo*', 'qr-*', 'qg-*', 'vlinuxbr*', 'vovsbr*', 'load_averages::*', 'memory::system::capacity', 'memory::system::used*', 'memory::system::available*', 'memory::swap::capacity', 'memory::swap::used*', 'memory::swap::available*']"
description: 'Ignore fact names that match these values during facts importing, you can use * wildcard to match names with indexes e.g. macvtap*'
settings_type: 'array'
attribute79:
name: append_domain_name_for_hosts
category: Setting::General
default: "true"
description: "Should append domain names when new hosts are provisioned"
attribute80:
name: failed_login_attempts_limit
category: Setting::Auth
default: 30
description: "Foreman will block user login after this number of failed login attempts for 5 minutes from offending IP address. Set to 0 to disable bruteforce protection"
attribute81:
name: bcrypt_cost
category: Setting::Auth
default: 4
description: "Cost value of bcrypt password hash function for internal auth-sources."
attribute82:
name: login_text
category: Setting::General
default: "--- \n"
description: 'Text to be shown in the login-page footer'
attribute83:
name: ssh_timeout
category: Setting::Provisioning
default: 120
description: 'Time in seconds before SSH provisioning times out'
attribute84:
name: destroy_vm_on_host_delete
category: Setting::Provisioning
default: true
description: 'Destroy associated VM on host delete. When enabled, VMs linked to Hosts will be deleted on Compute Resource, meaning they can be re-associated or imported back to Foreman again. This does not automatically power off the VM'
attribute85:
name: intermediate_ipxe_script
category: Setting::Provisioning
default: nil
description: 'Intermidiate iPXE script'
attribute86:
name: maximum_structured_facts
category: Setting::Provisioning
default: 100
description: 'Maximum structured facts'
attribute87:
name: instance_id
category: Setting::General
default: '2abbbe02-4ace-4269-9e20-2753f3206cc2'
description: 'Foreman UUID'
attribute88:
name: oidc_jwks_url
category: Setting::Auth
default: 'https://keycloak.example.com/auth/realms/foreman/protocol/openid-connect/certs'
description: 'OpenID Connect JSON Web Key Set(JWKS) URL. Typically https://keycloak.example.com/auth/realms/<realm name>/protocol/openid-connect/certs if you are using Keycloak as an IDP'
attribute89:
name: oidc_audience
category: Setting::Auth
default: 'rest-client'
description: 'Name of the OpenID Connect Audience that is being used for Authentication. For example in case of Keycloak this is the Client ID.'
attribute90:
name: oidc_issuer
category: Setting::Auth
default: 127.0.0.1
description: "The iss (issuer) claim identifies the principal that issued the JWT, which exists at a `/.well-known/openid-configuration` in case of most of the IDP's."
attribute91:
name: oidc_algorithm
category: Setting::Auth
default: 'RS512'
description: 'The algorithm used to encode the JWT in the IDP.'
attribute92:
name: authorize_login_delegation_auth_source_user_autocreate
category: Setting::Auth
default: 'External'
description: 'Name of the external auth source where unknown externally authentication users (see authorize_login_delegation) should be created (keep unset to prevent the autocreation)'
attribute93:
name: update_hostgroup_from_facts
category: Setting::Puppet
default: true
description: "Foreman will update a host's hostgroup from its facts"
attribute94:
name: default_global_registration_item
category: Setting::Provisioning
default: 'Global Registration'
description: "Default Global registration template"
attribute95:
name: default_host_init_config_template
category: Setting::Provisioning
default: 'Linux host initial configuration'
description: "Default host initial configuration template"
attribute96:
name: server_ca_file
category: Setting::Auth
default: /var/lib/puppet/ssl/certs/ca.pem
description: SSL CA file that will be used in templates (to verify the connection to Foreman)