Skip to content

image-manager: document preview-by-default #1022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jklare wants to merge 1 commit into from
Closed

image-manager: document preview-by-default #1022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/cloud-in-a-box/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<RELEASE>` 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.
Expand Down
18 changes: 18 additions & 0 deletions docs/guides/operations-guide/openstack/tools/image-manager/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<RELEASE>` 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
Expand Down