Revision history [back]

click to hide/show revision 1
initial version

Posting the output of /usr/bin/packstack --help to serve as online documentation until someone provides a link to the online documentation.

$ /usr/bin/packstack --help
Usage: packstack [options] [--help]

Options:
  -h, --help            show this help message and exit
  --gen-answer-file=GEN_ANSWER_FILE
                        Generate a template of an answer file, using this
                        option excludes all other options
  --answer-file=ANSWER_FILE
                        Runs the configuration in non-interactive mode,
                        extracting all information from the
                        configuration 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

  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 will be prompted for a password and
                        this key will be installed so the password will not be
                        required again
    --os-mysql-install=OS_MYSQL_INSTALL
                        Set to 'y' if you would like Packstack to install
                        MySQL
    --os-glance-install=OS_GLANCE_INSTALL
                        Set to 'y' if you would like Packstack to install
                        OpenStack Image Service (Glance)
    --os-cinder-install=OS_CINDER_INSTALL
                        Set to 'y' if you would like Packstack to install
                        OpenStack Block Storage (Cinder)
    --os-nova-install=OS_NOVA_INSTALL
                        Set to 'y' if you would like Packstack to install
                        OpenStack Compute (Nova)
    --os-neutron-install=OS_NEUTRON_INSTALL
                        Set to 'y' if you would like Packstack to install
                        OpenStack Networking (Neutron)
    --os-horizon-install=OS_HORIZON_INSTALL
                        Set to 'y' if you would like Packstack to install
                        OpenStack Dashboard (Horizon)
    --os-swift-install=OS_SWIFT_INSTALL
                        Set to 'y' if you would like Packstack to install
                        OpenStack Object Storage (Swift)
    --os-ceilometer-install=OS_CEILOMETER_INSTALL
                        Set to 'y' if you would like Packstack to install
                        OpenStack Metering (Ceilometer)
    --os-heat-install=OS_HEAT_INSTALL
                        Set to 'y' if you would like Packstack to install
                        OpenStack Orchestration (Heat)
    --os-client-install=OS_CLIENT_INSTALL
                        Set to 'y' if you would like Packstack to install the
                        OpenStack Client packages. An admin "rc" file will
                        also be installed
    --ntp-servers=NTP_SERVERS
                        Comma separated list of NTP servers. Leave plain if
                        Packstack should not install ntpd on instances.
    --nagios-install=NAGIOS_INSTALL
                        Set to 'y' if you would like Packstack to install
                        Nagios to monitor OpenStack hosts
    --exclude-servers=EXCLUDE_SERVERS
                        Comma separated list of servers to be excluded from
                        installation in case you are running Packstack the
                        second time with the same answer file and don't want
                        Packstack to touch these servers. Leave plain if you
                        don't need to exclude any server.

  MySQL Config parameters:
    --mysql-host=MYSQL_HOST
                        The IP address of the server on which to install MySQL
    --mysql-pw=MYSQL_PW
                        Password for the MySQL admin user

  QPID Config parameters:
    --qpid-host=QPID_HOST
                        The IP address of the server on which to install the
                        QPID service
    --qpid-enable-ssl=QPID_ENABLE_SSL
                        Enable SSL for the QPID service
    --qpid-enable-auth=QPID_ENABLE_AUTH
                        Enable Authentication for the QPID service

  QPID Config SSL parameters:
    --qpid-nss-certdb-pw=QPID_NSS_CERTDB_PW
                        The password for the NSS certificate database of the
                        QPID service
    --qpid-ssl-port=QPID_SSL_PORT
                        The port in which the QPID service listens to SSL
                        connections
    --qpid-ssl-cert-file=QPID_SSL_CERT_FILE
                        The filename of the certificate that the QPID service
                        is going to use
    --qpid-ssl-key-file=QPID_SSL_KEY_FILE
                        The filename of the private key that the QPID service
                        is going to use
    --qpid-ssl-self-signed=QPID_SSL_SELF_SIGNED
                        Auto Generates self signed SSL certificate and key

  QPID Config Athentication parameters:
    --qpid-auth-user=QPID_AUTH_USER
                        User for qpid authentication
    --qpid-auth-password=QPID_AUTH_PASSWORD
                        Password for user authentication

  Keystone Config parameters:
    --keystone-host=KEYSTONE_HOST
                        The IP address of the server on which to install
                        Keystone
    --keystone-admin-passwd=KEYSTONE_ADMIN_PASSWD
                        The password to use for the Keystone admin user
    --keystone-demo-passwd=KEYSTONE_DEMO_PASSWD
                        The password to use for the Keystone demo user

  Glance Config parameters:
    --glance-host=GLANCE_HOST
                        The IP address of the server on which to install
                        Glance

  Cinder Config parameters:
    --cinder-host=CINDER_HOST
                        The IP address of the server on which to install
                        Cinder
    --cinder-backend=CINDER_BACKEND
                        The Cinder backend to use, valid options are: lvm,
                        gluster, nfs

  Cinder volume create Config parameters:
    --cinder-volumes-create=CINDER_VOLUMES_CREATE
                        Create Cinder's volumes group. This should only be
                        done for testing on a proof-of-concept installation of
                        Cinder.  This will create a file-backed volume group
                        and is not suitable for production usage.

  Cinder volume size Config parameters:
    --cinder-volumes-size=CINDER_VOLUMES_SIZE
                        Cinder's volumes group size. Note that actual volume
                        size will be extended with 3% more space for VG
                        metadata.

  Cinder gluster Config parameters:
    --cinder-gluster-mounts=CINDER_GLUSTER_MOUNTS
                        A single or comma separated list of gluster volume
                        shares to mount, eg: ip-address:/vol-name, domain
                        :/vol-name

  Cinder NFS Config parameters:
    --cinder-nfs-mounts=CINDER_NFS_MOUNTS
                        A single or comma seprated list of NFS exports to
                        mount, eg: ip-address:/export-name

  Nova Options:
    --novaapi-host=NOVAAPI_HOST
                        The IP address of the server on which to install the
                        Nova API service
    --novacert-host=NOVACERT_HOST
                        The IP address of the server on which to install the
                        Nova Cert service
    --novavncproxy-hosts=NOVAVNCPROXY_HOSTS
                        The IP address of the server on which to install the
                        Nova VNC proxy
    --novacompute-hosts=NOVACOMPUTE_HOSTS
                        A comma separated list of IP addresses on which to
                        install the Nova Compute services
    --novaconductor-host=NOVACONDUCTOR_HOST
                        The IP address of the server on which to install the
                        Nova Conductor service
    --novasched-host=NOVASCHED_HOST
                        The IP address of the server on which to install the
                        Nova Scheduler service
    --novasched-cpu-allocation-ratio=NOVASCHED_CPU_ALLOCATION_RATIO
                        The overcommitment ratio for virtual to physical CPUs.
                        Set to 1.0 to disable CPU overcommitment
    --novasched-ram-allocation-ratio=NOVASCHED_RAM_ALLOCATION_RATIO
                        The overcommitment ratio for virtual to physical RAM.
                        Set to 1.0 to disable RAM overcommitment

  Nova Network Options:
    --novacompute-privif=NOVACOMPUTE_PRIVIF
                        Private interface for Flat DHCP on the Nova compute
                        servers
    --novanetwork-hosts=NOVANETWORK_HOSTS
                        The list of IP addresses of the server on which to
                        install the Nova Network service
    --novanetwork-manager=NOVANETWORK_MANAGER
                        Nova network manager
    --novanetwork-pubif=NOVANETWORK_PUBIF
                        Public interface on the Nova network server
    --novanetwork-privif=NOVANETWORK_PRIVIF
                        Private interface for network manager on the Nova
                        network server
    --novanetwork-fixed-range=NOVANETWORK_FIXED_RANGE
                        IP Range for network manager
    --novanetwork-floating-range=NOVANETWORK_FLOATING_RANGE
                        IP Range for Floating IP's
    --novanetwork-default-floating-pool=NOVANETWORK_DEFAULT_FLOATING_POOL
                        Name of the default floating pool to which the
                        specified floating ranges are added to
    --novanetwork-auto-assign-floating-ip=NOVANETWORK_AUTO_ASSIGN_FLOATING_IP
                        Automatically assign a floating IP to new instances

  Nova Network VLAN Options:
    --novanetwork-vlan-start=NOVANETWORK_VLAN_START
                        First VLAN for private networks
    --novanetwork-num-networks=NOVANETWORK_NUM_NETWORKS
                        Number of networks to support
    --novanetwork-network-size=NOVANETWORK_NETWORK_SIZE
                        Number of addresses in each private subnet

  Neutron config:
    --neutron-server-host=NEUTRON_SERVER_HOST
                        The IP addresses of the server on which to install the
                        Neutron server
    --neutron-l3-hosts=NEUTRON_L3_HOSTS
                        A comma separated list of IP addresses on which to
                        install Neutron L3 agent
    --neutron-l3-ext-bridge=NEUTRON_L3_EXT_BRIDGE
                        The name of the bridge that the Neutron L3 agent will
                        use for external traffic, or 'provider' if using
                        provider networks
    --neutron-dhcp-hosts=NEUTRON_DHCP_HOSTS
                        A comma separated list of IP addresses on which to
                        install Neutron DHCP agent
    --neutron-lbaas-hosts=NEUTRON_LBAAS_HOSTS
                        A comma separated list of IP addresses on which to
                        install Neutron LBaaS agent
    --neutron-l2-plugin=NEUTRON_L2_PLUGIN
                        The name of the L2 plugin to be used with Neutron
    --neutron-metadata-hosts=NEUTRON_METADATA_HOSTS
                        A comma separated list of IP addresses on which to
                        install Neutron metadata agent

  Neutron LB plugin config:
    --neutron-lb-tenant-network-type=NEUTRON_LB_TENANT_NETWORK_TYPE
                        The type of network to allocate for tenant networks
                        (eg. vlan, local, gre)
    --neutron-lb-vlan-ranges=NEUTRON_LB_VLAN_RANGES
                        A comma separated list of VLAN ranges for the Neutron
                        linuxbridge plugin (eg.
                        physnet1:1:4094,physnet2,physnet3:3000:3999)
    --neutron-lb-interface-mappings=NEUTRON_LB_INTERFACE_MAPPINGS
                        A comma separated list of interface mappings for the
                        Neutron linuxbridge plugin (eg. physnet1:br-
                        eth1,physnet2:br-eth2,physnet3:br-eth3)

  Neutron OVS plugin config:
    --neutron-ovs-tenant-network-type=NEUTRON_OVS_TENANT_NETWORK_TYPE
                        Type of network to allocate for tenant networks (eg.
                        vlan, local, gre)
    --neutron-ovs-vlan-ranges=NEUTRON_OVS_VLAN_RANGES
                        A comma separated list of VLAN ranges for the Neutron
                        openvswitch plugin (eg.
                        physnet1:1:4094,physnet2,physnet3:3000:3999)
    --neutron-ovs-bridge-mappings=NEUTRON_OVS_BRIDGE_MAPPINGS
                        A comma separated list of bridge mappings for the
                        Neutron openvswitch plugin (eg. physnet1:br-
                        eth1,physnet2:br-eth2,physnet3:br-eth3)
    --neutron-ovs-bridge-interfaces=NEUTRON_OVS_BRIDGE_INTERFACES
                        A comma separated list of colon-separated OVS
                        bridge:interface pairs. The interface will be added to
                        the associated bridge.

  Neutron OVS plugin config for GRE tunnels:
    --neutron-ovs-tunnel-ranges=NEUTRON_OVS_TUNNEL_RANGES
                        A comma separated list of tunnel ranges for the
                        Neutron openvswitch plugin
    --neutron-ovs-tunnel-if=NEUTRON_OVS_TUNNEL_IF
                        Override the IP used for GRE tunnels on this
                        hypervisor to the IP found on the specified interface
                        (defaults to the HOST IP)

  NOVACLIENT Config parameters:
    --osclient-host=OSCLIENT_HOST
                        The IP address of the server on which to install the
                        OpenStack client packages. An admin "rc" file will
                        also be installed

  OpenStack Horizon Config parameters:
    --os-horizon-host=OS_HORIZON_HOST
                        The IP address of the server on which to install
                        Horizon
    --os-horizon-ssl=OS_HORIZON_SSL
                        To set up Horizon communication over https set this to
                        "y"

  SSL Config parameters:
    --os-ssl-cert=OS_SSL_CERT
                        PEM encoded certificate to be used for ssl on the
                        https server, leave blank if one should be generated,
                        this certificate should not require a passphrase
    --os-ssl-key=OS_SSL_KEY
                        Keyfile corresponding to the certificate if one was
                        entered

  OpenStack Swift Config parameters:
    --os-swift-proxy=OS_SWIFT_PROXY
                        The IP address on which to install the Swift proxy
                        service (currently only single proxy is supported)
    --os-swift-storage=OS_SWIFT_STORAGE
                        A comma separated list of IP addresses on which to
                        install the Swift Storage services, each entry should
                        take the format <ipaddress>[/dev], for example
                        127.0.0.1/vdb will install /dev/vdb on 127.0.0.1 as a
                        swift storage device(packstack does not create the
                        filesystem, you must do this first), if /dev is
                        omitted Packstack will create a loopback device for a
                        test setup
    --os-swift-storage-zones=OS_SWIFT_STORAGE_ZONES
                        Number of swift storage zones, this number MUST be no
                        bigger than the number of storage devices configured
    --os-swift-storage-replicas=OS_SWIFT_STORAGE_REPLICAS
                        Number of swift storage replicas, this number MUST be
                        no bigger than the number of storage zones configured
    --os-swift-storage-fstype=OS_SWIFT_STORAGE_FSTYPE
                        FileSystem type for storage nodes
    --os-swift-storage-size=OS_SWIFT_STORAGE_SIZE
                        Size of the swift loopback file storage device

  Provisioning demo config:
    --provision-demo=PROVISION_DEMO
                        Whether to provision for demo usage and testing
    --provision-demo-floatrange=PROVISION_DEMO_FLOATRANGE
                        The CIDR network address for the floating IP subnet

  Provisioning tempest config:
    --provision-tempest=PROVISION_TEMPEST
                        Whether to configure tempest for testing

  Optional tempest git uri and branch:
    --provision-tempest-repo-uri=PROVISION_TEMPEST_REPO_URI
                        The uri of the tempest git repository to use
    --provision-tempest-repo-revision=PROVISION_TEMPEST_REPO_REVISION
                        The revision of the tempest git repository to use

  Provisioning all-in-one ovs bridge config:
    --provision-all-in-one-ovs-bridge=PROVISION_ALL_IN_ONE_OVS_BRIDGE
                        Whether to configure the ovs external bridge in an
                        all-in-one deployment

  Heat Config parameters:
    --heat-host=HEAT_HOST
                        The IP address of the server on which to install Heat
                        service
    --os-heat-cloudwatch-install=OS_HEAT_CLOUDWATCH_INSTALL
                        Set to 'y' if you would like Packstack to install Heat
                        CloudWatch API
    --os-heat-cfn-install=OS_HEAT_CFN_INSTALL
                        Set to 'y' if you would like Packstack to install Heat
                        CloudFormation API

  Heat CloudWatch API config parameters:
    --heat-api-cloudwatch-host=HEAT_API_CLOUDWATCH_HOST
                        The IP address of the server on which to install Heat
                        CloudWatch API service

  Heat CloudFormation API config parameters:
    --heat-api-cfn-host=HEAT_API_CFN_HOST
                        The IP address of the server on which to install Heat
                        CloudFormation API service

  Ceilometer Config parameters:
    --ceilometer-host=CEILOMETER_HOST
                        The IP address of the server on which to install
                        Ceilometer

  Nagios Config parameters:
    --nagios-host=NAGIOS_HOST
                        The IP address of the server on which to install the
                        Nagios server
    --nagios-passwd=NAGIOS_PASSWD
                        The password of the nagiosadmin user on the Nagios
                        server

  POSTSCRIPT Config parameters:

  Server Prepare Configs :
    --use-epel=USE_EPEL
                        To subscribe each server to EPEL enter "y"
    --additional-repo=ADDITIONAL_REPO
                        A comma separated list of URLs to any additional yum
                        repositories to install

  RHEL config:
    --rh-username=RH_USERNAME
                        To subscribe each server with Red Hat subscription
                        manager, include this with CONFIG_RH_PW
    --rh-password=RH_PASSWORD
                        To subscribe each server with Red Hat subscription
                        manager, include this with CONFIG_RH_USER
    --rh-beta-repo=RH_BETA_REPO
                        To subscribe each server to Red Hat Enterprise Linux 6
                        Server Beta channel (only needed for Preview versions
                        of RHOS) enter "y"
    --rhn-satellite-server=RHN_SATELLITE_SERVER
                        To subscribe each server with RHN Satellite,fill
                        Satellite's URL here. Note that either satellite's
                        username/password or activation key has to be provided

  RHN Satellite config:
    --rhn-satellite-username=RHN_SATELLITE_USERNAME
                        Username to access RHN Satellite
    --rhn-satellite-password=RHN_SATELLITE_PASSWORD
                        Password to access RHN Satellite
    --rhn-satellite-activation-key=RHN_SATELLITE_ACTIVATION_KEY
                        Activation key for subscription to RHN Satellite
    --rhn-satellite-cacert=RHN_SATELLITE_CACERT
                        Specify a path or URL to a SSL CA certificate to use
    --rhn-satellite-profile=RHN_SATELLITE_PROFILE
                        If required specify the profile name that should be
                        used as an identifier for the system in RHN Satellite
    --rhn-satellite-flags=RHN_SATELLITE_FLAGS
                        Comma separated list of flags passed to rhnreg_ks.
                        Valid flags are: novirtinfo, norhnsd, nopackages
    --rhn-satellite-proxy-host=RHN_SATELLITE_PROXY_HOST
                        Specify a HTTP proxy to use with RHN Satellite

  RHN Satellite proxy config:
    --rhn-satellite-proxy-username=RHN_SATELLITE_PROXY_USERNAME
                        Specify a username to use with an authenticated HTTP
                        proxy
    --rhn-satellite-proxy-password=RHN_SATELLITE_PROXY_PASSWORD
                        Specify a password to use with an authenticated HTTP
                        proxy.

  Puppet Config parameters: