gateway.networking.k8s.io / v1beta1 / GatewayClass
- string
.apiVersion
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- string
.kind
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- object
.metadata
- object required
.spec
Spec defines the desired state of GatewayClass.
- string required
.spec .controllerName
ControllerName is the name of the controller that is managing Gateways of this class. The value of this field MUST be a domain prefixed path.
Example: “example.net/gateway-controller”.
This field is not mutable and cannot be empty.
Support: Core
- string
.spec .description
Description helps describe a GatewayClass with more details.
- object
.spec .parametersRef
ParametersRef is a reference to a resource that contains the configuration parameters corresponding to the GatewayClass. This is optional if the controller does not require any additional configuration.
ParametersRef can reference a standard Kubernetes resource, i.e. ConfigMap, or an implementation-specific custom resource. The resource can be cluster-scoped or namespace-scoped.
If the referent cannot be found, refers to an unsupported kind, or when the data within that resource is malformed, the GatewayClass SHOULD be rejected with the “Accepted” status condition set to “False” and an “InvalidParameters” reason.
A Gateway for this GatewayClass may provide its own
parametersRef
. When both are specified, the merging behavior is implementation specific. It is generally recommended that GatewayClass provides defaults that can be overridden by a Gateway.Support: Implementation-specific
- string required
.spec .parametersRef .group
Group is the group of the referent.
- string required
.spec .parametersRef .kind
Kind is kind of the referent.
- string required
.spec .parametersRef .name
Name is the name of the referent.
- string
.spec .parametersRef .namespace
Namespace is the namespace of the referent. This field is required when referring to a Namespace-scoped resource and MUST be unset when referring to a Cluster-scoped resource.
- object
.status
Status defines the current state of GatewayClass.
Implementations MUST populate status on all GatewayClass resources which specify their controller name.
- array
.status .conditions
Conditions is the current status from the controller for this GatewayClass.
Controllers should prefer to publish conditions using values of GatewayClassConditionType for the type of each Condition.
- string required
.status .conditions[] .lastTransitionTime
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
- string required
.status .conditions[] .message
message is a human readable message indicating details about the transition. This may be an empty string.
- integer
.status .conditions[] .observedGeneration
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
- string required
.status .conditions[] .reason
reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
- string required
.status .conditions[] .status
status of the condition, one of True, False, Unknown.
- string required
.status .conditions[] .type
type of condition in CamelCase or in foo.example.com/CamelCase.
- array
.status .supportedFeatures
SupportedFeatures is the set of features the GatewayClass support. It MUST be sorted in ascending alphabetical order by the Name key.
- string required
.status .supportedFeatures[] .name
FeatureName is used to describe distinct features that are covered by conformance tests.