shaker/doc/source/tools/shaker-image-builder.txt

189 lines
11 KiB
Plaintext

usage: shaker-image-builder [-h] [--cleanup-on-error] [--config-dir DIR]
[--config-file PATH] [--debug]
[--dns-nameservers DNS_NAMESERVERS]
[--external-net EXTERNAL_NET]
[--flavor-disk FLAVOR_DISK]
[--flavor-name FLAVOR_NAME]
[--flavor-ram FLAVOR_RAM]
[--flavor-vcpus FLAVOR_VCPUS]
[--image-builder-distro IMAGE_BUILDER_DISTRO]
[--image-builder-mode IMAGE_BUILDER_MODE]
[--image-builder-template IMAGE_BUILDER_TEMPLATE]
[--image-name IMAGE_NAME]
[--log-config-append PATH]
[--log-date-format DATE_FORMAT]
[--log-dir LOG_DIR] [--log-file PATH]
[--nocleanup-on-error] [--nodebug]
[--noos-insecure] [--nouse-journal] [--nouse-json]
[--nouse-syslog] [--nowatch-log-file]
[--os-auth-url <auth-url>]
[--os-cacert <auth-cacert>]
[--os-identity-api-version <identity-api-version>]
[--os-insecure] [--os-interface <os-interface>]
[--os-password <auth-password>]
[--os-profile <hmac-key>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-project-name <auth-project-name>]
[--os-region-name <auth-region-name>]
[--os-tenant-name <auth-tenant-name>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-username <auth-username>]
[--reuse-stack-name REUSE_STACK_NAME]
[--stack-name STACK_NAME]
[--syslog-log-facility SYSLOG_LOG_FACILITY]
[--use-journal] [--use-json] [--use-syslog]
[--watch-log-file]
optional arguments:
-h, --help show this help message and exit
--cleanup-on-error Clean up the heat-stack upon any error occurred during
scenario execution.
--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.
--dns-nameservers DNS_NAMESERVERS
Comma-separated list of IPs of the DNS nameservers for
the subnets. If no value is provided defaults to
Google Public DNS.
--external-net EXTERNAL_NET
Name or ID of external network, defaults to
env[SHAKER_EXTERNAL_NET]. If no value provided then
Shaker picks any of available external networks.
--flavor-disk FLAVOR_DISK
Shaker image disk size in GB, defaults to
env[SHAKER_FLAVOR_DISK]
--flavor-name FLAVOR_NAME
Name of image flavor. The default is created by
shaker-image-builder.
--flavor-ram FLAVOR_RAM
Shaker image RAM size in MB, defaults to
env[SHAKER_FLAVOR_RAM]
--flavor-vcpus FLAVOR_VCPUS
Number of cores to allocate for Shaker image, defaults
to env[SHAKER_FLAVOR_VCPUS]
--image-builder-distro IMAGE_BUILDER_DISTRO
Operating System Distribution for shaker image when
using diskimage-builder, defaults to ubuntu Allowed
values: ubuntu, centos7
--image-builder-mode IMAGE_BUILDER_MODE
Image building mode: "heat" - using Heat template
(requires Glance v1 for base image upload); "dib" -
using diskimage-builder elements (requires qemu-utils
and debootstrap). If not set, switches to "dib" if
Glance v1 is not available. Can be specified as
env[SHAKER_IMAGE_BUILDER_MODE] Allowed values: heat,
dib
--image-builder-template IMAGE_BUILDER_TEMPLATE
Heat template containing receipt of building the
image. Can be a file name or one of aliases: "centos",
"debian", "ubuntu". Defaults to "ubuntu".
--image-name IMAGE_NAME
Name of image to use. The default is created by
shaker-image-builder.
--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.
--nocleanup-on-error The inverse of --cleanup-on-error
--nodebug The inverse of --debug
--noos-insecure The inverse of --os-insecure
--nouse-journal The inverse of --use-journal
--nouse-json The inverse of --use-json
--nouse-syslog The inverse of --use-syslog
--nowatch-log-file The inverse of --watch-log-file
--os-auth-url <auth-url>
Authentication URL, defaults to env[OS_AUTH_URL].
--os-cacert <auth-cacert>
Location of CA Certificate, defaults to
env[OS_CACERT].
--os-identity-api-version <identity-api-version>
Identity API version, defaults to
env[OS_IDENTITY_API_VERSION].
--os-insecure When using SSL in connections to the registry server,
do not require validation via a certifying authority,
defaults to env[OS_INSECURE].
--os-interface <os-interface>
Interface type. Valid options are public, admin and
internal. defaults to env[OS_INTERFACE].
--os-password <auth-password>
Authentication password, defaults to env[OS_PASSWORD].
--os-profile <hmac-key>
HMAC key for encrypting profiling context data,
defaults to env[OS_PROFILE].
--os-project-domain-name <auth-project-domain-name>
Authentication project domain name. Defaults to
env[OS_PROJECT_DOMAIN_NAME].
--os-project-name <auth-project-name>
Authentication project name. This option is mutually
exclusive with --os-tenant-name. Defaults to
env[OS_PROJECT_NAME].
--os-region-name <auth-region-name>
Authentication region name, defaults to
env[OS_REGION_NAME].
--os-tenant-name <auth-tenant-name>
Authentication tenant name, defaults to
env[OS_TENANT_NAME].
--os-user-domain-name <auth-user-domain-name>
Authentication username. Defaults to
env[OS_USER_DOMAIN_NAME].
--os-username <auth-username>
Authentication username, defaults to env[OS_USERNAME].
--reuse-stack-name REUSE_STACK_NAME
Name of an existing Shaker heat stack to reuse. The
default is to not reuse an existing stack. Caution
should be taken to only reuse stacks meant for a
specific scenario. Also certain configs e.g. image-
name, flavor-name, stack-name, etc will be ignored
when reusing an existing stack.
--stack-name STACK_NAME
Name of test heat stack. The default is a uniquely
generated name.
--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.
--watch-log-file 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.