Skip to content

Commit 5be94e7

Browse files
Copilotalvarolopez
andcommitted
chore: regenerate sample configuration file with new messenger options
Co-authored-by: alvarolopez <[email protected]>
1 parent 35b0431 commit 5be94e7

File tree

1 file changed

+307
-26
lines changed

1 file changed

+307
-26
lines changed

etc/caso/caso.conf.sample

Lines changed: 307 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,73 @@
11
[DEFAULT]
22

3+
#
4+
# From caso
5+
#
6+
7+
# List of messengers that will dispatch records. valid values are
8+
# logstash,noop,ssm,ssmv4. You can specify more than one messenger. (list
9+
# value)
10+
#messengers = noop
11+
12+
# Spool directory. (string value)
13+
#spooldir = /var/spool/caso
14+
15+
# Directory to use for lock files. For security, the specified directory should
16+
# only be writable by the user running the processes that need locking.
17+
# Defaults to environment variable CASO_LOCK_PATH or $spooldir (string value)
18+
#lock_path = $spooldir
19+
20+
# Extract records but do not push records to SSM. This will not update the last
21+
# run date. (boolean value)
22+
#dry_run = false
23+
24+
# Site name as in GOCDB. (string value)
25+
#site_name = <None>
26+
27+
# Service name within the site (string value)
28+
#service_name = $site_name
29+
30+
# List of projects to extract accounting records from. You can use this option,
31+
# or add 'caso' tag to the project in Keystone. Please refer to the
32+
# documentation for more details. (list value)
33+
#projects =
34+
35+
# Tag used to mark a project in Keystone to be extracted by cASO (string value)
36+
#caso_tag = caso
37+
38+
# Property key used to get the VO name from the project properties. (string
39+
# value)
40+
#vo_property = VO
41+
42+
# DEPRECATED: File containing the VO <-> project mapping as used in Keystone-
43+
# VOMS. (string value)
44+
# This option is deprecated for removal.
45+
# Its value may be silently ignored in the future.
46+
# Reason: This option is marked for removal in the next release. Please see the
47+
# release notes, and migrate your current configuration to use the new project
48+
# mapping as soon as possible. If you already migrated your configuration,
49+
# please remove the JSON file to get rid of this message.
50+
#mapping_file = /etc/caso/voms.json
51+
52+
# Extract record changes until this date. If it is not set, we use now. If a
53+
# server has ended after this date, it will be included, but the consuption
54+
# reported will end on this date. If no time zone is specified, UTC will be
55+
# used. (string value)
56+
#extract_to = <None>
57+
58+
# Extract records that have changed after this date. This means that if a
59+
# record has started before this date, and it has changed after this date (i.e.
60+
# it is still running or it has ended) it will be reported.
61+
# If it is not set, extract records from last run. If it is set to None and
62+
# last run file is not present, it will extract records from the beginning of
63+
# time. If no time zone is specified, UTC will be used. (string value)
64+
#extract_from = <None>
65+
66+
# Which extractor to use for getting the data. If you do not specify anything,
67+
# nova will be used. Available choices are ['cinder', 'neutron', 'nova',
68+
# 'prometheus'] (list value)
69+
#extractor = nova,cinder,neutron
70+
371
#
472
# From oslo.config
573
#
@@ -89,6 +157,12 @@
89157
# set. (boolean value)
90158
#use_stderr = false
91159

160+
# DEPRECATED: Log output to Windows Event Log. (boolean value)
161+
# This option is deprecated for removal.
162+
# Its value may be silently ignored in the future.
163+
# Reason: Windows support is no longer maintained.
164+
#use_eventlog = false
165+
92166
# (Optional) Set the 'color' key according to log levels. This option takes
93167
# effect only when logging to stderr or stdout is used. This option is ignored
94168
# if log_config_append is set. (boolean value)
@@ -182,6 +256,233 @@
182256
#fatal_deprecations = false
183257

184258

