Skip to content

Commit 81e4d13

Browse files
committed
conf: Rename 'configuration drive' to 'config drive'
Keeps dansmith happy. Change-Id: Ifd8537692de98ee02ff7333812d2877273a0a388 Signed-off-by: Stephen Finucane <[email protected]>
1 parent 92a432f commit 81e4d13

File tree

7 files changed

+47
-55
lines changed

7 files changed

+47
-55
lines changed

api-ref/source/parameters.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1997,7 +1997,7 @@ code:
19971997
type: string
19981998
config_drive:
19991999
description: |
2000-
Indicates whether a configuration drive enables metadata injection. The config_drive
2000+
Indicates whether a config drive enables metadata injection. The config_drive
20012001
setting provides information about a drive that the instance can mount at boot
20022002
time. The instance reads files from the drive to get information that is normally
20032003
available through the metadata service. This metadata is different from the user

api-ref/source/servers.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ List Servers Detailed
508508

509509
.. rest_method:: GET /servers/detail
510510

511-
For each server, shows server details including configuration drive,
511+
For each server, shows server details including config drive,
512512
extended status, and server usage information.
513513

514514
The extended status information appears in the OS-EXT-STS:vm_state,

doc/source/admin/support-compute.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -266,10 +266,9 @@ To disable injection in libvirt, set the following in ``nova.conf``:
266266
267267
.. note::
268268

269-
If you have not enabled the configuration drive and you want to make
270-
user-specified files available from the metadata server for to improve
271-
performance and avoid boot failure if injection fails, you must disable
272-
injection.
269+
If you have not enabled the config drive and you want to make user-specified
270+
files available from the metadata server for to improve performance and
271+
avoid boot failure if injection fails, you must disable injection.
273272

274273

275274
Cannot find suitable emulator for x86_64

doc/source/admin/vendordata.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ As with ``StaticJSON``, the service you must configure to enable the
116116
``DynamicJSON`` vendordata module depends on how guests are accessing
117117
vendordata. If using the metadata service, configuration applies to either
118118
:program:`nova-api` or :program:`nova-api-metadata`, depending on the
119-
deployment, while if using configuration drives, configuration applies to
119+
deployment, while if using config drives, configuration applies to
120120
:program:`nova-compute`. However, configuration is otherwise the same and the
121121
following options apply:
122122

nova/conf/configdrive.py

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@
3030
('vfat', 'Provided for legacy reasons and to enable live '
3131
'migration with the libvirt driver and non-shared storage')],
3232
help="""
33-
Configuration drive format
33+
Config drive format.
3434
35-
Configuration drive format that will contain metadata attached to the
36-
instance when it boots.
35+
Config drive format that will contain metadata attached to the instance when it
36+
boots.
3737
3838
Related options:
3939
@@ -46,32 +46,32 @@
4646
this is defined by ``img_config_drive`` property for that image.
4747
4848
* A compute node running Hyper-V hypervisor can be configured to attach
49-
configuration drive as a CD drive. To attach the configuration drive as a CD
50-
drive, set the ``[hyperv] config_drive_cdrom`` option to true.
49+
config drive as a CD drive. To attach the config drive as a CD drive, set the
50+
``[hyperv] config_drive_cdrom`` option to true.
5151
"""),
5252
cfg.BoolOpt('force_config_drive',
5353
default=False,
5454
help="""
5555
Force injection to take place on a config drive
5656
57-
When this option is set to true configuration drive functionality will be
58-
forced enabled by default, otherwise user can still enable configuration
59-
drives via the REST API or image metadata properties. Launched VMs are not
60-
affected by this option.
57+
When this option is set to true config drive functionality will be forced
58+
enabled by default, otherwise users can still enable config drives via the REST
59+
API or image metadata properties. Launched instances are not affected by this
60+
option.
6161
6262
Possible values:
6363
64-
* True: Force to use of configuration drive regardless the user's input in the
64+
* True: Force to use of config drive regardless the user's input in the
6565
REST API call.
66-
* False: Do not force use of configuration drive. Config drives can still be
66+
* False: Do not force use of config drive. Config drives can still be
6767
enabled via the REST API or image metadata properties.
6868
6969
Related options:
7070
7171
* Use the 'mkisofs_cmd' flag to set the path where you install the
7272
genisoimage program. If genisoimage is in same path as the
7373
nova-compute service, you do not need to set this flag.
74-
* To use configuration drive with Hyper-V, you must set the
74+
* To use a config drive with Hyper-V, you must set the
7575
'mkisofs_cmd' value to the full path to an mkisofs.exe installation.
7676
Additionally, you must set the qemu_img_cmd value in the hyperv
7777
configuration section to the full path to an qemu-img command
@@ -80,16 +80,16 @@
8080
cfg.StrOpt('mkisofs_cmd',
8181
default='genisoimage',
8282
help="""
83-
Name or path of the tool used for ISO image creation
83+
Name or path of the tool used for ISO image creation.
8484
85-
Use the mkisofs_cmd flag to set the path where you install the genisoimage
86-
program. If genisoimage is on the system path, you do not need to change
87-
the default value.
85+
Use the ``mkisofs_cmd`` flag to set the path where you install the
86+
``genisoimage`` program. If ``genisoimage`` is on the system path, you do not
87+
need to change the default value.
8888
89-
To use configuration drive with Hyper-V, you must set the mkisofs_cmd value
90-
to the full path to an mkisofs.exe installation. Additionally, you must set
91-
the qemu_img_cmd value in the hyperv configuration section to the full path
92-
to an qemu-img command installation.
89+
To use a config drive with Hyper-V, you must set the ``mkisofs_cmd`` value to
90+
the full path to an ``mkisofs.exe`` installation. Additionally, you must set
91+
the ``qemu_img_cmd`` value in the hyperv configuration section to the full path
92+
to an ``qemu-img`` command installation.
9393
9494
Possible values:
9595
@@ -100,8 +100,8 @@
100100
Related options:
101101
102102
* This option is meaningful when config drives are enabled.
103-
* To use configuration drive with Hyper-V, you must set the qemu_img_cmd
104-
value in the hyperv configuration section to the full path to an qemu-img
103+
* To use config drive with Hyper-V, you must set the ``qemu_img_cmd``
104+
value in the hyperv configuration section to the full path to an ``qemu-img``
105105
command installation.
106106
"""),
107107
]

nova/conf/hyperv.py

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,9 @@
171171
Related options:
172172
173173
* If the config_drive_cdrom option is False, qemu-img will be used to
174-
convert the ISO to a VHD, otherwise the configuration drive will
175-
remain an ISO. To use configuration drive with Hyper-V, you must
176-
set the mkisofs_cmd value to the full path to an mkisofs.exe
174+
convert the ISO to a VHD, otherwise the config drive will
175+
remain an ISO. To use config drive with Hyper-V, you must
176+
set the ``mkisofs_cmd`` value to the full path to an ``mkisofs.exe``
177177
installation.
178178
"""),
179179
cfg.StrOpt('vswitch_name',
@@ -212,44 +212,37 @@
212212
cfg.BoolOpt('config_drive_cdrom',
213213
default=False,
214214
help="""
215-
Configuration drive cdrom
215+
Mount config drive as a CD drive.
216216
217-
OpenStack can be configured to write instance metadata to
218-
a configuration drive, which is then attached to the
219-
instance before it boots. The configuration drive can be
217+
OpenStack can be configured to write instance metadata to a config drive, which
218+
is then attached to the instance before it boots. The config drive can be
220219
attached as a disk drive (default) or as a CD drive.
221220
222-
Possible values:
223-
224-
* True: Attach the configuration drive image as a CD drive.
225-
* False: Attach the configuration drive image as a disk drive (Default).
226-
227221
Related options:
228222
229-
* This option is meaningful with force_config_drive option set to 'True'
223+
* This option is meaningful with ``force_config_drive`` option set to ``True``
230224
or when the REST API call to create an instance will have
231-
'--config-drive=True' flag.
232-
* config_drive_format option must be set to 'iso9660' in order to use
233-
CD drive as the configuration drive image.
234-
* To use configuration drive with Hyper-V, you must set the
235-
mkisofs_cmd value to the full path to an mkisofs.exe installation.
236-
Additionally, you must set the qemu_img_cmd value to the full path
237-
to an qemu-img command installation.
225+
``--config-drive=True`` flag.
226+
* ``config_drive_format`` option must be set to ``iso9660`` in order to use
227+
CD drive as the config drive image.
228+
* To use config drive with Hyper-V, you must set the
229+
``mkisofs_cmd`` value to the full path to an ``mkisofs.exe`` installation.
230+
Additionally, you must set the ``qemu_img_cmd`` value to the full path
231+
to an ``qemu-img`` command installation.
238232
* You can configure the Compute service to always create a configuration
239-
drive by setting the force_config_drive option to 'True'.
233+
drive by setting the ``force_config_drive`` option to ``True``.
240234
"""),
241235
cfg.BoolOpt('config_drive_inject_password',
242236
default=False,
243237
help="""
244-
Configuration drive inject password
238+
Inject password to config drive.
245239
246-
Enables setting the admin password in the configuration drive image.
240+
When enabled, the admin password will be available from the config drive image.
247241
248242
Related options:
249243
250244
* This option is meaningful when used with other options that enable
251-
configuration drive usage with Hyper-V, such as force_config_drive.
252-
* Currently, the only accepted config_drive_format is 'iso9660'.
245+
config drive usage with Hyper-V, such as ``force_config_drive``.
253246
"""),
254247
cfg.IntOpt('volume_attach_retry_count',
255248
default=10,

nova/virt/powervm/tasks/storage.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ def execute(self, stor_adpt_mappings):
223223

224224
class CreateAndConnectCfgDrive(task.Task):
225225

226-
"""The task to create the configuration drive."""
226+
"""The task to create the config drive."""
227227

228228
def __init__(self, adapter, instance, injected_files,
229229
network_info, stg_ftsk, admin_pass=None):

0 commit comments

Comments
 (0)