From 5df1dd49322b76a3747f5a48aa76e4ce12afaed2 Mon Sep 17 00:00:00 2001 From: Jake Sanders Date: Thu, 19 Aug 2021 14:55:50 +0100 Subject: [PATCH] Update Docs on solver type to reflect default service type Signed-off-by: Jake Sanders --- deploy/crds/crd-challenges.yaml | 16 ++++++++-------- deploy/crds/crd-clusterissuers.yaml | 16 ++++++++-------- deploy/crds/crd-issuers.yaml | 16 ++++++++-------- pkg/apis/acme/v1/types_issuer.go | 4 ++-- pkg/apis/acme/v1alpha2/types_issuer.go | 4 ++-- pkg/apis/acme/v1alpha3/types_issuer.go | 4 ++-- pkg/apis/acme/v1beta1/types_issuer.go | 4 ++-- pkg/internal/apis/acme/types_issuer.go | 7 +++++-- 8 files changed, 37 insertions(+), 34 deletions(-) diff --git a/deploy/crds/crd-challenges.yaml b/deploy/crds/crd-challenges.yaml index 6934ccb70..0330be494 100644 --- a/deploy/crds/crd-challenges.yaml +++ b/deploy/crds/crd-challenges.yaml @@ -389,7 +389,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -937,7 +937,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. @@ -1346,7 +1346,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -1894,7 +1894,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. @@ -2304,7 +2304,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -2852,7 +2852,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. @@ -3262,7 +3262,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -3810,7 +3810,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. diff --git a/deploy/crds/crd-clusterissuers.yaml b/deploy/crds/crd-clusterissuers.yaml index 870a4246f..e18542474 100644 --- a/deploy/crds/crd-clusterissuers.yaml +++ b/deploy/crds/crd-clusterissuers.yaml @@ -423,7 +423,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -971,7 +971,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. @@ -1592,7 +1592,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -2140,7 +2140,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. @@ -2763,7 +2763,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -3311,7 +3311,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. @@ -3934,7 +3934,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -4482,7 +4482,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. diff --git a/deploy/crds/crd-issuers.yaml b/deploy/crds/crd-issuers.yaml index 2d7b27aff..52d0b8757 100644 --- a/deploy/crds/crd-issuers.yaml +++ b/deploy/crds/crd-issuers.yaml @@ -423,7 +423,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -971,7 +971,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. @@ -1592,7 +1592,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -2140,7 +2140,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. @@ -2763,7 +2763,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -3311,7 +3311,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. @@ -3934,7 +3934,7 @@ spec: additionalProperties: type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string ingress: description: The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. @@ -4482,7 +4482,7 @@ spec: description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. type: string serviceType: - description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP (default). + description: Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. type: string selector: description: Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. diff --git a/pkg/apis/acme/v1/types_issuer.go b/pkg/apis/acme/v1/types_issuer.go index eb0453942..7070a9634 100644 --- a/pkg/apis/acme/v1/types_issuer.go +++ b/pkg/apis/acme/v1/types_issuer.go @@ -217,7 +217,7 @@ type ACMEChallengeSolverHTTP01 struct { type ACMEChallengeSolverHTTP01Ingress struct { // Optional service type for Kubernetes solver service. Supported values - // are NodePort or ClusterIP (default). + // are NodePort or ClusterIP. If unset, defaults to NodePort. // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` @@ -250,7 +250,7 @@ type ACMEChallengeSolverHTTP01Ingress struct { // routing to an ACME challenge solver pod. type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { // Optional service type for Kubernetes solver service. Supported values - // are NodePort or ClusterIP (default). + // are NodePort or ClusterIP. If unset, defaults to NodePort. // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` diff --git a/pkg/apis/acme/v1alpha2/types_issuer.go b/pkg/apis/acme/v1alpha2/types_issuer.go index 26c6b64c8..37c987583 100644 --- a/pkg/apis/acme/v1alpha2/types_issuer.go +++ b/pkg/apis/acme/v1alpha2/types_issuer.go @@ -216,7 +216,7 @@ type ACMEChallengeSolverHTTP01 struct { type ACMEChallengeSolverHTTP01Ingress struct { // Optional service type for Kubernetes solver service. Supported values - // are NodePort or ClusterIP (default). + // are NodePort or ClusterIP. If unset, defaults to NodePort. // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` @@ -247,7 +247,7 @@ type ACMEChallengeSolverHTTP01Ingress struct { type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { // Optional service type for Kubernetes solver service. Supported values - // are NodePort or ClusterIP (default). + // are NodePort or ClusterIP. If unset, defaults to NodePort. // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` diff --git a/pkg/apis/acme/v1alpha3/types_issuer.go b/pkg/apis/acme/v1alpha3/types_issuer.go index 09bd16761..fca0ad6cf 100644 --- a/pkg/apis/acme/v1alpha3/types_issuer.go +++ b/pkg/apis/acme/v1alpha3/types_issuer.go @@ -216,7 +216,7 @@ type ACMEChallengeSolverHTTP01 struct { type ACMEChallengeSolverHTTP01Ingress struct { // Optional service type for Kubernetes solver service. Supported values - // are NodePort or ClusterIP (default). + // are NodePort or ClusterIP. If unset, defaults to NodePort. // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` @@ -247,7 +247,7 @@ type ACMEChallengeSolverHTTP01Ingress struct { type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { // Optional service type for Kubernetes solver service. Supported values - // are NodePort or ClusterIP. + // are NodePort or ClusterIP. If unset, defaults to NodePort. // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` diff --git a/pkg/apis/acme/v1beta1/types_issuer.go b/pkg/apis/acme/v1beta1/types_issuer.go index a76666a91..ef2c508eb 100644 --- a/pkg/apis/acme/v1beta1/types_issuer.go +++ b/pkg/apis/acme/v1beta1/types_issuer.go @@ -215,7 +215,7 @@ type ACMEChallengeSolverHTTP01 struct { type ACMEChallengeSolverHTTP01Ingress struct { // Optional service type for Kubernetes solver service. Supported values - // are NodePort or ClusterIP (default). + // are NodePort or ClusterIP. If unset, defaults to NodePort. // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` @@ -246,7 +246,7 @@ type ACMEChallengeSolverHTTP01Ingress struct { type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { // Optional service type for Kubernetes solver service. Supported values - // are NodePort or ClusterIP (default). + // are NodePort or ClusterIP. If unset, defaults to NodePort. // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"` diff --git a/pkg/internal/apis/acme/types_issuer.go b/pkg/internal/apis/acme/types_issuer.go index dfdc91340..d6a0f5b8a 100644 --- a/pkg/internal/apis/acme/types_issuer.go +++ b/pkg/internal/apis/acme/types_issuer.go @@ -196,7 +196,9 @@ type ACMEChallengeSolverHTTP01 struct { } type ACMEChallengeSolverHTTP01Ingress struct { - // Optional service type for Kubernetes solver service + // Optional service type for Kubernetes solver service. Supported values + // are NodePort or ClusterIP. If unset, defaults to NodePort. + // +optional ServiceType corev1.ServiceType // The ingress class to use when creating Ingress resources to solve ACME @@ -221,7 +223,8 @@ type ACMEChallengeSolverHTTP01Ingress struct { } type ACMEChallengeSolverHTTP01GatewayHTTPRoute struct { - // Optional service type for Kubernetes solver service + // Optional service type for Kubernetes solver service. Supported values + // are NodePort or ClusterIP. If unset, defaults to NodePort. // +optional ServiceType corev1.ServiceType `json:"serviceType,omitempty"`