Merge pull request #109293 from iamNoah1/improve-ingressclassname-api-doc

Ingress API: rework the ingressClassName API documentation
This commit is contained in:
Kubernetes Prow Robot
2022-06-09 11:13:41 -07:00
committed by GitHub
6 changed files with 24 additions and 24 deletions

View File

@@ -33608,7 +33608,7 @@ func schema_k8sio_api_networking_v1_IngressSpec(ref common.ReferenceCallback) co
Properties: map[string]spec.Schema{
"ingressClassName": {
SchemaProps: spec.SchemaProps{
Description: "IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation.",
Description: "IngressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.",
Type: []string{"string"},
Format: "",
},