Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: merge 'custom' and 'implementation-specific' conformance #1436

Merged
merged 1 commit into from
Oct 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apis/v1alpha2/gateway_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ type Listener = v1beta1.Listener
// Implementations can define their own protocols if a core ProtocolType does not
// exist. Such definitions must use prefixed name, such as
// `mycompany.com/my-custom-protocol`. Un-prefixed names are reserved for core
// protocols. Any protocol defined by implementations will fall under custom
// conformance.
// protocols. Any protocol defined by implementations will fall under
// implementation-specific conformance.
//
// Valid values include:
//
Expand Down
18 changes: 9 additions & 9 deletions apis/v1alpha2/grpcroute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,8 @@ type GRPCRouteRule struct {
// - Implementation-specific custom filters have no API guarantees across
// implementations.
//
// Specifying a core filter multiple times has unspecified or custom
// conformance.
// Specifying a core filter multiple times has unspecified or
// implementation-specific conformance.
// Support: Core
//
// +optional
Expand Down Expand Up @@ -256,7 +256,7 @@ type GRPCRouteRule struct {
//
// Support: Core for Kubernetes Service
//
// Support: Custom for any other resource
// Support: Implementation-specific for any other resource
//
// Support for weight: Core
//
Expand Down Expand Up @@ -308,9 +308,9 @@ type GRPCMethodMatch struct {
// Type specifies how to match against the service and/or method.
// Support: Core (Exact with service and method specified)
//
// Support Custom (Exact with method specified but no service specified)
// Support: Implementation-specific (Exact with method specified but no service specified)
//
// Support: Custom (RegularExpression)
// Support: Implementation-specific (RegularExpression)
//
// +optional
// +kubebuilder:default=Exact
Expand Down Expand Up @@ -402,7 +402,7 @@ type GRPCRouteFilter struct {
// "Support: Extended" in this package, e.g. "RequestMirror". Implementers
// are encouraged to support extended filters.
//
// - Custom: Filters that are defined and supported by specific vendors.
// - Implementation-specific: Filters that are defined and supported by specific vendors.
// In the future, filters showing convergence in behavior across multiple
// implementations will be considered for inclusion in extended or core
// conformance levels. Filter-specific configuration for such filters
Expand Down Expand Up @@ -475,7 +475,7 @@ type GRPCBackendRef struct {
//
// Support: Core for Kubernetes Service
//
// Support: Custom for any other resource
// Support: Implementation-specific for any other resource
//
// Support for weight: Core
//
Expand All @@ -485,8 +485,8 @@ type GRPCBackendRef struct {
// Filters defined at this level MUST be executed if and only if the
// request is being forwarded to the backend defined here.
//
// Support: Custom (For broader support of filters, use the Filters field
// in GRPCRouteRule.)
// Support: Implementation-specific (For broader support of filters, use the
// Filters field in GRPCRouteRule.)
//
// +optional
// +kubebuilder:validation:MaxItems=16
Expand Down
9 changes: 5 additions & 4 deletions apis/v1alpha2/httproute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,9 @@ const (
// Matches if the URL path matches the given regular expression with
// case sensitivity.
//
// Since `"RegularExpression"` has custom conformance, implementations
// can support POSIX, PCRE, RE2 or any other regular expression dialect.
// Since `"RegularExpression"` has implementation-specific conformance,
// implementations can support POSIX, PCRE, RE2 or any other regular expression
// dialect.
// Please read the implementation's documentation to determine the supported
// dialect.
PathMatchRegularExpression PathMatchType = "RegularExpression"
Expand Down Expand Up @@ -282,9 +283,9 @@ const (
// HTTPRouteFilterExtensionRef should be used for configuring custom
// HTTP filters.
//
// Support in HTTPRouteRule: Custom
// Support in HTTPRouteRule: Implementation-specific
//
// Support in HTTPBackendRef: Custom
// Support in HTTPBackendRef: Implementation-specific
HTTPRouteFilterExtensionRef HTTPRouteFilterType = "ExtensionRef"
)

Expand Down
6 changes: 3 additions & 3 deletions apis/v1alpha2/shared_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -317,8 +317,8 @@ type AnnotationValue = v1beta1.AnnotationValue
// The `NamedAddress` value has been deprecated in favor of implementation
// specific domain-prefixed strings.
//
// All other values, including domain-prefixed values have Custom support, which
// are used in implementation-specific behaviors. Support for additional
// All other values, including domain-prefixed values have Implementation-specific support,
// which are used in implementation-specific behaviors. Support for additional
// predefined CamelCase identifiers may be added in future releases.
//
// +kubebuilder:validation:MinLength=1
Expand Down Expand Up @@ -354,6 +354,6 @@ const (
// The `NamedAddress` type has been deprecated in favor of implementation
// specific domain-prefixed strings.
//
// Support: Implementation-Specific
// Support: Implementation-specific
NamedAddressType AddressType = "NamedAddress"
)
2 changes: 1 addition & 1 deletion apis/v1alpha2/tcproute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ type TCPRouteRule struct {
//
// Support: Core for Kubernetes Service
//
// Support: Custom for any other resource
// Support: Implementation-specific for any other resource
//
// Support for weight: Extended
//
Expand Down
2 changes: 1 addition & 1 deletion apis/v1alpha2/tlsroute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ type TLSRouteRule struct {
//
// Support: Core for Kubernetes Service
//
// Support: Custom for any other resource
// Support: Implementation-specific for any other resource
//
// Support for weight: Extended
//
Expand Down
2 changes: 1 addition & 1 deletion apis/v1alpha2/udproute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ type UDPRouteRule struct {
// the packets, then 80% of packets must be dropped instead.
//
// Support: Core for Kubernetes Service
// Support: Custom for any other resource
// Support: Implementation-specific for any other resource
//
// Support for weight: Extended
//
Expand Down
4 changes: 2 additions & 2 deletions apis/v1beta1/gateway_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,8 @@ type Listener struct {
// Implementations can define their own protocols if a core ProtocolType does not
// exist. Such definitions must use prefixed name, such as
// `mycompany.com/my-custom-protocol`. Un-prefixed names are reserved for core
// protocols. Any protocol defined by implementations will fall under custom
// conformance.
// protocols. Any protocol defined by implementations will fall under
// Implementation-specific conformance.
//
// Valid values include:
//
Expand Down
2 changes: 1 addition & 1 deletion apis/v1beta1/gatewayclass_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ type GatewayClassSpec struct {
// If the referent cannot be found, the GatewayClass's "InvalidParameters"
// status condition will be true.
//
// Support: Custom
// Support: Implementation-specific
//
// +optional
ParametersRef *ParametersReference `json:"parametersRef,omitempty"`
Expand Down
48 changes: 25 additions & 23 deletions apis/v1beta1/httproute_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,8 @@ type HTTPRouteRule struct {
// - Implementation-specific custom filters have no API guarantees across
// implementations.
//
// Specifying a core filter multiple times has unspecified or custom
// conformance.
// Specifying a core filter multiple times has unspecified or
// implementation-specific conformance.
//
// All filters are expected to be compatible with each other except for the
// URLRewrite and RequestRedirect filters, which may not be combined. If an
Expand Down Expand Up @@ -232,7 +232,7 @@ type HTTPRouteRule struct {
//
// Support: Core for Kubernetes Service
//
// Support: Custom for any other resource
// Support: Implementation-specific for any other resource
//
// Support for weight: Core
//
Expand Down Expand Up @@ -282,8 +282,9 @@ const (
// Matches if the URL path matches the given regular expression with
// case sensitivity.
//
// Since `"RegularExpression"` has custom conformance, implementations
// can support POSIX, PCRE, RE2 or any other regular expression dialect.
// Since `"RegularExpression"` has implementation-specific conformance,
// implementations can support POSIX, PCRE, RE2 or any other regular expression
// dialect.
// Please read the implementation's documentation to determine the supported
// dialect.
PathMatchRegularExpression PathMatchType = "RegularExpression"
Expand All @@ -295,7 +296,7 @@ type HTTPPathMatch struct {
//
// Support: Core (Exact, PathPrefix)
//
// Support: Custom (RegularExpression)
// Support: Implementation-specific (RegularExpression)
//
// +optional
// +kubebuilder:default=PathPrefix
Expand Down Expand Up @@ -356,12 +357,12 @@ type HTTPHeaderMatch struct {
//
// Support: Core (Exact)
//
// Support: Custom (RegularExpression)
// Support: Implementation-specific (RegularExpression)
//
// Since RegularExpression HeaderMatchType has custom conformance,
// implementations can support POSIX, PCRE or any other dialects of regular
// expressions. Please read the implementation's documentation to determine
// the supported dialect.
// Since RegularExpression HeaderMatchType has implementation-specific
// conformance, implementations can support POSIX, PCRE or any other dialects
// of regular expressions. Please read the implementation's documentation to
// determine the supported dialect.
//
// +optional
// +kubebuilder:default=Exact
Expand Down Expand Up @@ -419,12 +420,12 @@ type HTTPQueryParamMatch struct {
//
// Support: Extended (Exact)
//
// Support: Custom (RegularExpression)
// Support: Implementation-specific (RegularExpression)
//
// Since RegularExpression QueryParamMatchType has custom conformance,
// implementations can support POSIX, PCRE or any other dialects of regular
// expressions. Please read the implementation's documentation to determine
// the supported dialect.
// Since RegularExpression QueryParamMatchType has Implementation-specific
// conformance, implementations can support POSIX, PCRE or any other
// dialects of regular expressions. Please read the implementation's
// documentation to determine the supported dialect.
//
// +optional
// +kubebuilder:default=Exact
Expand Down Expand Up @@ -557,7 +558,8 @@ type HTTPRouteFilter struct {
// "Support: Extended" in this package, e.g. "RequestMirror". Implementers
// are encouraged to support extended filters.
//
// - Custom: Filters that are defined and supported by specific vendors.
// - Implementation-specific: Filters that are defined and supported by
// specific vendors.
// In the future, filters showing convergence in behavior across multiple
// implementations will be considered for inclusion in extended or core
// conformance levels. Filter-specific configuration for such filters
Expand Down Expand Up @@ -691,9 +693,9 @@ const (
// HTTPRouteFilterExtensionRef should be used for configuring custom
// HTTP filters.
//
// Support in HTTPRouteRule: Custom
// Support in HTTPRouteRule: Implementation-specific
//
// Support in HTTPBackendRef: Custom
// Support in HTTPBackendRef: Implementation-specific
HTTPRouteFilterExtensionRef HTTPRouteFilterType = "ExtensionRef"
)

Expand Down Expand Up @@ -961,7 +963,7 @@ type HTTPRequestMirrorFilter struct {
//
// Support: Extended for Kubernetes Service
//
// Support: Custom for any other resource
// Support: Implementation-specific for any other resource
BackendRef BackendObjectReference `json:"backendRef"`
}

Expand Down Expand Up @@ -991,7 +993,7 @@ type HTTPBackendRef struct {
//
// Support: Core for Kubernetes Service
//
// Support: Custom for any other resource
// Support: Implementation-specific for any other resource
//
// Support for weight: Core
//
Expand All @@ -1001,8 +1003,8 @@ type HTTPBackendRef struct {
// Filters defined at this level should be executed if and only if the
// request is being forwarded to the backend defined here.
//
// Support: Custom (For broader support of filters, use the Filters field
// in HTTPRouteRule.)
// Support: Implementation-specific (For broader support of filters, use the
// Filters field in HTTPRouteRule.)
//
// +optional
// +kubebuilder:validation:MaxItems=16
Expand Down
8 changes: 4 additions & 4 deletions apis/v1beta1/shared_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ type ParentReference struct {
//
// Support: Core (Gateway)
//
// Support: Custom (Other Resources)
// Support: Implementation-specific (Other Resources)
//
// +kubebuilder:default=Gateway
// +optional
Expand Down Expand Up @@ -507,8 +507,8 @@ type AnnotationValue string
// The `NamedAddress` value has been deprecated in favor of implementation
// specific domain-prefixed strings.
//
// All other values, including domain-prefixed values have Custom support, which
// are used in implementation-specific behaviors. Support for additional
// All other values, including domain-prefixed values have Implementation-specific support,
// which are used in implementation-specific behaviors. Support for additional
// predefined CamelCase identifiers may be added in future releases.
//
// +kubebuilder:validation:MinLength=1
Expand Down Expand Up @@ -544,6 +544,6 @@ const (
// The `NamedAddress` type has been deprecated in favor of implementation
// specific domain-prefixed strings.
//
// Support: Implementation-Specific
// Support: Implementation-specific
NamedAddressType AddressType = "NamedAddress"
)

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading