Skip to content
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.

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

Start to document known configuration parameters for common image repositories #208

Merged
merged 3 commits into from
Jul 3, 2024

Conversation

davidcollom
Copy link
Collaborator

This is an attempt to help the onboarding process of version-checker and introduces a list of images/repositories and any custom annotations needed on the pods.

This is after doing some extensive research, and determining that it is not feisable to attempt to address all the possible edgecases automatically

@davidcollom davidcollom added the documentation Improvements or additions to documentation label Jul 2, 2024
@davidcollom davidcollom added this to the v1 milestone Jul 2, 2024
Copy link
Contributor

@hawksight hawksight left a comment

Choose a reason for hiding this comment

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

Looks great.

For my reference, is this the only annotation needed in each case?
Or is there a standard one?

Just thinking if there is more than this to include a quick start example in each section too, so users can copy paste.

@davidcollom
Copy link
Collaborator Author

davidcollom commented Jul 2, 2024

Looks great.

😊 Thanks

For my reference, is this the only annotation needed in each case? Or is there a standard one?

These are the ONLY annotations I've needed to add to the containers to be able to successfully determine the latest version, yes. (aside from the global annotation needed if users aren't running with --test-all-containers (defaulted when using the helm chart))

Just thinking if there is more than this to include a quick start example in each section too, so users can copy paste.

Hmmm - Possibly, I do want to extend this as we go on with things like Offical Helm Chart values etc, etc.

@davidcollom davidcollom merged commit 29427b2 into main Jul 3, 2024
4 checks passed
@davidcollom davidcollom deleted the known-configurations branch July 3, 2024 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants