README.md

Kubernetes Gateway API

The Gateway API is a part of SIG Network, and this repository contains the specification and Custom Resource Definitions (CRDs).

Status

The latest supported version is v1beta1 as released by the v0.6.0 release of this project.

This version of the API is has beta level support for the following resources:

• v1beta1.GatewayClass
• v1beta1.Gateway
• v1beta1.HTTPRoute
• v1beta1.ReferenceGrant

For all other APIs we provide alpha level support.

Documentation

Website

The API specification and detailed documentation is available on the project website: https://gateway-api.sigs.k8s.io.

Concepts

To get started, please read through API concepts and Security model. These documents give the necessary background to understand the API and the use-cases it targets.

Getting started

Once you have a good understanding of the API at a higher-level, check out getting started to install your first Gateway controller and try out one of the guides.

References

A complete API reference, please refer to:

• API reference
• Go docs for the package

Contributing

Community meeting schedule, notes and developer guide can be found on the community page. Our Kubernetes Slack channel is #sig-network-gateway-api.

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.