search

openshift / kube-compare

A Kubectl plugin to allow to compare a known valid reference configuration and a set of specific cluster configuration CRs.
Apache License 2.0
8 stars 8 forks source link

Clarify use of --reference #15

Open pixelsoccupied opened 1 month ago

pixelsoccupied commented 1 month ago

Currently --reference is a path to a metadata.yaml and not just a simple annotated .yaml. This is should be reflected in helper/api?

nocturnalastro commented 2 weeks ago

--reference Seem to be the path to the director where the reference/metadata.yaml file is. Which also means that the metadata.yaml file is required and required to be named as such.

I think if reference were instead the path to the metadata.yaml it would be better flexibility wise and would make more sense to the user. You can then still then use the parent dir for the base for any relative paths in the metadata.yaml.

pixelsoccupied commented 2 weeks ago

/kind api-change

Also like we spoke about it earlier...--reference should be updated to --reference-manifest and metadata.yaml to manifest.yaml to improve clarity