From 622eaa191deefb942a9be90e0004c3318fa8981b Mon Sep 17 00:00:00 2001 From: JoshVanL Date: Fri, 7 Jun 2019 10:40:32 +0100 Subject: [PATCH] Adds podTemplate docs Signed-off-by: JoshVanL --- .../output/reference/api-docs/index.html | 8 ++++---- .../tasks/issuers/setup-acme/http01/index.rst | 20 +++++++++++++++++++ pkg/apis/certmanager/v1alpha1/types_issuer.go | 2 +- 3 files changed, 25 insertions(+), 5 deletions(-) diff --git a/docs/generated/reference/output/reference/api-docs/index.html b/docs/generated/reference/output/reference/api-docs/index.html index 09c007442..5f9d1b077 100755 --- a/docs/generated/reference/output/reference/api-docs/index.html +++ b/docs/generated/reference/output/reference/api-docs/index.html @@ -751,6 +751,10 @@ Appears In: ingress
*ACMEChallengeSolverHTTP01Ingress* 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. + +podTemplate
PodTemplateSpec +Optional template for configure the solver pods. Not all pod template options are valid (e.g. name). +

ACMEChallengeSolverHTTP01Ingress v1alpha1

@@ -1394,10 +1398,6 @@ Appears In: - - - - diff --git a/docs/tasks/issuers/setup-acme/http01/index.rst b/docs/tasks/issuers/setup-acme/http01/index.rst index 69f621ad4..2df7c1820 100644 --- a/docs/tasks/issuers/setup-acme/http01/index.rst +++ b/docs/tasks/issuers/setup-acme/http01/index.rst @@ -67,3 +67,23 @@ response specify the following http01 config: By default type NodePort will be used when you don't set http01 or when you set serviceType to an empty string. Normally there's no need to change this. + +podTemplate +----------- + +You may wish to change the solver's pod metadata, such as labels and +annotations. This can be done by editing the ``podTemplate`` attribute. Note +that the ``name``, ``generateName``, and all fields under ``spec`` cannot be +changed. + +.. code-block:: yaml + + - http01: + podTemplate: + namespace: default + labels: + environment: production + foo: bar + +Unless changed, the pod's metadata will remain the default for each unedited +field when a podTemplate is specified. diff --git a/pkg/apis/certmanager/v1alpha1/types_issuer.go b/pkg/apis/certmanager/v1alpha1/types_issuer.go index ccf8bfdff..e6c528d35 100644 --- a/pkg/apis/certmanager/v1alpha1/types_issuer.go +++ b/pkg/apis/certmanager/v1alpha1/types_issuer.go @@ -261,7 +261,7 @@ type ACMEChallengeSolverHTTP01 struct { // +optional Ingress *ACMEChallengeSolverHTTP01Ingress `json:"ingress"` - // Optional template for configure the solver pods. Not all pod template + // Optional template to configure the solver pods. Not all pod template // options are valid (e.g. name). // +optional PodTemplate corev1.PodTemplateSpec `json:"podTemplate,omitempty"`
PodTemplate
PodTemplate
Optional template for configure the solver pods. Not all pod template options are valid (e.g. name)
serviceType
string
Optional service type for Kubernetes solver service