259+
[accelerator]
260+
261+
#
262+
# From caso
263+
#
264+
265+
# Metadata key used to retrieve the accelerator type from the flavor
266+
# properties. (string value)
267+
#type_key = Accelerator:Type
268+
269+
# Metadata key used to retrieve the accelerator vendor from the flavor
270+
# properties. (string value)
271+
#vendor_key = Accelerator:Vendor
272+
273+
# Metadata key used to retrieve the accelerator model from the flavor
274+
# properties. (string value)
275+
#model_key = Accelerator:Model
276+
277+
# Metadata key used to retrieve the accelerator number from the flavor
278+
# properties. (string value)
279+
#number_key = Accelerator:Number
280+
281+
282+
[benchmark]
283+
284+
#
285+
# From caso
286+
#
287+
288+
# Metadata key used to retrieve the benchmark type from the flavor properties.
289+
# (string value)
290+
#name_key = accounting:benchmark_type
291+
292+
# Metadata key used to retrieve the benchmark value from the flavor properties.
293+
# (string value)
294+
#value_key = accounting:benchmark_value
295+
296+
297+
[keystone_auth]
298+
299+
#
300+
# From caso
301+
#
302+
303+
# Authentication type to load (string value)
304+
# Deprecated group/name - [keystone_auth]/auth_plugin
305+
#auth_type = <None>
306+
307+
# Config Section from which to load plugin specific options (string value)
308+
#auth_section = <None>
309+
310+
# PEM encoded Certificate Authority to use when verifying HTTPs connections.
311+
# (string value)
312+
#cafile = <None>
313+
314+
# PEM encoded client certificate cert file (string value)
315+
#certfile = <None>
316+
317+
# PEM encoded client certificate key file (string value)
318+
#keyfile = <None>
319+
320+
# Verify HTTPS connections. (boolean value)
321+
#insecure = false
322+
323+
# Timeout value for http requests (integer value)
324+
#timeout = <None>
325+
326+
# Collect per-API call timing information. (boolean value)
327+
#collect_timing = false
328+
329+
# Log requests to multiple loggers. (boolean value)
330+
#split_loggers = false
331+
332+
# Authentication URL (string value)
333+
#auth_url = <None>
334+
335+
# Scope for system operations (string value)
336+
#system_scope = <None>
337+
338+
# Domain ID to scope to (string value)
339+
#domain_id = <None>
340+
341+
# Domain name to scope to (string value)
342+
#domain_name = <None>
343+
344+
# Project ID to scope to (string value)
345+
# Deprecated group/name - [keystone_auth]/tenant_id
346+
#project_id = <None>
347+
348+
# Project name to scope to (string value)
349+
# Deprecated group/name - [keystone_auth]/tenant_name
350+
#project_name = <None>
351+
352+
# Domain ID containing project (string value)
353+
#project_domain_id = <None>
354+
355+
# Domain name containing project (string value)
356+
#project_domain_name = <None>
357+
358+
# ID of the trust to use as a trustee use (string value)
359+
#trust_id = <None>
360+
361+
# Optional domain ID to use with v3 and v2 parameters. It will be used for both
362+
# the user and project domain in v3 and ignored in v2 authentication. (string
363+
# value)
364+
#default_domain_id = <None>
365+
366+
# Optional domain name to use with v3 API and v2 parameters. It will be used
367+
# for both the user and project domain in v3 and ignored in v2 authentication.
368+
# (string value)
369+
#default_domain_name = <None>
370+
371+
# User id (string value)
372+
#user_id = <None>
373+
374+
# Username (string value)
375+
# Deprecated group/name - [keystone_auth]/user_name
376+
#username = <None>
377+
378+
# User's domain id (string value)
379+
#user_domain_id = <None>
380+
381+
# User's domain name (string value)
382+
#user_domain_name = <None>
383+
384+
# User's password (string value)
385+
#password = <None>
386+
387+
388+
[logstash]
389+
390+
#
391+
# From caso
392+
#
393+
394+
# Logstash host to send records to. (string value)
395+
#host = localhost
396+
397+
# Logstash server port. (integer value)
398+
#port = 5000
399+
400+
401+
[messenger_logstash]
402+
403+
#
404+
# From caso
405+
#
406+
407+
# List of record types to publish to this messenger. Valid values are: cloud,
408+
# ip, accelerator, storage, energy. If empty, all record types will be
409+
# published. Default for logstash: all record types. (list value)
410+
#record_types =
411+
412+
413+
[messenger_noop]
414+
415+
#
416+
# From caso
417+
#
418+
419+
# List of record types to publish to this messenger. Valid values are: cloud,
420+
# ip, accelerator, storage, energy. If empty, all record types will be
421+
# published. Default for noop: all record types. (list value)
422+
#record_types =
423+
424+
425+
[messenger_ssm]
426+
427+
#
428+
# From caso
429+
#
430+
431+
# List of record types to publish to this messenger. Valid values are: cloud,
432+
# ip, accelerator, storage, energy. If empty, all record types will be
433+
# published. Default for ssm: ['cloud', 'ip', 'accelerator', 'storage']. (list
434+
# value)
435+
#record_types = cloud,ip,accelerator,storage
436+
437+
438+
[messenger_ssmv4]
439+
440+
#
441+
# From caso
442+
#
443+
444+
# List of record types to publish to this messenger. Valid values are: cloud,
445+
# ip, accelerator, storage, energy. If empty, all record types will be
446+
# published. Default for ssmv4: ['cloud', 'ip', 'accelerator', 'storage'].
447+
# (list value)
448+
#record_types = cloud,ip,accelerator,storage
449+
450+
451+
[prometheus]
452+
453+
#
454+
# From caso
455+
#
456+
457+
# Prometheus server endpoint URL. (string value)
458+
#prometheus_endpoint = http://localhost:9090
459+
460+
# Name of the Prometheus metric to query for energy consumption. (string value)
461+
#prometheus_metric_name = prometheus_value
462+
463+
# Name of the label that matches the VM UUID in Prometheus metrics. (string
464+
# value)
465+
#vm_uuid_label_name = uuid
466+
467+
# List of label filters as key:value pairs to filter the Prometheus metric
468+
# (e.g., 'type_instance:scaph_process_power_microwatts'). The VM UUID label
469+
# will be added automatically based on vm_uuid_label_name. (list value)
470+
#labels = type_instance:scaph_process_power_microwatts
471+
472+
# Frequency between samples in the time series (in seconds). (integer value)
473+
#prometheus_step_seconds = 30
474+
475+
# Query time range (e.g., '1h', '6h', '24h'). (string value)
476+
#prometheus_query_range = 1h
477+
478+
# Whether to verify SSL when connecting to Prometheus. (boolean value)
479+
#prometheus_verify_ssl = true
480+
481+
# CPU normalization factor to apply to energy measurements. (floating point
482+
# value)
483+
#cpu_normalization_factor = 1.0
484+
485+
185486
[sample_remote_file_source]
186487
# Example of using a remote_file source
187488
#
@@ -246,34 +547,14 @@
246547
#timeout = 60
247548

