docs: Simplify RHCL disconnected installation to follow Red Hat patterns#2
Draft
mikenairn wants to merge 2 commits into
Draft
docs: Simplify RHCL disconnected installation to follow Red Hat patterns#2mikenairn wants to merge 2 commits into
mikenairn wants to merge 2 commits into
Conversation
Problem: Current RHCL disconnected docs use upstream catalog (quay.io/kuadrant), wrong package name (kuadrant-operator), and single-step mirroring that doesn't work for true air-gapped environments. Solution: Simplified docs that: 1. Use Red Hat catalog with correct package name (rhcl-operator) 2. Show two-step mirroring (mirror to disk → transfer → push to registry) 3. Focus on RHCL-specific details only, reference existing OLM disconnected docs for generic setup 4. Remove troubleshooting modules with wrong package names Pattern: Matches how other Red Hat operators document disconnected installation (HCP, MCE, Loki). Critical fixes: - Package name: kuadrant-operator → rhcl-operator - Catalog: quay.io/kuadrant/... → registry.redhat.io/redhat/redhat-operator-index - Mirroring: Single-step → Two-step disk-based workflow - CoreDNS image: quay.io/kuadrant/... → registry.redhat.io/rhcl-1/coredns-rhel9 Signed-off-by: Michael Nairn <mnairn@redhat.com>
ShaunaDiaz
reviewed
Jun 3, 2026
|
|
||
| .Prerequisites | ||
|
|
||
| * A disconnected {ocp} cluster version 4.14 or later |
Owner
There was a problem hiding this comment.
RHCL 1.4.0 doesn't support this version of OCP AFIAK (prereqs do not go in assemblies, either; we have these in the modules)
ShaunaDiaz
reviewed
Jun 3, 2026
|
|
||
| [role="_abstract"] | ||
| By using {prodname} as disconnected gateway, you can securely route traffic, enforce rate limits, and perform automated failover between your isolated clusters. You can also automate internal TLS certificate management and manage all internal networking and security policies. | ||
| {prodname} provides policy-driven traffic management for {ocp} clusters using Gateway API. In a disconnected environment, you must mirror the {prodname} operator catalog and its container images to your local registry before installation. |
Owner
There was a problem hiding this comment.
we need to retain the user-focus and not talk about features, but use
ShaunaDiaz
reviewed
Jun 3, 2026
| = About installing {prodname} in disconnected environments | ||
|
|
||
| [role="_abstract"] | ||
| By using {prodname} as disconnected gateway, you can securely route traffic, enforce rate limits, and perform automated failover between your isolated clusters. You can also automate internal TLS certificate management and manage all internal networking and security policies. |
Owner
There was a problem hiding this comment.
is this text wrong as far as what a user can do?
ShaunaDiaz
reviewed
Jun 3, 2026
| // | ||
| // *install-guide/disconnected-install.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE |
Owner
There was a problem hiding this comment.
most of this is in the existing documentation; i do see some differences in the YAMLs, but they are small--can we use what we have with notes for disconnected?
ShaunaDiaz
reviewed
Jun 3, 2026
| metadata: | ||
| name: kuadrant-operator-group | ||
| namespace: kuadrant-system | ||
| spec: {} |
Owner
There was a problem hiding this comment.
regular install doc has:
kind: OperatorGroup
apiVersion: operators.coreos.com/v1
metadata:
name: kuadrant
namespace: <kuadrant_system>
spec:
upgradeStrategy: Default
could we just say to leave the spec empty for disconnected?
ShaunaDiaz
force-pushed
the
OSDOCS-19851
branch
13 times, most recently
from
74f72f9 to
3804c3e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem: Current RHCL disconnected docs use upstream catalog (quay.io/kuadrant), wrong package name (kuadrant-operator), and single-step mirroring that doesn't work for true air-gapped environments.
Solution: Simplified docs that:
Pattern: Matches how other Red Hat operators document disconnected installation (HCP, MCE, Loki).
Critical fixes:
NOTE: You do not need to merge this(it was generated), but it was the easiest way i could see to show the correct procedures and names of items needed.