From 23e1acdd5cc5d7d178a003a4511663cfa548c6e4 Mon Sep 17 00:00:00 2001 From: Jake Sanders Date: Tue, 3 Aug 2021 15:26:40 +0100 Subject: [PATCH] Update Gateway HTTPRoute Label doc string Signed-off-by: Jake Sanders --- deploy/crds/crd-challenges.yaml | 8 ++++---- deploy/crds/crd-clusterissuers.yaml | 8 ++++---- deploy/crds/crd-issuers.yaml | 8 ++++---- pkg/apis/acme/v1/types_issuer.go | 5 +++-- pkg/apis/acme/v1alpha2/types_issuer.go | 5 +++-- pkg/apis/acme/v1alpha3/types_issuer.go | 5 +++-- pkg/apis/acme/v1beta1/types_issuer.go | 5 +++-- pkg/internal/apis/acme/types_issuer.go | 8 ++++---- 8 files changed, 28 insertions(+), 24 deletions(-) diff --git a/deploy/crds/crd-challenges.yaml b/deploy/crds/crd-challenges.yaml index 56ec4189b..f340251e1 100644 --- a/deploy/crds/crd-challenges.yaml +++ b/deploy/crds/crd-challenges.yaml @@ -384,7 +384,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string @@ -1341,7 +1341,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string @@ -2299,7 +2299,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string @@ -3257,7 +3257,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string diff --git a/deploy/crds/crd-clusterissuers.yaml b/deploy/crds/crd-clusterissuers.yaml index 7a79aa23b..03dd44e98 100644 --- a/deploy/crds/crd-clusterissuers.yaml +++ b/deploy/crds/crd-clusterissuers.yaml @@ -418,7 +418,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string @@ -1587,7 +1587,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string @@ -2758,7 +2758,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string @@ -3929,7 +3929,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string diff --git a/deploy/crds/crd-issuers.yaml b/deploy/crds/crd-issuers.yaml index b31d6d8e5..9461704af 100644 --- a/deploy/crds/crd-issuers.yaml +++ b/deploy/crds/crd-issuers.yaml @@ -418,7 +418,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string @@ -1587,7 +1587,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string @@ -2758,7 +2758,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string @@ -3929,7 +3929,7 @@ spec: type: object properties: labels: - description: The labels to set on HTTPRoute resources to solve ACME challenges that use this challenge solver. + description: The labels that cert-manager will use when creating the temporary HTTPRoute needed for solving the HTTP-01 challenge. These labels must match the label selector of at least one Gateway. type: object additionalProperties: type: string diff --git a/pkg/apis/acme/v1/types_issuer.go b/pkg/apis/acme/v1/types_issuer.go index 321474de2..eb0453942 100644 --- a/pkg/apis/acme/v1/types_issuer.go +++ b/pkg/apis/acme/v1/types_issuer.go @@ -254,8 +254,9 @@ type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` - // The labels to set on HTTPRoute resources to solve ACME - // challenges that use this challenge solver. + // The labels that cert-manager will use when creating the temporary + // HTTPRoute needed for solving the HTTP-01 challenge. These labels + // must match the label selector of at least one Gateway. Labels map[string]string `json:"labels,omitempty"` } diff --git a/pkg/apis/acme/v1alpha2/types_issuer.go b/pkg/apis/acme/v1alpha2/types_issuer.go index 973108ddf..26c6b64c8 100644 --- a/pkg/apis/acme/v1alpha2/types_issuer.go +++ b/pkg/apis/acme/v1alpha2/types_issuer.go @@ -251,8 +251,9 @@ type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` - // The labels to set on HTTPRoute resources to solve ACME - // challenges that use this challenge solver. + // The labels that cert-manager will use when creating the temporary + // HTTPRoute needed for solving the HTTP-01 challenge. These labels + // must match the label selector of at least one Gateway. Labels map[string]string `json:"labels,omitempty"` } diff --git a/pkg/apis/acme/v1alpha3/types_issuer.go b/pkg/apis/acme/v1alpha3/types_issuer.go index 55b140626..09bd16761 100644 --- a/pkg/apis/acme/v1alpha3/types_issuer.go +++ b/pkg/apis/acme/v1alpha3/types_issuer.go @@ -251,8 +251,9 @@ type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` - // The labels to set on HTTPRoute resources to solve ACME - // challenges that use this challenge solver. + // The labels that cert-manager will use when creating the temporary + // HTTPRoute needed for solving the HTTP-01 challenge. These labels + // must match the label selector of at least one Gateway. Labels map[string]string `json:"labels,omitempty"` } diff --git a/pkg/apis/acme/v1beta1/types_issuer.go b/pkg/apis/acme/v1beta1/types_issuer.go index 10fcaee10..e58bbf734 100644 --- a/pkg/apis/acme/v1beta1/types_issuer.go +++ b/pkg/apis/acme/v1beta1/types_issuer.go @@ -250,8 +250,9 @@ type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` - // The labels to set on HTTPRoute resources to solve ACME - // challenges that use this challenge solver. + // The labels that cert-manager will use when creating the temporary + // HTTPRoute needed for solving the HTTP-01 challenge. These labels + // must match the label selector of at least one Gateway. Labels map[string]string `json:"labels,omitempty"` } diff --git a/pkg/internal/apis/acme/types_issuer.go b/pkg/internal/apis/acme/types_issuer.go index 2c2f3c1b1..dfdc91340 100644 --- a/pkg/internal/apis/acme/types_issuer.go +++ b/pkg/internal/apis/acme/types_issuer.go @@ -225,16 +225,16 @@ type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` - // The labels to set on HTTPRoute resources to solve ACME - // challenges that use this challenge solver. - // +optional + // The labels that cert-manager will use when creating the temporary + // HTTPRoute needed for solving the HTTP-01 challenge. These labels + // must match the label selector of at least one Gateway. Labels map[string]string `json:"labels,omitempty"` } type ACMEChallengeSolverHTTP01IngressPodTemplate struct { // ObjectMeta overrides for the pod used to solve HTTP01 challenges. // Only the 'labels' and 'annotations' fields may be set. - // If labels or annotations overlap with in-built values, the values here + // If labels or §annotations overlap with in-built values, the values here // will override the in-built values. ACMEChallengeSolverHTTP01IngressPodObjectMeta