README
¶
Kubernetes Gateway API
The Gateway API is a part of the SIG Network, and this repository contains the specification and Custom Resource Definitions (CRDs).
Status
The latest supported version is v1alpha2 as released by the v0.4.0 release of this project. This version of the API is expected to graduate to beta in the future with relatively minimal changes.
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:
Contributing
Community meeting schedule, notes and developer guide can be found on the community page. Our Kubernetes Slack channel is #sig-network-gateway-api.
Technical Leads
- @bowei
- @thockin
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
v1alpha1
Package v1alpha1 contains API Schema definitions for the networking.x-k8s.io API group.
|
Package v1alpha1 contains API Schema definitions for the networking.x-k8s.io API group. |
|
v1alpha1/validation
Package validation has functions for validating the correctness of api objects and explaining what's wrong with them when they're not valid.
|
Package validation has functions for validating the correctness of api objects and explaining what's wrong with them when they're not valid. |
|
v1alpha2
Package v1alpha2 contains API Schema definitions for the gateway.networking.k8s.io API group.
|
Package v1alpha2 contains API Schema definitions for the gateway.networking.k8s.io API group. |
|
v1alpha2/validation
Package validation has functions for validating the correctness of api objects and explaining what's wrong with them when they're not valid.
|
Package validation has functions for validating the correctness of api objects and explaining what's wrong with them when they're not valid. |
|
cmd
|
|
|
conformance
|
|
|
echo-basic
Module
|
|
|
gwctl
module
|
|
|
pkg
|
|
|
client/clientset/gateway/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/gateway/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/gateway/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/gateway/versioned/typed/apis/v1alpha2
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/gateway/versioned/typed/apis/v1alpha2/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/clientset/networking/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/networking/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/networking/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/networking/versioned/typed/apis/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/networking/versioned/typed/apis/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |