cASO configuration file¶
caso: DEFAULT¶
- messengers¶
- Type
list
- Default
['noop']
List of messengers that will dispatch records. valid values are logstash,noop,ssm,ssmv4. You can specify more than one messenger.
- spooldir¶
- Type
string
- Default
/var/spool/caso
Spool directory.
- lock_path¶
- Type
string
- Default
$spooldir
Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable CASO_LOCK_PATH or $spooldir
- dry_run¶
- Type
boolean
- Default
False
Extract records but do not push records to SSM. This will not update the last run date.
- site_name¶
- Type
string
- Default
<None>
Site name as in GOCDB.
- service_name¶
- Type
string
- Default
$site_name
Service name within the site
- projects¶
- Type
list
- Default
[]
List of projects to extract accounting records from. You can use this option, or add ‘caso’ tag to the project in Keystone. Please refer to the documentation for more details.
- caso_tag¶
- Type
string
- Default
caso
Tag used to mark a project in Keystone to be extracted by cASO
- vo_property¶
- Type
string
- Default
VO
Property key used to get the VO name from the project properties.
- mapping_file¶
- Type
string
- Default
/etc/caso/voms.json
File containing the VO <-> project mapping as used in Keystone-VOMS.
Deprecated Variations¶ Group
Name
extractor
mapping_file
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
- Reason
This option is marked for removal in the next release. Please see the release notes, and migrate your current configuration to use the new project mapping as soon as possible. If you already migrated your configuration, please remove the JSON file to get rid of this message.
- extract_to¶
- Type
string
- Default
<None>
Extract record changes until this date. If it is not set, we use now. If a server has ended after this date, it will be included, but the consuption reported will end on this date. If no time zone is specified, UTC will be used.
- extract_from¶
- Type
string
- Default
<None>
Extract records that have changed after this date. This means that if a record has started before this date, and it has changed after this date (i.e. it is still running or it has ended) it will be reported. If it is not set, extract records from last run. If it is set to None and last run file is not present, it will extract records from the beginning of time. If no time zone is specified, UTC will be used.
- extractor¶
- Type
list
- Default
['nova', 'cinder', 'neutron']
Which extractor to use for getting the data. If you do not specify anything, nova will be used. Available choices are [‘cinder’, ‘neutron’, ‘nova’]
caso: accelerator¶
- type_key¶
- Type
string
- Default
Accelerator:Type
Metadata key used to retrieve the accelerator type from the flavor properties.
- vendor_key¶
- Type
string
- Default
Accelerator:Vendor
Metadata key used to retrieve the accelerator vendor from the flavor properties.
- model_key¶
- Type
string
- Default
Accelerator:Model
Metadata key used to retrieve the accelerator model from the flavor properties.
- number_key¶
- Type
string
- Default
Accelerator:Number
Metadata key used to retrieve the accelerator number from the flavor properties.
caso: benchmark¶
- name_key¶
- Type
string
- Default
accounting:benchmark_type
Metadata key used to retrieve the benchmark type from the flavor properties.
- value_key¶
- Type
string
- Default
accounting:benchmark_value
Metadata key used to retrieve the benchmark value from the flavor properties.
caso: keystone_auth¶
- auth_type¶
- Type
unknown type
- Default
<None>
Authentication type to load
Deprecated Variations¶ Group
Name
keystone_auth
auth_plugin
- auth_section¶
- Type
unknown type
- Default
<None>
Config Section from which to load plugin specific options
- cafile¶
- Type
string
- Default
<None>
PEM encoded Certificate Authority to use when verifying HTTPs connections.
- certfile¶
- Type
string
- Default
<None>
PEM encoded client certificate cert file
- keyfile¶
- Type
string
- Default
<None>
PEM encoded client certificate key file
- insecure¶
- Type
boolean
- Default
False
Verify HTTPS connections.
- timeout¶
- Type
integer
- Default
<None>
Timeout value for http requests
- collect_timing¶
- Type
boolean
- Default
False
Collect per-API call timing information.
- split_loggers¶
- Type
boolean
- Default
False
Log requests to multiple loggers.
- auth_url¶
- Type
unknown type
- Default
<None>
Authentication URL
- system_scope¶
- Type
unknown type
- Default
<None>
Scope for system operations
- domain_id¶
- Type
unknown type
- Default
<None>
Domain ID to scope to
- domain_name¶
- Type
unknown type
- Default
<None>
Domain name to scope to
- project_id¶
- Type
unknown type
- Default
<None>
Project ID to scope to
Deprecated Variations¶ Group
Name
keystone_auth
tenant-id
keystone_auth
tenant_id
- project_name¶
- Type
unknown type
- Default
<None>
Project name to scope to
Deprecated Variations¶ Group
Name
keystone_auth
tenant-name
keystone_auth
tenant_name
- project_domain_id¶
- Type
unknown type
- Default
<None>
Domain ID containing project
- project_domain_name¶
- Type
unknown type
- Default
<None>
Domain name containing project
- trust_id¶
- Type
unknown type
- Default
<None>
ID of the trust to use as a trustee use
- default_domain_id¶
- Type
unknown type
- Default
<None>
Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
- default_domain_name¶
- Type
unknown type
- Default
<None>
Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
- user_id¶
- Type
unknown type
- Default
<None>
User id
- username¶
- Type
unknown type
- Default
<None>
Username
Deprecated Variations¶ Group
Name
keystone_auth
user-name
keystone_auth
user_name
- user_domain_id¶
- Type
unknown type
- Default
<None>
User’s domain id
- user_domain_name¶
- Type
unknown type
- Default
<None>
User’s domain name
- password¶
- Type
unknown type
- Default
<None>
User’s password
caso: logstash¶
- host¶
- Type
string
- Default
localhost
Logstash host to send records to.
- port¶
- Type
integer
- Default
5000
Logstash server port.
caso: ssm¶
- output_path¶
- Type
string
- Default
/var/spool/apel/outgoing/openstack
Directory to put the generated SSM records.
- max_size¶
- Type
integer
- Default
100
Maximum number of records to send per message
oslo.config: DEFAULT¶
- config_file¶
- Type
list of filenames
- Default
['~/.project/project.conf', '~/project.conf', '/etc/project/project.conf', '/etc/project.conf']
Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence. Defaults to the value above. This option must be set from the command-line.
- config_dir¶
- Type
list of directory names
- Default
['~/.project/project.conf.d/', '~/project.conf.d/', '/etc/project/project.conf.d/', '/etc/project.conf.d/']
Path to a config directory to pull *.conf files from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous –config-file, arguments hence over-ridden options in the directory take precedence. This option must be set from the command-line.
- config_source¶
- Type
list
- Default
[]
Lists configuration groups that provide more details for accessing configuration settings from locations other than local files.
- driver¶
- Type
string
- Default
remote_file
This option has a sample default set, which means that its actual default value may vary from the one documented above.
The name of the driver that can load this configuration source.
- uri¶
- Type
URI
- Default
https://example.com/my-configuration.ini
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Required option with the URI of the extra configuration file’s location.
- ca_path¶
- Type
string
- Default
/etc/ca-certificates
This option has a sample default set, which means that its actual default value may vary from the one documented above.
The path to a CA_BUNDLE file or directory with certificates of trusted CAs.
- client_cert¶
- Type
string
- Default
/etc/ca-certificates/service-client-keystore
This option has a sample default set, which means that its actual default value may vary from the one documented above.
Client side certificate, as a single file path containing either the certificate only or the private key and the certificate.
- client_key¶
- Type
string
- Default
<None>
Client side private key, in case client_cert is specified but does not includes the private key.
oslo.log: DEFAULT¶
- debug¶
- Type
boolean
- Default
False- Mutable
This option can be changed without restarting.
If set to true, the logging level will be set to DEBUG instead of the default INFO level.
- log_config_append¶
- Type
string
- Default
<None>- Mutable
This option can be changed without restarting.
The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).
Deprecated Variations¶ Group
Name
DEFAULT
log-config
DEFAULT
log_config
- log_date_format¶
- Type
string
- Default
%Y-%m-%d %H:%M:%S
Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.
- log_file¶
- Type
string
- Default
<None>
(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
Deprecated Variations¶ Group
Name
DEFAULT
logfile
- log_dir¶
- Type
string
- Default
<None>
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
Deprecated Variations¶ Group
Name
DEFAULT
logdir
- watch_log_file¶
- Type
boolean
- Default
False
Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
- use_syslog¶
- Type
boolean
- Default
False
Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
- use_journal¶
- Type
boolean
- Default
False
Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.
- syslog_log_facility¶
- Type
string
- Default
LOG_USER
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
- use_json¶
- Type
boolean
- Default
False
Use JSON formatting for logging. This option is ignored if log_config_append is set.
- use_stderr¶
- Type
boolean
- Default
False
Log output to standard error. This option is ignored if log_config_append is set.
- use_eventlog¶
- Type
boolean
- Default
False
Log output to Windows Event Log.
- log_rotate_interval¶
- Type
integer
- Default
1
The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.
- log_rotate_interval_type¶
- Type
string
- Default
days- Valid Values
Seconds, Minutes, Hours, Days, Weekday, Midnight
Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.
- max_logfile_count¶
- Type
integer
- Default
30
Maximum number of rotated log files.
- max_logfile_size_mb¶
- Type
integer
- Default
200
Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.
- log_rotation_type¶
- Type
string
- Default
none- Valid Values
interval, size, none
Log rotation type.
Possible values
- interval
Rotate logs at predefined time intervals.
- size
Rotate logs once they reach a predefined size.
- none
Do not rotate log files.
- logging_context_format_string¶
- Type
string
- Default
%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s
Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter
- logging_default_format_string¶
- Type
string
- Default
%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter
- logging_debug_format_suffix¶
- Type
string
- Default
%(funcName)s %(pathname)s:%(lineno)d
Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter
- logging_exception_prefix¶
- Type
string
- Default
%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter
- logging_user_identity_format¶
- Type
string
- Default
%(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s
Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter
- default_log_levels¶
- Type
list
- Default
['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=INFO', 'oslo_messaging=INFO', 'iso8601=WARN', 'requests.packages.urllib3.connectionpool=WARN', 'urllib3.connectionpool=WARN', 'websocket=WARN', 'requests.packages.urllib3.util.retry=WARN', 'urllib3.util.retry=WARN', 'keystonemiddleware=WARN', 'routes.middleware=WARN', 'stevedore=WARN', 'taskflow=WARN', 'keystoneauth=WARN', 'oslo.cache=INFO', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO']
List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
- publish_errors¶
- Type
boolean
- Default
False
Enables or disables publication of error events.
- instance_format¶
- Type
string
- Default
"[instance: %(uuid)s] "
The format for an instance that is passed with the log message.
- instance_uuid_format¶
- Type
string
- Default
"[instance: %(uuid)s] "
The format for an instance UUID that is passed with the log message.
- rate_limit_interval¶
- Type
integer
- Default
0
Interval, number of seconds, of log rate limiting.
- rate_limit_burst¶
- Type
integer
- Default
0
Maximum number of logged messages per rate_limit_interval.
- rate_limit_except_level¶
- Type
string
- Default
CRITICAL
Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
- fatal_deprecations¶
- Type
boolean
- Default
False
Enables or disables fatal status of deprecations.