jetstack / version-checker

Kubernetes utility for exposing image versions in use, compared to latest available upstream, as metrics.
https://jetstack.io
Apache License 2.0
661 stars 76 forks source link

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

Closed davidcollom closed 5 days ago

davidcollom commented 2 weeks ago

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 commented 6 days ago

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.