Chapter 2. Packstack command-line client

show program's version number and exit

show this help message and exit

Generate a template of an answer file.

Runs the configuration in non-interactive mode, extracting all information from theconfiguration file. using this option excludes all other options

Install on a set of hosts in a single step. The format should be a comma separated list of hosts, the first is setup as a controller, and the others are setup as compute nodes.if only a single host is supplied then it is setup as an all in one installation. An answerfile will also be generated and should be used if Packstack needs to be run a second time

Shorthand for --install-hosts=<local ipaddr> --novanetwork-pubif=<dev> --novacompute-privif=lo --novanetwork-privif=lo --os-swift-install=y --nagios- install=y , this option can be used to install an all in one OpenStack on this host

The timeout for puppet Exec calls

Print details on options available in answer file(rst format)

Enable debug in logging

Don't execute, just generate manifests

Path to a public key to install on servers. If a usable key has not been installed on the remote servers, the user is prompted for a password and this key is installed so the password will not be required again.

Default password to be used everywhere (overridden by passwords set for individual services or users).

The amount of service workers/threads to use for each service. Useful to tweak when you have memory constraints. Defaults to the amount of cores on the system.

Specify 'y' to install MariaDB. ['y', 'n']

Specify 'y' to install OpenStack Image Service (glance). ['y', 'n']

Specify 'y' to install OpenStack Block Storage (cinder). ['y', 'n']

Specify 'y' to install OpenStack Shared File System (manila). ['y', 'n']

Specify 'y' to install OpenStack Compute (nova). ['y', 'n']

Specify 'y' to install OpenStack Networking (neutron); otherwise, Compute Networking (nova) will be used. ['y', 'n']

Specify 'y' to install OpenStack Dashboard (horizon). ['y', 'n']

Specify 'y' to install OpenStack Object Storage (swift). ['y', 'n']

Specify 'y' to install OpenStack Metering (ceilometer). ['y', 'n']

Specify 'y' to install OpenStack Telemetry Alarming (Aodh). Note Aodh requires Ceilometer to be installed as well. ['y', 'n']

Specify 'y' to install OpenStack Metering as a Service (gnocchi). ['y', 'n']

Specify 'y' to install OpenStack Orchestration (heat). ['y', 'n']

Specify 'y' to install OpenStack Data Processing (sahara). ['y', 'n']

Specify 'y' to install OpenStack Database (trove) ['y', 'n']

Specify 'y' to install OpenStack Bare Metal Provisioning (ironic). ['y', 'n']

Specify 'y' to install the OpenStack Client packages (command-line tools). An admin "rc" file will also be installed. ['y', 'n']

Comma-separated list of NTP servers. Leave plain if Packstack should not install ntpd on instances.

Specify 'y' to install Nagios to monitor OpenStack hosts. Nagios provides additional tools for monitoring the OpenStack environment. ['y', 'n']

Comma-separated list of servers to be excluded from the installation. This is helpful if you are running Packstack a second time with the same answer file and do not want Packstack to overwrite these server's configurations. Leave empty if you do not need to exclude any servers.

Specify 'y' if you want to run OpenStack services in debug mode; otherwise, specify 'n'. ['y', 'n']

IP address of the server on which to install OpenStack services specific to the controller role (for example, API servers or dashboard).

List of IP addresses of the servers on which to install the Compute service.

List of IP addresses of the server on which to install the network service such as Compute networking (nova network) or OpenStack Networking (neutron).

Specify 'y' if you want to use VMware vCenter as hypervisor and storage; otherwise, specify 'n'. ['y', 'n']

Specify 'y' if you want to use unsupported parameters. This should be used only if you know what you are doing. Issues caused by using unsupported options will not be fixed before the next major release. ['y', 'n']

IP address of the VMware vCenter server.

User name for VMware vCenter server authentication.

Password for VMware vCenter server authentication.

Name of the VMware vCenter cluster.

Specify 'y' to enable the EPEL repository (Extra Packages for Enterprise Linux). ['y', 'n']

Comma-separated list of URLs for any additional yum repositories, to use for installation.

To subscribe each server with Red Hat Subscription Manager, include this with CONFIG_RH_PW.

To subscribe each server to receive updates from a Satellite server, provide the URL of the Satellite server. You must also provide a user name (CONFIG_SATELLITE_USERNAME) and password (CONFIG_SATELLITE_PASSWORD) or an access key (CONFIG_SATELLITE_AKEY) for authentication.

Specify a Satellite 6 Server to register to. If not specified, Packstack will register the system to the Red Hat server. When this option is specified, you also need to set the Satellite 6 organization (CONFIG_RH_SAT6_ORG) and an activation key (CONFIG_RH_SAT6_KEY).

User name to authenticate with the RHN Satellite server; if you intend to use an access key for Satellite authentication, leave this blank.

Password to authenticate with the RHN Satellite server; if you intend to use an access key for Satellite authentication, leave this blank.

Access key for the Satellite server; if you intend to use a user name and password for Satellite authentication, leave this blank.

Certificate path or URL of the certificate authority to verify that the connection with the Satellite server is secure. If you are not using Satellite in your deployment, leave this blank.

Profile name that should be used as an identifier for the system in RHN Satellite (if required).

Comma-separated list of flags passed to the rhnreg_ks command. Valid flags are: novirtinfo, norhnsd, nopackages ['novirtinfo', 'norhnsd', 'nopackages']

HTTP proxy to use when connecting to the RHN Satellite server (if required).

Specify a Satellite 6 Server organization to use when registering the system.

Specify a Satellite 6 Server activation key to use when registering the system.

User name to authenticate with the Satellite-server HTTP proxy.

User password to authenticate with the Satellite- server HTTP proxy.

Service to be used as the AMQP broker. Allowed values are: rabbitmq ['rabbitmq']

IP address of the server on which to install the AMQP service.

Specify 'y' to enable SSL for the AMQP service. ['y', 'n']

Specify 'y' to enable authentication for the AMQP service. ['y', 'n']

Password for the NSS certificate database of the AMQP service.

Port on which the AMQP service listens for SSL connections.

File name of the CAcertificate that the AMQP service will use for verification.

File name of the certificate that the AMQP service will use for verification.

File name of the private key that the AMQP service will use for verification.

Specify 'y' to automatically generate a self-signed SSL certificate and key. ['y', 'n']

User for AMQP authentication.

Password for AMQP authentication.

Password to use for the Identity service (keystone) to access the database.

Default region name to use when creating tenants in the Identity service.

Email address for the Identity service 'admin' user. Defaults to

User name for the Identity service 'admin' user. Defaults to 'admin'.

Password to use for the Identity service 'admin' user.

Password to use for the Identity service 'demo' user.

Name of service to use to run the Identity service (keystone or httpd). ['keystone', 'httpd']

Type of Identity service backend (sql or ldap). ['sql', 'ldap']

Password to use for the Image service (glance) to access the database.

Password to use for the Image service to authenticate with the Identity service.

Storage backend for the Image service (controls how the Image service stores disk images). Valid options are: file or swift (Object Storage). The Object Storage service must be enabled to use it as a working backend; otherwise, Packstack falls back to 'file'. ['file', 'swift']

Password to use for the Block Storage service (cinder) to access the database.

Password to use for the Block Storage service to authenticate with the Identity service.

Storage backend to use for the Block Storage service; valid options are: lvm, gluster, nfs, vmdk, netapp. ['lvm', 'gluster', 'nfs', 'vmdk', 'netapp']

Specify 'y' to create the Block Storage volumes group. That is, Packstack creates a raw disk image in /var/lib/cinder, and mounts it using a loopback device. This should only be used for testing on a proof-of-concept installation of the Block Storage service (a file-backed volume group is not suitable for production usage). ['y', 'n']

Size of Block Storage volumes group. Actual volume size will be extended with 3% more space for VG metadata. Remember that the size of the volume group will restrict the amount of disk space that you can expose to Compute instances, and that the specified amount must be available on the device used for /var/lib/cinder.

A single or comma-separated list of Red Hat Storage (gluster) volume shares to mount. Example: 'ip-address :/vol-name', 'domain:/vol-name'

A single or comma-separated list of NFS exports to mount. Example: 'ip-address:/export-name'

Password to use for the Compute service (nova) to access the database.

Password to use for the Compute service to authenticate with the Identity service.

Overcommitment ratio for virtual to physical CPUs. Specify 1.0 to disable CPU overcommitment.

Overcommitment ratio for virtual to physical RAM. Specify 1.0 to disable RAM overcommitment.

Protocol used for instance migration. Valid options are: tcp and ssh. Note that by default, the Compute user is created with the /sbin/nologin shell so that the SSH protocol will not work. To make the SSH protocol work, you must configure the Compute user on compute hosts manually. ['tcp', 'ssh']

Manager that runs the Compute service.

Private interface for flat DHCP on the Compute servers.

Compute Network Manager. ['^nova\.network\.manager\.\w+Manager$']

Public interface on the Compute network server.

Private interface for flat DHCP on the Compute network server.

IP Range for flat DHCP. ['^[\:\.\da- fA-f]+(\/\d+){0,1}$']

IP Range for floating IP addresses. ['^[\:\.\da- fA-f]+(\/\d+){0,1}$']

Specify 'y' to automatically assign a floating IP to new instances. ['y', 'n']

First VLAN for private networks (Compute networking).

Number of networks to support (Compute networking).

Number of addresses in each private subnet (Compute networking).

Password to use for OpenStack Networking (neutron) to authenticate with the Identity service.

The password to use for OpenStack Networking to access the database.

The name of the Open vSwitch bridge (or empty for linuxbridge) for the OpenStack Networking L3 agent to use for external traffic. Specify 'provider' if you intend to use a provider network to handle external traffic.

Password for the OpenStack Networking metadata agent.

Specify 'y' to install OpenStack Networking's Load- Balancing-as-a-Service (LBaaS). ['y', 'n']

Specify 'y' to install OpenStack Networking's L3 Metering agent ['y', 'n']

Specify 'y' to configure OpenStack Networking's Firewall-as-a-Service (FWaaS). ['y', 'n']

Comma-separated list of interface mappings for the OpenStack Networking linuxbridge plugin. Each tuple in the list must be in the format <physical_network>:<net_interface>. Example: physnet1:eth1,physnet2:eth2,physnet3:eth3.

Comma-separated list of bridge mappings for the OpenStack Networking Open vSwitch plugin. Each tuple in the list must be in the format <physical_network>:<ovs_bridge>. Example: physnet1:br- eth1,physnet2:br-eth2,physnet3:br-eth3

Comma-separated list of colon-separated Open vSwitch <bridge>:<interface> pairs. The interface will be added to the associated bridge.

Comma-separated list of Open vSwitch bridges that must be created and connected to interfaces in compute nodes when flat or vlan type drivers are enabled. These bridges must exist in CONFIG_NEUTRON_OVS_BRIDGE_MAPPINGS and CONFIG_NEUTRON_OVS_BRIDGE_IFACES. Example: --os- neutron-ovs-bridges-compute=br-vlan --os-neutron-ovs- bridge-mappings="extnet:br-ex,physnet1:br-vlan" --os- neutron-ovs-bridge-interfaces="br-ex:eth1,br- vlan:eth2"

Interface for the Open vSwitch tunnel. Packstack overrides the IP address used for tunnels on this hypervisor to the IP found on the specified interface (for example, eth1).

Comma-separated list of subnets (for example, 192.168.10.0/24,192.168.11.0/24) used for sending tunneling packets. This is used to configure IP filtering to accept tunneling packets from these subnets instead of specific IP addresses of peer nodes. This is useful when you add existing nodes to EXCLUDE_SERVERS because, in this case, packstack cannot modify the IP filtering of the existing nodes.

VXLAN UDP port.

Password to use for the OpenStack File Share service (manila) to access the database.

Password to use for the OpenStack File Share service (manila) to authenticate with the Identity service.

Backend for the OpenStack File Share service (manila); valid options are: generic, netapp, glusternative, or glusternfs. ['generic', 'netapp', 'glusternative', 'glusternfs']

Denotes whether the driver should handle the responsibility of managing share servers. This must be set to false if the driver is to operate without managing share servers. Defaults to 'false' ['true', 'false']

The transport protocol used when communicating with the storage system or proxy server. Valid values are 'http' and 'https'. Defaults to 'https'. ['https', 'http']

Administrative user account name used to access the NetApp storage system. Defaults to ''.

Password for the NetApp administrative user account specified in the CONFIG_MANILA_NETAPP_LOGIN parameter. Defaults to ''.

Hostname (or IP address) for the NetApp storage system or proxy server. Defaults to ''.

The storage family type used on the storage system; valid values are ontap_cluster for clustered Data ONTAP. Defaults to 'ontap_cluster'. ['ontap_cluster']

The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS. Defaults to '443'.

Pattern for searching available aggregates for NetApp provisioning. Defaults to '(.*)'.

Name of aggregate on which to create the NetApp root volume. This option only applies when the option CONFIG_MANILA_NETAPP_DRV_HANDLES_SHARE_SERVERS is set to True.

NetApp root volume name. Defaults to 'root'.

This option specifies the storage virtual machine (previously called a Vserver) name on the storage cluster on which provisioning of shared file systems should occur. This option only applies when the option driver_handles_share_servers is set to False. Defaults to ''.

Denotes whether the driver should handle the responsibility of managing share servers. This must be set to false if the driver is to operate without managing share servers. Defaults to 'true'. ['true', 'false']

Volume name template for Manila service. Defaults to 'manila-share-%s'.

Share mount path for Manila service. Defaults to '/shares'.

Location of disk image for Manila service instance. Defaults to ''.

User in Manila service instance.

Password to service instance user.

Type of networking that the backend will use. A more detailed description of each option is available in the Manila docs. Defaults to 'neutron'. ['neutron', 'nova-network', 'standalone']

Gateway IPv4 address that should be used. Required. Defaults to ''.

Network mask that will be used. Can be either decimal like '24' or binary like '255.255.255.0'. Required. Defaults to ''.

Set it if network has segmentation (VLAN, VXLAN, etc). It will be assigned to share-network and share drivers will be able to use this for network interfaces within provisioned share servers. Optional. Example: 1001. Defaults to ''.

Can be IP address, range of IP addresses or list of addresses or ranges. Contains addresses from IP network that are allowed to be used. If empty, then will be assumed that all host addresses from network can be used. Optional. Examples: 10.0.0.10 or 10.0.0.10-10.0.0.20 or 10.0.0.10-10.0.0.20,10.0.0.30-10.0.0.40,10.0.0.50. Defaults to ''.

IP version of network. Optional. Defaults to '4'. ['4', '6']

List of GlusterFS servers that can be used to create shares. Each GlusterFS server should be of the form [remoteuser@]<volserver>, and they are assumed to belong to distinct Gluster clusters.

Path of Manila host's private SSH key file.

Regular expression template used to filter GlusterFS volumes for share creation. The regex template can optionally (ie. with support of the GlusterFS backend) contain the #{size} parameter which matches an integer (sequence of digits) in which case the value shall be intepreted as size of the volume in GB. Examples: "manila-share-volume-d+$", "manila-share- volume-#{size}G-d+$"; with matching volume names, respectively: "manila-share-volume-12", "manila-share- volume-3G-13". In latter example, the number that matches "#{size}", that is, 3, is an indication that the size of volume is 3G.

