Skip to content

image-manager: document third-party image definitions - #1141

Open
kallioli wants to merge 2 commits into
osism:mainfrom
kallioli:image-manager-external-definitions
Open

kallioli wants to merge 2 commits into
osism:mainfrom
kallioli:image-manager-external-definitions

Conversation

@kallioli

Copy link
Copy Markdown

The Image Manager accepts any file in the image definition format with --images, not only the definitions shipped in /etc/images. This adds a short section to the Image Manager guide showing that with a published third-party catalog, plus a note that such definitions are not reviewed by OSISM.

The example uses openimages.cloud, which publishes signed, boot-tested qcow2 images and their definitions at https://images.openimages.cloud/osism/images.yml. That file validates against etc/schema.yaml (yamale) and was checked with openstack-image-manager --latest --dry-run (URL test passed, import skipped as expected).

Happy to reword or drop the concrete example if you prefer to keep the section generic.

Any file in the image definition format can be passed with --images.
Add a short section showing it with a published third-party catalog,
and a note that such definitions are not reviewed by OSISM.

Signed-off-by: Kevin Allioli <kevin@stackops.ch>
Comment on lines +176 to +178

Third-party definitions are not reviewed by OSISM: check their source before using them.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Third-party definitions are not reviewed by OSISM: check their source before using them.
:::warning
Third-party definitions are not reviewed by OSISM: check their source before using them.
:::

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could make this a bit more visible by using the warning annotation here. It might even be worth to move this to the beginning of the section, before handing people the gun to shoot their own foot.

@jklare

jklare commented Nov 13, 2026

Copy link
Copy Markdown
Contributor

Hey @kallioli, thanks for the contribution. I left a quick suggestion, but think this looks like a good addition.

…e section

Signed-off-by: Kevin Allioli <kevin@stackops.ch>
@kallioli

Copy link
Copy Markdown
Author

Thanks @jklare, good point. I moved the note to the top of the section as a warning admonition (2e336a0).

@berendt
berendt requested a review from jklare November 13, 2026 20:21

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: New

Development

Successfully merging this pull request may close these issues.

2 participants