Adds podTemplate docs

Signed-off-by: JoshVanL <vleeuwenjoshua@gmail.com>
This commit is contained in:
JoshVanL 2019-06-07 10:40:32 +01:00
parent 0925392711
commit 622eaa191d
3 changed files with 25 additions and 5 deletions

View File

@ -751,6 +751,10 @@ Appears In:
<td><code>ingress</code><br /> *<a href="#acmechallengesolverhttp01ingress-v1alpha1">ACMEChallengeSolverHTTP01Ingress</a>*</td>
<td>The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for &#39;/.well-known/acme-challenge/XYZ&#39; to &#39;challenge solver&#39; pods that are provisioned by cert-manager for each Challenge to be completed.</td>
</tr>
<tr>
<td><code>podTemplate</code><br /> <em>PodTemplateSpec</em></td>
<td>Optional template for configure the solver pods. Not all pod template options are valid (e.g. name).</td>
</tr>
</tbody></table>
<h2 id="acmechallengesolverhttp01ingress-v1alpha1">ACMEChallengeSolverHTTP01Ingress v1alpha1</h2>
<table>
@ -1394,10 +1398,6 @@ Appears In:
</tr>
</thead>
<tbody><tr>
<td><code>PodTemplate</code><br /> <em>PodTemplate</em></td>
<td>Optional template for configure the solver pods. Not all pod template options are valid (e.g. name)</td>
</tr>
<tr>
<td><code>serviceType</code><br /> <em>string</em></td>
<td>Optional service type for Kubernetes solver service</td>
</tr>

View File

@ -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.

View File

@ -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"`