Skip to content

Start writing user documentation for Image finding. #326

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

Jump to bottom
Merged
garloff merged 20 commits into from
Dec 2, 2025
Merged

Start writing user documentation for Image finding. #326

garloff merged 20 commits into from
Dec 2, 2025

Conversation

@garloff
Copy link
Member

@garloff garloff commented Nov 26, 2025

Just to show what to do if we don't have standardized image names any longer. Python and Shell (CLI) covered, opentofu is TBD.

@garloff
Start writing user documentation for Image finding.
e40df25 
Just to show what to do if we don't have standardized image names any
longer. Python and Shell (CLI) covered, opentofu is TBD.

Signed-off-by: Kurt Garloff <[email protected]>
@garloff garloff self-assigned this Nov 26, 2025
@garloff garloff added documentation Improvements or additions to documentation work in progress Pull requests that are work in progress, do not merge them labels Nov 26, 2025
@garloff garloff added the standards Issues / ADR / pull requests relevant for standardization & certification label Nov 26, 2025
@garloff garloff marked this pull request as draft November 26, 2025 14:39
@garloff garloff requested a review from toothstone November 26, 2025 14:40
@garloff
Wording improvements
a47a6af 
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Tiny code improvements.
5508dcf 
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Comment out link to not yet existing standard version.
819538b 
scs-0102-v2 is not there yet ...

Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Try to avoid matching double space in tables.
b634819 
This fixes the markdownlint rule.

Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Add to sidebar. (1st attempt.)
72d8451 
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Link index file explicitly.
2961b4f 
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Copy link
Member Author

garloff commented Nov 26, 2025

OK, a preview of this is on https://docs-staging.scs.community/user-docs/.

@garloff garloff mentioned this pull request Nov 26, 2025
Closed
@garloff garloff marked this pull request as ready for review November 27, 2025 11:44
@garloff
opentofu/HCL, first part.
520d7fd 
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Revert "Try to avoid matching double space in tables."
404ffc0 
This reverts commit b634819.

Signed-off-by: Kurt Garloff <[email protected]>
@garloff
OK, make opentofu work with external helper.
f65f027 
This was more complicated than I hoped for.
We could have done some HCL magic IF the openstack provider would have
allowed to query image properties by IDs which it does not seem to.
So the external python3 program is easiest and we reuse what we already
have.

Also comment on heat.

Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Add ansible approach.
cb227fd 
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Ansible tested now.
517337b 
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Break long line in shell example.
ee5eb99 
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Add link to second terraform bits. Fix one typo.
a867890 
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Merge branch 'main' into feat/add-iaas-image-selection
26c0035
@garloff garloff removed the work in progress Pull requests that are work in progress, do not merge them label Nov 28, 2025
@garloff garloff requested a review from mbuechse November 28, 2025 16:55
@garloff
Copy link
Member Author

garloff commented Nov 28, 2025

Ready for merging IMVHO. Please review!

toothstone
toothstone approved these changes Dec 2, 2025
View reviewed changes
Copy link
Contributor

@toothstone toothstone left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks great, I was able to successfully run all scripts except the Heat config on the scs-0102-v1 compliant cloud I have access to (DD8).

It might be out of scope, but we could also consider UI users (they exist!). At least in Horizon, it seems to be rather convoluted to find the images as well. Only way I found to view the metadata was via "Edit metadata" on the Images tab, but I couldn't figure out a way to find the SCS mandated images from the "Launch Instance ↦ Source" tab at all.

Has someone tried this in Skyline?

garloff and others added 2 commits December 2, 2025 18:18
@garloff @toothstone
Update usage output in find_img.py
8ba58a4 
Thanks, @toothstone

Co-authored-by: toothstone <[email protected]>
Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Add screenshots from horizon and skyline.
729ffd3 
Thanks to @toothstone for the idea!

Signed-off-by: Kurt Garloff <[email protected]>
@garloff
Copy link
Member Author

garloff commented Dec 2, 2025

Looks great, I was able to successfully run all scripts except the Heat config on the scs-0102-v1 compliant cloud I have access to (DD8).

I did test :-)
Because I never get code correct without it.
Thanks for validating.

It might be out of scope, but we could also consider UI users (they exist!). At least in Horizon, it seems to be rather convoluted to find the images as well. Only way I found to view the metadata was via "Edit metadata" on the Images tab, but I couldn't figure out a way to find the SCS mandated images from the "Launch Instance ↦ Source" tab at all.

Unfortunately, I did not find anything in instance (VM) creation dialogues either.
But Compute, Images and just clicking on the image name gives you all the metadata for review, so you don't need to try editing it.
I included a screenshot.

Has someone tried this in Skyline?

Yes, I included a screenshot as well.

Thanks for the noting the web interface omission.
Somehow I was more concerned about users that automate things, as portability in my mind is all about making sure that the automation from one SCS cloud work on all others.
But indeed, you still might want to interactively select and verify the right image when you do the initial exploration.

@garloff garloff merged commit 0ffff94 into main Dec 2, 2025
7 checks passed
@garloff garloff deleted the feat/add-iaas-image-selection branch December 2, 2025 18:44
@github-project-automation github-project-automation bot moved this from Backlog to Done in Sovereign Cloud Stack Dec 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@toothstone toothstone toothstone approved these changes

@mbuechse mbuechse Awaiting requested review from mbuechse

Assignees

@garloff garloff

Labels

documentation Improvements or additions to documentation standards Issues / ADR / pull requests relevant for standardization & certification

Projects

Sovereign Cloud Stack
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@garloff @toothstone