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

[enterprise-4.10] redundant documentation in file registry/securing-exposing-registry.adoc #45793

Open
yrro opened this issue May 18, 2022 · 4 comments
Labels
lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.

Comments

@yrro
Copy link

yrro commented May 18, 2022

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?

@openshift-bot
Copy link

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

@openshift-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 17, 2022
@yrro
Copy link
Author

yrro commented Aug 17, 2022

/remove-lifecycle stale

@openshift-ci openshift-ci bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 17, 2022
@openshift-bot
Copy link

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

@yrro
Copy link
Author

yrro commented Nov 15, 2022

/remove-lifecycle stale
/lifecycle frozen

@openshift-ci openshift-ci bot added the lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. label Nov 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
None yet
Development

No branches or pull requests

2 participants