image-manager: document usage via OSISM CLI by jklare · Pull Request #1029 · osism/osism.github.io

jklare · 2026-07-15T17:33:13Z

What

Documents how the openstack-image-manager can be used through the OSISM CLI via osism manage images, which has been possible for a while but was never documented.

The Image Manager page previously only described the standalone pip-based installation. This change:

Adds a Usage via the OSISM CLI section covering osism manage images, its options (--dry-run, --filter, --delete, --latest, --hide, --no-wait, --cloud, --images), the default image definition directory (/etc/images) and cloud profile (openstack), and worked examples for the common flows.
Refactors the page so the two usage paths (OSISM CLI vs. standalone) are stated up front and read as parallel choices: a short overview links to both, and the former pip-based "Getting started" section is retitled to Standalone usage.

Notes

The documented option names, their help text, and defaults were cross-checked against the Images command in python-osism (osism/commands/manage.py). The --help output shown in the doc is written in argparse's standard format for readability; it was not captured verbatim from the command, so the exact rendered layout may differ slightly.

Fixes #774

🤖 Generated with Claude Code

github-actions · 2026-07-15T17:35:47Z

✅⚠️MegaLinter analysis: Success with warnings

Descriptor	Linter	Files	Errors	Warnings	Elapsed time
✅ ACTION	actionlint	5	0	0	0.06s
✅ JSON	jsonlint	4	0	0	0.13s
✅ JSON	prettier	4	0	0	0.44s
✅ JSON	v8r	4	0	0	9.17s
✅ MARKDOWN	markdownlint	154	0	0	2.64s
✅ MARKDOWN	markdown-table-formatter	154	0	0	0.42s
✅ REPOSITORY	betterleaks	yes	no	no	0.78s
✅ REPOSITORY	checkov	yes	no	no	21.81s
✅ REPOSITORY	git_diff	yes	no	no	0.07s
✅ REPOSITORY	secretlint	yes	no	no	1.93s
✅ REPOSITORY	trufflehog	yes	no	no	5.37s
✅ SPELL	codespell	164	0	0	0.59s
⚠️ SPELL	lychee	164	3	0	11.43s
✅ YAML	prettier	6	0	0	0.46s
✅ YAML	v8r	6	0	0	7.65s
✅ YAML	yamllint	6	0	0	0.66s

Detailed Issues

⚠️ SPELL / lychee - 3 errors

📝 Summary
---------------------
🔍 Total..........842
🔗 Unique.........692
✅ Successful.....793
⏳ Timeouts.........0
🔀 Redirected......49
👻 Excluded........46
❓ Unknown..........0
🚫 Errors...........3
⛔ Unsupported......3

Errors in docs/guides/configuration-guide/openstack/index.md
[404] https://github.com/openstack/kolla/blob/master/docker/base/set_configs.py (at 370:30) | Rejected status code: 404 Not Found
[404] https://github.com/openstack/kolla/blob/master/docker/base/start.sh (at 369:37) | Rejected status code: 404 Not Found

Errors in docs/release-notes/index.md
[ERROR] https://release.osism.tech/ (at 11:1) | Connection failed. Check network connectivity and firewall settings

Hint: Followed 49 redirects. You might want to consider replacing redirecting URLs with the resolved URLs. Use verbose mode (`-v`/`-vv`) to see redirection details.

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

Documentation: Custom Flavors
Command: npx mega-linter-runner@9.6.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,JSON_JSONLINT,JSON_V8R,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_BETTERLEAKS,REPOSITORY_SECRETLINT,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,SPELL_CODESPELL,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R

Show us your support by starring ⭐ the repository

ideaship · 2026-07-16T10:21:02Z

+repository. To manage your own image definitions, point the command at a different directory or a
+single image file with the `--filter` and `--images` options.
+
+By default the cloud profile with the name `openstack` is used. The credentials of this profile


As of 2026-07-16, the new default is admin (no longer openstack). It is still correct for all stable releases, though.

ideaship · 2026-07-16T10:22:31Z

+  --hide           Hide images that should be deleted
+  --delete         Delete images that should be deleted
+  --latest         Only import the latest version for images of type multi
+  --cloud CLOUD    Cloud name in clouds.yaml (default: openstack)


Here, the default also changed from openstack to admin.

ideaship · 2026-07-16T10:25:13Z

+For example, to only manage the `Ubuntu 24.04` image:
+
+```bash
+osism manage images --filter 'Ubuntu 24.04'


Suggested change

osism manage images --filter 'Ubuntu 24.04'

osism manage images --filter 'Ubuntu 24.04$'

This is a regex, 'Ubuntu 24.04' catches our 'Ubuntu 22.04 Minimal, too. Especially important once you start using the filter with delete (below).

ideaship · 2026-07-16T10:34:35Z

+Images that are no longer required are hidden by default (their visibility is changed so that they
+are no longer offered to users). To actually delete images that should be removed, use the


That sounds like somebody decides which images are no longer required. I am guessing this refers to old versions of images (e.g. older Ubuntu 24.04 versions) being omitted from the list).

Somebody actually decides what is managed by setting enabled: in the /etc/images osism/openstack-image-manager@1408090

ideaship · 2026-07-16T11:05:47Z

+                   single image file (default: /etc/images)
+```
+
+To manage all images defined in `/etc/images`, run:


Does the reader understand what "manage all images" means?

added an additional section above

ideaship · 2026-07-16T11:08:31Z

+## Standalone usage

-This **Getting started** will upload a private image to your OpenStack environment with
+For use independent of OSISM, the OpenStack Image Manager can be installed and run directly.


"For use independently of OSISM" or "For standalone use".

The openstack-image-manager has been usable directly through the OSISM CLI via `osism manage images` for a while, but this path was never documented. The page only described the standalone installation via pip, so operators of an OSISM environment had no guidance on the preferred, no-install way to manage images. Add a "Usage via the OSISM CLI" section documenting `osism manage images`, including its options (--dry-run, --filter, --delete, --latest, --hide, --no-wait, --cloud, --images), the default image definition directory (/etc/images) and cloud profile (openstack), and worked examples for the common flows. Refactor the page so the two ways to use the tool are stated up front and read as parallel choices: a short overview links to both paths, and the former pip-based "Getting started" section is retitled to "Standalone usage". Fixes: #774 Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Jan Klare <klare@osism.tech>

jklare assigned ideaship Jul 15, 2026

osism-agent added this to Human Board Jul 15, 2026

github-project-automation Bot moved this to New in Human Board Jul 15, 2026

jklare requested a review from ideaship July 15, 2026 17:33

jklare unassigned ideaship Jul 15, 2026

jklare moved this from New to In review in Human Board Jul 15, 2026

ideaship requested changes Jul 16, 2026

View reviewed changes

jklare force-pushed the docs/image-manager-osism-cli branch from adfed62 to 78016dd Compare July 16, 2026 12:25

	osism manage images --filter 'Ubuntu 24.04'
	osism manage images --filter 'Ubuntu 24.04$'

		Images that are no longer required are hidden by default (their visibility is changed so that they
		are no longer offered to users). To actually delete images that should be removed, use the

Uh oh!

Conversation

jklare commented Jul 15, 2026

What

Notes

Uh oh!

github-actions Bot commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅⚠️MegaLinter analysis: Success with warnings

Detailed Issues

Notices

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Jul 15, 2026 •

edited

Loading