Freezer Scheduler Configuration Options¶
The following is an overview of all available configuration options in Freezer Scheduler. To see sample configuration file, see Freezer Scheduler Sample Configuration File.
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
- 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.
- log_color¶
- Type:
boolean
- Default:
False
(Optional) Set the ‘color’ key according to log levels. This option takes effect only when logging to stderr or stdout is used. This option is ignored if log_config_append is set.
- 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', 'boto=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- Valid Values:
CRITICAL, ERROR, INFO, WARNING, DEBUG, ‘’
Log level name used by rate limiting. 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.
capabilities¶
- supported_actions¶
- Type:
list
- Default:
backup,restore,info,admin,exec
List of supported actions separated by comma.Other actions will be ignored. Default value is “backup,restore,info,admin,exec”
- supported_modes¶
- Type:
list
- Default:
fs,mongo,mysql,sqlserver,cinder,glance,cindernative,nova
List of supported modes separated by comma.Other modes will be ignored. Default value is “fs,mongo,mysql,sqlserver,cinder,glance,cindernative,nova”
- supported_storages¶
- Type:
list
- Default:
local,swift,ssh,s3,ftp,ftps
List of supported storages separated by comma.Other storages will be ignored. Default value is “local,swift,ssh,s3,ftp,ftps”
- supported_engines¶
- Type:
list
- Default:
tar,rsync,rsyncv2,nova,osbrick,glance
List of supported engines separated by comma.Other engines will be ignored. Default value is “tar,rsync,rsyncv2,nova,osbrick,glance”
scheduler¶
- client_id¶
- Type:
string
- Default:
<None>
- Specifies the client_id used when contacting the service.
If not specified it will be automatically created using the project-id and the machine hostname.
Deprecated Variations¶ Group
Name
DEFAULT
client-id
DEFAULT
client_id
- no_api¶
- Type:
boolean
- Default:
False
Prevents the scheduler from connecting to the API. In this case, scheduler will only read jobs from the local conf.d directory
Deprecated Variations¶ Group
Name
DEFAULT
no-api
DEFAULT
no_api
- jobs_dir¶
- Type:
string
- Default:
/etc/freezer/scheduler/conf.d
Path to the directory containing jobs configuration files. Default value is /etc/freezer/scheduler/conf.d (Env: FREEZER_SCHEDULER_CONF_D)
Deprecated Variations¶ Group
Name
DEFAULT
conf
- interval¶
- Type:
integer
- Default:
60
Specifies the api-polling interval in seconds. Defaults to 60 seconds
Deprecated Variations¶ Group
Name
DEFAULT
interval
- no_daemon¶
- Type:
boolean
- Default:
False
Prevents the scheduler from running in daemon mode
Deprecated Variations¶ Group
Name
DEFAULT
no-daemon
DEFAULT
no_daemon
- insecure¶
- Type:
boolean
- Default:
False
Allow to access servers without checking SSL certs.
- disable_exec¶
- Type:
boolean
- Default:
False
Allow Freezer Scheduler to deny jobs that execute commands for security reasons
Deprecated Variations¶ Group
Name
DEFAULT
disable-exec
DEFAULT
disable_exec
- concurrent_jobs¶
- Type:
integer
- Default:
1
Specifies how many jobs can be run at the same time
Deprecated Variations¶ Group
Name
DEFAULT
concurrent_jobs
- enable_v1_api¶
- Type:
boolean
- Default:
False
If set to true, it will use freezer v1 api instead of v2
Deprecated Variations¶ Group
Name
DEFAULT
enable-v1-api
DEFAULT
enable_v1_api
service_auth¶
- os_username¶
- Type:
string
- Default:
''
Name used for authentication with the OpenStack Identity service. Defaults to env[OS_USERNAME].
Deprecated Variations¶ Group
Name
DEFAULT
os-username
DEFAULT
os_username
- os_password¶
- Type:
string
- Default:
''
Password used for authentication with the OpenStack Identity service. Defaults to env[OS_PASSWORD].
Deprecated Variations¶ Group
Name
DEFAULT
os-password
DEFAULT
os_password
- os_project_id¶
- Type:
string
- Default:
''
Project id to scope to. Defaults to env[OS_PROJECT_ID].
Deprecated Variations¶ Group
Name
DEFAULT
os-project-id
DEFAULT
os_project_id
- os_project_name¶
- Type:
string
- Default:
''
Project name to scope to. Defaults to env[OS_PROJECT_NAME].
Deprecated Variations¶ Group
Name
DEFAULT
os-project-name
DEFAULT
os_project_name
- os_project_domain_id¶
- Type:
string
- Default:
''
Domain ID containing project. Defaults to env[OS_PROJECT_DOMAIN_ID].
Deprecated Variations¶ Group
Name
DEFAULT
os-project-domain-id
DEFAULT
os_project_domain_id
- os_project_domain_name¶
- Type:
string
- Default:
''
Domain name containing project. Defaults to env[OS_PROJECT_DOMAIN_NAME].
Deprecated Variations¶ Group
Name
DEFAULT
os-project-domain-name
DEFAULT
os_project_domain_name
- os_user_domain_id¶
- Type:
string
- Default:
''
User’s domain id. Defaults to env[OS_USER_DOMAIN_ID].
Deprecated Variations¶ Group
Name
DEFAULT
os-user-domain-id
DEFAULT
os_user_domain_id
- os_user_domain_name¶
- Type:
string
- Default:
''
User’s domain name. Defaults to env[OS_USER_DOMAIN_NAME].
Deprecated Variations¶ Group
Name
DEFAULT
os-user-domain-name
DEFAULT
os_user_domain_name
- os_auth_url¶
- Type:
string
- Default:
''
Specify the Identity endpoint to use for authentication. Defaults to env[OS_AUTH_URL].
Deprecated Variations¶ Group
Name
DEFAULT
os-auth-url
DEFAULT
os_auth_url
- os_backup_url¶
- Type:
string
- Default:
''
Specify the Freezer backup service endpoint to use. Defaults to env[OS_BACKUP_URL].
Deprecated Variations¶ Group
Name
DEFAULT
os-backup-url
DEFAULT
os_backup_url
- os_region_name¶
- Type:
string
- Default:
''
Specify the region to use. Defaults to env[OS_REGION_NAME].
Deprecated Variations¶ Group
Name
DEFAULT
os-region-name
DEFAULT
os_region_name
- os_token¶
- Type:
string
- Default:
''
Specify an existing token to use instead of retrieving one via authentication (e.g. with username & password). Defaults to env[OS_TOKEN].
Deprecated Variations¶ Group
Name
DEFAULT
os-token
DEFAULT
os_token
- os_endpoint_type¶
- Type:
string
- Default:
public- Valid Values:
public, publicURL, internal, internalURL, admin, adminURL
Endpoint type to select. Valid endpoint types: “public” or “publicURL”, “internal” or “internalURL”, “admin” or “adminURL”. Defaults to env[OS_ENDPOINT_TYPE] or “public”
Deprecated Variations¶ Group
Name
DEFAULT
os-endpoint-type
DEFAULT
os_endpoint_type
