From 26060346de6a241c9198877d054fac872424c388 Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Mon, 3 Mar 2014 16:58:24 +0100 Subject: [PATCH] Updated flagmappings and tables for nova Import results of the autohelp.py tool for nova. Change-Id: I64412e5b0c1c82842582dd161d15c2f59c9b0ff1 --- doc/common/tables/nova-api.xml | 12 ++++--- doc/common/tables/nova-authentication.xml | 2 +- doc/common/tables/nova-availabilityzones.xml | 6 ++-- doc/common/tables/nova-baremetal.xml | 24 ++++++------- doc/common/tables/nova-ca.xml | 4 +-- doc/common/tables/nova-cells.xml | 8 ++--- doc/common/tables/nova-common.xml | 22 ++++++++---- doc/common/tables/nova-compute.xml | 16 ++++----- doc/common/tables/nova-conductor.xml | 6 ++-- doc/common/tables/nova-db.xml | 16 ++++----- doc/common/tables/nova-ec2.xml | 14 ++++---- doc/common/tables/nova-glance.xml | 8 ++--- doc/common/tables/nova-hyperv.xml | 10 +++++- doc/common/tables/nova-hypervisor.xml | 24 ++++++------- doc/common/tables/nova-ipv6.xml | 2 +- doc/common/tables/nova-ldap.xml | 20 +++++------ doc/common/tables/nova-libvirt.xml | 12 +++++++ doc/common/tables/nova-logging.xml | 10 ++++-- doc/common/tables/nova-metadata.xml | 6 ++-- doc/common/tables/nova-network.xml | 36 +++++++++---------- doc/common/tables/nova-neutron.xml | 22 +++++++----- doc/common/tables/nova-periodic.xml | 4 +-- doc/common/tables/nova-policy.xml | 10 +++--- doc/common/tables/nova-qpid.xml | 6 ++-- doc/common/tables/nova-quota.xml | 28 +++++++-------- doc/common/tables/nova-rabbitmq.xml | 18 +++++----- doc/common/tables/nova-rdp.xml | 31 ++++++++++++++++ doc/common/tables/nova-redis.xml | 12 ++----- doc/common/tables/nova-rpc.xml | 17 +++------ doc/common/tables/nova-s3.xml | 18 +++++----- doc/common/tables/nova-scheduling.xml | 24 +++++++++---- doc/common/tables/nova-spice.xml | 10 +++--- doc/common/tables/nova-testing.xml | 2 +- doc/common/tables/nova-tilera.xml | 12 +++---- doc/common/tables/nova-trustedcomputing.xml | 10 +++--- doc/common/tables/nova-upgrade_levels.xml | 2 +- doc/common/tables/nova-vmware.xml | 4 +-- doc/common/tables/nova-vnc.xml | 8 ++--- doc/common/tables/nova-volumes.xml | 26 +++++++------- doc/common/tables/nova-vpn.xml | 2 +- doc/common/tables/nova-xen.xml | 30 +++++++++------- doc/common/tables/nova-xvpnvncproxy.xml | 2 +- doc/common/tables/nova-zeromq.xml | 2 +- doc/common/tables/nova-zookeeper.xml | 2 +- .../nova.flagmappings | 23 ++++++++---- 45 files changed, 329 insertions(+), 254 deletions(-) create mode 100644 doc/common/tables/nova-rdp.xml diff --git a/doc/common/tables/nova-api.xml b/doc/common/tables/nova-api.xml index 5e2f54f8d8..5748183153 100644 --- a/doc/common/tables/nova-api.xml +++ b/doc/common/tables/nova-api.xml @@ -24,16 +24,20 @@ enabled_apis = ec2, osapi_compute, metadata - (ListOpt) a list of APIs to enable by default + (ListOpt) A list of APIs to enable by default enabled_ssl_apis = - (ListOpt) a list of APIs with enabled SSL + (ListOpt) A list of APIs with enabled SSL instance_name_template = instance-%08x (StrOpt) Template string to be used to generate instance names + + max_header_line = 16384 + (IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs). + multi_instance_display_name_template = %(name)s-%(uuid)s (StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s". Valid keys for the template are: name, uuid, count. @@ -44,7 +48,7 @@ null_kernel = nokernel - (StrOpt) kernel image that indicates not to use a kernel, but to use a raw disk image instead + (StrOpt) Kernel image that indicates not to use a kernel, but to use a raw disk image instead osapi_compute_ext_list = @@ -68,7 +72,7 @@ osapi_compute_workers = None - (IntOpt) Number of workers for OpenStack API service + (IntOpt) Number of workers for OpenStack API service. The default will be the number of CPUs available. osapi_hide_server_address_states = building diff --git a/doc/common/tables/nova-authentication.xml b/doc/common/tables/nova-authentication.xml index ae6421817e..242be14bb2 100644 --- a/doc/common/tables/nova-authentication.xml +++ b/doc/common/tables/nova-authentication.xml @@ -20,7 +20,7 @@ api_rate_limit = False - (BoolOpt) whether to use per-user rate limiting for the api. This option is only used by v2 api. rate limiting is removed from v3 api. + (BoolOpt) Whether to use per-user rate limiting for the api. This option is only used by v2 api. Rate limiting is removed from v3 api. auth_strategy = noauth diff --git a/doc/common/tables/nova-availabilityzones.xml b/doc/common/tables/nova-availabilityzones.xml index c37428898c..a75e021e97 100644 --- a/doc/common/tables/nova-availabilityzones.xml +++ b/doc/common/tables/nova-availabilityzones.xml @@ -20,15 +20,15 @@ default_availability_zone = nova - (StrOpt) default compute node availability_zone + (StrOpt) Default compute node availability_zone default_schedule_zone = None - (StrOpt) availability zone to use when user doesn't specify one + (StrOpt) Availability zone to use when user doesn't specify one internal_service_availability_zone = internal - (StrOpt) availability_zone to show internal services under + (StrOpt) The availability_zone to show internal services under diff --git a/doc/common/tables/nova-baremetal.xml b/doc/common/tables/nova-baremetal.xml index 3a88f86244..cde0fd32c5 100644 --- a/doc/common/tables/nova-baremetal.xml +++ b/doc/common/tables/nova-baremetal.xml @@ -36,11 +36,11 @@ flavor_extra_specs = - (ListOpt) a list of additional capabilities corresponding to flavor_extra_specs for this compute host to advertise. Valid entries are name=value, pairs For example, "key1:val1, key2:val2" + (ListOpt) A list of additional capabilities corresponding to flavor_extra_specs for this compute host to advertise. Valid entries are name=value, pairs For example, "key1:val1, key2:val2" ipmi_power_retry = 10 - (IntOpt) maximal number of retries for IPMI operations + (IntOpt) Maximal number of retries for IPMI operations net_config_template = $pybasedir/nova/virt/baremetal/net-dhcp.ubuntu.template @@ -52,7 +52,7 @@ pxe_append_params = nofb nomodeset vga=normal - (StrOpt) additional append parameters for baremetal PXE boot + (StrOpt) Additional append parameters for baremetal PXE boot pxe_bootfile_name = pxelinux.0 @@ -76,22 +76,22 @@ terminal = shellinaboxd - (StrOpt) path to baremetal terminal program + (StrOpt) Path to baremetal terminal program terminal_cert_dir = None - (StrOpt) path to baremetal terminal SSL cert(PEM) + (StrOpt) Path to baremetal terminal SSL cert(PEM) terminal_pid_dir = $state_path/baremetal/console - (StrOpt) path to directory stores pidfiles of baremetal_terminal + (StrOpt) Path to directory stores pidfiles of baremetal_terminal tftp_root = /tftpboot (StrOpt) Baremetal compute node's tftp root path - use_file_injection = True + use_file_injection = False (BoolOpt) If True, enable file injection for network info, files and admin password @@ -104,19 +104,19 @@ virtual_power_host_key = None - (StrOpt) ssh key for virtual power host_user + (StrOpt) The ssh key for virtual power host_user virtual_power_host_pass = - (StrOpt) password for virtual power host_user + (StrOpt) Password for virtual power host_user virtual_power_host_user = - (StrOpt) user to execute virtual power commands as + (StrOpt) User to execute virtual power commands as virtual_power_ssh_host = - (StrOpt) ip or name to virtual power host + (StrOpt) IP or name to virtual power host virtual_power_ssh_port = 22 @@ -124,7 +124,7 @@ virtual_power_type = virsh - (StrOpt) base command to use for virtual power(vbox,virsh) + (StrOpt) Base command to use for virtual power(vbox, virsh) [xenserver] diff --git a/doc/common/tables/nova-ca.xml b/doc/common/tables/nova-ca.xml index 0b41201935..ad73eb1c04 100644 --- a/doc/common/tables/nova-ca.xml +++ b/doc/common/tables/nova-ca.xml @@ -28,11 +28,11 @@ cert_manager = nova.cert.manager.CertManager - (StrOpt) full class name for the Manager for cert + (StrOpt) Full class name for the Manager for cert cert_topic = cert - (StrOpt) the topic cert nodes listen on + (StrOpt) The topic cert nodes listen on crl_file = crl.pem diff --git a/doc/common/tables/nova-cells.xml b/doc/common/tables/nova-cells.xml index 602246e651..9ba4a1cb68 100644 --- a/doc/common/tables/nova-cells.xml +++ b/doc/common/tables/nova-cells.xml @@ -64,15 +64,15 @@ mute_weight_multiplier = -10.0 - (FloatOpt) Multiplier used to weigh mute children. (The value should be negative.) + (FloatOpt) Multiplier used to weigh mute children. (The value should be negative.) mute_weight_value = 1000.0 - (FloatOpt) Weight value assigned to mute children. (The value should be positive.) + (FloatOpt) Weight value assigned to mute children. (The value should be positive.) name = nova - (StrOpt) name of this cell + (StrOpt) Name of this cell offset_weight_multiplier = 1.0 @@ -84,7 +84,7 @@ topic = cells - (StrOpt) the topic cells nodes listen on + (StrOpt) The topic cells nodes listen on diff --git a/doc/common/tables/nova-common.xml b/doc/common/tables/nova-common.xml index 9664d71336..3e3160686e 100644 --- a/doc/common/tables/nova-common.xml +++ b/doc/common/tables/nova-common.xml @@ -24,15 +24,15 @@ compute_topic = compute - (StrOpt) the topic compute nodes listen on + (StrOpt) The topic compute nodes listen on console_topic = console - (StrOpt) the topic console proxy nodes listen on + (StrOpt) The topic console proxy nodes listen on consoleauth_topic = consoleauth - (StrOpt) the topic console auth proxy nodes listen on + (StrOpt) The topic console auth proxy nodes listen on disable_process_locking = False @@ -52,7 +52,7 @@ my_ip = 10.0.0.1 - (StrOpt) ip address of this host + (StrOpt) IP address of this host notification_driver = [] @@ -70,13 +70,17 @@ notify_on_state_change = None (StrOpt) If set, send compute.instance.update notifications on instance state changes. Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes. + + port = 6379 + (IntOpt) Use this port to connect to redis host. + pybasedir = /usr/lib/python/site-packages (StrOpt) Directory where the nova python module is installed report_interval = 10 - (IntOpt) seconds between nodes reporting state to datastore + (IntOpt) Seconds between nodes reporting state to datastore rootwrap_config = /etc/nova/rootwrap.conf @@ -84,16 +88,20 @@ service_down_time = 60 - (IntOpt) maximum time since last check-in for up service + (IntOpt) Maximum time since last check-in for up service - state_path = $pybasedir + state_path = /var/lib/nova (StrOpt) Top-level directory for maintaining nova's state tempdir = None (StrOpt) Explicitly specify the temporary working directory + + transport_url = None + (StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. + diff --git a/doc/common/tables/nova-compute.xml b/doc/common/tables/nova-compute.xml index 11b8da7b24..c34be2de12 100644 --- a/doc/common/tables/nova-compute.xml +++ b/doc/common/tables/nova-compute.xml @@ -28,7 +28,7 @@ compute_manager = nova.compute.manager.ComputeManager - (StrOpt) full class name for the Manager for compute + (StrOpt) Full class name for the Manager for compute compute_monitors = @@ -44,11 +44,11 @@ console_manager = nova.console.manager.ConsoleProxyManager - (StrOpt) full class name for the Manager for console proxy + (StrOpt) Full class name for the Manager for console proxy default_flavor = m1.small - (StrOpt) default flavor to use for the EC2 API only. The Nova API does not support a default flavor. + (StrOpt) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor. default_notification_level = INFO @@ -66,10 +66,6 @@ heal_instance_info_cache_interval = 60 (IntOpt) Number of seconds between instance info_cache self healing updates - - host_state_interval = 120 - (IntOpt) Interval in seconds for querying the host status - image_cache_manager_interval = 2400 (IntOpt) Number of seconds to wait between runs of the image cache manager @@ -92,11 +88,11 @@ instance_usage_audit_period = month - (StrOpt) time period to generate instance usages for. Time period must be hour, day, month or year + (StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year instances_path = $state_path/instances - (StrOpt) where instances are stored on disk + (StrOpt) Where instances are stored on disk maximum_instance_delete_attempts = 5 @@ -140,7 +136,7 @@ sync_power_state_interval = 600 - (IntOpt) interval to sync power states between the database and the hypervisor + (IntOpt) Interval to sync power states between the database and the hypervisor diff --git a/doc/common/tables/nova-conductor.xml b/doc/common/tables/nova-conductor.xml index 3125302450..83d4583d64 100644 --- a/doc/common/tables/nova-conductor.xml +++ b/doc/common/tables/nova-conductor.xml @@ -27,11 +27,11 @@ manager = nova.conductor.manager.ConductorManager - (StrOpt) full class name for the Manager for conductor + (StrOpt) Full class name for the Manager for conductor topic = conductor - (StrOpt) the topic conductor nodes listen on + (StrOpt) The topic on which conductor nodes listen use_local = False @@ -39,7 +39,7 @@ workers = None - (IntOpt) Number of workers for OpenStack Conductor service + (IntOpt) Number of workers for OpenStack Conductor service. The default will be the number of CPUs available. diff --git a/doc/common/tables/nova-db.xml b/doc/common/tables/nova-db.xml index a9e3932abf..9fd8d15e2f 100644 --- a/doc/common/tables/nova-db.xml +++ b/doc/common/tables/nova-db.xml @@ -20,22 +20,22 @@ db_driver = nova.db - (StrOpt) driver to use for database access + (StrOpt) The driver to use for database access sqlite_db = nova.sqlite - (StrOpt) the filename to use with sqlite + (StrOpt) The file name to use with SQLite sqlite_synchronous = True - (BoolOpt) If true, use synchronous mode for sqlite + (BoolOpt) If True, SQLite uses synchronous mode [cells] db_check_interval = 60 - (IntOpt) Seconds between getting fresh cell info from db. + (IntOpt) Interval, in seconds, for getting fresh cell information from the database. [database] @@ -45,7 +45,7 @@ (StrOpt) The backend to use for db - connection = sqlite:////home/shaunm/Projects/nova/nova/openstack/common/db/$sqlite_db + connection = sqlite:////usr/lib/python/site-packages/nova/openstack/common/db/$sqlite_db (StrOpt) The SQLAlchemy connection string used to connect to the database @@ -58,7 +58,7 @@ idle_timeout = 3600 - (IntOpt) timeout before idle sql connections are reaped + (IntOpt) Timeout before idle sql connections are reaped max_overflow = None @@ -70,7 +70,7 @@ max_retries = 10 - (IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count) + (IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count) min_pool_size = 1 @@ -82,7 +82,7 @@ retry_interval = 10 - (IntOpt) interval between retries of opening a sql connection + (IntOpt) Interval between retries of opening a sql connection slave_connection = diff --git a/doc/common/tables/nova-ec2.xml b/doc/common/tables/nova-ec2.xml index 0363716854..9ebaa074bb 100644 --- a/doc/common/tables/nova-ec2.xml +++ b/doc/common/tables/nova-ec2.xml @@ -20,11 +20,11 @@ ec2_dmz_host = $my_ip - (StrOpt) the internal ip of the ec2 api server + (StrOpt) The internal IP address of the EC2 API server ec2_host = $my_ip - (StrOpt) the ip of the ec2 api server + (StrOpt) The IP address of the EC2 API server ec2_listen = 0.0.0.0 @@ -36,11 +36,11 @@ ec2_path = /services/Cloud - (StrOpt) the path prefix used to call the ec2 api server + (StrOpt) The path prefix used to call the ec2 API server ec2_port = 8773 - (IntOpt) the port of the ec2 api server + (IntOpt) The port of the EC2 API server ec2_private_dns_show_ip = False @@ -48,7 +48,7 @@ ec2_scheme = http - (StrOpt) the protocol to use when connecting to the ec2 api server (http, https) + (StrOpt) The protocol to use when connecting to the EC2 API server (http, https) ec2_strict_validation = True @@ -60,7 +60,7 @@ ec2_workers = None - (IntOpt) Number of workers for EC2 API service + (IntOpt) Number of workers for EC2 API service. The default will be equal to the number of CPUs available. keystone_ec2_url = http://localhost:5000/v2.0/ec2tokens @@ -80,7 +80,7 @@ region_list = - (ListOpt) list of region=fqdn pairs separated by commas + (ListOpt) List of region=fqdn pairs separated by commas diff --git a/doc/common/tables/nova-glance.xml b/doc/common/tables/nova-glance.xml index c781c4b7f3..9ae65648c2 100644 --- a/doc/common/tables/nova-glance.xml +++ b/doc/common/tables/nova-glance.xml @@ -32,15 +32,15 @@ glance_host = $my_ip - (StrOpt) default glance hostname or ip + (StrOpt) Default glance hostname or IP address glance_num_retries = 0 - (IntOpt) Number retries when downloading an image from glance + (IntOpt) Number of retries when downloading an image from glance glance_port = 9292 - (IntOpt) default glance port + (IntOpt) Default glance port glance_protocol = http @@ -55,7 +55,7 @@ filesystems = - (ListOpt) A list of filesystems that will be configured in this file under the sections image_file_url:<list entry name> + (ListOpt) List of file systems that are configured in this file in the image_file_url:<list entry name> sections diff --git a/doc/common/tables/nova-hyperv.xml b/doc/common/tables/nova-hyperv.xml index 8e9f0a6d80..c9af280293 100644 --- a/doc/common/tables/nova-hyperv.xml +++ b/doc/common/tables/nova-hyperv.xml @@ -38,9 +38,17 @@ limit_cpu_features = False (BoolOpt) Required for live migration among hosts with different CPU features + + mounted_disk_query_retry_count = 10 + (IntOpt) The number of times to retry checking for a disk mounted via iSCSI. + + + mounted_disk_query_retry_interval = 5 + (IntOpt) Interval between checks for a mounted iSCSI disk, in seconds. + qemu_img_cmd = qemu-img.exe - (StrOpt) qemu-img is used to convert between different image types + (StrOpt) Path of qemu-img command which is used to convert between different image types vswitch_name = None diff --git a/doc/common/tables/nova-hypervisor.xml b/doc/common/tables/nova-hypervisor.xml index 2611f6c54e..0699bb6300 100644 --- a/doc/common/tables/nova-hypervisor.xml +++ b/doc/common/tables/nova-hypervisor.xml @@ -36,7 +36,7 @@ timeout_nbd = 10 - (IntOpt) time to wait for a NBD device coming up + (IntOpt) Amount of time, in seconds, to wait for NBD device start up. use_cow_images = True @@ -44,11 +44,11 @@ vcpu_pin_set = None - (StrOpt) Which pcpus can be used by vcpus of instance e.g: "4-12,^8,15" + (StrOpt) Defines which pcpus that instance vcpus can use. For example, "4-12,^8,15" virt_mkfs = [] - (MultiStrOpt) mkfs commands for ephemeral device. The format is <os_type>=<mkfs command> + (MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is <os_type>=<mkfs command> [libvirt] @@ -63,26 +63,26 @@ images_rbd_ceph_conf = - (StrOpt) path to the ceph configuration file to use + (StrOpt) Path to the ceph configuration file to use images_rbd_pool = rbd - (StrOpt) the RADOS pool in which rbd volumes are stored + (StrOpt) The RADOS pool in which rbd volumes are stored images_type = default - (StrOpt) VM Images format. Acceptable values are: raw, qcow2, lvm,rbd, default. If default is specified, then use_cow_images flag is used instead of this one. + (StrOpt) VM Images format. Acceptable values are: raw, qcow2, lvm, rbd, default. If default is specified, then use_cow_images flag is used instead of this one. images_volume_group = None (StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm. - inject_key = True + inject_key = False (BoolOpt) Inject the ssh public key at boot time - inject_partition = 1 + inject_partition = -2 (IntOpt) The partition to inject to : -2 => disable, -1 => inspect (libguestfs only), 0 => not partitioned, >0 => partition number @@ -91,15 +91,11 @@ iscsi_use_multipath = False - (BoolOpt) use multipath connection of the iSCSI volume + (BoolOpt) Use multipath connection of the iSCSI volume iser_use_multipath = False - (BoolOpt) use multipath connection of the iSER volume - - - lvm_snapshot_size = 1000 - (IntOpt) The amount of storage (in megabytes) to allocate for LVM snapshot copy-on-write blocks. + (BoolOpt) Use multipath connection of the iSER volume rescue_image_id = None diff --git a/doc/common/tables/nova-ipv6.xml b/doc/common/tables/nova-ipv6.xml index ee49c6deda..760b29e801 100644 --- a/doc/common/tables/nova-ipv6.xml +++ b/doc/common/tables/nova-ipv6.xml @@ -32,7 +32,7 @@ use_ipv6 = False - (BoolOpt) use ipv6 + (BoolOpt) Use IPv6 diff --git a/doc/common/tables/nova-ldap.xml b/doc/common/tables/nova-ldap.xml index 1d536b35c8..1949478623 100644 --- a/doc/common/tables/nova-ldap.xml +++ b/doc/common/tables/nova-ldap.xml @@ -20,43 +20,43 @@ ldap_dns_base_dn = ou=hosts,dc=example,dc=org - (StrOpt) Base DN for DNS entries in ldap + (StrOpt) Base DN for DNS entries in LDAP ldap_dns_password = password - (StrOpt) password for ldap DNS + (StrOpt) Password for LDAP DNS ldap_dns_servers = ['dns.example.org'] - (MultiStrOpt) DNS Servers for ldap dns driver + (MultiStrOpt) DNS Servers for LDAP DNS driver ldap_dns_soa_expiry = 86400 - (StrOpt) Expiry interval (in seconds) for ldap dns driver Statement of Authority + (StrOpt) Expiry interval (in seconds) for LDAP DNS driver Statement of Authority ldap_dns_soa_hostmaster = hostmaster@example.org - (StrOpt) Hostmaster for ldap dns driver Statement of Authority + (StrOpt) Hostmaster for LDAP DNS driver Statement of Authority ldap_dns_soa_minimum = 7200 - (StrOpt) Minimum interval (in seconds) for ldap dns driver Statement of Authority + (StrOpt) Minimum interval (in seconds) for LDAP DNS driver Statement of Authority ldap_dns_soa_refresh = 1800 - (StrOpt) Refresh interval (in seconds) for ldap dns driver Statement of Authority + (StrOpt) Refresh interval (in seconds) for LDAP DNS driver Statement of Authority ldap_dns_soa_retry = 3600 - (StrOpt) Retry interval (in seconds) for ldap dns driver Statement of Authority + (StrOpt) Retry interval (in seconds) for LDAP DNS driver Statement of Authority ldap_dns_url = ldap://ldap.example.com:389 - (StrOpt) URL for ldap server which will store dns entries + (StrOpt) URL for LDAP server which will store DNS entries ldap_dns_user = uid=admin,ou=people,dc=example,dc=org - (StrOpt) user for ldap DNS + (StrOpt) User for LDAP DNS diff --git a/doc/common/tables/nova-libvirt.xml b/doc/common/tables/nova-libvirt.xml index 3d0be249f0..0b7b60ad2e 100644 --- a/doc/common/tables/nova-libvirt.xml +++ b/doc/common/tables/nova-libvirt.xml @@ -65,6 +65,10 @@ remove_unused_resized_minimum_age_seconds = 3600 (IntOpt) Unused resized base images younger than this will not be removed + + rng_dev_path = None + (StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng + snapshots_directory = $instances_path/snapshots (StrOpt) Location where libvirt driver will store snapshots before uploading them to image service @@ -77,6 +81,14 @@ virt_type = kvm (StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen) + + volume_clear = zero + (StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred) + + + volume_clear_size = 0 + (IntOpt) Size in MiB to wipe at start of old volumes. 0 => all + volume_drivers = iscsi=nova.virt.libvirt.volume.LibvirtISCSIVolumeDriver, iser=nova.virt.libvirt.volume.LibvirtISERVolumeDriver, local=nova.virt.libvirt.volume.LibvirtVolumeDriver, fake=nova.virt.libvirt.volume.LibvirtFakeVolumeDriver, rbd=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, sheepdog=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, nfs=nova.virt.libvirt.volume.LibvirtNFSVolumeDriver, aoe=nova.virt.libvirt.volume.LibvirtAOEVolumeDriver, glusterfs=nova.virt.libvirt.volume.LibvirtGlusterfsVolumeDriver, fibre_channel=nova.virt.libvirt.volume.LibvirtFibreChannelVolumeDriver, scality=nova.virt.libvirt.volume.LibvirtScalityVolumeDriver (ListOpt) Libvirt handlers for remote volumes. diff --git a/doc/common/tables/nova-logging.xml b/doc/common/tables/nova-logging.xml index b8e8824476..e58ee3c186 100644 --- a/doc/common/tables/nova-logging.xml +++ b/doc/common/tables/nova-logging.xml @@ -23,7 +23,7 @@ (BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). - default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, keystone=INFO, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN + default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN (ListOpt) list of logger=LEVEL pairs @@ -32,7 +32,7 @@ fatal_exception_format_errors = False - (BoolOpt) make exception message format errors fatal + (BoolOpt) Make exception message format errors fatal instance_format = "[instance: %(uuid)s] " @@ -88,7 +88,11 @@ use-syslog = False - (BoolOpt) Use syslog for logging. + (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424 + + + use-syslog-rfc-format = False + (BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J. use_stderr = True diff --git a/doc/common/tables/nova-metadata.xml b/doc/common/tables/nova-metadata.xml index f1114bdae2..abc09cd4fb 100644 --- a/doc/common/tables/nova-metadata.xml +++ b/doc/common/tables/nova-metadata.xml @@ -20,7 +20,7 @@ metadata_host = $my_ip - (StrOpt) the ip for the metadata api server + (StrOpt) The IP address for the metadata API server metadata_listen = 0.0.0.0 @@ -36,11 +36,11 @@ metadata_port = 8775 - (IntOpt) the port for the metadata api port + (IntOpt) The port for the metadata API port metadata_workers = None - (IntOpt) Number of workers for metadata service + (IntOpt) Number of workers for metadata service. The default will be the number of CPUs available. vendordata_driver = nova.api.metadata.vendordata_json.JsonFileVendorData diff --git a/doc/common/tables/nova-network.xml b/doc/common/tables/nova-network.xml index 2ce504d42b..6285d1ccac 100644 --- a/doc/common/tables/nova-network.xml +++ b/doc/common/tables/nova-network.xml @@ -24,7 +24,7 @@ auto_assign_floating_ip = False - (BoolOpt) Autoassigning floating ip to VM + (BoolOpt) Autoassigning floating IP to VM cnt_vpn_clients = 0 @@ -36,11 +36,11 @@ default_access_ip_network_name = None - (StrOpt) Name of network to use to set access ips for instances + (StrOpt) Name of network to use to set access IPs for instances default_floating_pool = nova - (StrOpt) Default pool for floating ips + (StrOpt) Default pool for floating IPs defer_iptables_apply = False @@ -48,7 +48,7 @@ dhcp_domain = novalocal - (StrOpt) domain to use for building the hostnames + (StrOpt) Domain to use for building the hostnames dhcp_lease_time = 120 @@ -56,15 +56,15 @@ dhcpbridge = $bindir/nova-dhcpbridge - (StrOpt) location of nova-dhcpbridge + (StrOpt) Location of nova-dhcpbridge dhcpbridge_flagfile = ['/etc/nova/nova-dhcpbridge.conf'] - (MultiStrOpt) location of flagfiles for dhcpbridge + (MultiStrOpt) Location of flagfiles for dhcpbridge dns_server = [] - (MultiStrOpt) if set, uses specific dns server for dnsmasq. Canbe specified multiple times. + (MultiStrOpt) If set, uses specific DNS server for dnsmasq. Can be specified multiple times. dns_update_periodic_interval = -1 @@ -80,7 +80,7 @@ fixed_ip_disassociate_timeout = 600 - (IntOpt) Seconds after which a deallocated ip is disassociated + (IntOpt) Seconds after which a deallocated IP is disassociated flat_injected = False @@ -96,11 +96,11 @@ flat_network_dns = 8.8.4.4 - (StrOpt) Dns for simple network + (StrOpt) DNS server for simple network floating_ip_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver - (StrOpt) full class name for the DNS Manager for floating IPs + (StrOpt) Full class name for the DNS Manager for floating IPs force_dhcp_release = True @@ -124,11 +124,11 @@ instance_dns_domain = - (StrOpt) full class name for the DNS Zone for instance IPs + (StrOpt) Full class name for the DNS Zone for instance IPs instance_dns_manager = nova.network.noop_dns_driver.NoopDNSDriver - (StrOpt) full class name for the DNS Manager for instance IPs + (StrOpt) Full class name for the DNS Manager for instance IPs iptables_bottom_regex = @@ -176,7 +176,7 @@ network_manager = nova.network.manager.VlanManager - (StrOpt) full class name for the Manager for network + (StrOpt) Full class name for the Manager for network network_size = 256 @@ -184,7 +184,7 @@ network_topic = network - (StrOpt) the topic network nodes listen on + (StrOpt) The topic network nodes listen on networks_path = $state_path/networks @@ -212,11 +212,11 @@ send_arp_for_ha = False - (BoolOpt) send gratuitous ARPs for HA setup + (BoolOpt) Send gratuitous ARPs for HA setup send_arp_for_ha_count = 3 - (IntOpt) send this many gratuitous ARPs for HA setup + (IntOpt) Send this many gratuitous ARPs for HA setup share_dhcp_address = False @@ -232,7 +232,7 @@ use_network_dns_servers = False - (BoolOpt) if set, uses the dns1 and dns2 from the network ref.as dns servers. + (BoolOpt) If set, uses the dns1 and dns2 from the network ref. as dns servers. use_neutron_default_nets = False @@ -244,7 +244,7 @@ vlan_interface = None - (StrOpt) vlans will bridge into this interface if set + (StrOpt) VLANs will bridge into this interface if set vlan_start = 100 diff --git a/doc/common/tables/nova-neutron.xml b/doc/common/tables/nova-neutron.xml index b07a967281..28f77e091a 100644 --- a/doc/common/tables/nova-neutron.xml +++ b/doc/common/tables/nova-neutron.xml @@ -20,31 +20,35 @@ neutron_admin_auth_url = http://localhost:5000/v2.0 - (StrOpt) auth url for connecting to neutron in admin context + (StrOpt) Authorization URL for connecting to neutron in admin context neutron_admin_password = None - (StrOpt) password for connecting to neutron in admin context + (StrOpt) Password for connecting to neutron in admin context + + + neutron_admin_tenant_id = None + (StrOpt) Tenant id for connecting to neutron in admin context neutron_admin_tenant_name = None - (StrOpt) tenant name for connecting to neutron in admin context + (StrOpt) DEPRECATED: Tenant name for connecting to neutron in admin context. This option is deprecated. Please use neutron_admin_tenant_id instead. Note that with Keystone V3 tenant names may not be unique. neutron_admin_username = None - (StrOpt) username for connecting to neutron in admin context + (StrOpt) Username for connecting to neutron in admin context neutron_api_insecure = False - (BoolOpt) if set, ignore any SSL validation issues + (BoolOpt) If set, ignore any SSL validation issues neutron_auth_strategy = keystone - (StrOpt) auth strategy for connecting to neutron in admin context + (StrOpt) Authorization strategy for connecting to neutron in admin context neutron_ca_certificates_file = None - (StrOpt) Location of ca certificates file to use for neutron client requests. + (StrOpt) Location of CA certificates file to use for neutron client requests. neutron_default_tenant_id = default @@ -64,7 +68,7 @@ neutron_region_name = None - (StrOpt) region name for connecting to neutron in admin context + (StrOpt) Region name for connecting to neutron in admin context neutron_url = http://127.0.0.1:9696 @@ -72,7 +76,7 @@ neutron_url_timeout = 30 - (IntOpt) timeout value for connecting to neutron in seconds + (IntOpt) Timeout value for connecting to neutron in seconds service_neutron_metadata_proxy = False diff --git a/doc/common/tables/nova-periodic.xml b/doc/common/tables/nova-periodic.xml index e9ee74d932..ee85235a48 100644 --- a/doc/common/tables/nova-periodic.xml +++ b/doc/common/tables/nova-periodic.xml @@ -20,11 +20,11 @@ periodic_enable = True - (BoolOpt) enable periodic tasks + (BoolOpt) Enable periodic tasks periodic_fuzzy_delay = 60 - (IntOpt) range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) + (IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0) run_external_periodic_tasks = True diff --git a/doc/common/tables/nova-policy.xml b/doc/common/tables/nova-policy.xml index bd7bc5e2f2..03fa84db1b 100644 --- a/doc/common/tables/nova-policy.xml +++ b/doc/common/tables/nova-policy.xml @@ -32,7 +32,7 @@ max_age = 0 - (IntOpt) number of seconds between subsequent usage refreshes + (IntOpt) Number of seconds between subsequent usage refreshes max_local_block_devices = 3 @@ -44,11 +44,11 @@ osapi_max_limit = 1000 - (IntOpt) the maximum number of items returned in a single response from a collection resource + (IntOpt) The maximum number of items returned in a single response from a collection resource osapi_max_request_body_size = 114688 - (IntOpt) the maximum body size per each osapi request(bytes) + (IntOpt) The maximum body size per each osapi request(bytes) password_length = 12 @@ -64,7 +64,7 @@ reservation_expire = 86400 - (IntOpt) number of seconds until a reservation expires + (IntOpt) Number of seconds until a reservation expires resize_fs_using_block_device = False @@ -72,7 +72,7 @@ until_refresh = 0 - (IntOpt) count of reservations until usage is refreshed + (IntOpt) Count of reservations until usage is refreshed diff --git a/doc/common/tables/nova-qpid.xml b/doc/common/tables/nova-qpid.xml index 8d87acb549..5b54d12b12 100644 --- a/doc/common/tables/nova-qpid.xml +++ b/doc/common/tables/nova-qpid.xml @@ -23,7 +23,7 @@ (IntOpt) Seconds between connection keepalive heartbeats - qpid_hostname = localhost + qpid_hostname = oslo (StrOpt) Qpid broker hostname @@ -32,7 +32,7 @@ qpid_password = - (StrOpt) Password for qpid connection + (StrOpt) Password for Qpid connection qpid_port = 5672 @@ -56,7 +56,7 @@ qpid_username = - (StrOpt) Username for qpid connection + (StrOpt) Username for Qpid connection diff --git a/doc/common/tables/nova-quota.xml b/doc/common/tables/nova-quota.xml index 8387d094f1..83b660c43b 100644 --- a/doc/common/tables/nova-quota.xml +++ b/doc/common/tables/nova-quota.xml @@ -20,7 +20,7 @@ bandwidth_poll_interval = 600 - (IntOpt) interval to pull bandwidth usage info + (IntOpt) Interval to pull network bandwidth usage info. Not supported on all hypervisors. Set to 0 to disable. enable_network_quota = False @@ -28,55 +28,55 @@ quota_cores = 20 - (IntOpt) number of instance cores allowed per project + (IntOpt) Number of instance cores allowed per project quota_driver = nova.quota.DbQuotaDriver - (StrOpt) default driver to use for quota checks + (StrOpt) Default driver to use for quota checks quota_fixed_ips = -1 - (IntOpt) number of fixed ips allowed per project (this should be at least the number of instances allowed) + (IntOpt) Number of fixed IPs allowed per project (this should be at least the number of instances allowed) quota_floating_ips = 10 - (IntOpt) number of floating ips allowed per project + (IntOpt) Number of floating IPs allowed per project quota_injected_file_content_bytes = 10240 - (IntOpt) number of bytes allowed per injected file + (IntOpt) Number of bytes allowed per injected file quota_injected_file_path_bytes = 255 - (IntOpt) number of bytes allowed per injected file path + (IntOpt) Number of bytes allowed per injected file path quota_injected_files = 5 - (IntOpt) number of injected files allowed + (IntOpt) Number of injected files allowed quota_instances = 10 - (IntOpt) number of instances allowed per project + (IntOpt) Number of instances allowed per project quota_key_pairs = 100 - (IntOpt) number of key pairs per user + (IntOpt) Number of key pairs per user quota_metadata_items = 128 - (IntOpt) number of metadata items allowed per instance + (IntOpt) Number of metadata items allowed per instance quota_ram = 51200 - (IntOpt) megabytes of instance ram allowed per project + (IntOpt) Megabytes of instance RAM allowed per project quota_security_group_rules = 20 - (IntOpt) number of security rules per security group + (IntOpt) Number of security rules per security group quota_security_groups = 10 - (IntOpt) number of security groups per project + (IntOpt) Number of security groups per project [cells] diff --git a/doc/common/tables/nova-rabbitmq.xml b/doc/common/tables/nova-rabbitmq.xml index d568129688..a3b2e421f7 100644 --- a/doc/common/tables/nova-rabbitmq.xml +++ b/doc/common/tables/nova-rabbitmq.xml @@ -20,10 +20,10 @@ rabbit_ha_queues = False - (BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option. + (BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. - rabbit_host = localhost + rabbit_host = oslo (StrOpt) The RabbitMQ broker address where a single node is used @@ -32,11 +32,11 @@ rabbit_max_retries = 0 - (IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count) + (IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count) rabbit_password = guest - (StrOpt) the RabbitMQ password + (StrOpt) The RabbitMQ password rabbit_port = 5672 @@ -44,23 +44,23 @@ rabbit_retry_backoff = 2 - (IntOpt) how long to backoff for between retries when connecting to RabbitMQ + (IntOpt) How long to backoff for between retries when connecting to RabbitMQ rabbit_retry_interval = 1 - (IntOpt) how frequently to retry connecting with RabbitMQ + (IntOpt) How frequently to retry connecting with RabbitMQ rabbit_use_ssl = False - (BoolOpt) connect over SSL for RabbitMQ + (BoolOpt) Connect over SSL for RabbitMQ rabbit_userid = guest - (StrOpt) the RabbitMQ userid + (StrOpt) The RabbitMQ userid rabbit_virtual_host = / - (StrOpt) the RabbitMQ virtual host + (StrOpt) The RabbitMQ virtual host diff --git a/doc/common/tables/nova-rdp.xml b/doc/common/tables/nova-rdp.xml new file mode 100644 index 0000000000..b58fe1ff6e --- /dev/null +++ b/doc/common/tables/nova-rdp.xml @@ -0,0 +1,31 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of configuration options for rdp
Configuration option = Default valueDescription
[rdp]
enabled = False(BoolOpt) Enable RDP related features
html5_proxy_base_url = http://127.0.0.1:6083/(StrOpt) Location of RDP html5 console proxy, in the form "http://127.0.0.1:6083/"
+ diff --git a/doc/common/tables/nova-redis.xml b/doc/common/tables/nova-redis.xml index 6ce82f74f0..02dfe9ac0c 100644 --- a/doc/common/tables/nova-redis.xml +++ b/doc/common/tables/nova-redis.xml @@ -16,26 +16,18 @@ - [matchmaker_redis] - - - host = 127.0.0.1 - (StrOpt) Host to locate redis + [DEFAULT] password = None (StrOpt) Password for Redis server. (optional) - - port = 6379 - (IntOpt) Use this port to connect to redis host. - [remote_debug] host = None - (StrOpt) Debug host (ip or name) to connect. Note that using the remote debug option changes how Nova uses the eventlet library to support async IO. This could result in failures that do not occur under normal operation. Use at your own risk. + (StrOpt) Debug host (IP or name) to connect. Note that using the remote debug option changes how Nova uses the eventlet library to support async IO. This could result in failures that do not occur under normal operation. Use at your own risk. port = None diff --git a/doc/common/tables/nova-rpc.xml b/doc/common/tables/nova-rpc.xml index 571fa0f344..df4bca0683 100644 --- a/doc/common/tables/nova-rpc.xml +++ b/doc/common/tables/nova-rpc.xml @@ -28,7 +28,7 @@ control_exchange = openstack - (StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid + (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. matchmaker_heartbeat_freq = 300 @@ -39,8 +39,8 @@ (IntOpt) Heartbeat time-to-live. - rpc_backend = nova.openstack.common.rpc.impl_kombu - (StrOpt) The messaging module to use, defaults to kombu. + rpc_backend = rabbit + (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. rpc_cast_timeout = 30 @@ -52,11 +52,11 @@ rpc_response_timeout = 60 - (IntOpt) Seconds to wait for a response from call or multicall + (IntOpt) Seconds to wait for a response from a call rpc_thread_pool_size = 64 - (IntOpt) Size of RPC thread pool + (IntOpt) Size of RPC greenthread pool [cells] @@ -72,13 +72,6 @@ ringfile = /etc/oslo/matchmaker_ring.json (StrOpt) Matchmaker ring file (JSON) - - [rpc_notifier2] - - - topics = notifications - (ListOpt) AMQP topic(s) used for OpenStack notifications - [upgrade_levels] diff --git a/doc/common/tables/nova-s3.xml b/doc/common/tables/nova-s3.xml index 5343597b25..13efc4b1d5 100644 --- a/doc/common/tables/nova-s3.xml +++ b/doc/common/tables/nova-s3.xml @@ -20,23 +20,23 @@ buckets_path = $state_path/buckets - (StrOpt) path to s3 buckets + (StrOpt) Path to S3 buckets image_decryption_dir = /tmp - (StrOpt) parent dir for tempdir used for image decryption + (StrOpt) Parent directory for tempdir used for image decryption s3_access_key = notchecked - (StrOpt) access key to use for s3 server for images + (StrOpt) Access key to use for S3 server for images s3_affix_tenant = False - (BoolOpt) whether to affix the tenant id to the access key when downloading from s3 + (BoolOpt) Whether to affix the tenant id to the access key when downloading from S3 s3_host = $my_ip - (StrOpt) hostname or ip for OpenStack to use when accessing the s3 api + (StrOpt) Hostname or IP for OpenStack to use when accessing the S3 api s3_listen = 0.0.0.0 @@ -44,19 +44,19 @@ s3_listen_port = 3333 - (IntOpt) port for s3 api to listen + (IntOpt) Port for S3 API to listen s3_port = 3333 - (IntOpt) port used when accessing the s3 api + (IntOpt) Port used when accessing the S3 api s3_secret_key = notchecked - (StrOpt) secret key to use for s3 server for images + (StrOpt) Secret key to use for S3 server for images s3_use_ssl = False - (BoolOpt) whether to use ssl when talking to s3 + (BoolOpt) Whether to use SSL when talking to S3 diff --git a/doc/common/tables/nova-scheduling.xml b/doc/common/tables/nova-scheduling.xml index 54cb3d7286..9688b7eefe 100644 --- a/doc/common/tables/nova-scheduling.xml +++ b/doc/common/tables/nova-scheduling.xml @@ -32,7 +32,7 @@ disk_allocation_ratio = 1.0 - (FloatOpt) virtual disk to physical disk allocation ratio + (FloatOpt) Virtual disk to physical disk allocation ratio isolated_hosts = @@ -82,6 +82,10 @@ scheduler_driver = nova.scheduler.filter_scheduler.FilterScheduler (StrOpt) Default driver to use for the scheduler + + scheduler_driver_task_period = 60 + (IntOpt) How often (in seconds) to run periodic tasks in the scheduler driver of your choice. Please note this is likely to interact with the value of service_down_time, but exactly how they interact will depend on your choice of scheduler driver. + scheduler_host_manager = nova.scheduler.host_manager.HostManager (StrOpt) The scheduler host manager class to use @@ -96,7 +100,7 @@ scheduler_manager = nova.scheduler.manager.SchedulerManager - (StrOpt) full class name for the Manager for scheduler + (StrOpt) Full class name for the Manager for scheduler scheduler_max_attempts = 3 @@ -104,7 +108,7 @@ scheduler_topic = scheduler - (StrOpt) the topic scheduler nodes listen on + (StrOpt) The topic scheduler nodes listen on scheduler_weight_classes = nova.scheduler.weights.all_weighers @@ -119,7 +123,7 @@ scheduler_filter_classes = nova.cells.filters.all_filters - (ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters"maps to all cells filters included with nova. + (ListOpt) Filter classes the cells scheduler should use. An entry of "nova.cells.filters.all_filters" maps to all cells filters included with nova. scheduler_retries = 10 @@ -131,18 +135,26 @@ scheduler_weight_classes = nova.cells.weights.all_weighers - (ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers"maps to all cell weighers included with nova. + (ListOpt) Weigher classes the cells scheduler should use. An entry of "nova.cells.weights.all_weighers" maps to all cell weighers included with nova. [metrics] + + required = True + (BoolOpt) How to treat the unavailable metrics. When a metric is NOT available for a host, if it is set to be True, it would raise an exception, so it is recommended to use the scheduler filter MetricFilter to filter out those hosts. If it is set to be False, the unavailable metric would be treated as a negative factor in weighing process, the returned value would be set by the option weight_of_unavailable. + weight_multiplier = 1.0 (FloatOpt) Multiplier used for weighing metrics. + + weight_of_unavailable = -10000.0 + (FloatOpt) The final weight value to be returned if required is set to False and any one of the metrics set by weight_setting is unavailable. + weight_setting = - (ListOpt) How the metrics are going to be weighed. This should be in the form of "<name1>=<ratio1>, <name2>=<ratio2>, ...", where <nameX> is one of the metric to be weighed, and <ratioX> is the corresponding ratio. So for "name1=1.0, name2=-1.0" The final weight would be name1.value * 1.0 + name2.value * -1.0. + (ListOpt) How the metrics are going to be weighed. This should be in the form of "<name1>=<ratio1>, <name2>=<ratio2>, ...", where <nameX> is one of the metrics to be weighed, and <ratioX> is the corresponding ratio. So for "name1=1.0, name2=-1.0" The final weight would be name1.value * 1.0 + name2.value * -1.0. diff --git a/doc/common/tables/nova-spice.xml b/doc/common/tables/nova-spice.xml index 4d5d75c71b..21314528af 100644 --- a/doc/common/tables/nova-spice.xml +++ b/doc/common/tables/nova-spice.xml @@ -20,19 +20,19 @@ agent_enabled = True - (BoolOpt) enable spice guest agent support + (BoolOpt) Enable spice guest agent support enabled = False - (BoolOpt) enable spice related features + (BoolOpt) Enable spice related features html5proxy_base_url = http://127.0.0.1:6082/spice_auto.html - (StrOpt) location of spice html5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html" + (StrOpt) Location of spice HTML5 console proxy, in the form "http://127.0.0.1:6082/spice_auto.html" keymap = en-us - (StrOpt) keymap for spice + (StrOpt) Keymap for spice server_listen = 127.0.0.1 @@ -40,7 +40,7 @@ server_proxyclient_address = 127.0.0.1 - (StrOpt) the address to which proxy clients (like nova-spicehtml5proxy) should connect + (StrOpt) The address to which proxy clients (like nova-spicehtml5proxy) should connect diff --git a/doc/common/tables/nova-testing.xml b/doc/common/tables/nova-testing.xml index 4293733f66..3a2d23f012 100644 --- a/doc/common/tables/nova-testing.xml +++ b/doc/common/tables/nova-testing.xml @@ -19,7 +19,7 @@ [DEFAULT] - allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions + allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions (ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call. diff --git a/doc/common/tables/nova-tilera.xml b/doc/common/tables/nova-tilera.xml index 8a0cbde507..43c8e9b194 100644 --- a/doc/common/tables/nova-tilera.xml +++ b/doc/common/tables/nova-tilera.xml @@ -20,27 +20,27 @@ tile_pdu_ip = 10.0.100.1 - (StrOpt) ip address of tilera pdu + (StrOpt) IP address of tilera pdu tile_pdu_mgr = /tftpboot/pdu_mgr - (StrOpt) management script for tilera pdu + (StrOpt) Management script for tilera pdu tile_pdu_off = 2 - (IntOpt) power status of tilera PDU is OFF + (IntOpt) Power status of tilera PDU is OFF tile_pdu_on = 1 - (IntOpt) power status of tilera PDU is ON + (IntOpt) Power status of tilera PDU is ON tile_pdu_status = 9 - (IntOpt) power status of tilera PDU + (IntOpt) Power status of tilera PDU tile_power_wait = 9 - (IntOpt) wait time in seconds until check the result after tilera power operations + (IntOpt) Wait time in seconds until check the result after tilera power operations diff --git a/doc/common/tables/nova-trustedcomputing.xml b/doc/common/tables/nova-trustedcomputing.xml index 217fb7cc8e..a78596c310 100644 --- a/doc/common/tables/nova-trustedcomputing.xml +++ b/doc/common/tables/nova-trustedcomputing.xml @@ -20,11 +20,11 @@ attestation_api_url = /OpenAttestationWebServices/V1.0 - (StrOpt) attestation web API URL + (StrOpt) Attestation web API URL attestation_auth_blob = None - (StrOpt) attestation authorization blob - must change + (StrOpt) Attestation authorization blob - must change attestation_auth_timeout = 60 @@ -32,15 +32,15 @@ attestation_port = 8443 - (StrOpt) attestation server port + (StrOpt) Attestation server port attestation_server = None - (StrOpt) attestation server http + (StrOpt) Attestation server HTTP attestation_server_ca_file = None - (StrOpt) attestation server Cert file for Identity verification + (StrOpt) Attestation server Cert file for Identity verification diff --git a/doc/common/tables/nova-upgrade_levels.xml b/doc/common/tables/nova-upgrade_levels.xml index e9bfccd2d6..7c1f037961 100644 --- a/doc/common/tables/nova-upgrade_levels.xml +++ b/doc/common/tables/nova-upgrade_levels.xml @@ -35,7 +35,7 @@ compute = None - (StrOpt) Set a version cap for messages sent to compute services + (StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from havana to icehouse, you should set this option to "icehouse-compat" before beginning the live upgrade procedure. conductor = None diff --git a/doc/common/tables/nova-vmware.xml b/doc/common/tables/nova-vmware.xml index bf38244c2e..28249e6c17 100644 --- a/doc/common/tables/nova-vmware.xml +++ b/doc/common/tables/nova-vmware.xml @@ -28,7 +28,7 @@ datastore_regex = None - (StrOpt) Regex to match the name of a datastore. Used only if compute_driver is vmwareapi.VMwareVCDriver. + (StrOpt) Regex to match the name of a datastore. host_ip = None @@ -51,7 +51,7 @@ (IntOpt) The maximum number of ObjectContent data objects that should be returned in a single result. A positive value will cause the operation to suspend the retrieval when the count of objects reaches the specified maximum. The server may still limit the count to something less than the configured value. Any remaining objects may be retrieved with additional requests. - task_poll_interval = 5.0 + task_poll_interval = 0.5 (FloatOpt) The interval used for polling of remote tasks. diff --git a/doc/common/tables/nova-vnc.xml b/doc/common/tables/nova-vnc.xml index 6add230d39..6b82f8a886 100644 --- a/doc/common/tables/nova-vnc.xml +++ b/doc/common/tables/nova-vnc.xml @@ -20,15 +20,15 @@ novncproxy_base_url = http://127.0.0.1:6080/vnc_auto.html - (StrOpt) location of vnc console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html" + (StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html" vnc_enabled = True - (BoolOpt) enable vnc related features + (BoolOpt) Enable VNC related features vnc_keymap = en-us - (StrOpt) keymap for vnc + (StrOpt) Keymap for VNC vncserver_listen = 127.0.0.1 @@ -36,7 +36,7 @@ vncserver_proxyclient_address = 127.0.0.1 - (StrOpt) the address to which proxy clients (like nova-xvpvncproxy) should connect + (StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect [vmware] diff --git a/doc/common/tables/nova-volumes.xml b/doc/common/tables/nova-volumes.xml index de8909a713..c8ce5b9de9 100644 --- a/doc/common/tables/nova-volumes.xml +++ b/doc/common/tables/nova-volumes.xml @@ -28,7 +28,7 @@ cinder_catalog_info = volume:cinder:publicURL - (StrOpt) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: <service_type>:<service_name>:<endpoint_type> + (StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: <service_type>:<service_name>:<endpoint_type> cinder_cross_az_attach = True @@ -44,7 +44,7 @@ os_region_name = None - (StrOpt) region name of this node + (StrOpt) Region name of this node volume_api_class = nova.volume.cinder.API @@ -59,7 +59,7 @@ iscsi_iqn_prefix = iqn.2010-10.org.openstack.baremetal - (StrOpt) iSCSI IQN prefix used in baremetal volume connections. + (StrOpt) The iSCSI IQN prefix used in baremetal volume connections. volume_driver = nova.virt.baremetal.volume_driver.LibvirtVolumeDriver @@ -85,27 +85,27 @@ glusterfs_mount_point_base = $state_path/mnt - (StrOpt) Dir where the glusterfs volume is mounted on the compute node + (StrOpt) Directory where the glusterfs volume is mounted on the compute node nfs_mount_options = None - (StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details + (StrOpt) Mount options passedf to the NFS client. See section of the nfs man page for details nfs_mount_point_base = $state_path/mnt - (StrOpt) Dir where the nfs volume is mounted on the compute node + (StrOpt) Directory where the NFS volume is mounted on the compute node num_aoe_discover_tries = 3 - (IntOpt) number of times to rediscover AoE target to find volume + (IntOpt) Number of times to rediscover AoE target to find volume - num_iscsi_scan_tries = 3 - (IntOpt) number of times to rescan iSCSI target to find volume + num_iscsi_scan_tries = 5 + (IntOpt) Number of times to rescan iSCSI target to find volume - num_iser_scan_tries = 3 - (IntOpt) number of times to rescan iSER target to find volume + num_iser_scan_tries = 5 + (IntOpt) Number of times to rescan iSER target to find volume qemu_allowed_storage_drivers = @@ -113,11 +113,11 @@ rbd_secret_uuid = None - (StrOpt) the libvirt uuid of the secret for the rbd_uservolumes + (StrOpt) The libvirt UUID of the secret for the rbd_uservolumes rbd_user = None - (StrOpt) the RADOS client name for accessing rbd volumes + (StrOpt) The RADOS client name for accessing rbd volumes scality_sofs_config = None diff --git a/doc/common/tables/nova-vpn.xml b/doc/common/tables/nova-vpn.xml index 72546ce39f..8bf7de417c 100644 --- a/doc/common/tables/nova-vpn.xml +++ b/doc/common/tables/nova-vpn.xml @@ -40,7 +40,7 @@ vpn_image_id = 0 - (StrOpt) image id used when starting up a cloudpipe vpn server + (StrOpt) Image ID used when starting up a cloudpipe vpn server vpn_ip = $my_ip diff --git a/doc/common/tables/nova-xen.xml b/doc/common/tables/nova-xen.xml index d892b82129..d5d4532dbd 100644 --- a/doc/common/tables/nova-xen.xml +++ b/doc/common/tables/nova-xen.xml @@ -24,15 +24,15 @@ console_vmrc_error_retries = 10 - (IntOpt) number of retries for retrieving VMRC information + (IntOpt) Number of retries for retrieving VMRC information console_vmrc_port = 443 - (IntOpt) port for VMware VMRC connections + (IntOpt) Port for VMware VMRC connections console_xvp_conf = /etc/xvp.conf - (StrOpt) generated XVP conf file + (StrOpt) Generated XVP conf file console_xvp_conf_template = $pybasedir/nova/console/xvp.conf.template @@ -44,7 +44,7 @@ console_xvp_multiplex_port = 5900 - (IntOpt) port for XVP to multiplex VNC connections on + (IntOpt) Port for XVP to multiplex VNC connections on console_xvp_pid = /var/run/xvp.pid @@ -66,19 +66,19 @@ agent_path = usr/sbin/xe-update-networking - (StrOpt) Specifies the path in which the xenapi guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True + (StrOpt) Specifies the path in which the XenAPI guest agent should be located. If the agent is present, network configuration is not injected into the image. Used if compute_driver=xenapi.XenAPIDriver and flat_injected=True agent_resetnetwork_timeout = 60 - (IntOpt) number of seconds to wait for agent reply to resetnetwork request + (IntOpt) Number of seconds to wait for agent reply to resetnetwork request agent_timeout = 30 - (IntOpt) number of seconds to wait for agent reply + (IntOpt) Number of seconds to wait for agent reply agent_version_timeout = 300 - (IntOpt) number of seconds to wait for agent to be fully operational + (IntOpt) Number of seconds to wait for agent to be fully operational cache_images = all @@ -120,6 +120,10 @@ image_upload_handler = nova.virt.xenapi.image.glance.GlanceStore (StrOpt) Dom0 plugin driver used to handle image uploads. + + introduce_vdi_retry_wait = 20 + (IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced + ipxe_boot_menu_url = None (StrOpt) URL to the iPXE boot menu @@ -162,7 +166,7 @@ running_timeout = 60 - (IntOpt) number of seconds to wait for instance to go to running state + (IntOpt) Number of seconds to wait for instance to go to running state sparse_copy = True @@ -178,11 +182,11 @@ target_host = None - (StrOpt) iSCSI Target Host + (StrOpt) The iSCSI Target Host target_port = 3260 - (StrOpt) iSCSI Target Port, 3260 Default + (StrOpt) The iSCSI Target Port, default is port 3260 torrent_base_url = None @@ -222,14 +226,14 @@ use_agent_default = False - (BoolOpt) Determines if the xenapi agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "true" or "false". Note that waiting for the agent when it is not present will significantly increase server boot times. + (BoolOpt) Determines if the XenAPI agent should be used when the image used does not contain a hint to declare if the agent is present or not. The hint is a glance property "xenapi_use_agent" that has the value "True" or "False". Note that waiting for the agent when it is not present will significantly increase server boot times. use_join_force = True (BoolOpt) To use for hosts with different CPUs - vhd_coalesce_max_attempts = 5 + vhd_coalesce_max_attempts = 20 (IntOpt) Max number of times to poll for VHD to coalesce. Used only if compute_driver=xenapi.XenAPIDriver diff --git a/doc/common/tables/nova-xvpnvncproxy.xml b/doc/common/tables/nova-xvpnvncproxy.xml index c623b136c1..47017c9b39 100644 --- a/doc/common/tables/nova-xvpnvncproxy.xml +++ b/doc/common/tables/nova-xvpnvncproxy.xml @@ -20,7 +20,7 @@ xvpvncproxy_base_url = http://127.0.0.1:6081/console - (StrOpt) location of nova xvp vnc console proxy, in the form "http://127.0.0.1:6081/console" + (StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console" xvpvncproxy_host = 0.0.0.0 diff --git a/doc/common/tables/nova-zeromq.xml b/doc/common/tables/nova-zeromq.xml index 56ce043e32..9638aad1f5 100644 --- a/doc/common/tables/nova-zeromq.xml +++ b/doc/common/tables/nova-zeromq.xml @@ -35,7 +35,7 @@ (StrOpt) Directory for holding IPC sockets - rpc_zmq_matchmaker = nova.openstack.common.rpc.matchmaker.MatchMakerLocalhost + rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost (StrOpt) MatchMaker driver diff --git a/doc/common/tables/nova-zookeeper.xml b/doc/common/tables/nova-zookeeper.xml index 0f0a4f5cb8..c71889cd2d 100644 --- a/doc/common/tables/nova-zookeeper.xml +++ b/doc/common/tables/nova-zookeeper.xml @@ -24,7 +24,7 @@ recv_timeout = 4000 - (IntOpt) recv_timeout parameter for the zk session + (IntOpt) The recv_timeout parameter for the zk session sg_prefix = /servicegroups diff --git a/tools/autogenerate-config-flagmappings/nova.flagmappings b/tools/autogenerate-config-flagmappings/nova.flagmappings index 0a031d6805..16b660c4b9 100644 --- a/tools/autogenerate-config-flagmappings/nova.flagmappings +++ b/tools/autogenerate-config-flagmappings/nova.flagmappings @@ -125,7 +125,6 @@ glance_port glance glance_protocol glance heal_instance_info_cache_interval compute host common -host_state_interval compute image_cache_manager_interval compute image_cache_subdirectory_name compute image_decryption_dir s3 @@ -184,6 +183,7 @@ logging_exception_prefix logging matchmaker_heartbeat_freq rpc matchmaker_heartbeat_ttl rpc max_age policy +max_header_line api max_instances_per_host scheduling max_io_ops_per_host scheduling max_local_block_devices policy @@ -212,6 +212,7 @@ network_topic network networks_path network neutron_admin_auth_url neutron neutron_admin_password neutron +neutron_admin_tenant_id neutron neutron_admin_tenant_name neutron neutron_admin_username neutron neutron_api_insecure neutron @@ -245,6 +246,7 @@ osapi_hide_server_address_states api osapi_max_limit policy osapi_max_request_body_size policy ovs_vsctl_timeout network +password redis password_length policy pci_alias pci pci_passthrough_whitelist pci @@ -252,6 +254,7 @@ periodic_enable periodic periodic_fuzzy_delay periodic policy_default_rule policy policy_file policy +port common preallocate_images hypervisor project_cert_subject ca public_interface network @@ -336,6 +339,7 @@ s3_use_ssl s3 scheduler_available_filters scheduling scheduler_default_filters scheduling scheduler_driver scheduling +scheduler_driver_task_period scheduling scheduler_host_manager scheduling scheduler_host_subset_size scheduling scheduler_json_config_location scheduling @@ -366,9 +370,11 @@ tcp_keepidle wsgi teardown_unused_network_gateway network tempdir common timeout_nbd hypervisor +transport_url common until_refresh policy update_dns_entries network use-syslog logging +use-syslog-rfc-format logging use_cow_images hypervisor use_forwarded_for api use_ipv6 ipv6 @@ -488,6 +494,8 @@ hyperv/force_hyperv_utils_v1 hyperv hyperv/force_volumeutils_v1 volumes hyperv/instances_path_share hyperv hyperv/limit_cpu_features hyperv +hyperv/mounted_disk_query_retry_count hyperv +hyperv/mounted_disk_query_retry_interval hyperv hyperv/qemu_img_cmd hyperv hyperv/volume_attach_retry_count volumes hyperv/volume_attach_retry_interval volumes @@ -517,7 +525,6 @@ libvirt/iser_use_multipath hypervisor libvirt/live_migration_bandwidth livemigration libvirt/live_migration_flag livemigration libvirt/live_migration_uri livemigration -libvirt/lvm_snapshot_size hypervisor libvirt/nfs_mount_options volumes libvirt/nfs_mount_point_base volumes libvirt/num_aoe_discover_tries volumes @@ -531,6 +538,7 @@ libvirt/remove_unused_resized_minimum_age_seconds libvirt libvirt/rescue_image_id hypervisor libvirt/rescue_kernel_id hypervisor libvirt/rescue_ramdisk_id hypervisor +libvirt/rng_dev_path libvirt libvirt/scality_sofs_config volumes libvirt/scality_sofs_mount_point volumes libvirt/snapshot_compression hypervisor @@ -541,21 +549,23 @@ libvirt/use_usb_tablet hypervisor libvirt/use_virtio_for_bridges hypervisor libvirt/vif_driver libvirt libvirt/virt_type libvirt +libvirt/volume_clear libvirt +libvirt/volume_clear_size libvirt libvirt/volume_drivers libvirt libvirt/wait_soft_reboot_seconds libvirt libvirt/xen_hvmloader_path xen -matchmaker_redis/host redis -matchmaker_redis/password redis -matchmaker_redis/port redis matchmaker_ring/ringfile rpc +metrics/required scheduling metrics/weight_multiplier scheduling +metrics/weight_of_unavailable scheduling metrics/weight_setting scheduling osapi_v3/enabled apiv3 osapi_v3/extensions_blacklist apiv3 osapi_v3/extensions_whitelist apiv3 +rdp/enabled rdp +rdp/html5_proxy_base_url rdp remote_debug/host redis remote_debug/port redis -rpc_notifier2/topics rpc spice/agent_enabled spice spice/enabled spice spice/html5proxy_base_url spice @@ -610,6 +620,7 @@ xenserver/default_os_type xen xenserver/disable_agent xen xenserver/image_compression_level xen xenserver/image_upload_handler xen +xenserver/introduce_vdi_retry_wait xen xenserver/ipxe_boot_menu_url xen xenserver/ipxe_mkisofs_cmd xen xenserver/ipxe_network_name xen