Chapter 2. Packstack command-line client

The packstack client is the command-line interface (CLI) for installing single node, proof-of-concept deployments. This chapter documents packstack version 2015.1.dev1537.gba5183c.
For help on a specific packstack command, enter:
$ packstack help COMMAND

2.1. packstack usage

Usage: packstack [options] [--help]

2.2. packstack optional arguments

--version
show program's version number and exit
-h, --help
show this help message and exit
--gen-answer-file=GEN_ANSWER_FILE
Generate a template of an answer file.
--answer-file=ANSWER_FILE
Runs the configuration in non-interactive mode, extracting all information from theconfiguration file. using this option excludes all other options
--install-hosts=INSTALL_HOSTS
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
--allinone
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
-t TIMEOUT, --timeout=TIMEOUT
The timeout for puppet Exec calls
-o, --options
Print details on options available in answer file(rst format)
-d, --debug
Enable debug in logging
-y, --dry-run
Don't execute, just generate manifests

2.3. packstack Global Options

--ssh-public-key=SSH_PUBLIC_KEY
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=DEFAULT_PASSWORD
Default password to be used everywhere (overridden by passwords set for individual services or users).
--mariadb-install=MARIADB_INSTALL
Specify 'y' to install MariaDB. ['y', 'n']
--os-glance-install=OS_GLANCE_INSTALL
Specify 'y' to install OpenStack Image Service (glance). ['y', 'n']
--os-cinder-install=OS_CINDER_INSTALL
Specify 'y' to install OpenStack Block Storage (cinder). ['y', 'n']
--os-manila-install=OS_MANILA_INSTALL
Specify 'y' to install OpenStack Shared File System (manila). ['y', 'n']
--os-nova-install=OS_NOVA_INSTALL
Specify 'y' to install OpenStack Compute (nova). ['y', 'n']
--os-neutron-install=OS_NEUTRON_INSTALL
Specify 'y' to install OpenStack Networking (neutron); otherwise, Compute Networking (nova) will be used. ['y', 'n']
--os-horizon-install=OS_HORIZON_INSTALL
Specify 'y' to install OpenStack Dashboard (horizon). ['y', 'n']
--os-swift-install=OS_SWIFT_INSTALL
Specify 'y' to install OpenStack Object Storage (swift). ['y', 'n']
--os-ceilometer-install=OS_CEILOMETER_INSTALL
Specify 'y' to install OpenStack Metering (ceilometer). ['y', 'n']
--os-heat-install=OS_HEAT_INSTALL
Specify 'y' to install OpenStack Orchestration (heat). ['y', 'n']
--os-sahara-install=OS_SAHARA_INSTALL
Specify 'y' to install OpenStack Data Processing (sahara). ['y', 'n']
--os-trove-install=OS_TROVE_INSTALL
Specify 'y' to install OpenStack Database (trove) ['y', 'n']
--os-ironic-install=OS_IRONIC_INSTALL
Specify 'y' to install OpenStack Bare Metal Provisioning (ironic). ['y', 'n']
--os-client-install=OS_CLIENT_INSTALL
Specify 'y' to install the OpenStack Client packages (command-line tools). An admin "rc" file will also be installed. ['y', 'n']
--ntp-servers=NTP_SERVERS
Comma-separated list of NTP servers. Leave plain if Packstack should not install ntpd on instances.
--nagios-install=NAGIOS_INSTALL
Specify 'y' to install Nagios to monitor OpenStack hosts. Nagios provides additional tools for monitoring the OpenStack environment. ['y', 'n']
--exclude-servers=EXCLUDE_SERVERS
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.
--os-debug-mode=OS_DEBUG_MODE
Specify 'y' if you want to run OpenStack services in debug mode; otherwise, specify 'n'. ['y', 'n']
--os-controller-host=OS_CONTROLLER_HOST
IP address of the server on which to install OpenStack services specific to the controller role (for example, API servers or dashboard).
--os-compute-hosts=OS_COMPUTE_HOSTS
List of IP addresses of the servers on which to install the Compute service.
--os-network-hosts=OS_NETWORK_HOSTS
List of IP addresses of the server on which to install the network service such as Compute networking (nova network) or OpenStack Networking (neutron).
--os-vmware=OS_VMWARE
Specify 'y' if you want to use VMware vCenter as hypervisor and storage; otherwise, specify 'n'. ['y', 'n']
--unsupported=UNSUPPORTED
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']

