FlagsGrouping
In-progress effort to logically group flags, in order to provide raw material for doc.
The idea is also to order them in a way that make sense to discover them, rather than alphabetically (user just before password for example, or retry_interval just before max_retries), and put the important ones first, and in bold.
General-purpose flags
flagfile: Insert flag definitions from the given file into the command line.
- (default: empty string)
- -?,--[no]help: show this help
- [no]helpshort: show usage only for this module
- [no]helpxml: like --help, but generates XML output
- host: name of this node
- (default: (calculated))
- my_ip: host ip address
- (default: (calculated))
- daemonize: Prepare nova- services to run in the background and become a daemon
- (default: 0 (false))
Flags for all services
state_path: Top-level directory for maintaining nova's state
- (default: '/Users/termie/p/nova/nova/../')
- periodic_interval: seconds between running periodic tasks
- (default: '60') (a positive integer)
- report_interval: seconds between nodes reporting state to datastore
- (default: '10') (a positive integer)
Hardware staging
- enable_new_services: Services to be added to the available pool on
- create (default: 'true')
Logging
Where to log
logdir: output to a per-service log file in named directory
- logfile: output to named file
- [no]use_syslog: output to syslog
- (default: 'false')
Log levels
verbose: show debug output
- (default: 'false')
- default_log_levels: list of logger=LEVEL pairs
- (default: 'amqplib=WARN,sqlalchemy=WARN,boto=WARN,eventlet.wsgi.server=WARN') (a comma separated list)
Customize log formats
- logging_context_format_string: format string to use for log messages with
- context (default: '%(asctime)s %(levelname)s %(name)s [%(request_id)s %(user)s %(project)s] %(message)s')
- logging_debug_format_suffix: data to append to log format when level is
- DEBUG (default: 'from %(processName)s (pid=%(process)d) %(funcName)s %(pathname)s:%(lineno)d')
- logging_default_format_string: format string to use for log messages without
- context (default: '%(asctime)s %(levelname)s %(name)s [-] %(message)s')
- logging_exception_prefix: prefix each line of exception output with this
- format (default: '(%(name)s): TRACE: ')
Database connection
sql_connection: connection string for sql database
- (default: 'sqlite:///$state_path/nova.sqlite')
- sql_idle_timeout: timeout for idle sql database connections
- (default: '3600') (an integer)
- sql_retry_interval: sql connection retry interval
- (default: '10') (an integer)
- sql_max_retries: sql connection attempts
- (default: '12') (an integer)
- db_backend: The backend to use for db
- (default: 'sqlalchemy')
- db_driver: driver to use for database access
- (default: 'nova.db.api')
RPC/RabbitMQ
Connection
rabbit_host: rabbit host
- (default: 'localhost')
rabbit_userid: rabbit userid
- (default: 'guest')
rabbit_password: rabbit password
- (default: 'guest')
- rabbit_port: rabbit port
- (default: '5672') (an integer)
- rabbit_virtual_host: rabbit virtual host
- (default: '/')
Tuning
- rabbit_retry_interval: rabbit connection retry interval
- (default: '10') (an integer)
- rabbit_max_retries: rabbit connection attempts
- (default: '12') (an integer)
- rpc_thread_pool_size: Size of RPC thread pool
- (default: '1024') (an integer)
Customize Exchange/Topic names
- control_exchange: the main exchange to connect to
- (default: 'nova')
- network_topic: the topic network nodes listen on
- (default: 'network')
- compute_topic: the topic compute nodes listen on
- (default: 'compute')
- ajax_console_proxy_topic: the topic ajax proxy nodes listen on
- (default: 'ajax_proxy')
- console_topic: the topic console proxy nodes listen on
- (default: 'console')
- scheduler_topic: the topic scheduler nodes listen on
- (default: 'scheduler')
- volume_topic: the topic volume nodes listen on
- (default: 'volume')
Image service to use
- image_service: The service to use for retrieving and searching for images.
(default: 'nova.image.local.LocalImageService')
- glance_host: glance host
- (default: '$my_ip')
- glance_port: glance port
- (default: '9292') (an integer)
- s3_host: s3 host (for infrastructure/image management)
- (default: '$my_ip')
- s3_port: s3 port
- (default: '3333') (an integer)
- s3_dmz: s3 dmz ip (for instances)
- (default: '$my_ip')
- use_s3: whether to get images from s3 or use local copy
- (default: 'true')
objectstore
Paths
- buckets_path: path to s3 buckets
- (default: '$state_path/buckets')
- images_path: path to decrypted images
- (default: '$state_path/images')
Authentication
auth_driver: Driver that auth manager uses
(default: 'nova.auth.dbdriver.DbDriver')
- auth_token_ttl: Seconds for auth tokens to linger
- (default: '3600')
(an integer) APPARENTLY UNUSED IN CODE
- (default: '3600')
Customize roles
- allowed_roles: Allowed roles for project
- (default: 'cloudadmin,itsec,sysadmin,netadmin,developer') (a comma separated list)
- global_roles: Roles that apply to all projects
- (default: 'cloudadmin,itsec') (a comma separated list)
- superuser_roles: Roles that ignore authorization checking completely
- (default: 'cloudadmin') (a comma separated list)
Customize credentials zipfile
- credentials_template: Template for creating users rc file
- (default: '/Users/termie/p/nova/nova/auth/novarc.template')
- credential_rc_file: Filename of rc in credentials zip, %s will be replaced
- by name of the region (nova by default) (default: '%src')
- credential_cert_file: Filename of certificate in credentials zip
- (default: 'cert.pem')
- credential_key_file: Filename of private key in credentials zip
- (default: 'pk.pem')
- vpn_client_template: Template for creating users vpn file
- (default: 'nova/cloudpipe/client.ovpn.template')
- credential_vpn_file: Filename of certificate in credentials zip
- (default: 'nova-vpn.conf')
Certificate authority
- keys_path: Where we keep our keys
- (default: '$state_path/keys')
- ca_file: Filename of root CA
- (default: 'cacert.pem')
- ca_path: Where we keep our root CA
- (default: '$state_path/CA')
- crl_file: Filename of root Certificate Revokation List
- (default: 'crl.pem')
- key_file: Filename of private key
- (default: 'private/cakey.pem')
- use_project_ca: Should we use a CA for each project?
- (default: 'false')
- project_cert_subject: Subject for certificate for projects, %s for project,
- timestamp (default: '/C=US/ST=California/L=MountainView/O=AnsoLabs/OU=NovaDev/CN=proje ct-ca-%s-%s')
- user_cert_subject: Subject for certificate for users, %s for project, user,
- timestamp (default: '/C=US/ST=California/L=MountainView/O=AnsoLabs/OU=NovaDev/CN=%s-%s-%s')
- vpn_cert_subject: Subject for certificate for vpns, %s for project,
- timestamp (default: '/C=US/ST=California/L=MountainView/O=AnsoLabs/OU=NovaDev/CN=proje ct-vpn-%s-%s')
Compute node
Autostart behavior
- start_guests_on_host_boot: Whether to restart guests when the host reboots
- (default: 'false')
- resume_guests_state_on_host_boot: Whether to start guests, that was running before the host reboot
- (default: 'false')
Virt type
connection_type: libvirt, xenapi or fake
- (default: 'libvirt')
- compute_manager: Manager for compute
(default: 'nova.compute.manager.ComputeManager')
- compute_driver: Driver to use for controlling virtualization
- (default: 'nova.virt.connection.get_connection')
libvirt
libvirt_type: Libvirt domain type (valid options are: kvm, qemu, uml, xen)
- (default: 'kvm')
- allow_project_net_traffic: Whether to allow in project network traffic
- (default: 'true')
- firewall_driver: Firewall driver (defaults to iptables)
(default: 'nova.virt.libvirt_conn.IptablesFirewallDriver')
- injected_network_template: Template file for injected network
- (default: '/Users/termie/p/nova/nova/virt/interfaces.template')
- libvirt_uri: Override the default libvirt URI (which is dependent on
- libvirt_type) (default: empty string)
- libvirt_xml_template: Libvirt XML Template
- (default: '/Users/termie/p/nova/nova/virt/libvirt.xml.template')
- use_cow_images: Whether to use cow images
- (default: 'true')
libvirt rescue mode
- rescue_image_id: Rescue ami image
- (default: 'ami-rescue')
- rescue_kernel_id: Rescue aki image
- (default: 'aki-rescue')
- rescue_ramdisk_id: Rescue ari image
- (default: 'ari-rescue')
Paths
- instances_path: where instances are stored on disk
- (default: '$state_path/instances')
Features
XS Password reset
- password_length: Length of generated admin passwords
- (default: '12') (an integer)
Serial Console
- console_host: Console proxy host to use to connect to instances onthis host.
- (default: 'preciousroy.hsd1.ca.comcast.net')
- console_manager: Manager for console proxy
(default: 'nova.console.manager.ConsoleProxyManager')
CloudPipe VPNs
- vpn_image_id: AMI for cloudpipe vpn server
- (default: 'ami-cloudpipe')
- vpn_key_suffix: Suffix to add to project name for vpn key and secgroups
- (default: '-vpn')
- vpn_ip: Public IP for the cloudpipe VPN servers
- (default: '$my_ip')
- vpn_start: First Vpn port for private networks
- (default: '1000') (an integer)
Web console
- ajax_console_proxy_port: port that ajax_console_proxy binds
- (default: '8000')
- ajax_console_proxy_url: location of ajax console proxy, in the form
"http://127.0.0.1:8000" (default: 'http://127.0.0.1:8000')
- ajaxterm_portrange: Range of ports that ajaxterm should randomly try to bind
- (default: '10000-12000')
Test mode
- fake_network: should we use fake network devices and addresses
- (default: 'false')
- fake_rabbit: use a fake rabbit
- (default: 'false')
- stub_network: Stub network related code
- (default: 'False')
Unclassified yet
nova.db.api:
- instance_name_template: Template string to be used to generate instance
- names (default: 'instance-%08x')
- volume_name_template: Template string to be used to generate instance names
- (default: 'volume-%08x')
nova.log:
- aws_access_key_id: AWS Access ID
- (default: 'admin')
- aws_secret_access_key: AWS Access Key
- (default: 'admin')
- default_image: default image to use, testing only
- (default: 'ami-11111')
- default_instance_type: default instance type to use, testing only
- (default: 'm1.small')
- default_project: default project for openstack
- (default: 'openstack')
- ec2_dmz_host: internal ip of api server
- (default: '$my_ip')
- ec2_host: ip of api server
- (default: '$my_ip')
- ec2_path: suffix for ec2
- (default: '/services/Cloud')
- ec2_port: cloud controller port
- (default: '8773') (an integer)
- ec2_scheme: prefix for ec2
- (default: 'http')
- network_manager: Manager for network
(default: 'nova.network.manager.VlanManager')
- node_availability_zone: availability zone of this node
- (default: 'nova')
- null_kernel: kernel image that indicates not to use a kernel, but to use a
- raw disk image instead (default: 'nokernel')
- osapi_host: ip of api server
- (default: '$my_ip')
- osapi_path: suffix for openstack
- (default: '/v1.0/')
osapi_port: OpenStack API port
- (default: '8774') (an integer)
- osapi_scheme: prefix for openstack
- (default: 'http')
- region_list: list of region=fqdn pairs separated by commas
- (default: empty string) (a comma separated list)
- scheduler_manager: Manager for scheduler
(default: 'nova.scheduler.manager.SchedulerManager')
- volume_manager: Manager for volume
(default: 'nova.volume.manager.VolumeManager')
nova.network.linux_net:
- dhcp_domain: domain to use for building the hostnames
- (default: 'novalocal')
- dhcpbridge: location of nova-dhcpbridge
- (default: '/Users/termie/p/nova/bin/nova-dhcpbridge')
- dhcpbridge_flagfile: location of flagfile for dhcpbridge
- (default: '/etc/nova/nova-dhcpbridge.conf')
- dmz_cidr: dmz range that should be accepted
- (default: '10.128.0.0/24')
- dns_server: if set, uses specific dns server for dnsmasq
- input_chain: chain to add nova_input to
- (default: 'INPUT')
- networks_path: Location to keep network config files
- (default: '$state_path/networks')
- public_interface: Interface for public IP addresses
- (default: 'eth0')
- routing_source_ip: Public IP of network host. When instances without a floating ip hit the internet, traffic is snatted to that ip.
- (default: '$my_ip')
- [no]use_nova_chains: use the nova_ routing chains instead of default
- (default: 'false')
vlan_interface: This is the interface that VlanManager uses to bind bridges and vlans to.
- (default: 'eth0')
nova.network.manager:
- cnt_vpn_clients: Number of addresses reserved for vpn clients
- (default: '0') (an integer)
- [no]fake_call: If True, skip using the queue and make local calls
- (default: 'false')
- fixed_ip_disassociate_timeout: Seconds after which a deallocated ip is
- disassociated (default: '600') (an integer)
- fixed_range: Fixed IP address block
- (default: '10.0.0.0/8')
- fixed_range_v6: Fixed IPv6 address block
- (default: 'fd00::/48')
- [no]flat_injected: Whether to attempt to inject network setup into guest
- (default: 'true')
flat_interface: FlatDhcp will bridge into this interface if set
- flat_network_bridge: Bridge for simple network instances
- (default: 'br100')
flat_network_dhcp_start: Dhcp start for FlatDhcp
- (default: '10.0.0.2')
- flat_network_dns: Dns for simple network
- (default: '8.8.4.4')
- floating_range: Floating IP address block
- (default: '4.4.4.0/24')
- network_driver: Driver to use for network creation
- (default: 'nova.network.linux_net')
- network_host: Network host to use for ip allocation in flat modes
- (default: 'preciousroy.hsd1.ca.comcast.net')
- network_size: Number of addresses in each private subnet
- (default: '256') (an integer)
- num_networks: Number of networks to support
- (default: '1000') (an integer)
- [no]update_dhcp_on_disassociate: Whether to update dhcp when fixed_ip is
- disassociated (default: 'false')
- [no]use_ipv6: use the ipv6
- (default: 'false')
- vlan_start: First VLAN for private networks
- (default: '100') (an integer)
nova.quota:
- quota_cores: number of instance cores allowed per project
- (default: '20') (an integer)
- quota_floating_ips: number of floating ips allowed per project
- (default: '10') (an integer)
- quota_gigabytes: number of volume gigabytes allowed per project
- (default: '1000') (an integer)
- quota_instances: number of instances allowed per project
- (default: '10') (an integer)
- quota_volumes: number of volumes allowed per project
- (default: '10') (an integer)
nova.virt.disk:
- block_size: block_size to use for dd
- (default: '268435456') (an integer)
- minimum_root_size: minimum size in bytes of root partition
- (default: '10737418240') (an integer)
- timeout_nbd: time to wait for a NBD device coming up
- (default: '10') (an integer)
nova.virt.xenapi_conn:
- iqn_prefix: IQN Prefix
- (default: 'iqn.2010-10.org.openstack')
- target_host: iSCSI Target Host
- target_port: iSCSI Target Port, 3260 Default
- (default: '3260')
- xenapi_connection_password: Password for connection to XenServer/Xen Cloud
- Platform. Used only if connection_type=xenapi.
- xenapi_connection_url: URL for connection to XenServer/Xen Cloud Platform.
- Required if connection_type=xenapi.
- xenapi_connection_username: Username for connection to XenServer/Xen Cloud
- Platform. Used only if connection_type=xenapi. (default: 'root')
- xenapi_image_service: Where to get VM images: glance or objectstore.
- (default: 'glance')
- [no]xenapi_remap_vbd_dev: Used to enable the remapping of VBD dev (Works
- around an issue in Ubuntu Maverick) (default: 'false')
- xenapi_remap_vbd_dev_prefix: Specify prefix to remap VBD dev to (ex.
/dev/xvdb -> /dev/sdb) (default: 'sd')
- xenapi_task_poll_interval: The interval used for polling of remote tasks
- (Async.VM.start, etc). Used only if connection_type=xenapi. (default: '0.5') (a number)
- xenapi_vhd_coalesce_max_attempts: Max number of times to poll for VHD to
- coalesce. Used only if connection_type=xenapi. (default: '5') (an integer)
- xenapi_vhd_coalesce_poll_interval: The interval used for polling of
- coalescing vhds. Used only if connection_type=xenapi. (default: '5.0') (a number)
nova.volume.driver:
- aoe_eth_dev: Which device to export the volumes on
- (default: 'eth0')
- blades_per_shelf: Number of vblade blades per shelf
- (default: '16') (an integer)
- iscsi_ip_prefix: discover volumes on the ip that starts with this prefix
- (default: '$my_ip')
- iscsi_num_targets: Number of iscsi target ids per host
- (default: '100') (an integer)
- iscsi_target_prefix: prefix for iscsi volumes
- (default: 'iqn.2010-10.org.openstack:')
- num_shell_tries: number of times to attempt to run flakey shell commands
- (default: '3')
- num_shelves: Number of vblade shelves
- (default: '100') (an integer)
- rbd_pool: the rbd pool in which volumes are stored
- (default: 'rbd')
- volume_group: Name for the VG that will contain exported volumes
- (default: 'nova-volumes')
nova.volume.manager:
- storage_availability_zone: availability zone of this service
- (default: 'nova')
- [no]use_local_volumes: if True, will not discover local volumes
- (default: 'true')
- volume_driver: Driver to use for volume creation
- (default: 'nova.volume.driver.ISCSIDriver')