Rename "repository" to "registry" #1171
Conversation
| | `BaseUrl` | yes | The base URL for the repository. Appending `/` plus an image name should be a valid image reference. | ||
| | `BaseUrl` | yes | The base URL for the registry. Appending `/` plus an image name should be a valid image reference. |
There was a problem hiding this comment.
If you're here to correct terminology, this is NOT a BaseURL. If you were actually specifying the BaseURL for the registry API here, it would look something like https://dp.apps.rancher.io/v2.
What you instead seem to be keeping here is the target registry hostname plus optional namespace prefix - for example dp.apps.rancher.io/containers which is NOT a URL, and is actually comprised of both a hostname, and a namespace that is prefixed to the image name when syncing.
There was a problem hiding this comment.
Hmm, you're right that it isn't a URL. Though I'm not sure what to call it - BaseName? BaseRef? BaseImageRef? RepositoryPrefix? What do you think?
There was a problem hiding this comment.
"BaseURL" could have a few interpretations - is it a "full URL used as the base value", or is it "the base string that URLs that will be constructed from". I think we mean the second one and I could see how the current term could imply the first meaning too.
It makes me wonder does "BaseURL == URLBase"? Potentially flipping it changes the implied meaning - where one will be more fitting for our use?
If we consider how this value is used, we construct a string like:
docker.io/rancher/mirrored-tonistiigi-xx:1.6.1
If we think about URI vs URL - it cannot be a URL as it has not protocol, however it can be considered a URI. If we included the protocol - like some tools require skopeo - then I think it would be a URL.
That in mind - maybe a term like URIBase or BaseURI is more accurate than using URL.
3 participants
Related to rancher/rancher#52259.
Using the term "repository" to refer to "a location that stores many different images (not just different tags)" is incorrect. Technically, "repository" refers to a single image, which may have a number of different tags e.g.
rancher/rancher. A better term for this use is "registry". This PR makes that change.Note that this PR does not change occurrences of "repository" as in "git repository", nor does it change occurrences of "repository" as in "helm repository".