Specifies the GlusterFS volume to be mounted on the Manila host. For e.g: [remoteuser@]<volserver>:/<volid>

Base directory containing mount points for Gluster volumes.

Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha).

Path of Manila host's private SSH key file.

Remote Ganesha server node's IP address.

Specify 'y' to set up Horizon communication over https. ['y', 'n']

PEM-encoded certificate to be used for SSL connections on the https server (the certificate should not require a passphrase). To generate a certificate, leave blank.

SSL keyfile corresponding to the certificate if one was specified.

PEM-encoded CA certificates from which the certificate chain of the server certificate can be assembled.

Password to use for the Object Storage service to authenticate with the Identity service.

Comma-separated list of devices to use as storage device for Object Storage. Each entry must take the format /path/to/dev (for example, specifying /dev/vdb installs /dev/vdb as the Object Storage storage device; Packstack does not create the filesystem, you must do this first). If left empty, Packstack creates a loopback device for test setup.

Number of Object Storage storage zones; this number MUST be no larger than the number of configured storage devices.

Number of Object Storage storage replicas; this number MUST be no larger than the number of configured storage zones.

File system type for storage nodes. ['xfs', 'ext4']

Size of the Object Storage loopback file storage device.

Password used by Orchestration service user to authenticate against the database.

Password to use for the Orchestration service to authenticate with the Identity service.

Specify 'y' to install the Orchestration CloudWatch API. ['y', 'n']

Specify 'y' to install the Orchestration CloudFormation API. ['y', 'n']

Name of the Identity domain for Orchestration.

Name of the Identity domain administrative user for Orchestration.

Password for the Identity domain administrative user for Orchestration.

Specify 'y' to provision for demo usage and testing. ['y', 'n']

Specify 'y' to configure the OpenStack Integration Test Suite (tempest) for testing. The test suite requires OpenStack Networking to be installed. ['y', 'n']

CIDR network address for the floating IP subnet.

The name to be assigned to the demo image in Glance (default "cirros").

A URL or local file location for an image to download and provision in Glance (defaults to a URL for a recent "cirros" image).

Format for the demo image (default "qcow2").

User to use when connecting to instances booted from the demo image.

Name of the Integration Test Suite provisioning user. If you do not provide a user name, Tempest is configured in a standalone mode.

Password to use for the Integration Test Suite provisioning user.

CIDR network address for the floating IP subnet.

URI of the Integration Test Suite git repository.

Revision (branch) of the Integration Test Suite git repository.

Specify 'y' to run Tempest smoke test as last step of installation.

Test suites to run, example: "smoke dashboard TelemetryAlarming". Optional, defaults to "smoke".

Specify 'y' to configure the Open vSwitch external bridge for an all-in-one deployment (the L3 external bridge acts as the gateway for virtual machines). ['y', 'n']

Password to use for Gnocchi to access the database.

Password to use for Gnocchi to authenticate with the Identity service.

Password to use for Telemetry to authenticate with the Identity service.

Ceilometer service name. ['httpd', 'ceilometer']

IP address of the server on which to install MongoDB.

IP address of the server on which to install the Redis master server.

Port on which the Redis server(s) listens.

Specify 'y' to have Redis try to use HA. ['y', 'n']

Hosts on which to install Redis slaves.

Hosts on which to install Redis sentinel servers.

Host to configure as the Redis coordination sentinel.

Port on which Redis sentinel servers listen.

Quorum value for Redis sentinel servers.

Name of the master server watched by the Redis sentinel. ['[a-z]+']

Password to use for Telemetry Alarming to authenticate with the Identity service.

Password to use for OpenStack Database-as-a-Service (trove) to access the database.

Password to use for OpenStack Database-as-a-Service to authenticate with the Identity service.

Password to use when OpenStack Database-as-a-Service connects to the Compute service.

Password to use for OpenStack Data Processing (sahara) to access the database.

Password to use for OpenStack Data Processing to authenticate with the Identity service.

Password of the nagiosadmin user on the Nagios server.