2.4. packstack vCenter Config Parameters

--vcenter-host=VCENTER_HOST
IP address of the VMware vCenter server.
--vcenter-username=VCENTER_USERNAME
User name for VMware vCenter server authentication.
--vcenter-password=VCENTER_PASSWORD
Password for VMware vCenter server authentication.
--vcenter-cluster=VCENTER_CLUSTER
Name of the VMware vCenter cluster.

2.5. packstack Server Prepare Configs

--use-epel=USE_EPEL
Specify 'y' to enable the EPEL repository (Extra Packages for Enterprise Linux). ['y', 'n']
--additional-repo=ADDITIONAL_REPO
Comma-separated list of URLs for any additional yum repositories, to use for installation.

2.6. packstack RHEL config

--rh-username=RH_USERNAME
To subscribe each server with Red Hat Subscription Manager, include this with CONFIG_RH_PW.
--rhn-satellite-server=RHN_SATELLITE_SERVER
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.

2.7. packstack RHN Satellite config

--rhn-satellite-username=RHN_SATELLITE_USERNAME
User name to authenticate with the RHN Satellite server; if you intend to use an access key for Satellite authentication, leave this blank.
--rhn-satellite-password=RHN_SATELLITE_PASSWORD
Password to authenticate with the RHN Satellite server; if you intend to use an access key for Satellite authentication, leave this blank.
--rhn-satellite-activation-key=RHN_SATELLITE_ACTIVATION_KEY
Access key for the Satellite server; if you intend to use a user name and password for Satellite authentication, leave this blank.
--rhn-satellite-cacert=RHN_SATELLITE_CACERT
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.
--rhn-satellite-profile=RHN_SATELLITE_PROFILE
Profile name that should be used as an identifier for the system in RHN Satellite (if required).
--rhn-satellite-flags=RHN_SATELLITE_FLAGS
Comma-separated list of flags passed to the rhnreg_ks command. Valid flags are: novirtinfo, norhnsd, nopackages ['novirtinfo', 'norhnsd', 'nopackages']
--rhn-satellite-proxy-host=RHN_SATELLITE_PROXY_HOST
HTTP proxy to use when connecting to the RHN Satellite server (if required).

2.8. packstack RHN Satellite proxy config

--rhn-satellite-proxy-username=RHN_SATELLITE_PROXY_USERNAME
User name to authenticate with the Satellite-server HTTP proxy.
--rhn-satellite-proxy-password=RHN_SATELLITE_PROXY_PASSWORD
User password to authenticate with the Satellite- server HTTP proxy.

2.9. packstack AMQP Config parameters

--amqp-backend=AMQP_BACKEND
Service to be used as the AMQP broker. Allowed values are: qpid, rabbitmq ['qpid', 'rabbitmq']
--amqp-host=AMQP_HOST
IP address of the server on which to install the AMQP service.
--amqp-enable-ssl=AMQP_ENABLE_SSL
Specify 'y' to enable SSL for the AMQP service. ['y', 'n']
--amqp-enable-auth=AMQP_ENABLE_AUTH
Specify 'y' to enable authentication for the AMQP service. ['y', 'n']

2.10. packstack AMQP Config SSL parameters

