openshift
[enterprise-4.10] redundant documentation in file registry/securing-exposing-registry.adoc
Which section(s) is the issue in?
Exposing the registry
What needs fixing?
This page has two sections. "Exposing a default registry manually". which is basically "patch the image registry operator config to enable the defaultRoute attribute".
But these instructions are also found on the main "Image registry operator operator in OCP" page at https://docs.openshift.com/container-platform/4.10/registry/configuring-registry-operator.html#registry-operator-default-crd_configuring-registry-operator
I think they should only be in the documentation in one place.
As for the next section, "Exposing a secure registry manually". This repeats the same instruction about enabling the default registry route. Then it tells you to patch the image registry operator config to create a new public-routes route (the name is a bit odd using the plural). And this new route is then configured to use a custom TLS server certificate. The result is that you end up with two routes exposing the registry, where only one is needed.
The naming of the sections is a bit odd as it implies that there are two kinds of registries, a "default registry" and a "secure registry".
I think this page ended up suffering from a bit of copy & paste and needs a little bit of cleanup. How about these as sections:
- Exposing the registry with a default hostname
- Exposing the registry with a custom hostname
- Exposing the registry with a custom TLS server certificate
... and removing the redundant instruction to use the defaultRoute attribute when using a custom hostname/certificate?
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.
If this issue is safe to close now please do so with /close.
/lifecycle stale
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.
If this issue is safe to close now please do so with /close.
/lifecycle stale