conf: Rename 'configuration drive' to 'config drive'

Keeps dansmith happy.

Change-Id: Ifd8537692de98ee02ff7333812d2877273a0a388
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Stephen Finucane
2019-03-07 16:42:49 +00:00
parent 92a432fde7
commit 81e4d13c32
7 changed files with 47 additions and 55 deletions

View File

@@ -1997,7 +1997,7 @@ code:
type: string type: string
config_drive: config_drive:
description: | description: |
Indicates whether a configuration drive enables metadata injection. The config_drive Indicates whether a config drive enables metadata injection. The config_drive
setting provides information about a drive that the instance can mount at boot setting provides information about a drive that the instance can mount at boot
time. The instance reads files from the drive to get information that is normally time. The instance reads files from the drive to get information that is normally
available through the metadata service. This metadata is different from the user available through the metadata service. This metadata is different from the user

View File

@@ -508,7 +508,7 @@ List Servers Detailed
.. rest_method:: GET /servers/detail .. rest_method:: GET /servers/detail
For each server, shows server details including configuration drive, For each server, shows server details including config drive,
extended status, and server usage information. extended status, and server usage information.
The extended status information appears in the OS-EXT-STS:vm_state, The extended status information appears in the OS-EXT-STS:vm_state,

View File

@@ -266,10 +266,9 @@ To disable injection in libvirt, set the following in ``nova.conf``:
.. note:: .. note::
If you have not enabled the configuration drive and you want to make If you have not enabled the config drive and you want to make user-specified
user-specified files available from the metadata server for to improve files available from the metadata server for to improve performance and
performance and avoid boot failure if injection fails, you must disable avoid boot failure if injection fails, you must disable injection.
injection.
Cannot find suitable emulator for x86_64 Cannot find suitable emulator for x86_64

View File

@@ -116,7 +116,7 @@ As with ``StaticJSON``, the service you must configure to enable the
``DynamicJSON`` vendordata module depends on how guests are accessing ``DynamicJSON`` vendordata module depends on how guests are accessing
vendordata. If using the metadata service, configuration applies to either vendordata. If using the metadata service, configuration applies to either
:program:`nova-api` or :program:`nova-api-metadata`, depending on the :program:`nova-api` or :program:`nova-api-metadata`, depending on the
deployment, while if using configuration drives, configuration applies to deployment, while if using config drives, configuration applies to
:program:`nova-compute`. However, configuration is otherwise the same and the :program:`nova-compute`. However, configuration is otherwise the same and the
following options apply: following options apply:

View File