--amqp-nss-certdb-pw=AMQP_NSS_CERTDB_PW
Password for the NSS certificate database of the AMQP service.
--amqp-ssl-port=AMQP_SSL_PORT
Port on which the AMQP service listens for SSL connections.
--amqp-ssl-cacert-file=AMQP_SSL_CACERT_FILE
File name of the CAcertificate that the AMQP service will use for verification.
--amqp-ssl-cert-file=AMQP_SSL_CERT_FILE
File name of the certificate that the AMQP service will use for verification.
--amqp-ssl-key-file=AMQP_SSL_KEY_FILE
File name of the private key that the AMQP service will use for verification.
--amqp-ssl-self-signed=AMQP_SSL_SELF_SIGNED
Specify 'y' to automatically generate a self-signed SSL certificate and key. ['y', 'n']

2.11. packstack AMQP Config Athentication parameters

--amqp-auth-user=AMQP_AUTH_USER
User for AMQP authentication.
--amqp-auth-password=AMQP_AUTH_PASSWORD
Password for AMQP authentication.

2.12. packstack Keystone Config parameters

--keystone-db-passwd=KEYSTONE_DB_PASSWD
Password to use for the Identity service (keystone) to access the database.
--keystone-region=KEYSTONE_REGION
Default region name to use when creating tenants in the Identity service.
--keystone-admin-email=KEYSTONE_ADMIN_EMAIL
Email address for the Identity service 'admin' user. Defaults to
--keystone-admin-username=KEYSTONE_ADMIN_USERNAME
User name for the Identity service 'admin' user. Defaults to 'admin'.
--keystone-admin-passwd=KEYSTONE_ADMIN_PASSWD
Password to use for the Identity service 'admin' user.
--keystone-demo-passwd=KEYSTONE_DEMO_PASSWD
Password to use for the Identity service 'demo' user.
--keystone-service-name=KEYSTONE_SERVICE_NAME
Name of service to use to run the Identity service (keystone or httpd). ['keystone', 'httpd']
--keystone-identity-backend=KEYSTONE_IDENTITY_BACKEND
Type of Identity service backend (sql or ldap). ['sql', 'ldap']

2.13. packstack Glance Config parameters

--glance-db-passwd=GLANCE_DB_PASSWD
Password to use for the Image service (glance) to access the database.
--glance-ks-passwd=GLANCE_KS_PASSWD
Password to use for the Image service to authenticate with the Identity service.
--glance-backend=GLANCE_BACKEND
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']

2.14. packstack Cinder Config parameters

--cinder-db-passwd=CINDER_DB_PASSWD
Password to use for the Block Storage service (cinder) to access the database.
--cinder-ks-passwd=CINDER_KS_PASSWD
Password to use for the Block Storage service to authenticate with the Identity service.
--cinder-backend=CINDER_BACKEND
Storage backend to use for the Block Storage service; valid options are: lvm, gluster, nfs, vmdk, netapp. ['lvm', 'gluster', 'nfs', 'vmdk', 'netapp']

2.15. packstack Cinder volume create Config parameters

--cinder-volumes-create=CINDER_VOLUMES_CREATE
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']

2.16. packstack Cinder volume size Config parameters

--cinder-volumes-size=CINDER_VOLUMES_SIZE
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.

2.17. packstack Cinder gluster Config parameters

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

2.18. packstack Cinder NFS Config parameters

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

2.19. packstack Nova Options

--nova-db-passwd=NOVA_DB_PASSWD
Password to use for the Compute service (nova) to access the database.
--nova-ks-passwd=NOVA_KS_PASSWD
Password to use for the Compute service to authenticate with the Identity service.
--novasched-cpu-allocation-ratio=NOVASCHED_CPU_ALLOCATION_RATIO
Overcommitment ratio for virtual to physical CPUs. Specify 1.0 to disable CPU overcommitment.
--novasched-ram-allocation-ratio=NOVASCHED_RAM_ALLOCATION_RATIO
Overcommitment ratio for virtual to physical RAM. Specify 1.0 to disable RAM overcommitment.
--novacompute-migrate-protocol=NOVACOMPUTE_MIGRATE_PROTOCOL
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']
--nova-compute-manager=NOVA_COMPUTE_MANAGER
Manager that runs the Compute service.

