features

package

v1.1.0-rc2 Latest Latest Go to latest Published: May 2, 2024 License: Apache-2.0 Imports: 1 Imported by: 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

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var AllFeatures = sets.New[SupportedFeature]().
	Insert(GatewayCoreFeatures.UnsortedList()...).
	Insert(GatewayExtendedFeatures.UnsortedList()...).
	Insert(ReferenceGrantCoreFeatures.UnsortedList()...).
	Insert(HTTPRouteCoreFeatures.UnsortedList()...).
	Insert(HTTPRouteExtendedFeatures.UnsortedList()...).
	Insert(HTTPRouteExperimentalFeatures.UnsortedList()...).
	Insert(TLSRouteCoreFeatures.UnsortedList()...).
	Insert(MeshCoreFeatures.UnsortedList()...).
	Insert(MeshExtendedFeatures.UnsortedList()...).
	Insert(GRPCRouteCoreFeatures.UnsortedList()...)

AllFeatures contains all the supported features and can be used to run all conformance tests with `all-features` flag.

NOTE: as new feature sets are added they should be inserted into this set.

View Source

var GRPCRouteCoreFeatures = sets.New(
	SupportGRPCRoute,
)

GRPCRouteCoreFeatures includes all the supported features for GRPCRoute at a Core level of support.

View Source

var GatewayCoreFeatures = sets.New(
	SupportGateway,
)

GatewayCoreFeatures are the features that are required to be conformant with the Gateway resource.

View Source

var GatewayExtendedFeatures = sets.New(
	SupportGatewayPort8080,
	SupportGatewayStaticAddresses,
	SupportGatewayHTTPListenerIsolation,
)

GatewayExtendedFeatures are extra generic features that implementations may choose to support as an opt-in. This does not include any Core Features.

View Source

var HTTPRouteCoreFeatures = sets.New(
	SupportHTTPRoute,
)

HTTPRouteCoreFeatures includes all SupportedFeatures needed to be conformant with the HTTPRoute resource.

View Source

var HTTPRouteExperimentalFeatures = sets.New(
	SupportHTTPRouteDestinationPortMatching,
	SupportHTTPRouteBackendProtocolH2C,
	SupportHTTPRouteBackendProtocolWebSocket,
)

HTTPRouteExperimentalFeatures includes all the supported experimental features, currently only available in our experimental release channel. Implementations have the flexibility to opt-in for either specific features or the entire set.

View Source

var HTTPRouteExtendedFeatures = sets.New(
	SupportHTTPRouteQueryParamMatching,
	SupportHTTPRouteMethodMatching,
	SupportHTTPRouteResponseHeaderModification,
	SupportHTTPRoutePortRedirect,
	SupportHTTPRouteSchemeRedirect,
	SupportHTTPRoutePathRedirect,
	SupportHTTPRouteHostRewrite,
	SupportHTTPRoutePathRewrite,
	SupportHTTPRouteRequestMirror,
	SupportHTTPRouteRequestMultipleMirrors,
	SupportHTTPRouteRequestTimeout,
	SupportHTTPRouteBackendTimeout,
	SupportHTTPRouteParentRefPort,
	SupportHTTPRouteBackendRequestHeaderModification,
)

HTTPRouteExtendedFeatures includes all extended features for HTTPRoute conformance and can be used to opt-in to run all HTTPRoute extended features tests. This does not include any Core Features.

View Source

var MeshCoreFeatures = sets.New(
	SupportMesh,
)

MeshCoreFeatures includes all the supported features for the service mesh at a Core level of support.

View Source

var MeshExtendedFeatures = sets.New(
	SupportMeshClusterIPMatching,
	SupportMeshConsumerRoute,
)

MeshExtendedFeatures includes all the supported features for the service mesh at an Extended level of support.

View Source

var ReferenceGrantCoreFeatures = sets.New(
	SupportReferenceGrant,
)

ReferenceGrantCoreFeatures includes all SupportedFeatures needed to be conformant with the ReferenceGrant resource.

View Source

var TLSRouteCoreFeatures = sets.New(
	SupportTLSRoute,
)

TLSCoreFeatures includes all the supported features for the TLSRoute API at a Core level of support.

View Source

var UDPRouteFeatures = sets.New(
	SupportUDPRoute,
)

UDPRouteCoreFeatures includes all SupportedFeatures needed to be conformant with the UDPRoute resource.

Functions ¶

This section is empty.

Types ¶

type SupportedFeature ¶

type SupportedFeature string

SupportedFeature allows opting in to additional conformance tests at an individual feature granularity.