248549

249-
[prometheus]
550+
[ssm]
250551

251552
#
252-
# From caso.extract.prometheus
553+
# From caso
253554
#
254555

255-
# Prometheus server endpoint URL. (string value)
256-
#prometheus_endpoint = http://localhost:9090
257-
258-
# Name of the Prometheus metric to query for energy consumption. (string value)
259-
#prometheus_metric_name = prometheus_value
556+
# Directory to put the generated SSM records. (string value)
557+
#output_path = /var/spool/apel/outgoing/openstack
260558

261-
# Name of the label that matches the VM UUID in Prometheus metrics. (string value)
262-
#vm_uuid_label_name = uuid
263-
264-
# List of label filters as key:value pairs to filter the Prometheus metric (e.g.,
265-
# 'type_instance:scaph_process_power_microwatts'). The VM UUID label will be added
266-
# automatically based on vm_uuid_label_name. (list value)
267-
#labels = type_instance:scaph_process_power_microwatts
268-
269-
# Frequency between samples in the time series (in seconds). (integer value)
270-
#prometheus_step_seconds = 30
271-
272-
# Query time range (e.g., '1h', '6h', '24h'). (string value)
273-
#prometheus_query_range = 1h
274-
275-
# Whether to verify SSL when connecting to Prometheus. (boolean value)
276-
#prometheus_verify_ssl = true
277-
278-
# CPU normalization factor to apply to energy measurements. (floating point value)
279-
#cpu_normalization_factor = 1.0
559+
# Maximum number of records to send per message (integer value)
560+
#max_size = 100

0 commit comments

Comments
 (0)