2.20. packstack Nova Network Options

--novacompute-privif=NOVACOMPUTE_PRIVIF
Private interface for flat DHCP on the Compute servers.
--novanetwork-manager=NOVANETWORK_MANAGER
Compute Network Manager. ['^nova\.network\.manager\.\w+Manager$']
--novanetwork-pubif=NOVANETWORK_PUBIF
Public interface on the Compute network server.
--novanetwork-privif=NOVANETWORK_PRIVIF
Private interface for flat DHCP on the Compute network server.
--novanetwork-fixed-range=NOVANETWORK_FIXED_RANGE
IP Range for flat DHCP. ['^[\:\.\da- fA-f]+(\/\d+){0,1}$']
--novanetwork-floating-range=NOVANETWORK_FLOATING_RANGE
IP Range for floating IP addresses. ['^[\:\.\da- fA-f]+(\/\d+){0,1}$']
--novanetwork-auto-assign-floating-ip=NOVANETWORK_AUTO_ASSIGN_FLOATING_IP
Specify 'y' to automatically assign a floating IP to new instances. ['y', 'n']

2.21. packstack Nova Network VLAN Options

--novanetwork-vlan-start=NOVANETWORK_VLAN_START
First VLAN for private networks (Compute networking).
--novanetwork-num-networks=NOVANETWORK_NUM_NETWORKS
Number of networks to support (Compute networking).
--novanetwork-network-size=NOVANETWORK_NETWORK_SIZE
Number of addresses in each private subnet (Compute networking).

2.22. packstack Neutron config

--os-neutron-ks-password=OS_NEUTRON_KS_PASSWORD
Password to use for OpenStack Networking (neutron) to authenticate with the Identity service.
--os-neutron-db-password=OS_NEUTRON_DB_PASSWORD
The password to use for OpenStack Networking to access the database.
--os-neutron-l3-ext-bridge=OS_NEUTRON_L3_EXT_BRIDGE
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.
--os-neutron-metadata-pw=OS_NEUTRON_METADATA_PW
Password for the OpenStack Networking metadata agent.
--os-neutron-lbaas-install=OS_NEUTRON_LBAAS_INSTALL
Specify 'y' to install OpenStack Networking's Load- Balancing-as-a-Service (LBaaS). ['y', 'n']
--os-neutron-metering-agent-install=OS_NEUTRON_METERING_AGENT_INSTALL
Specify 'y' to install OpenStack Networking's L3 Metering agent ['y', 'n']
--neutron-fwaas=NEUTRON_FWAAS
Specify 'y' to configure OpenStack Networking's Firewall-as-a-Service (FWaaS). ['y', 'n']

2.23. packstack Neutron LB agent config

--os-neutron-lb-interface-mappings=OS_NEUTRON_LB_INTERFACE_MAPPINGS
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.

2.24. packstack Neutron OVS agent config

--os-neutron-ovs-bridge-mappings=OS_NEUTRON_OVS_BRIDGE_MAPPINGS
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
--os-neutron-ovs-bridge-interfaces=OS_NEUTRON_OVS_BRIDGE_INTERFACES
Comma-separated list of colon-separated Open vSwitch <bridge>:<interface> pairs. The interface will be added to the associated bridge.

2.25. packstack Neutron OVS agent config for tunnels

--os-neutron-ovs-tunnel-if=OS_NEUTRON_OVS_TUNNEL_IF
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).

2.26. packstack Neutron OVS agent config for VXLAN

--os-neutron-ovs-vxlan-udp-port=OS_NEUTRON_OVS_VXLAN_UDP_PORT
VXLAN UDP port.

2.27. packstack NOVACLIENT Config parameters

2.28. packstack OpenStack Horizon Config parameters

--os-horizon-ssl=OS_HORIZON_SSL
Specify 'y' to set up Horizon communication over https. ['y', 'n']

2.29. packstack SSL Config parameters

--os-ssl-cert=OS_SSL_CERT
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.
--os-ssl-key=OS_SSL_KEY
SSL keyfile corresponding to the certificate if one was specified.
--os-ssl-cachain=OS_SSL_CACHAIN
PEM-encoded CA certificates from which the certificate chain of the server certificate can be assembled.

2.30. packstack OpenStack Swift Config parameters

--os-swift-ks-passwd=OS_SWIFT_KS_PASSWD
Password to use for the Object Storage service to authenticate with the Identity service.
--os-swift-storages=OS_SWIFT_STORAGES
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.
--os-swift-storage-zones=OS_SWIFT_STORAGE_ZONES
Number of Object Storage storage zones; this number MUST be no larger than the number of configured storage devices.
--os-swift-storage-replicas=OS_SWIFT_STORAGE_REPLICAS
Number of Object Storage storage replicas; this number MUST be no larger than the number of configured storage zones.
--os-swift-storage-fstype=OS_SWIFT_STORAGE_FSTYPE
File system type for storage nodes. ['xfs', 'ext4']
--os-swift-storage-size=OS_SWIFT_STORAGE_SIZE
Size of the Object Storage loopback file storage device.

2.31. packstack Heat Config parameters

--os-heat-mysql-password=OS_HEAT_MYSQL_PASSWORD
Password used by Orchestration service user to authenticate against the database.
--os-heat-ks-passwd=OS_HEAT_KS_PASSWD
Password to use for the Orchestration service to authenticate with the Identity service.
--os-heat-cloudwatch-install=OS_HEAT_CLOUDWATCH_INSTALL
Specify 'y' to install the Orchestration CloudWatch API. ['y', 'n']
--os-heat-cfn-install=OS_HEAT_CFN_INSTALL
Specify 'y' to install the Orchestration CloudFormation API. ['y', 'n']
--os-heat-domain=OS_HEAT_DOMAIN
Name of the Identity domain for Orchestration.
--os-heat-domain-admin=OS_HEAT_DOMAIN_ADMIN
Name of the Identity domain administrative user for Orchestration.
--os-heat-domain-password=OS_HEAT_DOMAIN_PASSWORD
Password for the Identity domain administrative user for Orchestration.

2.32. packstack Provisioning demo config

--provision-demo=PROVISION_DEMO
Specify 'y' to provision for demo usage and testing. ['y', 'n']
--provision-tempest=PROVISION_TEMPEST
Specify 'y' to configure the OpenStack Integration Test Suite (tempest) for testing. The test suite requires OpenStack Networking to be installed. ['y', 'n']

2.33. packstack Provisioning demo config

--provision-demo-floatrange=PROVISION_DEMO_FLOATRANGE
CIDR network address for the floating IP subnet.
--provision-image-name=PROVISION_IMAGE_NAME
The name to be assigned to the demo image in Glance (default "cirros").
--provision-image-url=PROVISION_IMAGE_URL
A URL or local file location for an image to download and provision in Glance (defaults to a URL for a recent "cirros" image).
--provision-image-format=PROVISION_IMAGE_FORMAT
Format for the demo image (default "qcow2").
--provision-image-ssh-user=PROVISION_IMAGE_SSH_USER
User to use when connecting to instances booted from the demo image.

2.34. packstack Ceilometer Config parameters

--ceilometer-ks-passwd=CEILOMETER_KS_PASSWD
Password to use for Telemetry to authenticate with the Identity service.

2.35. packstack MONGODB Config parameters

--mongodb-host=MONGODB_HOST
IP address of the server on which to install MongoDB.

2.36. packstack Nagios Config parameters

--nagios-passwd=NAGIOS_PASSWD
Password of the nagiosadmin user on the Nagios server.

2.37. packstack POSTSCRIPT Config parameters

2.38. packstack Puppet Config parameters