const (
	// This option indicates that the Gateway can also use port 8080
	SupportGatewayPort8080 SupportedFeature = "GatewayPort8080"

	// SupportGatewayStaticAddresses option indicates that the Gateway is capable
	// of allocating pre-determined addresses, rather than dynamically having
	// addresses allocated for it.
	SupportGatewayStaticAddresses SupportedFeature = "GatewayStaticAddresses"

	// SupportGatewayHTTPListenerIsolation option indicates support for the isolation
	// of HTTP listeners.
	SupportGatewayHTTPListenerIsolation SupportedFeature = "GatewayHTTPListenerIsolation"
)

const (
	// This option indicates support for HTTPRoute backend request header modification
	SupportHTTPRouteBackendRequestHeaderModification SupportedFeature = "HTTPRouteBackendRequestHeaderModification"

	// This option indicates support for HTTPRoute query param matching (extended conformance).
	SupportHTTPRouteQueryParamMatching SupportedFeature = "HTTPRouteQueryParamMatching"

	// This option indicates support for HTTPRoute method matching (extended conformance).
	SupportHTTPRouteMethodMatching SupportedFeature = "HTTPRouteMethodMatching"

	// This option indicates support for HTTPRoute response header modification (extended conformance).
	SupportHTTPRouteResponseHeaderModification SupportedFeature = "HTTPRouteResponseHeaderModification"

	// This option indicates support for HTTPRoute port redirect (extended conformance).
	SupportHTTPRoutePortRedirect SupportedFeature = "HTTPRoutePortRedirect"

	// This option indicates support for HTTPRoute scheme redirect (extended conformance).
	SupportHTTPRouteSchemeRedirect SupportedFeature = "HTTPRouteSchemeRedirect"

	// This option indicates support for HTTPRoute path redirect (extended conformance).
	SupportHTTPRoutePathRedirect SupportedFeature = "HTTPRoutePathRedirect"

	// This option indicates support for HTTPRoute host rewrite (extended conformance)
	SupportHTTPRouteHostRewrite SupportedFeature = "HTTPRouteHostRewrite"

	// This option indicates support for HTTPRoute path rewrite (extended conformance)
	SupportHTTPRoutePathRewrite SupportedFeature = "HTTPRoutePathRewrite"

	// This option indicates support for HTTPRoute request mirror (extended conformance).
	SupportHTTPRouteRequestMirror SupportedFeature = "HTTPRouteRequestMirror"

	// This option indicates support for multiple RequestMirror filters within the same HTTPRoute rule (extended conformance).
	SupportHTTPRouteRequestMultipleMirrors SupportedFeature = "HTTPRouteRequestMultipleMirrors"

	// This option indicates support for HTTPRoute request timeouts (extended conformance).
	SupportHTTPRouteRequestTimeout SupportedFeature = "HTTPRouteRequestTimeout"

	// This option indicates support for HTTPRoute backendRequest timeouts (extended conformance).
	SupportHTTPRouteBackendTimeout SupportedFeature = "HTTPRouteBackendTimeout"

	// This option indicates support for HTTPRoute parentRef port (extended conformance).
	SupportHTTPRouteParentRefPort SupportedFeature = "HTTPRouteParentRefPort"
)

const (
	// This option indicates support for Destination Port matching.
	SupportHTTPRouteDestinationPortMatching SupportedFeature = "HTTPRouteDestinationPortMatching"

	// This option indicates support for HTTPRoute with a backendref with an appProtocol 'kubernetes.io/h2c'
	SupportHTTPRouteBackendProtocolH2C SupportedFeature = "HTTPRouteBackendProtocolH2C"

	// This option indicates support for HTTPRoute with a backendref with an appProtoocol 'kubernetes.io/ws'
	SupportHTTPRouteBackendProtocolWebSocket SupportedFeature = "HTTPRouteBackendProtocolWebSocket"
)

const (
	// This option indicates general support for service mesh
	SupportMesh SupportedFeature = "Mesh"
	// This option indicates support for matching Service traffic specifically by Cluster IP rather than other mechanisms.
	SupportMeshClusterIPMatching SupportedFeature = "MeshClusterIPMatching"
	// This option indicates support for "consumer" routes, where a namespace creates a route for a service in another namespace.
	SupportMeshConsumerRoute SupportedFeature = "MeshConsumerRoute"
)

const (
	// This option indicates general support for service mesh
	SupportGRPCRoute SupportedFeature = "GRPCRoute"
)

const (
	// This option indicates support for Gateway.
	// Opting out of this is allowed only for GAMMA-only implementations
	SupportGateway SupportedFeature = "Gateway"
)

const (
	// This option indicates support for HTTPRoute
	SupportHTTPRoute SupportedFeature = "HTTPRoute"
)

const (
	// This option indicates support for ReferenceGrant.
	SupportReferenceGrant SupportedFeature = "ReferenceGrant"
)

const (
	// This option indicates support for TLSRoute
	SupportTLSRoute SupportedFeature = "TLSRoute"
)

const (
	// This option indicates support for UDPRoute
	SupportUDPRoute SupportedFeature = "UDPRoute"
)

Source Files ¶

View all Source files

features.go

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