Config Reference update options and regenerate

Move some generic hypervisor variables to libvirt.
Regenerate against current nova master, mark new options and add new
tables.
Reference new tables in Config Reference.

Change-Id: I87a4e5e7e8284e36b365f60f26ab0bee7126fdd6
Closes-Bug: #1267316
Closes-Bug: #1367224
Closes-Bug: #1367012
This commit is contained in:
Andreas Jaeger 2014-09-09 21:46:47 +02:00
parent 34220ea5ec
commit 97b970b8c7
10 changed files with 247 additions and 118 deletions

View File

@ -26,55 +26,55 @@
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
<td>(StrOpt) The back end to use for the database.</td>
</tr>
<tr>
<td>connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
</tr>
<tr>
<td>connection_debug = 0</td>
<td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr>
<tr>
<td>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
<td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
<td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
<td>(IntOpt) Seconds between database connection retries.</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
<td>(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>mysql_sql_mode = TRADITIONAL</td>
@ -82,27 +82,27 @@
</tr>
<tr>
<td>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr>
<tr>
<td>retry_interval = 10</td>
<td>(IntOpt) Interval between retries of opening a sql connection</td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr>
<tr>
<td>slave_connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
</tr>
<tr>
<td>sqlite_db = nova.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
<td>sqlite_db = oslo.sqlite</td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr>
<tr>
<td>use_tpool = False</td>

View File

@ -0,0 +1,34 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_nova_ephemeral_storage_encryption">
<caption>Description of ephemeral storage encryption configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[ephemeral_storage_encryption]</th>
</tr>
<tr>
<td>cipher = aes-xts-plain64</td>
<td>(StrOpt) The cipher and mode to be used to encrypt ephemeral storage. Which ciphers are available ciphers depends on kernel support. See /proc/crypto for the list of available options.</td>
</tr>
<tr>
<td>enabled = False</td>
<td>(BoolOpt) Whether to encrypt ephemeral storage</td>
</tr>
<tr>
<td>key_size = 512</td>
<td>(IntOpt) The bit length of the encryption key to be used to encrypt ephemeral storage (in XTS mode only half of the bits are used for encryption key)</td>
</tr>
</tbody>
</table>
</para>

View File

@ -45,85 +45,6 @@
<td>virt_mkfs = []</td>
<td>(MultiStrOpt) Name of the mkfs commands for ephemeral device. The format is &lt;os_type&gt;=&lt;mkfs command&gt;</td>
</tr>
<tr>
<th colspan="2">[libvirt]</th>
</tr>
<tr>
<td>block_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_LIVE, VIR_MIGRATE_TUNNELLED, VIR_MIGRATE_NON_SHARED_INC</td>
<td>(StrOpt) Migration flags to be set for block migration</td>
</tr>
<tr>
<td>disk_cachemodes = </td>
<td>(ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none</td>
</tr>
<tr>
<td>images_rbd_ceph_conf = </td>
<td>(StrOpt) Path to the ceph configuration file to use</td>
</tr>
<tr>
<td>images_rbd_pool = rbd</td>
<td>(StrOpt) The RADOS pool in which rbd volumes are stored</td>
</tr>
<tr>
<td>images_type = default</td>
<td>(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.</td>
</tr>
<tr>
<td>images_volume_group = None</td>
<td>(StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm.</td>
</tr>
<tr>
<td>inject_key = False</td>
<td>(BoolOpt) Inject the ssh public key at boot time</td>
</tr>
<tr>
<td>inject_partition = -2</td>
<td>(IntOpt) The partition to inject to : -2 =&gt; disable, -1 =&gt; inspect (libguestfs only), 0 =&gt; not partitioned, &gt;0 =&gt; partition number</td>
</tr>
<tr>
<td>inject_password = False</td>
<td>(BoolOpt) Inject the admin password at boot time, without an agent.</td>
</tr>
<tr>
<td>iscsi_use_multipath = False</td>
<td>(BoolOpt) Use multipath connection of the iSCSI volume</td>
</tr>
<tr>
<td>iser_use_multipath = False</td>
<td>(BoolOpt) Use multipath connection of the iSER volume</td>
</tr>
<tr>
<td>rescue_image_id = None</td>
<td>(StrOpt) Rescue ami image. This will not be used if an image id is provided by the user.</td>
</tr>
<tr>
<td>rescue_kernel_id = None</td>
<td>(StrOpt) Rescue aki image</td>
</tr>
<tr>
<td>rescue_ramdisk_id = None</td>
<td>(StrOpt) Rescue ari image</td>
</tr>
<tr>
<td>snapshot_compression = False</td>
<td>(BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images</td>
</tr>
<tr>
<td>snapshot_image_format = None</td>
<td>(StrOpt) Snapshot image format (valid options are : raw, qcow2, vmdk, vdi). Defaults to same as source image</td>
</tr>
<tr>
<td>sparse_logical_volumes = False</td>
<td>(BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True.</td>
</tr>
<tr>
<td>use_usb_tablet = True</td>
<td>(BoolOpt) Sync virtual and real mouse cursors in Windows VMs</td>
</tr>
<tr>
<td>use_virtio_for_bridges = True</td>
<td>(BoolOpt) Use virtio for bridge interfaces with KVM/QEMU</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,62 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_nova_ironic">
<caption>Description of bare metal configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[ironic]</th>
</tr>
<tr>
<td>admin_auth_token = None</td>
<td>(StrOpt) Ironic keystone auth token.</td>
</tr>
<tr>
<td>admin_password = None</td>
<td>(StrOpt) Ironic keystone admin password.</td>
</tr>
<tr>
<td>admin_tenant_name = None</td>
<td>(StrOpt) Ironic keystone tenant name.</td>
</tr>
<tr>
<td>admin_url = None</td>
<td>(StrOpt) Keystone public API endpoint.</td>
</tr>
<tr>
<td>admin_username = None</td>
<td>(StrOpt) Ironic keystone admin name</td>
</tr>
<tr>
<td>api_endpoint = None</td>
<td>(StrOpt) URL for Ironic API endpoint.</td>
</tr>
<tr>
<td>api_max_retries = 60</td>
<td>(IntOpt) How many retries when a request does conflict.</td>
</tr>
<tr>
<td>api_retry_interval = 2</td>
<td>(IntOpt) How often to retry in seconds when a request does conflict</td>
</tr>
<tr>
<td>api_version = 1</td>
<td>(IntOpt) Version of Ironic API service endpoint.</td>
</tr>
<tr>
<td>client_log_level = None</td>
<td>(StrOpt) Log level override for ironicclient. Set this in order to override the global "default_log_levels", "verbose", and "debug" settings.</td>
</tr>
</tbody>
</table>
</para>

View File

@ -28,6 +28,10 @@
<tr>
<th colspan="2">[libvirt]</th>
</tr>
<tr>
<td>block_migration_flag = VIR_MIGRATE_UNDEFINE_SOURCE, VIR_MIGRATE_PEER2PEER, VIR_MIGRATE_LIVE, VIR_MIGRATE_TUNNELLED, VIR_MIGRATE_NON_SHARED_INC</td>
<td>(StrOpt) Migration flags to be set for block migration</td>
</tr>
<tr>
<td>checksum_base_images = False</td>
<td>(BoolOpt) Write a checksum for files in _base to disk</td>
@ -48,10 +52,18 @@
<td>cpu_model = None</td>
<td>(StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu"</td>
</tr>
<tr>
<td>disk_cachemodes = </td>
<td>(ListOpt) Specific cachemodes to use for different disk types e.g: file=directsync,block=none</td>
</tr>
<tr>
<td>disk_prefix = None</td>
<td>(StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd)</td>
</tr>
<tr>
<td>gid_maps = </td>
<td>(ListOpt) List of guid targets and ranges.Syntax is guest-gid:host-gid:countMaximum of 5 allowed.</td>
</tr>
<tr>
<td>hw_machine_type = None</td>
<td>(ListOpt) For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the "virsh capabilities"command. The format of the value for this config option is host-arch=machine-type. For example: x86_64=machinetype1,armv7l=machinetype2</td>
@ -60,6 +72,42 @@
<td>image_info_filename_pattern = $instances_path/$image_cache_subdirectory_name/%(image)s.info</td>
<td>(StrOpt) Allows image information files to be stored in non-standard locations</td>
</tr>
<tr>
<td>images_rbd_ceph_conf = </td>
<td>(StrOpt) Path to the ceph configuration file to use</td>
</tr>
<tr>
<td>images_rbd_pool = rbd</td>
<td>(StrOpt) The RADOS pool in which rbd volumes are stored</td>
</tr>
<tr>
<td>images_type = default</td>
<td>(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.</td>
</tr>
<tr>
<td>images_volume_group = None</td>
<td>(StrOpt) LVM Volume Group that is used for VM images, when you specify images_type=lvm.</td>
</tr>
<tr>
<td>inject_key = False</td>
<td>(BoolOpt) Inject the ssh public key at boot time</td>
</tr>
<tr>
<td>inject_partition = -2</td>
<td>(IntOpt) The partition to inject to : -2 =&gt; disable, -1 =&gt; inspect (libguestfs only), 0 =&gt; not partitioned, &gt;0 =&gt; partition number</td>
</tr>
<tr>
<td>inject_password = False</td>
<td>(BoolOpt) Inject the admin password at boot time, without an agent.</td>
</tr>
<tr>
<td>iscsi_use_multipath = False</td>
<td>(BoolOpt) Use multipath connection of the iSCSI volume</td>
</tr>
<tr>
<td>iser_use_multipath = False</td>
<td>(BoolOpt) Use multipath connection of the iSER volume</td>
</tr>
<tr>
<td>mem_stats_period_seconds = 10</td>
<td>(IntOpt) A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics.</td>
@ -72,18 +120,54 @@
<td>remove_unused_resized_minimum_age_seconds = 3600</td>
<td>(IntOpt) Unused resized base images younger than this will not be removed</td>
</tr>
<tr>
<td>rescue_image_id = None</td>
<td>(StrOpt) Rescue ami image. This will not be used if an image id is provided by the user.</td>
</tr>
<tr>
<td>rescue_kernel_id = None</td>
<td>(StrOpt) Rescue aki image</td>
</tr>
<tr>
<td>rescue_ramdisk_id = None</td>
<td>(StrOpt) Rescue ari image</td>
</tr>
<tr>
<td>rng_dev_path = None</td>
<td>(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</td>
</tr>
<tr>
<td>snapshot_compression = False</td>
<td>(BoolOpt) Compress snapshot images when possible. This currently applies exclusively to qcow2 images</td>
</tr>
<tr>
<td>snapshot_image_format = None</td>
<td>(StrOpt) Snapshot image format (valid options are : raw, qcow2, vmdk, vdi). Defaults to same as source image</td>
</tr>
<tr>
<td>snapshots_directory = $instances_path/snapshots</td>
<td>(StrOpt) Location where libvirt driver will store snapshots before uploading them to image service</td>
</tr>
<tr>
<td>sparse_logical_volumes = False</td>
<td>(BoolOpt) Create sparse logical volumes (with virtualsize) if this flag is set to True.</td>
</tr>
<tr>
<td>sysinfo_serial = auto</td>
<td>(StrOpt) The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS. Permitted options are "hardware", "os", "none" or "auto" (default).</td>
</tr>
<tr>
<td>uid_maps = </td>
<td>(ListOpt) List of uid targets and ranges.Syntax is guest-uid:host-uid:countMaximum of 5 allowed.</td>
</tr>
<tr>
<td>use_usb_tablet = True</td>
<td>(BoolOpt) Sync virtual and real mouse cursors in Windows VMs</td>
</tr>
<tr>
<td>use_virtio_for_bridges = True</td>
<td>(BoolOpt) Use virtio for bridge interfaces with KVM/QEMU</td>
</tr>
<tr>
<td>virt_type = kvm</td>
<td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen)</td>

View File

@ -41,6 +41,10 @@
<td>qpid_protocol = tcp</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td>qpid_receiver_capacity = 1</td>
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms = </td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>

View File

@ -81,6 +81,10 @@
<td>qpid_protocol = tcp</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td>qpid_receiver_capacity = 1</td>
<td>(IntOpt) The number of prefetched messages held by receiver.</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms = </td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>

View File

@ -23,10 +23,12 @@
<xi:include href="../../common/tables/nova-console.xml"/>
<xi:include href="../../common/tables/nova-database.xml"/>
<xi:include href="../../common/tables/nova-ec2.xml"/>
<xi:include href="../../common/tables/nova-ephemeral_storage_encryption.xml"/>
<xi:include href="../../common/tables/nova-fping.xml"/>
<xi:include href="../../common/tables/nova-glance.xml"/>
<xi:include href="../../common/tables/nova-hyperv.xml"/>
<xi:include href="../../common/tables/nova-hypervisor.xml"/>
<xi:include href="../../common/tables/nova-ironic.xml"/>
<xi:include href="../../common/tables/nova-ipv6.xml"/>
<xi:include href="../../common/tables/nova-keymgr.xml"/>
<xi:include href="../../common/tables/nova-ldap.xml"/>

View File

@ -240,6 +240,7 @@ qpid_hosts qpid rpc_all
qpid_password qpid rpc_all
qpid_port qpid rpc_all
qpid_protocol qpid rpc_all
qpid_receiver_capacity qpid rpc_all
qpid_sasl_mechanisms qpid rpc_all
qpid_tcp_nodelay qpid rpc_all
qpid_topology_version qpid rpc_all
@ -477,6 +478,9 @@ database/sqlite_db database
database/sqlite_synchronous database
database/use_db_reconnect database
database/use_tpool database
ephemeral_storage_encryption/cipher ephemeral_storage_encryption
ephemeral_storage_encryption/enabled ephemeral_storage_encryption
ephemeral_storage_encryption/key_size ephemeral_storage_encryption
glance/allowed_direct_url_schemes glance
glance/api_insecure glance
glance/api_servers glance
@ -500,6 +504,16 @@ hyperv/volume_attach_retry_interval volumes
hyperv/vswitch_name hyperv
hyperv/wait_soft_reboot_seconds hyperv
image_file_url/filesystems glance
ironic/admin_auth_token ironic
ironic/admin_password ironic
ironic/admin_tenant_name ironic
ironic/admin_url ironic
ironic/admin_username ironic
ironic/api_endpoint ironic
ironic/api_max_retries ironic
ironic/api_retry_interval ironic
ironic/api_version ironic
ironic/client_log_level ironic
keymgr/api_class keymgr
keymgr/fixed_key keymgr
keystone_authtoken/admin_password auth_token
@ -531,26 +545,27 @@ keystone_authtoken/memcached_servers auth_token
keystone_authtoken/revocation_cache_time auth_token
keystone_authtoken/signing_dir auth_token
keystone_authtoken/token_cache_time auth_token
libvirt/block_migration_flag hypervisor
libvirt/block_migration_flag libvirt
libvirt/checksum_base_images libvirt
libvirt/checksum_interval_seconds libvirt
libvirt/connection_uri libvirt
libvirt/cpu_mode libvirt
libvirt/cpu_model libvirt
libvirt/disk_cachemodes hypervisor
libvirt/disk_cachemodes libvirt
libvirt/disk_prefix libvirt
libvirt/gid_maps libvirt
libvirt/glusterfs_mount_point_base volumes
libvirt/hw_machine_type libvirt
libvirt/image_info_filename_pattern libvirt
libvirt/images_rbd_ceph_conf hypervisor
libvirt/images_rbd_pool hypervisor
libvirt/images_type hypervisor
libvirt/images_volume_group hypervisor
libvirt/inject_key hypervisor
libvirt/inject_partition hypervisor
libvirt/inject_password hypervisor
libvirt/iscsi_use_multipath hypervisor
libvirt/iser_use_multipath hypervisor
libvirt/images_rbd_ceph_conf libvirt
libvirt/images_rbd_pool libvirt
libvirt/images_type libvirt
libvirt/images_volume_group libvirt
libvirt/inject_key libvirt
libvirt/inject_partition libvirt
libvirt/inject_password libvirt
libvirt/iscsi_use_multipath libvirt
libvirt/iser_use_multipath libvirt
libvirt/live_migration_bandwidth livemigration
libvirt/live_migration_flag livemigration
libvirt/live_migration_uri livemigration
@ -565,19 +580,20 @@ libvirt/rbd_secret_uuid volumes
libvirt/rbd_user volumes
libvirt/remove_unused_kernels libvirt
libvirt/remove_unused_resized_minimum_age_seconds libvirt
libvirt/rescue_image_id hypervisor
libvirt/rescue_kernel_id hypervisor
libvirt/rescue_ramdisk_id hypervisor
libvirt/rescue_image_id libvirt
libvirt/rescue_kernel_id libvirt
libvirt/rescue_ramdisk_id libvirt
libvirt/rng_dev_path libvirt
libvirt/scality_sofs_config volumes
libvirt/scality_sofs_mount_point volumes
libvirt/snapshot_compression hypervisor
libvirt/snapshot_image_format hypervisor
libvirt/snapshot_compression libvirt
libvirt/snapshot_image_format libvirt
libvirt/snapshots_directory libvirt
libvirt/sparse_logical_volumes hypervisor
libvirt/sparse_logical_volumes libvirt
libvirt/sysinfo_serial libvirt
libvirt/use_usb_tablet hypervisor
libvirt/use_virtio_for_bridges hypervisor
libvirt/uid_maps libvirt
libvirt/use_usb_tablet libvirt
libvirt/use_virtio_for_bridges libvirt
libvirt/virt_type libvirt
libvirt/volume_clear libvirt
libvirt/volume_clear_size libvirt

View File

@ -8,9 +8,11 @@ conductor conductor
configdrive config drive
console console
ec2 EC2
ephemeral_storage_encryption ephemeral storage encryption
fping fping
hyperv HyperV
hypervisor hypervisor
ironic bare metal
ipv6 IPv6
keymgr key manager
kombu kombu