@@ -30,10 +30,10 @@ necessary or useful.
('vfat', 'Provided for legacy reasons and to enable live ' ('vfat', 'Provided for legacy reasons and to enable live '
'migration with the libvirt driver and non-shared storage')], 'migration with the libvirt driver and non-shared storage')],
help=""" help="""
Configuration drive format Config drive format.
Configuration drive format that will contain metadata attached to the Config drive format that will contain metadata attached to the instance when it
instance when it boots. boots.
Related options: Related options:
@@ -46,24 +46,24 @@ Related options:
this is defined by ``img_config_drive`` property for that image. this is defined by ``img_config_drive`` property for that image.
* A compute node running Hyper-V hypervisor can be configured to attach * A compute node running Hyper-V hypervisor can be configured to attach
configuration drive as a CD drive. To attach the configuration drive as a CD config drive as a CD drive. To attach the config drive as a CD drive, set the
drive, set the ``[hyperv] config_drive_cdrom`` option to true. ``[hyperv] config_drive_cdrom`` option to true.
"""), """),
cfg.BoolOpt('force_config_drive', cfg.BoolOpt('force_config_drive',
default=False, default=False,
help=""" help="""
Force injection to take place on a config drive Force injection to take place on a config drive
When this option is set to true configuration drive functionality will be When this option is set to true config drive functionality will be forced
forced enabled by default, otherwise user can still enable configuration enabled by default, otherwise users can still enable config drives via the REST
drives via the REST API or image metadata properties. Launched VMs are not API or image metadata properties. Launched instances are not affected by this
affected by this option. option.
Possible values: Possible values:
* True: Force to use of configuration drive regardless the user's input in the * True: Force to use of config drive regardless the user's input in the
REST API call. REST API call.
* False: Do not force use of configuration drive. Config drives can still be * False: Do not force use of config drive. Config drives can still be
enabled via the REST API or image metadata properties. enabled via the REST API or image metadata properties.
Related options: Related options:
@@ -71,7 +71,7 @@ Related options:
* Use the 'mkisofs_cmd' flag to set the path where you install the * Use the 'mkisofs_cmd' flag to set the path where you install the
genisoimage program. If genisoimage is in same path as the genisoimage program. If genisoimage is in same path as the
nova-compute service, you do not need to set this flag. nova-compute service, you do not need to set this flag.
* To use configuration drive with Hyper-V, you must set the * To use a config drive with Hyper-V, you must set the
'mkisofs_cmd' value to the full path to an mkisofs.exe installation. 'mkisofs_cmd' value to the full path to an mkisofs.exe installation.
Additionally, you must set the qemu_img_cmd value in the hyperv Additionally, you must set the qemu_img_cmd value in the hyperv
configuration section to the full path to an qemu-img command configuration section to the full path to an qemu-img command
@@ -80,16 +80,16 @@ Related options:
cfg.StrOpt('mkisofs_cmd', cfg.StrOpt('mkisofs_cmd',
default='genisoimage', default='genisoimage',
help=""" help="""
Name or path of the tool used for ISO image creation Name or path of the tool used for ISO image creation.
Use the mkisofs_cmd flag to set the path where you install the genisoimage Use the ``mkisofs_cmd`` flag to set the path where you install the
program. If genisoimage is on the system path, you do not need to change ``genisoimage`` program. If ``genisoimage`` is on the system path, you do not
the default value. need to change the default value.
To use configuration drive with Hyper-V, you must set the mkisofs_cmd value To use a config drive with Hyper-V, you must set the ``mkisofs_cmd`` value to
to the full path to an mkisofs.exe installation. Additionally, you must set the full path to an ``mkisofs.exe`` installation. Additionally, you must set
the qemu_img_cmd value in the hyperv configuration section to the full path the ``qemu_img_cmd`` value in the hyperv configuration section to the full path
to an qemu-img command installation. to an ``qemu-img`` command installation.
Possible values: Possible values:
@@ -100,8 +100,8 @@ Possible values:
Related options: Related options:
* This option is meaningful when config drives are enabled. * This option is meaningful when config drives are enabled.
* To use configuration drive with Hyper-V, you must set the qemu_img_cmd * To use config drive with Hyper-V, you must set the ``qemu_img_cmd``
value in the hyperv configuration section to the full path to an qemu-img value in the hyperv configuration section to the full path to an ``qemu-img``
command installation. command installation.
"""), """),
] ]

View File

@@ -171,9 +171,9 @@ Possible values:
Related options: Related options:
* If the config_drive_cdrom option is False, qemu-img will be used to * If the config_drive_cdrom option is False, qemu-img will be used to
convert the ISO to a VHD, otherwise the configuration drive will convert the ISO to a VHD, otherwise the config drive will
remain an ISO. To use configuration drive with Hyper-V, you must remain an ISO. To use config drive with Hyper-V, you must
set the mkisofs_cmd value to the full path to an mkisofs.exe set the ``mkisofs_cmd`` value to the full path to an ``mkisofs.exe``
installation. installation.
"""), """),
cfg.StrOpt('vswitch_name', cfg.StrOpt('vswitch_name',
@@ -212,44 +212,37 @@ Possible values:
cfg.BoolOpt('config_drive_cdrom', cfg.BoolOpt('config_drive_cdrom',
default=False, default=False,
help=""" help="""
Configuration drive cdrom Mount config drive as a CD drive.
OpenStack can be configured to write instance metadata to OpenStack can be configured to write instance metadata to a config drive, which
a configuration drive, which is then attached to the is then attached to the instance before it boots. The config drive can be
instance before it boots. The configuration drive can be
attached as a disk drive (default) or as a CD drive. attached as a disk drive (default) or as a CD drive.
Possible values:
* True: Attach the configuration drive image as a CD drive.
* False: Attach the configuration drive image as a disk drive (Default).
Related options: Related options:
* This option is meaningful with force_config_drive option set to 'True' * This option is meaningful with ``force_config_drive`` option set to ``True``
or when the REST API call to create an instance will have or when the REST API call to create an instance will have
'--config-drive=True' flag. ``--config-drive=True`` flag.
* config_drive_format option must be set to 'iso9660' in order to use * ``config_drive_format`` option must be set to ``iso9660`` in order to use
CD drive as the configuration drive image. CD drive as the config drive image.
* To use configuration drive with Hyper-V, you must set the * To use config drive with Hyper-V, you must set the
mkisofs_cmd value to the full path to an mkisofs.exe installation. ``mkisofs_cmd`` value to the full path to an ``mkisofs.exe`` installation.
Additionally, you must set the qemu_img_cmd value to the full path Additionally, you must set the ``qemu_img_cmd`` value to the full path
to an qemu-img command installation. to an ``qemu-img`` command installation.
* You can configure the Compute service to always create a configuration * You can configure the Compute service to always create a configuration
drive by setting the force_config_drive option to 'True'. drive by setting the ``force_config_drive`` option to ``True``.
"""), """),
cfg.BoolOpt('config_drive_inject_password', cfg.BoolOpt('config_drive_inject_password',
default=False, default=False,
help=""" help="""
Configuration drive inject password Inject password to config drive.
Enables setting the admin password in the configuration drive image. When enabled, the admin password will be available from the config drive image.
Related options: Related options:
* This option is meaningful when used with other options that enable * This option is meaningful when used with other options that enable
configuration drive usage with Hyper-V, such as force_config_drive. config drive usage with Hyper-V, such as ``force_config_drive``.
* Currently, the only accepted config_drive_format is 'iso9660'.
"""), """),
cfg.IntOpt('volume_attach_retry_count', cfg.IntOpt('volume_attach_retry_count',
default=10, default=10,

View File

@@ -223,7 +223,7 @@ class DeleteDisk(task.Task):
class CreateAndConnectCfgDrive(task.Task): class CreateAndConnectCfgDrive(task.Task):
"""The task to create the configuration drive.""" """The task to create the config drive."""
def __init__(self, adapter, instance, injected_files, def __init__(self, adapter, instance, injected_files,
network_info, stg_ftsk, admin_pass=None): network_info, stg_ftsk, admin_pass=None):