sigs.k8s.io/service-apis

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 v1 as released by the v1.2.0 release of this project.

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

• v1.GatewayClass
• v1.Gateway
• v1.HTTPRoute
• v1.GRPCRoute

For all the other APIs and their support levels please consult the spec.

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

For a complete API reference, please refer to:

• API reference
• Go docs for the package

Gateway API conformance

If you are developing a Gateway API implementation and want to run conformance tests against your project and eventually submit the proof of conformance, visit the conformance documentation for the test suite documentation, and the conformance reports readme to see the reports submission rules. If you are a user who wants to explore the features supported by the various implementations, navigate the conformance reports

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.