Skip to content

docs(ingress): add note about OpenShift Gateway API and link to OpenShift guide #2100

Description

@akram

Problem Statement

The ingress docs (docs/kubernetes/ingress.mdx) only cover Envoy Gateway. On OpenShift, Envoy Gateway cannot be installed because the Ingress Operator manages Gateway API CRDs and rejects third-party installations. Users following the ingress guide on OpenShift hit an error with no guidance on what to do instead.

Proposed Design

Add a <Note> callout at the top of docs/kubernetes/ingress.mdx directing OpenShift users to the OpenShift-specific guide:

<Note>
On OpenShift, the Ingress Operator manages Gateway API CRDs and Envoy Gateway cannot be installed.
Refer to [OpenShift — Gateway Connection](/kubernetes/openshift/gateway-connection) for OpenShift-specific
ingress options including reencrypt Routes and the Istio-based Gateway API controller.
</Note>

Changes required

  • docs/kubernetes/ingress.mdx — add the <Note> after the introductory paragraph (before "## Install Envoy Gateway")

Alternatives Considered

  1. Add a full OpenShift section to ingress.mdx: Would duplicate content already covered in docs/kubernetes/openshift/gateway-connection.mdx. A cross-reference note is sufficient.

  2. Do nothing, rely on the OpenShift section: Users coming from the Kubernetes nav sidebar would land on ingress.mdx first and not know to check the OpenShift section.


  • I've reviewed existing issues and the architecture docs
  • This is a design proposal, not a "please build this" request

Metadata

Metadata

Assignees

No one assigned

    Labels

    state:triage-neededOpened without agent diagnostics and needs triage

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions