gateway-api

module

v1.0.0 Latest Latest Go to latest Published: Oct 31, 2023 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kubernetes-sigs/gateway-api

Links

Open Source Insights

README ¶

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 v1.0.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:

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.

Directories ¶

Path	Synopsis
apis
v1 Package v1 contains API Schema definitions for the gateway.networking.k8s.io API group.	Package v1 contains API Schema definitions for the gateway.networking.k8s.io API group.
v1/util/validation
v1/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/util/validation
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.
v1beta1 Package v1beta1 contains API Schema definitions for the gateway.networking.k8s.io API group.	Package v1beta1 contains API Schema definitions for the gateway.networking.k8s.io API group.
v1beta1/util/validation
v1beta1/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
admission
conformance
apis/v1alpha1
tests
utils/config
utils/echo
utils/flags flags contains command-line flag definitions for the conformance profile certification.	flags contains command-line flag definitions for the conformance profile certification.
utils/http
utils/kubernetes
utils/roundtripper
utils/suite
utils/tls
echo-basic Module
gwctl module
hack
supportedfeatures
pkg
admission
client/clientset/versioned This package has the automatically generated clientset.	This package has the automatically generated clientset.
client/clientset/versioned/fake This package has the automatically generated fake clientset.	This package has the automatically generated fake clientset.
client/clientset/versioned/scheme This package contains the scheme of the automatically generated clientset.	This package contains the scheme of the automatically generated clientset.
client/clientset/versioned/typed/apis/v1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
client/clientset/versioned/typed/apis/v1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
client/clientset/versioned/typed/apis/v1alpha2 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
client/clientset/versioned/typed/apis/v1alpha2/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
client/clientset/versioned/typed/apis/v1beta1 This package has the automatically generated typed clients.	This package has the automatically generated typed clients.
client/clientset/versioned/typed/apis/v1beta1/fake Package fake has the automatically generated clients.	Package fake has the automatically generated clients.
client/informers/externalversions
client/informers/externalversions/apis
client/informers/externalversions/apis/v1
client/informers/externalversions/apis/v1alpha2
client/informers/externalversions/apis/v1beta1
client/informers/externalversions/internalinterfaces
client/listers/apis/v1
client/listers/apis/v1alpha2
client/listers/apis/v1beta1
generator

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL