Skip to content

Commit 5368186

Browse files
committed
Fixup README
1 parent ed97aae commit 5368186

File tree

1 file changed

+35
-21
lines changed

1 file changed

+35
-21
lines changed

roles/os_images/README.md

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ on the build host.
2727

2828
`os_images_cache`: a path to a directory in which to cache build artefacts.
2929
It defaults to `~/disk_images`
30-
`NOTE`: new images will NOT be built, even if changes are made in config, if an image is already cached.
31-
Use `force_rebuild` flag in order to apply new config changes.
30+
`NOTE`: new images will NOT be built, even if changes are made in config, if an image
31+
is already cached. Use `force_rebuild` flag in order to apply new config changes.
3232

3333
`os_images_auth_type`: OpenStack authentication endpoint and credentials.
3434
Defaults to `password`.
@@ -68,15 +68,15 @@ mutually exclusive where each contain:
6868
[here](https://docs.openstack.org/glance/latest/user/common-image-properties.html).
6969
* `type`: (optional) image type. Default in DIB is qcow2. Image formats are
7070
available [here](https://docs.openstack.org/glance/latest/user/formats.html).
71-
* `force_rebuild`: (optional) boolean flag indicating whether or not the image should always
72-
be built (even if an existing image that name has been built before). The images on glance
73-
will be replaced if `os_images_upload` is set to `True`. This defaults to
71+
* `force_rebuild`: (optional) boolean flag indicating whether or not the image should
72+
always be built (even if an existing image that name has been built before). The images
73+
in glance will be replaced if `os_images_upload` is set to `True`. This defaults to
7474
`os_images_force_rebuild`if left unset.
75-
* `is_public`: (optional) (deprecated - use `visibility`) whether the image should be set as visible to all
76-
projects or kept private. Note that if both `is_public` and `visibility` are provided, `is_public` will
77-
be preferred.
75+
* `is_public`: (optional) (deprecated - use `visibility`) whether the image should be set
76+
as visible to all projects or kept private. Note that if both `is_public` and `visibility`
77+
are provided, `is_public` will be preferred.
7878
* `visibility`: (optional) Allowed values are 'public', 'private', 'shared'
79-
or 'community'. Default is 'public'
79+
or 'community'. Default is 'public'
8080
* `owner`: (optional) ID of the project that should own the uploaded image.
8181

8282
`os_images_common`: A set of elements to include in every image listed.
@@ -105,36 +105,50 @@ following parameters:
105105

106106
`os_images_upload`: Whether to upload built images to Glance. Defaults to `True`.
107107

108-
`os_images_force_rebuild`: Whether or not to force a rebuild of the DIB image. The images on Glance
109-
will be replaced with the newly built image if `os_images_upload` is set to `True`. Defaults to
110-
`False`.
108+
`os_images_force_rebuild`: Whether or not to force a rebuild of the DIB image.
109+
The images on Glance will be replaced with the newly built image if `os_images_upload`
110+
is set to `True`. Defaults to `False`.
111111

112-
`os_images_public`: (Deprecated - use `os_images_visibility`) Whether uploaded images are public. Defaults to `True` - note this requires admin permissions.
112+
`os_images_public`: (Deprecated - use `os_images_visibility`) Whether uploaded
113+
images are public. Defaults to `True` - note this requires admin permissions.
113114

114-
`os_images_visibility`: The visibility of images uploaded. One of `community`,`public` or `private`. If unset, defaults to `os_images_public` (requires admin permissions for anything other than `private`)
115+
`os_images_visibility`: The visibility of images uploaded. One of `community`,
116+
`public` or `private`. If unset, defaults to `os_images_public` (requires admin
117+
permissions for anything other than `private`)
115118

116-
`os_images_venv`: Path to virtualenv in which to install python dependencies to upload images.
119+
`os_images_venv`: Path to virtualenv in which to install python dependencies to
120+
upload images.
117121

118122
`os_images_dib_venv`: Path to virtualenv in which to install DIB to build images.
119123

120124
`os_images_promote`: Whether or not to promote new images. Defaults to `False`.
121125

122-
`os_images_retire`: Whether or not to retire old images. Defaults to `os_image_promote`. May be necessary to set separately if you are promoting a new candidate image for which there is no existing one to retire, for example.
126+
`os_images_retire`: Whether or not to retire old images. Defaults to `os_image_promote`.
127+
May be necessary to set separately if you are promoting a new candidate image for which
128+
there is no existing one to retire, for example.
123129

124130
`os_images_build`: Whether or not to build the images.
125131

126-
`os_images_name_suffix`: Image suffix which would be removed during image promotion, for exmple: -rc, -dev, -test etc. Mandatory for promotion functionality. Empty by default.
132+
`os_images_name_suffix`: Image suffix which would be removed during image promotion, for
133+
exmple: -rc, -dev, -test etc. Mandatory for promotion functionality. Empty by default.
127134

128-
`os_images_hide`: Whether or not to hide the images in Glance list. Hiding images is available as an option in image retirement/promotion process. Defaults to `False`.
135+
`os_images_hide`: Whether or not to hide the images in Glance list. Hiding images is
136+
available as an option in image retirement/promotion process. Defaults to `False`.
129137

130138
Changing platform architecture in os_images
131139
-------------------------------------------
132140

133-
The target CPU architecture for each image defined in `os_images_list` may be set to any architecture supported by diskimage-builder with the `architecture` parameter.
141+
The target CPU architecture for each image defined in `os_images_list` may be set to any
142+
architecture supported by diskimage-builder with the `architecture` parameter.
134143

135-
If it is unset, an image with the default diskimage-builder architecture (`x86_64`) will be built and optionally uploaded to Glance, with the Glance image property `cpu_arch` set to `x86_64`. If it is set to `arm64` or `aarch64`, images will be uploaded to Glance with the Glance image property `cpu_arch` set to `aarch64`.
144+
If it is unset, an image with the default diskimage-builder architecture (`x86_64`) will
145+
be built and optionally uploaded to Glance, with the Glance image property `cpu_arch` set
146+
to `x86_64`. If it is set to `arm64` or `aarch64`, images will be uploaded to Glance with
147+
the Glance image property `cpu_arch` set to `aarch64`.
136148

137-
If setting to a different `architecture`, consider also setting `properties.cpu_arch` to an architecture [supported by Glance](https://docs.openstack.org/glance/latest/admin/useful-image-properties.html#image-property-keys-and-values).
149+
If setting to a different `architecture`, consider also setting `properties.cpu_arch` to an
150+
architecture
151+
[supported by Glance](https://docs.openstack.org/glance/latest/admin/useful-image-properties.html#image-property-keys-and-values).
138152

139153
Dependencies
140154
------------

0 commit comments

Comments
 (0)