From 44f5e445f0484c242be0534016d101d9561c84c5 Mon Sep 17 00:00:00 2001 From: Jan Klare Date: Wed, 8 Jul 2026 11:14:07 +0000 Subject: [PATCH] image-manager: document preview-by-default The OpenStack Image Manager no longer imports images when invoked without arguments. It now shows a local-only preview of the images that would be uploaded and requires --upload to actually perform the import (see osism/openstack-image-manager#1251). The osism manage images wrapper behaves the same way and also needs --upload. Update the Getting started guide and the Cloud in a Box image import example to pass --upload for uploads, and add a note that preview by default is only available from a certain OSISM release onwards. The concrete release still needs to be filled in once the change is released, tracked by the placeholder. Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Jan Klare --- docs/cloud-in-a-box/index.md | 12 +++++++++++- .../openstack/tools/image-manager/index.md | 18 ++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/cloud-in-a-box/index.md b/docs/cloud-in-a-box/index.md index c45cca7174..77d58e2f69 100644 --- a/docs/cloud-in-a-box/index.md +++ b/docs/cloud-in-a-box/index.md @@ -287,8 +287,18 @@ can be viewed in the file `/var/log/install-cloud-in-a-box.log`. The [OpenStack Image Manager](https://github.com/osism/openstack-image-manager/) is used to manage images. In the example, the `Garden Linux` image is imported. +Without `--upload` the command only shows a preview of the images that would be uploaded and +makes no changes. Add `--upload` to actually import the images. + +:::note + +Preview by default is available from OSISM `` onwards. In earlier releases the command +uploaded the images immediately, without requiring `--upload`. + +::: + ```bash -osism manage images --cloud=admin --filter 'Garden Linux' +osism manage images --upload --cloud=admin --filter 'Garden Linux' ``` All available images can be found in the [osism/openstack-image-manager](https://github.com/osism/openstack-image-manager/tree/main/etc/images) repository. diff --git a/docs/guides/operations-guide/openstack/tools/image-manager/index.md b/docs/guides/operations-guide/openstack/tools/image-manager/index.md index c2a3d7f595..5d32d2722f 100644 --- a/docs/guides/operations-guide/openstack/tools/image-manager/index.md +++ b/docs/guides/operations-guide/openstack/tools/image-manager/index.md @@ -144,10 +144,28 @@ the help of the OpenStack Image Manager. 3. Run the OpenStack Image Manager. It is assumed that a profile with the name `openstack` exists in the [clouds.yaml](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). + By default `openstack-image-manager` (and `osism manage images`, which uses it in the + backend) only shows a **preview** of the images that would be uploaded, a rough estimate of + how long that would take and the command to actually perform the upload. It does not connect + to OpenStack and makes no changes: + + :::note + + Preview by default is available from OSISM `` onwards. In earlier releases the + command uploaded the images immediately, without requiring `--upload`. + + ::: + ```bash openstack-image-manager --cloud openstack --filter ".*Cirr.*" --images images/ ``` + To actually import the images, add `--upload`: + + ```bash + openstack-image-manager --upload --cloud openstack --filter ".*Cirr.*" --images images/ + ``` + ## Image definitions The configuration consists of different parameter settings, such as values for