freezer-scheduler¶
DESCRIPTION¶
freezer-scheduler is being used to schedule backup and restore of different cloud resources. It can also be used to schedule admin operations on your backup like (remove old backups, list backups, …).
OPTIONS¶
usage: freezer-scheduler [-h] [--config-dir DIR] [--config-file PATH]
[--debug] [--log-config-append PATH]
[--log-date-format DATE_FORMAT] [--log-dir LOG_DIR]
[--log-file PATH] [--nodebug] [--nouse-journal]
[--nouse-json] [--nouse-syslog]
[--shell_completion SHELL_COMPLETION]
[--syslog-log-facility SYSLOG_LOG_FACILITY]
[--use-journal] [--use-json] [--use-syslog]
[--version]
[--service_auth-auth-url SERVICE_AUTH_OS_AUTH_URL]
[--service_auth-backup_url SERVICE_AUTH_OS_BACKUP_URL]
[--service_auth-cacert SERVICE_AUTH_OS_CACERT]
[--service_auth-cert SERVICE_AUTH_OS_CERT]
[--service_auth-endpoint-type SERVICE_AUTH_OS_ENDPOINT_TYPE]
[--service_auth-password SERVICE_AUTH_OS_PASSWORD]
[--service_auth-project-domain-id SERVICE_AUTH_OS_PROJECT_DOMAIN_ID]
[--service_auth-project-domain-name SERVICE_AUTH_OS_PROJECT_DOMAIN_NAME]
[--service_auth-project-id SERVICE_AUTH_OS_PROJECT_ID]
[--service_auth-project-name SERVICE_AUTH_OS_PROJECT_NAME]
[--service_auth-region-name SERVICE_AUTH_OS_REGION_NAME]
[--service_auth-token SERVICE_AUTH_OS_TOKEN]
[--service_auth-user-domain-id SERVICE_AUTH_OS_USER_DOMAIN_ID]
[--service_auth-user_domain_name SERVICE_AUTH_OS_USER_DOMAIN_NAME]
[--service_auth-username SERVICE_AUTH_OS_USERNAME]
[--scheduler-client-id SCHEDULER_CLIENT_ID]
[--scheduler-concurrent-jobs SCHEDULER_CONCURRENT_JOBS]
[--scheduler-disable-exec]
[--scheduler-enable-v1-api] [--scheduler-insecure]
[--scheduler-interval SCHEDULER_INTERVAL]
[--scheduler-jobs-dir SCHEDULER_JOBS_DIR]
[--scheduler-no-api] [--scheduler-no-daemon]
[--scheduler-nodisable-exec]
[--scheduler-noenable-v1-api]
[--scheduler-noinsecure] [--scheduler-nono-api]
[--scheduler-nono-daemon]
[--capabilities-supported-actions CAPABILITIES_SUPPORTED_ACTIONS]
[--capabilities-supported-engines CAPABILITIES_SUPPORTED_ENGINES]
[--capabilities-supported-modes CAPABILITIES_SUPPORTED_MODES]
[--capabilities-supported-storages CAPABILITIES_SUPPORTED_STORAGES]
action
positional arguments:
action ['start', 'stop', 'restart', 'status', 'reload']
Allowed values: start, stop, restart, status, reload
options:
-h, --help show this help message and exit
--config-dir DIR 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-file PATH Path to a config file to use. Multiple config files
can be specified, with values in later files taking
precedence. Defaults to None. This option must be set
from the command-line.
--debug, -d If set to true, the logging level will be set to DEBUG
instead of the default INFO level.
--log-config-append PATH, --log-config PATH, --log_config PATH
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).
--log-date-format DATE_FORMAT
Defines the format string for %(asctime)s in log
records. Default: None . This option is ignored if
log_config_append is set.
--log-dir LOG_DIR, --logdir LOG_DIR
(Optional) The base directory used for relative
log_file paths. This option is ignored if
log_config_append is set.
--log-file PATH, --logfile PATH
(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.
--nodebug The inverse of --debug
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--shell_completion SHELL_COMPLETION
Display a shell completion script Allowed values:
bash, zsh
--syslog-log-facility SYSLOG_LOG_FACILITY
Syslog facility to receive log lines. This option is
ignored if log_config_append is set.
--use-journal 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.
--use-json Use JSON formatting for logging. This option is
ignored if log_config_append is set.
--use-syslog 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.
--version show program's version number and exit
Service Authentication Options:
--service_auth-auth-url SERVICE_AUTH_OS_AUTH_URL, --os-auth-url SERVICE_AUTH_OS_AUTH_URL, --os_auth_url SERVICE_AUTH_OS_AUTH_URL
Specify the Identity endpoint to use for
authentication. Defaults to env[OS_AUTH_URL].
--service_auth-backup_url SERVICE_AUTH_OS_BACKUP_URL, --os-backup-url SERVICE_AUTH_OS_BACKUP_URL, --os_backup_url SERVICE_AUTH_OS_BACKUP_URL
Specify the Freezer backup service endpoint to use.
Defaults to env[OS_BACKUP_URL].
--service_auth-cacert SERVICE_AUTH_OS_CACERT, --os-cacert SERVICE_AUTH_OS_CACERT, --os_cacert SERVICE_AUTH_OS_CACERT
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to
--service_auth-cert SERVICE_AUTH_OS_CERT, --os-cert SERVICE_AUTH_OS_CERT, --os_cert SERVICE_AUTH_OS_CERT
Specify a cert file to use in verifying a TLS (https)
server certificate
--service_auth-endpoint-type SERVICE_AUTH_OS_ENDPOINT_TYPE, --os-endpoint-type SERVICE_AUTH_OS_ENDPOINT_TYPE, --os_endpoint_type SERVICE_AUTH_OS_ENDPOINT_TYPE
Endpoint type to select. Valid endpoint types:
"public" or "publicURL", "internal" or "internalURL",
"admin" or "adminURL". Defaults to
env[OS_ENDPOINT_TYPE] or "public" Allowed values:
public, publicURL, internal, internalURL, admin,
adminURL
--service_auth-password SERVICE_AUTH_OS_PASSWORD, --os-password SERVICE_AUTH_OS_PASSWORD, --os_password SERVICE_AUTH_OS_PASSWORD
Password used for authentication with the OpenStack
Identity service. Defaults to env[OS_PASSWORD].
--service_auth-project-domain-id SERVICE_AUTH_OS_PROJECT_DOMAIN_ID, --os-project-domain-id SERVICE_AUTH_OS_PROJECT_DOMAIN_ID, --os_project_domain_id SERVICE_AUTH_OS_PROJECT_DOMAIN_ID
Domain ID containing project. Defaults to
env[OS_PROJECT_DOMAIN_ID].
--service_auth-project-domain-name SERVICE_AUTH_OS_PROJECT_DOMAIN_NAME, --os-project-domain-name SERVICE_AUTH_OS_PROJECT_DOMAIN_NAME, --os_project_domain_name SERVICE_AUTH_OS_PROJECT_DOMAIN_NAME
Domain name containing project. Defaults to
env[OS_PROJECT_DOMAIN_NAME].
--service_auth-project-id SERVICE_AUTH_OS_PROJECT_ID, --os-project-id SERVICE_AUTH_OS_PROJECT_ID, --os_project_id SERVICE_AUTH_OS_PROJECT_ID
Project id to scope to. Defaults to
env[OS_PROJECT_ID].
--service_auth-project-name SERVICE_AUTH_OS_PROJECT_NAME, --os-project-name SERVICE_AUTH_OS_PROJECT_NAME, --os_project_name SERVICE_AUTH_OS_PROJECT_NAME
Project name to scope to. Defaults to
env[OS_PROJECT_NAME].
--service_auth-region-name SERVICE_AUTH_OS_REGION_NAME, --os-region-name SERVICE_AUTH_OS_REGION_NAME, --os_region_name SERVICE_AUTH_OS_REGION_NAME
Specify the region to use. Defaults to
env[OS_REGION_NAME].
--service_auth-token SERVICE_AUTH_OS_TOKEN, --os-token SERVICE_AUTH_OS_TOKEN, --os_token SERVICE_AUTH_OS_TOKEN
Specify an existing token to use instead of retrieving
one via authentication (e.g. with username &
password). Defaults to env[OS_TOKEN].
--service_auth-user-domain-id SERVICE_AUTH_OS_USER_DOMAIN_ID, --os-user-domain-id SERVICE_AUTH_OS_USER_DOMAIN_ID, --os_user_domain_id SERVICE_AUTH_OS_USER_DOMAIN_ID
User's domain id. Defaults to env[OS_USER_DOMAIN_ID].
--service_auth-user_domain_name SERVICE_AUTH_OS_USER_DOMAIN_NAME, --os-user-domain-name SERVICE_AUTH_OS_USER_DOMAIN_NAME, --os_user_domain_name SERVICE_AUTH_OS_USER_DOMAIN_NAME
User's domain name. Defaults to
env[OS_USER_DOMAIN_NAME].
--service_auth-username SERVICE_AUTH_OS_USERNAME, --os-username SERVICE_AUTH_OS_USERNAME, --os_username SERVICE_AUTH_OS_USERNAME
Name used for authentication with the OpenStack
Identity service. Defaults to env[OS_USERNAME].
Scheduler Options:
--scheduler-client-id SCHEDULER_CLIENT_ID, -c SCHEDULER_CLIENT_ID, --client-id SCHEDULER_CLIENT_ID, --client_id SCHEDULER_CLIENT_ID
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.
--scheduler-concurrent-jobs SCHEDULER_CONCURRENT_JOBS, --concurrent_jobs SCHEDULER_CONCURRENT_JOBS
Specifies how many jobs can be run at the same time
--scheduler-disable-exec, --disable-exec, --disable_exec
Allow Freezer Scheduler to deny jobs that execute
commands for security reasons
--scheduler-enable-v1-api, --enable-v1-api, --enable_v1_api
If set to true, it will use freezer v1 api instead of
v2
--scheduler-insecure Allow to access servers without checking SSL certs.
--scheduler-interval SCHEDULER_INTERVAL, -i SCHEDULER_INTERVAL, --interval SCHEDULER_INTERVAL
Specifies the api-polling interval in seconds.
Defaults to 60 seconds
--scheduler-jobs-dir SCHEDULER_JOBS_DIR, -f SCHEDULER_JOBS_DIR, --conf SCHEDULER_JOBS_DIR
Path to the directory containing jobs configuration
files. Default value is /etc/freezer/scheduler/conf.d
(Env: FREEZER_SCHEDULER_CONF_D)
--scheduler-no-api, -n, --no-api, --no_api
Prevents the scheduler from connecting to the API. In
this case, scheduler will only read jobs from the
local conf.d directory
--scheduler-no-daemon, --no-daemon, --no_daemon
Prevents the scheduler from running in daemon mode
--scheduler-nodisable-exec, --nodisable-exec, --nodisable_exec
The inverse of --disable-exec
--scheduler-noenable-v1-api, --noenable-v1-api, --noenable_v1_api
The inverse of --enable-v1-api
--scheduler-noinsecure
The inverse of --insecure
--scheduler-nono-api, --nono-api, --nono_api
The inverse of --no-api
--scheduler-nono-daemon, --nono-daemon, --nono_daemon
The inverse of --no-daemon
Capabilities of the freezer-scheduler:
--capabilities-supported-actions CAPABILITIES_SUPPORTED_ACTIONS
List of supported actions separated by comma.Other
actions will be ignored. Default value is
"backup,restore,info,admin,exec"
--capabilities-supported-engines CAPABILITIES_SUPPORTED_ENGINES
List of supported engines separated by comma.Other
engines will be ignored. Default value is
"tar,rsync,rsyncv2,nova,osbrick,glance"
--capabilities-supported-modes CAPABILITIES_SUPPORTED_MODES
List of supported modes separated by comma.Other modes
will be ignored. Default value is "fs,mongo,mysql,sqls
erver,cinder,glance,cindernative,nova"
--capabilities-supported-storages CAPABILITIES_SUPPORTED_STORAGES
List of supported storages separated by comma.Other
storages will be ignored. Default value is
"local,swift,ssh,s3,ftp,ftps"
SEE ALSO¶
BUGS¶
Freezer bugs are managed at Launchpad Bugs : Freezer
