Use Cases:

• As a user of Gateway API GA on OpenShift, I want to be able to configure rules based routing.
• As a troubleshooter of Gateway API on OpenShift, I want to be able to verify the configuration details when someone reports an issue.

Summary:

The only docs we have are a generic quick start, CRD succession, and a section on deployment topologies.

We need to at least add descriptions of the fields available for configuration in Gateways, especially listeners, and HTTPRoutes.

We cannot point to Kubernetes Gateway API documentation because it too often references experimental fields that are not available to our users.

We cannot ask a docs person unfamiliar with Gateway API to do this on their own.

Acceptance criteria:

• Establish way to work with Docs team to deliver this initially in 4.19, the GA release of Gateway API on OpenShift, and then in 4.20
• Use AI to generate content quickly. See references below.
• Pending agreement with Docs team, start with Google docs reviewed by QE for accuracy, then delivered to Docs team for a real PR
• Establish coverage for the following areas:

1. Gateway Listeners- hostnames, ports, protocol, termination, TLS settings and which routes can be attached to a listener.
2. Gateway Addresses- Define the network addresses requested for this gateway.
3. Gateway Status and Conditions - how to tell if things are working properly
4. GatewayClass Status and Conditions - how to tell if things are working properly
5. HTTPRoute Hostnames - a list of hostnames to use for matching the Host header of HTTP requests.
6. HTTP/GRPCRoute Rules- a list of rules to perform actions against matching HTTP requests.
7. HTTP/GRPCRoute Rule matches, filters, backendRefs, and timeouts
8. HTTP/GRPCRoute status and conditions
9. Advanced capabilities not available in OpenShift routing.

References:

Existing docs: https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html-single/ingress_and_load_balancing/index#ingress-gateway-api    

We have some good basis docs at https://github.com/openshift/network-edge-tools/blob/main/docs/blogs/EnhancedDevPreviewGatewayAPI/GettingCreative.md.

More and updated information can be found at:
https://gateway-api.sigs.k8s.io/api-types/gateway/
https://gateway-api.sigs.k8s.io/api-types/httproute/