Skip to content

Commit 5fea52c

Browse files
authored
image-manager: overall improvements (#804)
Signed-off-by: Christian Berendt <[email protected]>
1 parent 1696beb commit 5fea52c

File tree

1 file changed

+32
-47
lines changed
  • docs/guides/operations-guide/openstack/tools/image-manager

1 file changed

+32
-47
lines changed

docs/guides/operations-guide/openstack/tools/image-manager/index.md

+32-47
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,45 @@ sidebar_position: 50
55

66
# Image Manager
77

8-
The [OpenStack Image Manager](https://pypi.org/project/openstack-image-manager/) is a tool for managing all
9-
images on an OpenStack environment
8+
The [OpenStack Image Manager](https://pypi.org/project/openstack-image-manager/) is
9+
a tool for managing all machine images on an OpenStack environment.
1010

1111
## Requirements
1212

13-
This information is only relevant for the operator of an OpenStack environment. You can skip this section if
14-
you want to use OpenStack Image Manager as a normal user and you are not an operator of an openStack environment.
13+
:::info
14+
15+
This information is only relevant for the operator of an OpenStack environment. You
16+
can skip this section if you want to use OpenStack Image Manager as a normal user
17+
and you are not an operator of an OpenStack environment.
1518

16-
### OpenStack Image Service (Glance)
19+
:::
1720

18-
The OpenStack Image Service (Glance) is required to upload and discover data assets that are used by other
19-
services.
21+
The OpenStack Image Service (Glance) is required to upload and discover data assets
22+
that are used by other services.
2023

21-
Since this script stores many images in a single project, the Glance quota must be set accordingly high or to unlimited.
24+
Since this script stores many images in a single project, the Glance quota must be set
25+
accordingly high or to unlimited.
2226

23-
```ini
27+
```ini file="environments/kolla/files/overlays/glance/glance-api.conf"
2428
[DEFAULT]
2529
user_storage_quota = 1TB
2630
```
2731

28-
With most storage backends it makes sense to convert the imported images directly to RAW. So it is required for using Ceph and it's
29-
features too. Recited from the Ceph documentation [QEMU and block devices](https://docs.ceph.com/en/latest/rbd/qemu-rbd/) and
32+
With most storage backends it makes sense to convert the imported images directly to RAW.
33+
So it is required for using Ceph and it's features too. Recited from the Ceph documentation
34+
[QEMU and block devices](https://docs.ceph.com/en/latest/rbd/qemu-rbd/) and
3035
[Block devices and OpenStack](https://docs.ceph.com/en/latest/rbd/rbd-openstack/).
3136

3237
:::info
3338

34-
The raw data format is really the only sensible format option to use with RBD. Technically, you could use other QEMU-supported formats
35-
(such as qcow2 or vmdk), but doing so would add additional overhead, and would also render the volume unsafe for virtual machine live
39+
The raw data format is really the only sensible format option to use with RBD. Technically,
40+
you could use other QEMU-supported formats (such as qcow2 or vmdk), but doing so would add
41+
additional overhead, and would also render the volume unsafe for virtual machine live
3642
migration when caching (see below) is enabled.
3743

38-
Important Ceph doesn't support QCOW2 for hosting a virtual machine disk. Thus if you want to boot virtual machines in Ceph (ephemeral
39-
backend or boot from volume), the Glance image format must be RAW.
44+
Important Ceph doesn't support QCOW2 for hosting a virtual machine disk. Thus if you want
45+
to boot virtual machines in Ceph (ephemeral backend or boot from volume), the Glance image
46+
format must be RAW.
4047

4148
See the [OpenStack Glance documentation](https://docs.openstack.org/glance/latest/configuration/sample-configuration.html)
4249
for more details.
@@ -45,7 +52,7 @@ for more details.
4552

4653
This requires the following parameter for the image import workflow.
4754

48-
```ini
55+
```ini file="environments/kolla/files/overlays/glance/glance-api.conf"
4956
[taskflow_executor]
5057
conversion_format = raw
5158

@@ -56,18 +63,13 @@ image_import_plugins = ['image_decompression', 'image_conversion']
5663
output_format = raw
5764
```
5865

59-
### Object storage backend
60-
61-
If the mirror functionality is used, an object storage backend is required. The use of the mirror functionality
62-
is optional and is not used by default.
63-
6466
## Getting started
6567

6668
This **Getting started** will upload a private image to your OpenStack environment with
6769
the help of the OpenStack Image Manager.
6870

69-
1. Install the [openstack-image-manager](https://pypi.org/project/openstack-image-manager/) package with
70-
[pip](https://pypi.org/project/pip/).
71+
1. Install the [openstack-image-manager](https://pypi.org/project/openstack-image-manager/)
72+
package with [pip](https://pypi.org/project/pip/).
7173

7274
```sh
7375
pip3 install openstack-image-manager
@@ -85,7 +87,7 @@ the help of the OpenStack Image Manager.
8587
name = "pypi"
8688

8789
[packages]
88-
openstack-image-manager = "==0.20240403.0"
90+
openstack-image-manager = "==0.20250413.0"
8991

9092
[dev-packages]
9193

@@ -155,9 +157,12 @@ for all parameters. After a change to the configuration, validate it with
155157
### SCS image standard
156158

157159
* The value of `login` is stored as `image_original_user` in the metadata of an image.
158-
* If `image_description` is not set as meta information, `image_description` is set to the name of the image.
159-
* The value of `build_date` of a specific version of an image is stored as `image_build_date` in the metadata of an image.
160-
* The value of `url` of a specific version of an image is stored as `image_source` in the metadata of an image.
160+
* If `image_description` is not set as meta information, `image_description` is set
161+
to the name of the image.
162+
* The value of `build_date` of a specific version of an image is stored as `image_build_date`
163+
in the metadata of an image.
164+
* The value of `url` of a specific version of an image is stored as `image_source`
165+
in the metadata of an image.
161166

162167
### Image with regular rebuilds
163168

@@ -286,23 +291,3 @@ A full documentation about the visibility of images can be found in the **Image
286291
* community: set ``visibility`` to ``community``
287292
* shared: set ``visibility`` to ``shared``
288293
* private: set ``visibility`` to ``private``
289-
290-
## Usage
291-
292-
### Mirroring images
293-
294-
Since the upstreams often only keep their images for a short time, we mirror most of the images on REGIO.cloud.
295-
This makes us independent of the availability of the images in the individual upstreams.
296-
297-
### Updating images
298-
299-
Some of the images are automatically updated by a [CI job](update). The latest available build at the time of the CI job execution is mirrored and
300-
made available as the current version.
301-
302-
Currently, the following images are updated once a week (every Sunday at 0 am):
303-
304-
* Almalinux
305-
* CentOS
306-
* Debian
307-
* Rockylinux
308-
* Ubuntu

0 commit comments

Comments
 (0)