weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
7b7869ee04
cert-manager/docs/generated/reference/output/reference/api-docs/index.html
James Munnelly 9d643923fb Update reference docs generation 
Signed-off-by: James Munnelly <james@munnelly.eu>
2019-09-23 10:07:53 +01:00

2827 lines
104 KiB
HTML
Executable File
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Cert-manager API Reference</title>
<link rel="shortcut icon" href="favicon.ico" type="image/vnd.microsoft.icon">
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="node_modules/bootstrap/dist/css/bootstrap.min.css">
<link rel="stylesheet" href="node_modules/font-awesome/css/font-awesome.min.css" type="text/css">
<link rel="stylesheet" href="node_modules/highlight.js/styles/default.css" type="text/css">
<link rel="stylesheet" href="stylesheet.css" type="text/css">
</head>
<body>
<div id="sidebar-wrapper" class="side-nav side-bar-nav"><ul><li class="nav-level-1 strong-nav"><a href="#-strong-cert-manager-strong-" class="nav-item"><strong>cert-manager</strong></a></li></ul><ul><li class="nav-level-1"><a href="#certificate-v1alpha2" class="nav-item">Certificate v1alpha2</a></li></ul><ul><li class="nav-level-1"><a href="#clusterissuer-v1alpha2" class="nav-item">ClusterIssuer v1alpha2</a></li></ul><ul><li class="nav-level-1"><a href="#issuer-v1alpha2" class="nav-item">Issuer v1alpha2</a></li></ul><ul><li class="nav-level-1 strong-nav"><a href="#-strong-acme-strong-" class="nav-item"><strong>Acme</strong></a></li></ul><ul><li class="nav-level-1"><a href="#order-v1alpha2" class="nav-item">Order v1alpha2</a></li></ul><ul><li class="nav-level-1"><a href="#challenge-v1alpha2" class="nav-item">Challenge v1alpha2</a></li></ul><ul><li class="nav-level-1 strong-nav"><a href="#-strong-old-api-versions-strong-" class="nav-item"><strong>Old API Versions</strong></a></li></ul><ul><li class="nav-level-1 strong-nav"><a href="#-strong-field-definitions-strong-" class="nav-item"><strong>Field Definitions</strong></a></li><ul id="-strong-field-definitions-strong--nav" style="display: none;"><li class="nav-level-2"><a href="#acmeauthorization-v1alpha2" class="nav-item">ACMEAuthorization v1alpha2</a></li><li class="nav-level-2"><a href="#acmechallenge-v1alpha2" class="nav-item">ACMEChallenge v1alpha2</a></li><li class="nav-level-2"><a href="#acmechallengesolver-v1alpha2" class="nav-item">ACMEChallengeSolver v1alpha2</a></li><li class="nav-level-2"><a href="#acmechallengesolverdns01-v1alpha2" class="nav-item">ACMEChallengeSolverDNS01 v1alpha2</a></li><li class="nav-level-2"><a href="#acmechallengesolverhttp01-v1alpha2" class="nav-item">ACMEChallengeSolverHTTP01 v1alpha2</a></li><li class="nav-level-2"><a href="#acmechallengesolverhttp01ingress-v1alpha2" class="nav-item">ACMEChallengeSolverHTTP01Ingress v1alpha2</a></li><li class="nav-level-2"><a href="#acmechallengesolverhttp01ingresspodspec-v1alpha2" class="nav-item">ACMEChallengeSolverHTTP01IngressPodSpec v1alpha2</a></li><li class="nav-level-2"><a href="#acmechallengesolverhttp01ingresspodtemplate-v1alpha2" class="nav-item">ACMEChallengeSolverHTTP01IngressPodTemplate v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuer-v1alpha2" class="nav-item">ACMEIssuer v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuerdns01provideracmedns-v1alpha2" class="nav-item">ACMEIssuerDNS01ProviderAcmeDNS v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerakamai-v1alpha2" class="nav-item">ACMEIssuerDNS01ProviderAkamai v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerazuredns-v1alpha2" class="nav-item">ACMEIssuerDNS01ProviderAzureDNS v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerclouddns-v1alpha2" class="nav-item">ACMEIssuerDNS01ProviderCloudDNS v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providercloudflare-v1alpha2" class="nav-item">ACMEIssuerDNS01ProviderCloudflare v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerdigitalocean-v1alpha2" class="nav-item">ACMEIssuerDNS01ProviderDigitalOcean v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerrfc2136-v1alpha2" class="nav-item">ACMEIssuerDNS01ProviderRFC2136 v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerroute53-v1alpha2" class="nav-item">ACMEIssuerDNS01ProviderRoute53 v1alpha2</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerwebhook-v1alpha2" class="nav-item">ACMEIssuerDNS01ProviderWebhook v1alpha2</a></li><li class="nav-level-2"><a href="#affinity-v1" class="nav-item">Affinity v1</a></li><li class="nav-level-2"><a href="#caissuer-v1alpha2" class="nav-item">CAIssuer v1alpha2</a></li><li class="nav-level-2"><a href="#certificatecondition-v1alpha2" class="nav-item">CertificateCondition v1alpha2</a></li><li class="nav-level-2"><a href="#certificatednsnameselector-v1alpha2" class="nav-item">CertificateDNSNameSelector v1alpha2</a></li><li class="nav-level-2"><a href="#duration-v1" class="nav-item">Duration v1</a></li><li class="nav-level-2"><a href="#fieldsv1-v1" class="nav-item">FieldsV1 v1</a></li><li class="nav-level-2"><a href="#issuercondition-v1alpha2" class="nav-item">IssuerCondition v1alpha2</a></li><li class="nav-level-2"><a href="#labelselector-v1" class="nav-item">LabelSelector v1</a></li><li class="nav-level-2"><a href="#labelselectorrequirement-v1" class="nav-item">LabelSelectorRequirement v1</a></li><li class="nav-level-2"><a href="#localobjectreference-v1" class="nav-item">LocalObjectReference v1</a></li><li class="nav-level-2"><a href="#managedfieldsentry-v1" class="nav-item">ManagedFieldsEntry v1</a></li><li class="nav-level-2"><a href="#nodeaffinity-v1" class="nav-item">NodeAffinity v1</a></li><li class="nav-level-2"><a href="#nodeselector-v1" class="nav-item">NodeSelector v1</a></li><li class="nav-level-2"><a href="#nodeselectorrequirement-v1" class="nav-item">NodeSelectorRequirement v1</a></li><li class="nav-level-2"><a href="#nodeselectorterm-v1" class="nav-item">NodeSelectorTerm v1</a></li><li class="nav-level-2"><a href="#objectmeta-v1" class="nav-item">ObjectMeta v1</a></li><li class="nav-level-2"><a href="#objectreference-v1" class="nav-item">ObjectReference v1</a></li><li class="nav-level-2"><a href="#ownerreference-v1" class="nav-item">OwnerReference v1</a></li><li class="nav-level-2"><a href="#podaffinity-v1" class="nav-item">PodAffinity v1</a></li><li class="nav-level-2"><a href="#podaffinityterm-v1" class="nav-item">PodAffinityTerm v1</a></li><li class="nav-level-2"><a href="#podantiaffinity-v1" class="nav-item">PodAntiAffinity v1</a></li><li class="nav-level-2"><a href="#preferredschedulingterm-v1" class="nav-item">PreferredSchedulingTerm v1</a></li><li class="nav-level-2"><a href="#secretkeyselector-v1" class="nav-item">SecretKeySelector v1</a></li><li class="nav-level-2"><a href="#selfsignedissuer-v1alpha2" class="nav-item">SelfSignedIssuer v1alpha2</a></li><li class="nav-level-2"><a href="#time-v1" class="nav-item">Time v1</a></li><li class="nav-level-2"><a href="#toleration-v1" class="nav-item">Toleration v1</a></li><li class="nav-level-2"><a href="#vaultapprole-v1alpha2" class="nav-item">VaultAppRole v1alpha2</a></li><li class="nav-level-2"><a href="#vaultauth-v1alpha2" class="nav-item">VaultAuth v1alpha2</a></li><li class="nav-level-2"><a href="#vaultissuer-v1alpha2" class="nav-item">VaultIssuer v1alpha2</a></li><li class="nav-level-2"><a href="#venaficloud-v1alpha2" class="nav-item">VenafiCloud v1alpha2</a></li><li class="nav-level-2"><a href="#venafiissuer-v1alpha2" class="nav-item">VenafiIssuer v1alpha2</a></li><li class="nav-level-2"><a href="#venafitpp-v1alpha2" class="nav-item">VenafiTPP v1alpha2</a></li><li class="nav-level-2"><a href="#weightedpodaffinityterm-v1" class="nav-item">WeightedPodAffinityTerm v1</a></li></ul></ul><br/><div class="copyright"><a href="https://jetstack.io">Copyright 2018 Jetstack Ltd.</a></div></div>
<div id="wrapper">
<div id="code-tabs-wrapper" class="code-tabs"><ul class="code-tab-list"></ul></div>
<div id="page-content-wrapper" class="body-content container-fluid"><h1 id="-strong-cert-manager-strong-"><strong>cert-manager</strong></h1>
<hr>
<p>This page contains reference documentation for cert-manager API types.</p>
<p>For full documentation on how to use cert-manager, please view our
<a href="https://docs.cert-manager.io/">official documentation</a>.</p>
<hr>
<h1 id="certificate-v1alpha2">Certificate v1alpha2</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>Certificate</code></td>
</tr>
</tbody></table>
<p>Certificate is a type to represent a Certificate from ACME</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources</a></td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> *<a href="#objectmeta-v1">ObjectMeta</a>*</td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> *<a href="#certificatespec-v1alpha2">CertificateSpec</a>*</td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> *<a href="#certificatestatus-v1alpha2">CertificateStatus</a>*</td>
<td></td>
</tr>
</tbody></table>
<h3 id="certificatespec-v1alpha2">CertificateSpec v1alpha2</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificate-v1alpha2">Certificate v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>commonName</code><br /> <em>string</em></td>
<td>CommonName is a common name to be used on the Certificate. If no CommonName is given, then the first entry in DNSNames is used as the CommonName. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs; in order to have longer domain names, set the CommonName (or first DNSNames entry) to have 64 characters or fewer, and then add the longer domain name to DNSNames.</td>
</tr>
<tr>
<td><code>dnsNames</code><br /> <em>string array</em></td>
<td>DNSNames is a list of subject alt names to be used on the Certificate. If no CommonName is given, then the first entry in DNSNames is used as the CommonName and must have a length of 64 characters or fewer.</td>
</tr>
<tr>
<td><code>duration</code><br /> *<a href="#duration-v1">Duration</a>*</td>
<td>Certificate default Duration</td>
</tr>
<tr>
<td><code>ipAddresses</code><br /> <em>string array</em></td>
<td>IPAddresses is a list of IP addresses to be used on the Certificate</td>
</tr>
<tr>
<td><code>isCA</code><br /> <em>boolean</em></td>
<td>IsCA will mark this Certificate as valid for signing. This implies that the &#39;cert sign&#39; usage is set</td>
</tr>
<tr>
<td><code>issuerRef</code><br /> *<a href="#objectreference-v1">ObjectReference</a>*</td>
<td>IssuerRef is a reference to the issuer for this certificate. If the &#39;kind&#39; field is not set, or set to &#39;Issuer&#39;, an Issuer resource with the given name in the same namespace as the Certificate will be used. If the &#39;kind&#39; field is set to &#39;ClusterIssuer&#39;, a ClusterIssuer with the provided name will be used. The &#39;name&#39; field in this stanza is required at all times.</td>
</tr>
<tr>
<td><code>keyAlgorithm</code><br /> <em>string</em></td>
<td>KeyAlgorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either &#34;rsa&#34; or &#34;ecdsa&#34; If KeyAlgorithm is specified and KeySize is not provided, key size of 256 will be used for &#34;ecdsa&#34; key algorithm and key size of 2048 will be used for &#34;rsa&#34; key algorithm.</td>
</tr>
<tr>
<td><code>keyEncoding</code><br /> <em>string</em></td>
<td>KeyEncoding is the private key cryptography standards (PKCS) for this certificate&#39;s private key to be encoded in. If provided, allowed values are &#34;pkcs1&#34; and &#34;pkcs8&#34; standing for PKCS#1 and PKCS#8, respectively. If KeyEncoding is not specified, then PKCS#1 will be used by default.</td>
</tr>
<tr>
<td><code>keySize</code><br /> <em>integer</em></td>
<td>KeySize is the key bit size of the corresponding private key for this certificate. If provided, value must be between 2048 and 8192 inclusive when KeyAlgorithm is empty or is set to &#34;rsa&#34;, and value must be one of (256, 384, 521) when KeyAlgorithm is set to &#34;ecdsa&#34;.</td>
</tr>
<tr>
<td><code>organization</code><br /> <em>string array</em></td>
<td>Organization is the organization to be used on the Certificate</td>
</tr>
<tr>
<td><code>renewBefore</code><br /> *<a href="#duration-v1">Duration</a>*</td>
<td>Certificate renew before expiration duration</td>
</tr>
<tr>
<td><code>secretName</code><br /> <em>string</em></td>
<td>SecretName is the name of the secret resource to store this secret in</td>
</tr>
<tr>
<td><code>usages</code><br /> <em>string array</em></td>
<td>Usages is the set of x509 actions that are enabled for a given key. Defaults are (&#39;digital signature&#39;, &#39;key encipherment&#39;) if empty</td>
</tr>
</tbody></table>
<h3 id="certificatestatus-v1alpha2">CertificateStatus v1alpha2</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificate-v1alpha2">Certificate v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>conditions</code><br /> *<a href="#certificatecondition-v1alpha2">CertificateCondition</a> array*</td>
<td></td>
</tr>
<tr>
<td><code>lastFailureTime</code><br /> *<a href="#time-v1">Time</a>*</td>
<td></td>
</tr>
<tr>
<td><code>notAfter</code><br /> *<a href="#time-v1">Time</a>*</td>
<td>The expiration time of the certificate stored in the secret named by this resource in spec.secretName.</td>
</tr>
</tbody></table>
<hr>
<h1 id="clusterissuer-v1alpha2">ClusterIssuer v1alpha2</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>ClusterIssuer</code></td>
</tr>
</tbody></table>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources</a></td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> *<a href="#objectmeta-v1">ObjectMeta</a>*</td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> *<a href="#issuerspec-v1alpha2">IssuerSpec</a>*</td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> *<a href="#issuerstatus-v1alpha2">IssuerStatus</a>*</td>
<td></td>
</tr>
</tbody></table>
<hr>
<h1 id="issuer-v1alpha2">Issuer v1alpha2</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>Issuer</code></td>
</tr>
</tbody></table>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources</a></td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> *<a href="#objectmeta-v1">ObjectMeta</a>*</td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> *<a href="#issuerspec-v1alpha2">IssuerSpec</a>*</td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> *<a href="#issuerstatus-v1alpha2">IssuerStatus</a>*</td>
<td></td>
</tr>
</tbody></table>
<h3 id="issuerspec-v1alpha2">IssuerSpec v1alpha2</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#clusterissuer-v1alpha2">ClusterIssuer v1alpha2</a></li>
<li><a href="#issuer-v1alpha2">Issuer v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code><br /> *<a href="#acmeissuer-v1alpha2">ACMEIssuer</a>*</td>
<td></td>
</tr>
<tr>
<td><code>ca</code><br /> *<a href="#caissuer-v1alpha2">CAIssuer</a>*</td>
<td></td>
</tr>
<tr>
<td><code>selfSigned</code><br /> *<a href="#selfsignedissuer-v1alpha2">SelfSignedIssuer</a>*</td>
<td></td>
</tr>
<tr>
<td><code>vault</code><br /> *<a href="#vaultissuer-v1alpha2">VaultIssuer</a>*</td>
<td></td>
</tr>
<tr>
<td><code>venafi</code><br /> *<a href="#venafiissuer-v1alpha2">VenafiIssuer</a>*</td>
<td></td>
</tr>
</tbody></table>
<h3 id="issuerstatus-v1alpha2">IssuerStatus v1alpha2</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#clusterissuer-v1alpha2">ClusterIssuer v1alpha2</a></li>
<li><a href="#issuer-v1alpha2">Issuer v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code><br /> *<a href="#acmeissuerstatus-v1alpha2">ACMEIssuerStatus</a>*</td>
<td></td>
</tr>
<tr>
<td><code>conditions</code><br /> *<a href="#issuercondition-v1alpha2">IssuerCondition</a> array*</td>
<td></td>
</tr>
</tbody></table>
<h1 id="-strong-acme-strong-"><strong>Acme</strong></h1>
<hr>
<hr>
<h1 id="order-v1alpha2">Order v1alpha2</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>Order</code></td>
</tr>
</tbody></table>
<p>Order is a type to represent an Order with an ACME server</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources</a></td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> *<a href="#objectmeta-v1">ObjectMeta</a>*</td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> *<a href="#orderspec-v1alpha2">OrderSpec</a>*</td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> *<a href="#orderstatus-v1alpha2">OrderStatus</a>*</td>
<td></td>
</tr>
</tbody></table>
<h3 id="orderspec-v1alpha2">OrderSpec v1alpha2</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#order-v1alpha2">Order v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>commonName</code><br /> <em>string</em></td>
<td>CommonName is the common name as specified on the DER encoded CSR. If CommonName is not specified, the first DNSName specified will be used as the CommonName. At least one of CommonName or a DNSNames must be set. This field must match the corresponding field on the DER encoded CSR.</td>
</tr>
<tr>
<td><code>csr</code><br /> <em>string</em></td>
<td>Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order.</td>
</tr>
<tr>
<td><code>dnsNames</code><br /> <em>string array</em></td>
<td>DNSNames is a list of DNS names that should be included as part of the Order validation process. If CommonName is not specified, the first DNSName specified will be used as the CommonName. At least one of CommonName or a DNSNames must be set. This field must match the corresponding field on the DER encoded CSR.</td>
</tr>
<tr>
<td><code>issuerRef</code><br /> *<a href="#objectreference-v1">ObjectReference</a>*</td>
<td>IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an &#39;ACME&#39; Issuer, an error will be returned and the Order will be marked as failed.</td>
</tr>
</tbody></table>
<h3 id="orderstatus-v1alpha2">OrderStatus v1alpha2</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#order-v1alpha2">Order v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>authorizations</code><br /> *<a href="#acmeauthorization-v1alpha2">ACMEAuthorization</a> array*</td>
<td>Authorizations contains data returned from the ACME server on what authoriations must be completed in order to validate the DNS names specified on the Order.</td>
</tr>
<tr>
<td><code>certificate</code><br /> <em>string</em></td>
<td>Certificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the &#39;valid&#39; state.</td>
</tr>
<tr>
<td><code>failureTime</code><br /> *<a href="#time-v1">Time</a>*</td>
<td>FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off.</td>
</tr>
<tr>
<td><code>finalizeURL</code><br /> <em>string</em></td>
<td>FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed.</td>
</tr>
<tr>
<td><code>reason</code><br /> <em>string</em></td>
<td>Reason optionally provides more information about a why the order is in the current state.</td>
</tr>
<tr>
<td><code>state</code><br /> <em>string</em></td>
<td>State contains the current state of this Order resource. States &#39;success&#39; and &#39;expired&#39; are &#39;final&#39;</td>
</tr>
<tr>
<td><code>url</code><br /> <em>string</em></td>
<td>URL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set.</td>
</tr>
</tbody></table>
<hr>
<h1 id="challenge-v1alpha2">Challenge v1alpha2</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>Challenge</code></td>
</tr>
</tbody></table>
<p>Challenge is a type to represent a Challenge request with an ACME server</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources</a></td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> *<a href="#objectmeta-v1">ObjectMeta</a>*</td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> *<a href="#challengespec-v1alpha2">ChallengeSpec</a>*</td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> *<a href="#challengestatus-v1alpha2">ChallengeStatus</a>*</td>
<td></td>
</tr>
</tbody></table>
<h3 id="challengespec-v1alpha2">ChallengeSpec v1alpha2</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#challenge-v1alpha2">Challenge v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>authzURL</code><br /> <em>string</em></td>
<td>AuthzURL is the URL to the ACME Authorization resource that this challenge is a part of.</td>
</tr>
<tr>
<td><code>dnsName</code><br /> <em>string</em></td>
<td>DNSName is the identifier that this challenge is for, e.g. example.com.</td>
</tr>
<tr>
<td><code>issuerRef</code><br /> *<a href="#objectreference-v1">ObjectReference</a>*</td>
<td>IssuerRef references a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an &#39;ACME&#39; Issuer, an error will be returned and the Challenge will be marked as failed.</td>
</tr>
<tr>
<td><code>key</code><br /> <em>string</em></td>
<td>Key is the ACME challenge key for this challenge</td>
</tr>
<tr>
<td><code>solver</code><br /> *<a href="#acmechallengesolver-v1alpha2">ACMEChallengeSolver</a>*</td>
<td>Solver contains the domain solving configuration that should be used to solve this challenge resource. Only <strong>one</strong> of &#39;config&#39; or &#39;solver&#39; may be specified, and if both are specified then no action will be performed on the Challenge resource.</td>
</tr>
<tr>
<td><code>token</code><br /> <em>string</em></td>
<td>Token is the ACME challenge token for this challenge.</td>
</tr>
<tr>
<td><code>type</code><br /> <em>string</em></td>
<td>Type is the type of ACME challenge this resource represents, e.g. &#34;dns01&#34; or &#34;http01&#34;</td>
</tr>
<tr>
<td><code>url</code><br /> <em>string</em></td>
<td>URL is the URL of the ACME Challenge resource for this challenge. This can be used to lookup details about the status of this challenge.</td>
</tr>
<tr>
<td><code>wildcard</code><br /> <em>boolean</em></td>
<td>Wildcard will be true if this challenge is for a wildcard identifier, for example &#39;*.example.com&#39;</td>
</tr>
</tbody></table>
<h3 id="challengestatus-v1alpha2">ChallengeStatus v1alpha2</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#challenge-v1alpha2">Challenge v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>presented</code><br /> <em>boolean</em></td>
<td>Presented will be set to true if the challenge values for this challenge are currently &#39;presented&#39;. This <em>does not</em> imply the self check is passing. Only that the values have been &#39;submitted&#39; for the appropriate challenge mechanism (i.e. the DNS01 TXT record has been presented, or the HTTP01 configuration has been configured).</td>
</tr>
<tr>
<td><code>processing</code><br /> <em>boolean</em></td>
<td>Processing is used to denote whether this challenge should be processed or not. This field will only be set to true by the &#39;scheduling&#39; component. It will only be set to false by the &#39;challenges&#39; controller, after the challenge has reached a final state or timed out. If this field is set to false, the challenge controller will not take any more action.</td>
</tr>
<tr>
<td><code>reason</code><br /> <em>string</em></td>
<td>Reason contains human readable information on why the Challenge is in the current state.</td>
</tr>
<tr>
<td><code>state</code><br /> <em>string</em></td>
<td>State contains the current &#39;state&#39; of the challenge. If not set, the state of the challenge is unknown.</td>
</tr>
</tbody></table>
<h1 id="-strong-old-api-versions-strong-"><strong>Old API Versions</strong></h1>
<hr>
<h1 id="-strong-field-definitions-strong-"><strong>Field Definitions</strong></h1>
<hr>
<h2 id="acmeauthorization-v1alpha2">ACMEAuthorization v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEAuthorization</code></td>
</tr>
</tbody></table>
<p>ACMEAuthorization contains data returned from the ACME server on an authorization that must be completed in order validate a DNS name on an ACME Order resource.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#orderstatus-v1alpha2">OrderStatus v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>challenges</code><br /> *<a href="#acmechallenge-v1alpha2">ACMEChallenge</a> array*</td>
<td>Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process.</td>
</tr>
<tr>
<td><code>identifier</code><br /> <em>string</em></td>
<td>Identifier is the DNS name to be validated as part of this authorization</td>
</tr>
<tr>
<td><code>url</code><br /> <em>string</em></td>
<td>URL is the URL of the Authorization that must be completed</td>
</tr>
<tr>
<td><code>wildcard</code><br /> <em>boolean</em></td>
<td>Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the <em>non-wildcard</em> version of the DNS name. For example, if &#39;*.example.com&#39; is the DNS name being validated, this field will be &#39;true&#39; and the &#39;identifier&#39; field will be &#39;example.com&#39;.</td>
</tr>
</tbody></table>
<h2 id="acmechallenge-v1alpha2">ACMEChallenge v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEChallenge</code></td>
</tr>
</tbody></table>
<p>Challenge specifies a challenge offered by the ACME server for an Order. An appropriate Challenge resource can be created to perform the ACME challenge process.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmeauthorization-v1alpha2">ACMEAuthorization v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>token</code><br /> <em>string</em></td>
<td>Token is the token that must be presented for this challenge. This is used to compute the &#39;key&#39; that must also be presented.</td>
</tr>
<tr>
<td><code>type</code><br /> <em>string</em></td>
<td>Type is the type of challenge being offered, e.g. http-01, dns-01</td>
</tr>
<tr>
<td><code>url</code><br /> <em>string</em></td>
<td>URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.</td>
</tr>
</tbody></table>
<h2 id="acmechallengesolver-v1alpha2">ACMEChallengeSolver v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEChallengeSolver</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmeissuer-v1alpha2">ACMEIssuer v1alpha2</a></li>
<li><a href="#challengespec-v1alpha2">ChallengeSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>dns01</code><br /> *<a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01</a>*</td>
<td></td>
</tr>
<tr>
<td><code>http01</code><br /> *<a href="#acmechallengesolverhttp01-v1alpha2">ACMEChallengeSolverHTTP01</a>*</td>
<td></td>
</tr>
<tr>
<td><code>selector</code><br /> *<a href="#certificatednsnameselector-v1alpha2">CertificateDNSNameSelector</a>*</td>
<td>Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver.</td>
</tr>
</tbody></table>
<h2 id="acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEChallengeSolverDNS01</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolver-v1alpha2">ACMEChallengeSolver v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>acmedns</code><br /> *<a href="#acmeissuerdns01provideracmedns-v1alpha2">ACMEIssuerDNS01ProviderAcmeDNS</a>*</td>
<td></td>
</tr>
<tr>
<td><code>akamai</code><br /> *<a href="#acmeissuerdns01providerakamai-v1alpha2">ACMEIssuerDNS01ProviderAkamai</a>*</td>
<td></td>
</tr>
<tr>
<td><code>azuredns</code><br /> *<a href="#acmeissuerdns01providerazuredns-v1alpha2">ACMEIssuerDNS01ProviderAzureDNS</a>*</td>
<td></td>
</tr>
<tr>
<td><code>clouddns</code><br /> *<a href="#acmeissuerdns01providerclouddns-v1alpha2">ACMEIssuerDNS01ProviderCloudDNS</a>*</td>
<td></td>
</tr>
<tr>
<td><code>cloudflare</code><br /> *<a href="#acmeissuerdns01providercloudflare-v1alpha2">ACMEIssuerDNS01ProviderCloudflare</a>*</td>
<td></td>
</tr>
<tr>
<td><code>cnameStrategy</code><br /> <em>string</em></td>
<td>CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.</td>
</tr>
<tr>
<td><code>digitalocean</code><br /> *<a href="#acmeissuerdns01providerdigitalocean-v1alpha2">ACMEIssuerDNS01ProviderDigitalOcean</a>*</td>
<td></td>
</tr>
<tr>
<td><code>rfc2136</code><br /> *<a href="#acmeissuerdns01providerrfc2136-v1alpha2">ACMEIssuerDNS01ProviderRFC2136</a>*</td>
<td></td>
</tr>
<tr>
<td><code>route53</code><br /> *<a href="#acmeissuerdns01providerroute53-v1alpha2">ACMEIssuerDNS01ProviderRoute53</a>*</td>
<td></td>
</tr>
<tr>
<td><code>webhook</code><br /> *<a href="#acmeissuerdns01providerwebhook-v1alpha2">ACMEIssuerDNS01ProviderWebhook</a>*</td>
<td></td>
</tr>
</tbody></table>
<h2 id="acmechallengesolverhttp01-v1alpha2">ACMEChallengeSolverHTTP01 v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEChallengeSolverHTTP01</code></td>
</tr>
</tbody></table>
<p>ACMEChallengeSolverHTTP01 contains configuration detailing how to solve HTTP01 challenges within a Kubernetes cluster. Typically this is accomplished through creating &#39;routes&#39; of some description that configure ingress controllers to direct traffic to &#39;solver pods&#39;, which are responsible for responding to the ACME server&#39;s HTTP requests.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolver-v1alpha2">ACMEChallengeSolver v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>ingress</code><br /> *<a href="#acmechallengesolverhttp01ingress-v1alpha2">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>
</tbody></table>
<h2 id="acmechallengesolverhttp01ingress-v1alpha2">ACMEChallengeSolverHTTP01Ingress v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEChallengeSolverHTTP01Ingress</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverhttp01-v1alpha2">ACMEChallengeSolverHTTP01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>class</code><br /> <em>string</em></td>
<td>The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of &#39;class&#39; or &#39;name&#39; may be specified.</td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources.</td>
</tr>
<tr>
<td><code>podTemplate</code><br /> *<a href="#acmechallengesolverhttp01ingresspodtemplate-v1alpha2">ACMEChallengeSolverHTTP01IngressPodTemplate</a>*</td>
<td>Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges</td>
</tr>
<tr>
<td><code>serviceType</code><br /> <em>string</em></td>
<td>Optional service type for Kubernetes solver service</td>
</tr>
</tbody></table>
<h2 id="acmechallengesolverhttp01ingresspodspec-v1alpha2">ACMEChallengeSolverHTTP01IngressPodSpec v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEChallengeSolverHTTP01IngressPodSpec</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverhttp01ingresspodtemplate-v1alpha2">ACMEChallengeSolverHTTP01IngressPodTemplate v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>affinity</code><br /> *<a href="#affinity-v1">Affinity</a>*</td>
<td>If specified, the pod&#39;s scheduling constraints</td>
</tr>
<tr>
<td><code>nodeSelector</code><br /> <em>object</em></td>
<td>NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node&#39;s labels for the pod to be scheduled on that node. More info: <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/">https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</a></td>
</tr>
<tr>
<td><code>tolerations</code><br /> *<a href="#toleration-v1">Toleration</a> array*</td>
<td>If specified, the pod&#39;s tolerations.</td>
</tr>
</tbody></table>
<h2 id="acmechallengesolverhttp01ingresspodtemplate-v1alpha2">ACMEChallengeSolverHTTP01IngressPodTemplate v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEChallengeSolverHTTP01IngressPodTemplate</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverhttp01ingress-v1alpha2">ACMEChallengeSolverHTTP01Ingress v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>metadata</code><br /> *<a href="#objectmeta-v1">ObjectMeta</a>*</td>
<td>ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the &#39;labels&#39; and &#39;annotations&#39; fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values.</td>
</tr>
<tr>
<td><code>spec</code><br /> *<a href="#acmechallengesolverhttp01ingresspodspec-v1alpha2">ACMEChallengeSolverHTTP01IngressPodSpec</a>*</td>
<td>PodSpec defines overrides for the HTTP01 challenge solver pod. Only the &#39;nodeSelector&#39;, &#39;affinity&#39; and &#39;tolerations&#39; fields are supported currently. All other fields will be ignored.</td>
</tr>
</tbody></table>
<h2 id="acmeissuer-v1alpha2">ACMEIssuer v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuer</code></td>
</tr>
</tbody></table>
<p>ACMEIssuer contains the specification for an ACME issuer</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#issuerspec-v1alpha2">IssuerSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>email</code><br /> <em>string</em></td>
<td>Email is the email for this account</td>
</tr>
<tr>
<td><code>privateKeySecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td>PrivateKey is the name of a secret containing the private key for this user account.</td>
</tr>
<tr>
<td><code>server</code><br /> <em>string</em></td>
<td>Server is the ACME server URL</td>
</tr>
<tr>
<td><code>skipTLSVerify</code><br /> <em>boolean</em></td>
<td>If true, skip verifying the ACME server TLS certificate</td>
</tr>
<tr>
<td><code>solvers</code><br /> *<a href="#acmechallengesolver-v1alpha2">ACMEChallengeSolver</a> array*</td>
<td>Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains.</td>
</tr>
</tbody></table>
<h2 id="acmeissuerdns01provideracmedns-v1alpha2">ACMEIssuerDNS01ProviderAcmeDNS v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuerDNS01ProviderAcmeDNS</code></td>
</tr>
</tbody></table>
<p>ACMEIssuerDNS01ProviderAcmeDNS is a structure containing the configuration for ACME-DNS servers</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>accountSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td></td>
</tr>
<tr>
<td><code>host</code><br /> <em>string</em></td>
<td></td>
</tr>
</tbody></table>
<h2 id="acmeissuerdns01providerakamai-v1alpha2">ACMEIssuerDNS01ProviderAkamai v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuerDNS01ProviderAkamai</code></td>
</tr>
</tbody></table>
<p>ACMEIssuerDNS01ProviderAkamai is a structure containing the DNS configuration for Akamai DNS—Zone Record Management API</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>accessTokenSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td></td>
</tr>
<tr>
<td><code>clientSecretSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td></td>
</tr>
<tr>
<td><code>clientTokenSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td></td>
</tr>
<tr>
<td><code>serviceConsumerDomain</code><br /> <em>string</em></td>
<td></td>
</tr>
</tbody></table>
<h2 id="acmeissuerdns01providerazuredns-v1alpha2">ACMEIssuerDNS01ProviderAzureDNS v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuerDNS01ProviderAzureDNS</code></td>
</tr>
</tbody></table>
<p>ACMEIssuerDNS01ProviderAzureDNS is a structure containing the configuration for Azure DNS</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>clientID</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>clientSecretSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td></td>
</tr>
<tr>
<td><code>environment</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>hostedZoneName</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>resourceGroupName</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>subscriptionID</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>tenantID</code><br /> <em>string</em></td>
<td></td>
</tr>
</tbody></table>
<h2 id="acmeissuerdns01providerclouddns-v1alpha2">ACMEIssuerDNS01ProviderCloudDNS v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuerDNS01ProviderCloudDNS</code></td>
</tr>
</tbody></table>
<p>ACMEIssuerDNS01ProviderCloudDNS is a structure containing the DNS configuration for Google Cloud DNS</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>project</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>serviceAccountSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td></td>
</tr>
</tbody></table>
<h2 id="acmeissuerdns01providercloudflare-v1alpha2">ACMEIssuerDNS01ProviderCloudflare v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuerDNS01ProviderCloudflare</code></td>
</tr>
</tbody></table>
<p>ACMEIssuerDNS01ProviderCloudflare is a structure containing the DNS configuration for Cloudflare</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>apiKeySecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td></td>
</tr>
<tr>
<td><code>email</code><br /> <em>string</em></td>
<td></td>
</tr>
</tbody></table>
<h2 id="acmeissuerdns01providerdigitalocean-v1alpha2">ACMEIssuerDNS01ProviderDigitalOcean v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuerDNS01ProviderDigitalOcean</code></td>
</tr>
</tbody></table>
<p>ACMEIssuerDNS01ProviderDigitalOcean is a structure containing the DNS configuration for DigitalOcean Domains</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>tokenSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td></td>
</tr>
</tbody></table>
<h2 id="acmeissuerdns01providerrfc2136-v1alpha2">ACMEIssuerDNS01ProviderRFC2136 v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuerDNS01ProviderRFC2136</code></td>
</tr>
</tbody></table>
<p>ACMEIssuerDNS01ProviderRFC2136 is a structure containing the configuration for RFC2136 DNS</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>nameserver</code><br /> <em>string</em></td>
<td>The IP address of the DNS supporting RFC2136. Required. Note: FQDN is not a valid value, only IP.</td>
</tr>
<tr>
<td><code>tsigAlgorithm</code><br /> <em>string</em></td>
<td>The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when <code>tsigSecretSecretRef</code> and <code>tsigKeyName</code> are defined. Supported values are (case-insensitive): <code>HMACMD5</code> (default), <code>HMACSHA1</code>, <code>HMACSHA256</code> or <code>HMACSHA512</code>.</td>
</tr>
<tr>
<td><code>tsigKeyName</code><br /> <em>string</em></td>
<td>The TSIG Key name configured in the DNS. If <code>tsigSecretSecretRef</code> is defined, this field is required.</td>
</tr>
<tr>
<td><code>tsigSecretSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td>The name of the secret containing the TSIG value. If <code>tsigKeyName</code> is defined, this field is required.</td>
</tr>
</tbody></table>
<h2 id="acmeissuerdns01providerroute53-v1alpha2">ACMEIssuerDNS01ProviderRoute53 v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuerDNS01ProviderRoute53</code></td>
</tr>
</tbody></table>
<p>ACMEIssuerDNS01ProviderRoute53 is a structure containing the Route 53 configuration for AWS</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>accessKeyID</code><br /> <em>string</em></td>
<td>The AccessKeyID is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata see: <a href="https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials">https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials</a></td>
</tr>
<tr>
<td><code>hostedZoneID</code><br /> <em>string</em></td>
<td>If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.</td>
</tr>
<tr>
<td><code>region</code><br /> <em>string</em></td>
<td>Always set the region when using AccessKeyID and SecretAccessKey</td>
</tr>
<tr>
<td><code>role</code><br /> <em>string</em></td>
<td>Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata</td>
</tr>
<tr>
<td><code>secretAccessKeySecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td>The SecretAccessKey is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata <a href="https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials">https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials</a></td>
</tr>
</tbody></table>
<h2 id="acmeissuerdns01providerwebhook-v1alpha2">ACMEIssuerDNS01ProviderWebhook v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>ACMEIssuerDNS01ProviderWebhook</code></td>
</tr>
</tbody></table>
<p>ACMEIssuerDNS01ProviderWebhook specifies configuration for a webhook DNS01 provider, including where to POST ChallengePayload resources.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverdns01-v1alpha2">ACMEChallengeSolverDNS01 v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>config</code><br /> <em>JSON</em></td>
<td>Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation&#39;s documentation.</td>
</tr>
<tr>
<td><code>groupName</code><br /> <em>string</em></td>
<td>The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation.</td>
</tr>
<tr>
<td><code>solverName</code><br /> <em>string</em></td>
<td>The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. &#39;cloudflare&#39;.</td>
</tr>
</tbody></table>
<h2 id="affinity-v1">Affinity v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>Affinity</code></td>
</tr>
</tbody></table>
<p>Affinity is a group of affinity scheduling rules.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverhttp01ingresspodspec-v1alpha2">ACMEChallengeSolverHTTP01IngressPodSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>nodeAffinity</code><br /> *<a href="#nodeaffinity-v1">NodeAffinity</a>*</td>
<td>Describes node affinity scheduling rules for the pod.</td>
</tr>
<tr>
<td><code>podAffinity</code><br /> *<a href="#podaffinity-v1">PodAffinity</a>*</td>
<td>Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).</td>
</tr>
<tr>
<td><code>podAntiAffinity</code><br /> *<a href="#podantiaffinity-v1">PodAntiAffinity</a>*</td>
<td>Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).</td>
</tr>
</tbody></table>
<h2 id="caissuer-v1alpha2">CAIssuer v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>CAIssuer</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#issuerspec-v1alpha2">IssuerSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>secretName</code><br /> <em>string</em></td>
<td>SecretName is the name of the secret used to sign Certificates issued by this Issuer.</td>
</tr>
</tbody></table>
<h2 id="certificatecondition-v1alpha2">CertificateCondition v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>CertificateCondition</code></td>
</tr>
</tbody></table>
<p>CertificateCondition contains condition information for an Certificate.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificatestatus-v1alpha2">CertificateStatus v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>lastTransitionTime</code><br /> *<a href="#time-v1">Time</a>*</td>
<td>LastTransitionTime is the timestamp corresponding to the last status change of this condition.</td>
</tr>
<tr>
<td><code>message</code><br /> <em>string</em></td>
<td>Message is a human readable description of the details of the last transition, complementing reason.</td>
</tr>
<tr>
<td><code>reason</code><br /> <em>string</em></td>
<td>Reason is a brief machine readable explanation for the condition&#39;s last transition.</td>
</tr>
<tr>
<td><code>status</code><br /> <em>string</em></td>
<td>Status of the condition, one of (&#39;True&#39;, &#39;False&#39;, &#39;Unknown&#39;).</td>
</tr>
<tr>
<td><code>type</code><br /> <em>string</em></td>
<td>Type of the condition, currently (&#39;Ready&#39;).</td>
</tr>
</tbody></table>
<h2 id="certificatednsnameselector-v1alpha2">CertificateDNSNameSelector v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>acme</code></td>
<td><code>v1alpha2</code></td>
<td><code>CertificateDNSNameSelector</code></td>
</tr>
</tbody></table>
<p>CertificateDomainSelector selects certificates using a label selector, and can optionally select individual DNS names within those certificates. If both MatchLabels and DNSNames are empty, this selector will match all certificates and DNS names within them.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolver-v1alpha2">ACMEChallengeSolver v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>dnsNames</code><br /> <em>string array</em></td>
<td>List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.</td>
</tr>
<tr>
<td><code>dnsZones</code><br /> <em>string array</em></td>
<td>List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain <a href="http://www.sys.example.com">www.sys.example.com</a>. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.</td>
</tr>
<tr>
<td><code>matchLabels</code><br /> <em>object</em></td>
<td>A label selector that is used to refine the set of certificate&#39;s that this challenge solver will apply to.</td>
</tr>
</tbody></table>
<h2 id="duration-v1">Duration v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>Duration</code></td>
</tr>
</tbody></table>
<p>Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificatespec-v1alpha2">CertificateSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
</table>
<h2 id="fieldsv1-v1">FieldsV1 v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>FieldsV1</code></td>
</tr>
</tbody></table>
<p>FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.</p>
<p>Each key is either a &#39;.&#39; representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: &#39;f:&lt;name&gt;&#39;, where &lt;name&gt; is the name of a field in a struct, or key in a map &#39;v:&lt;value&gt;&#39;, where &lt;value&gt; is the exact json formatted value of a list item &#39;i:&lt;index&gt;&#39;, where &lt;index&gt; is position of a item in a list &#39;k:&lt;keys&gt;&#39;, where &lt;keys&gt; is a map of a list item&#39;s key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.</p>
<p>The exact format is defined in sigs.k8s.io/structured-merge-diff</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#managedfieldsentry-v1">ManagedFieldsEntry v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
</table>
<h2 id="issuercondition-v1alpha2">IssuerCondition v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>IssuerCondition</code></td>
</tr>
</tbody></table>
<p>IssuerCondition contains condition information for an Issuer.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#issuerstatus-v1alpha2">IssuerStatus v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>lastTransitionTime</code><br /> *<a href="#time-v1">Time</a>*</td>
<td>LastTransitionTime is the timestamp corresponding to the last status change of this condition.</td>
</tr>
<tr>
<td><code>message</code><br /> <em>string</em></td>
<td>Message is a human readable description of the details of the last transition, complementing reason.</td>
</tr>
<tr>
<td><code>reason</code><br /> <em>string</em></td>
<td>Reason is a brief machine readable explanation for the condition&#39;s last transition.</td>
</tr>
<tr>
<td><code>status</code><br /> <em>string</em></td>
<td>Status of the condition, one of (&#39;True&#39;, &#39;False&#39;, &#39;Unknown&#39;).</td>
</tr>
<tr>
<td><code>type</code><br /> <em>string</em></td>
<td>Type of the condition, currently (&#39;Ready&#39;).</td>
</tr>
</tbody></table>
<h2 id="labelselector-v1">LabelSelector v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>LabelSelector</code></td>
</tr>
</tbody></table>
<p>A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#podaffinityterm-v1">PodAffinityTerm v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>matchExpressions</code><br /> *<a href="#labelselectorrequirement-v1">LabelSelectorRequirement</a> array*</td>
<td>matchExpressions is a list of label selector requirements. The requirements are ANDed.</td>
</tr>
<tr>
<td><code>matchLabels</code><br /> <em>object</em></td>
<td>matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is &#34;key&#34;, the operator is &#34;In&#34;, and the values array contains only &#34;value&#34;. The requirements are ANDed.</td>
</tr>
</tbody></table>
<h2 id="labelselectorrequirement-v1">LabelSelectorRequirement v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>LabelSelectorRequirement</code></td>
</tr>
</tbody></table>
<p>A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#labelselector-v1">LabelSelector v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>key</code><br /> <em>string</em> <br /> <strong>patch type</strong>: <em>merge</em> <br /> <strong>patch merge key</strong>: <em>key</em></td>
<td>key is the label key that the selector applies to.</td>
</tr>
<tr>
<td><code>operator</code><br /> <em>string</em></td>
<td>operator represents a key&#39;s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.</td>
</tr>
<tr>
<td><code>values</code><br /> <em>string array</em></td>
<td>values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.</td>
</tr>
</tbody></table>
<h2 id="localobjectreference-v1">LocalObjectReference v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>LocalObjectReference</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#venafitpp-v1alpha2">VenafiTPP v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>name</code><br /> <em>string</em></td>
<td>Name of the referent. More info: <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names">https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names</a></td>
</tr>
</tbody></table>
<h2 id="managedfieldsentry-v1">ManagedFieldsEntry v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>ManagedFieldsEntry</code></td>
</tr>
</tbody></table>
<p>ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#objectmeta-v1">ObjectMeta v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>APIVersion defines the version of this resource that this field set applies to. The format is &#34;group/version&#34; just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.</td>
</tr>
<tr>
<td><code>fieldsType</code><br /> <em>string</em></td>
<td>FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: &#34;FieldsV1&#34;</td>
</tr>
<tr>
<td><code>fieldsV1</code><br /> *<a href="#fieldsv1-v1">FieldsV1</a>*</td>
<td>FieldsV1 holds the first JSON version format as described in the &#34;FieldsV1&#34; type.</td>
</tr>
<tr>
<td><code>manager</code><br /> <em>string</em></td>
<td>Manager is an identifier of the workflow managing these fields.</td>
</tr>
<tr>
<td><code>operation</code><br /> <em>string</em></td>
<td>Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are &#39;Apply&#39; and &#39;Update&#39;.</td>
</tr>
<tr>
<td><code>time</code><br /> *<a href="#time-v1">Time</a>*</td>
<td>Time is timestamp of when these fields were set. It should always be empty if Operation is &#39;Apply&#39;</td>
</tr>
</tbody></table>
<h2 id="nodeaffinity-v1">NodeAffinity v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>NodeAffinity</code></td>
</tr>
</tbody></table>
<p>Node affinity is a group of node affinity scheduling rules.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#affinity-v1">Affinity v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>preferredDuringSchedulingIgnoredDuringExecution</code><br /> *<a href="#preferredschedulingterm-v1">PreferredSchedulingTerm</a> array*</td>
<td>The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding &#34;weight&#34; to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.</td>
</tr>
<tr>
<td><code>requiredDuringSchedulingIgnoredDuringExecution</code><br /> *<a href="#nodeselector-v1">NodeSelector</a>*</td>
<td>If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.</td>
</tr>
</tbody></table>
<h2 id="nodeselector-v1">NodeSelector v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>NodeSelector</code></td>
</tr>
</tbody></table>
<p>A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#nodeaffinity-v1">NodeAffinity v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>nodeSelectorTerms</code><br /> *<a href="#nodeselectorterm-v1">NodeSelectorTerm</a> array*</td>
<td>Required. A list of node selector terms. The terms are ORed.</td>
</tr>
</tbody></table>
<h2 id="nodeselectorrequirement-v1">NodeSelectorRequirement v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>NodeSelectorRequirement</code></td>
</tr>
</tbody></table>
<p>A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#nodeselectorterm-v1">NodeSelectorTerm v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>key</code><br /> <em>string</em></td>
<td>The label key that the selector applies to.</td>
</tr>
<tr>
<td><code>operator</code><br /> <em>string</em></td>
<td>Represents a key&#39;s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.</td>
</tr>
<tr>
<td><code>values</code><br /> <em>string array</em></td>
<td>An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.</td>
</tr>
</tbody></table>
<h2 id="nodeselectorterm-v1">NodeSelectorTerm v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>NodeSelectorTerm</code></td>
</tr>
</tbody></table>
<p>A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#nodeselector-v1">NodeSelector v1</a></li>
<li><a href="#preferredschedulingterm-v1">PreferredSchedulingTerm v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>matchExpressions</code><br /> *<a href="#nodeselectorrequirement-v1">NodeSelectorRequirement</a> array*</td>
<td>A list of node selector requirements by node&#39;s labels.</td>
</tr>
<tr>
<td><code>matchFields</code><br /> *<a href="#nodeselectorrequirement-v1">NodeSelectorRequirement</a> array*</td>
<td>A list of node selector requirements by node&#39;s fields.</td>
</tr>
</tbody></table>
<h2 id="objectmeta-v1">ObjectMeta v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>ObjectMeta</code></td>
</tr>
</tbody></table>
<p>ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverhttp01ingresspodtemplate-v1alpha2">ACMEChallengeSolverHTTP01IngressPodTemplate v1alpha2</a></li>
<li><a href="#certificate-v1alpha2">Certificate v1alpha2</a></li>
<li><a href="#challenge-v1alpha2">Challenge v1alpha2</a></li>
<li><a href="#clusterissuer-v1alpha2">ClusterIssuer v1alpha2</a></li>
<li><a href="#issuer-v1alpha2">Issuer v1alpha2</a></li>
<li><a href="#order-v1alpha2">Order v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>annotations</code><br /> <em>object</em></td>
<td>Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: <a href="http://kubernetes.io/docs/user-guide/annotations">http://kubernetes.io/docs/user-guide/annotations</a></td>
</tr>
<tr>
<td><code>clusterName</code><br /> <em>string</em></td>
<td>The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.</td>
</tr>
<tr>
<td><code>creationTimestamp</code><br /> *<a href="#time-v1">Time</a>*</td>
<td>CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</a></td>
</tr>
<tr>
<td><code>deletionGracePeriodSeconds</code><br /> <em>integer</em></td>
<td>Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.</td>
</tr>
<tr>
<td><code>deletionTimestamp</code><br /> *<a href="#time-v1">Time</a>*</td>
<td>DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</a></td>
</tr>
<tr>
<td><code>finalizers</code><br /> <em>string array</em> <br /> <strong>patch type</strong>: <em>merge</em></td>
<td>Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.</td>
</tr>
<tr>
<td><code>generateName</code><br /> <em>string</em></td>
<td>GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency</a></td>
</tr>
<tr>
<td><code>generation</code><br /> <em>integer</em></td>
<td>A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.</td>
</tr>
<tr>
<td><code>labels</code><br /> <em>object</em></td>
<td>Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: <a href="http://kubernetes.io/docs/user-guide/labels">http://kubernetes.io/docs/user-guide/labels</a></td>
</tr>
<tr>
<td><code>managedFields</code><br /> *<a href="#managedfieldsentry-v1">ManagedFieldsEntry</a> array*</td>
<td>ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn&#39;t need to set or understand this field. A workflow can be the user&#39;s name, a controller&#39;s name, or the name of a specific apply path like &#34;ci-cd&#34;. The set of fields is always in the version that the workflow used when modifying the object. This field is alpha and can be changed or removed without notice.</td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#names">http://kubernetes.io/docs/user-guide/identifiers#names</a></td>
</tr>
<tr>
<td><code>namespace</code><br /> <em>string</em></td>
<td>Namespace defines the space within each name must be unique. An empty namespace is equivalent to the &#34;default&#34; namespace, but &#34;default&#34; is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: <a href="http://kubernetes.io/docs/user-guide/namespaces">http://kubernetes.io/docs/user-guide/namespaces</a></td>
</tr>
<tr>
<td><code>ownerReferences</code><br /> *<a href="#ownerreference-v1">OwnerReference</a> array* <br /> <strong>patch type</strong>: <em>merge</em> <br /> <strong>patch merge key</strong>: <em>uid</em></td>
<td>List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.</td>
</tr>
<tr>
<td><code>resourceVersion</code><br /> <em>string</em></td>
<td>An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency</a></td>
</tr>
<tr>
<td><code>selfLink</code><br /> <em>string</em></td>
<td>SelfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.</td>
</tr>
<tr>
<td><code>uid</code><br /> <em>string</em></td>
<td>UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#uids">http://kubernetes.io/docs/user-guide/identifiers#uids</a></td>
</tr>
</tbody></table>
<h2 id="objectreference-v1">ObjectReference v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>ObjectReference</code></td>
</tr>
</tbody></table>
<p>ObjectReference is a reference to an object with a given name, kind and group.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificatespec-v1alpha2">CertificateSpec v1alpha2</a></li>
<li><a href="#challengespec-v1alpha2">ChallengeSpec v1alpha2</a></li>
<li><a href="#orderspec-v1alpha2">OrderSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>group</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td></td>
</tr>
</tbody></table>
<h2 id="ownerreference-v1">OwnerReference v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>OwnerReference</code></td>
</tr>
</tbody></table>
<p>OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#objectmeta-v1">ObjectMeta v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>apiVersion</code><br /> <em>string</em></td>
<td>API version of the referent.</td>
</tr>
<tr>
<td><code>blockOwnerDeletion</code><br /> <em>boolean</em></td>
<td>If true, AND if the owner has the &#34;foregroundDeletion&#34; finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs &#34;delete&#34; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.</td>
</tr>
<tr>
<td><code>controller</code><br /> <em>boolean</em></td>
<td>If true, this reference points to the managing controller.</td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>Kind of the referent. More info: <a href="https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>Name of the referent. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#names">http://kubernetes.io/docs/user-guide/identifiers#names</a></td>
</tr>
<tr>
<td><code>uid</code><br /> <em>string</em></td>
<td>UID of the referent. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#uids">http://kubernetes.io/docs/user-guide/identifiers#uids</a></td>
</tr>
</tbody></table>
<h2 id="podaffinity-v1">PodAffinity v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>PodAffinity</code></td>
</tr>
</tbody></table>
<p>Pod affinity is a group of inter pod affinity scheduling rules.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#affinity-v1">Affinity v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>preferredDuringSchedulingIgnoredDuringExecution</code><br /> *<a href="#weightedpodaffinityterm-v1">WeightedPodAffinityTerm</a> array*</td>
<td>The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding &#34;weight&#34; to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.</td>
</tr>
<tr>
<td><code>requiredDuringSchedulingIgnoredDuringExecution</code><br /> *<a href="#podaffinityterm-v1">PodAffinityTerm</a> array*</td>
<td>If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.</td>
</tr>
</tbody></table>
<h2 id="podaffinityterm-v1">PodAffinityTerm v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>PodAffinityTerm</code></td>
</tr>
</tbody></table>
<p>Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key &lt;topologyKey&gt; matches that of any node on which a pod of the set of pods is running</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#podaffinity-v1">PodAffinity v1</a></li>
<li><a href="#podantiaffinity-v1">PodAntiAffinity v1</a></li>
<li><a href="#weightedpodaffinityterm-v1">WeightedPodAffinityTerm v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>labelSelector</code><br /> *<a href="#labelselector-v1">LabelSelector</a>*</td>
<td>A label query over a set of resources, in this case pods.</td>
</tr>
<tr>
<td><code>namespaces</code><br /> <em>string array</em></td>
<td>namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means &#34;this pod&#39;s namespace&#34;</td>
</tr>
<tr>
<td><code>topologyKey</code><br /> <em>string</em></td>
<td>This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.</td>
</tr>
</tbody></table>
<h2 id="podantiaffinity-v1">PodAntiAffinity v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>PodAntiAffinity</code></td>
</tr>
</tbody></table>
<p>Pod anti affinity is a group of inter pod anti affinity scheduling rules.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#affinity-v1">Affinity v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>preferredDuringSchedulingIgnoredDuringExecution</code><br /> *<a href="#weightedpodaffinityterm-v1">WeightedPodAffinityTerm</a> array*</td>
<td>The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding &#34;weight&#34; to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.</td>
</tr>
<tr>
<td><code>requiredDuringSchedulingIgnoredDuringExecution</code><br /> *<a href="#podaffinityterm-v1">PodAffinityTerm</a> array*</td>
<td>If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.</td>
</tr>
</tbody></table>
<h2 id="preferredschedulingterm-v1">PreferredSchedulingTerm v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>PreferredSchedulingTerm</code></td>
</tr>
</tbody></table>
<p>An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it&#39;s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#nodeaffinity-v1">NodeAffinity v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>preference</code><br /> *<a href="#nodeselectorterm-v1">NodeSelectorTerm</a>*</td>
<td>A node selector term, associated with the corresponding weight.</td>
</tr>
<tr>
<td><code>weight</code><br /> <em>integer</em></td>
<td>Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.</td>
</tr>
</tbody></table>
<h2 id="secretkeyselector-v1">SecretKeySelector v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>SecretKeySelector</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmeissuer-v1alpha2">ACMEIssuer v1alpha2</a></li>
<li><a href="#acmeissuerdns01provideracmedns-v1alpha2">ACMEIssuerDNS01ProviderAcmeDNS v1alpha2</a></li>
<li><a href="#acmeissuerdns01providerakamai-v1alpha2">ACMEIssuerDNS01ProviderAkamai v1alpha2</a></li>
<li><a href="#acmeissuerdns01providerazuredns-v1alpha2">ACMEIssuerDNS01ProviderAzureDNS v1alpha2</a></li>
<li><a href="#acmeissuerdns01providerclouddns-v1alpha2">ACMEIssuerDNS01ProviderCloudDNS v1alpha2</a></li>
<li><a href="#acmeissuerdns01providercloudflare-v1alpha2">ACMEIssuerDNS01ProviderCloudflare v1alpha2</a></li>
<li><a href="#acmeissuerdns01providerdigitalocean-v1alpha2">ACMEIssuerDNS01ProviderDigitalOcean v1alpha2</a></li>
<li><a href="#acmeissuerdns01providerrfc2136-v1alpha2">ACMEIssuerDNS01ProviderRFC2136 v1alpha2</a></li>
<li><a href="#acmeissuerdns01providerroute53-v1alpha2">ACMEIssuerDNS01ProviderRoute53 v1alpha2</a></li>
<li><a href="#vaultapprole-v1alpha2">VaultAppRole v1alpha2</a></li>
<li><a href="#vaultauth-v1alpha2">VaultAuth v1alpha2</a></li>
<li><a href="#venaficloud-v1alpha2">VenafiCloud v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>key</code><br /> <em>string</em></td>
<td>The key of the secret to select from. Must be a valid secret key.</td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>Name of the referent. More info: <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names">https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names</a></td>
</tr>
</tbody></table>
<h2 id="selfsignedissuer-v1alpha2">SelfSignedIssuer v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>SelfSignedIssuer</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#issuerspec-v1alpha2">IssuerSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
</table>
<h2 id="time-v1">Time v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>meta</code></td>
<td><code>v1</code></td>
<td><code>Time</code></td>
</tr>
</tbody></table>
<p>Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificatecondition-v1alpha2">CertificateCondition v1alpha2</a></li>
<li><a href="#certificatestatus-v1alpha2">CertificateStatus v1alpha2</a></li>
<li><a href="#issuercondition-v1alpha2">IssuerCondition v1alpha2</a></li>
<li><a href="#managedfieldsentry-v1">ManagedFieldsEntry v1</a></li>
<li><a href="#objectmeta-v1">ObjectMeta v1</a></li>
<li><a href="#orderstatus-v1alpha2">OrderStatus v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
</table>
<h2 id="toleration-v1">Toleration v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>Toleration</code></td>
</tr>
</tbody></table>
<p>The pod this Toleration is attached to tolerates any taint that matches the triple &lt;key,value,effect&gt; using the matching operator &lt;operator&gt;.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmechallengesolverhttp01ingresspodspec-v1alpha2">ACMEChallengeSolverHTTP01IngressPodSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>effect</code><br /> <em>string</em></td>
<td>Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.</td>
</tr>
<tr>
<td><code>key</code><br /> <em>string</em></td>
<td>Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.</td>
</tr>
<tr>
<td><code>operator</code><br /> <em>string</em></td>
<td>Operator represents a key&#39;s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.</td>
</tr>
<tr>
<td><code>tolerationSeconds</code><br /> <em>integer</em></td>
<td>TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.</td>
</tr>
<tr>
<td><code>value</code><br /> <em>string</em></td>
<td>Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.</td>
</tr>
</tbody></table>
<h2 id="vaultapprole-v1alpha2">VaultAppRole v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>VaultAppRole</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#vaultauth-v1alpha2">VaultAuth v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code><br /> <em>string</em></td>
<td>Where the authentication path is mounted in Vault.</td>
</tr>
<tr>
<td><code>roleId</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>secretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td></td>
</tr>
</tbody></table>
<h2 id="vaultauth-v1alpha2">VaultAuth v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>VaultAuth</code></td>
</tr>
</tbody></table>
<p>Vault authentication can be configured: - With a secret containing a token. Cert-manager is using this token as-is. - With a secret containing a AppRole. This AppRole is used to authenticate to
Vault and retrieve a token.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#vaultissuer-v1alpha2">VaultIssuer v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>appRole</code><br /> *<a href="#vaultapprole-v1alpha2">VaultAppRole</a>*</td>
<td>This Secret contains a AppRole and Secret</td>
</tr>
<tr>
<td><code>tokenSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td>This Secret contains the Vault token key</td>
</tr>
</tbody></table>
<h2 id="vaultissuer-v1alpha2">VaultIssuer v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>VaultIssuer</code></td>
</tr>
</tbody></table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#issuerspec-v1alpha2">IssuerSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>auth</code><br /> *<a href="#vaultauth-v1alpha2">VaultAuth</a>*</td>
<td>Vault authentication</td>
</tr>
<tr>
<td><code>caBundle</code><br /> <em>string</em></td>
<td>Base64 encoded CA bundle to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection.</td>
</tr>
<tr>
<td><code>path</code><br /> <em>string</em></td>
<td>Vault URL path to the certificate role</td>
</tr>
<tr>
<td><code>server</code><br /> <em>string</em></td>
<td>Server is the vault connection address</td>
</tr>
</tbody></table>
<h2 id="venaficloud-v1alpha2">VenafiCloud v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>VenafiCloud</code></td>
</tr>
</tbody></table>
<p>VenafiCloud defines connection configuration details for Venafi Cloud</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#venafiissuer-v1alpha2">VenafiIssuer v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>apiTokenSecretRef</code><br /> *<a href="#secretkeyselector-v1">SecretKeySelector</a>*</td>
<td>APITokenSecretRef is a secret key selector for the Venafi Cloud API token.</td>
</tr>
<tr>
<td><code>url</code><br /> <em>string</em></td>
<td>URL is the base URL for Venafi Cloud</td>
</tr>
</tbody></table>
<h2 id="venafiissuer-v1alpha2">VenafiIssuer v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>VenafiIssuer</code></td>
</tr>
</tbody></table>
<p>VenafiIssuer describes issuer configuration details for Venafi Cloud.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#issuerspec-v1alpha2">IssuerSpec v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>cloud</code><br /> *<a href="#venaficloud-v1alpha2">VenafiCloud</a>*</td>
<td>Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified.</td>
</tr>
<tr>
<td><code>tpp</code><br /> *<a href="#venafitpp-v1alpha2">VenafiTPP</a>*</td>
<td>TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified.</td>
</tr>
<tr>
<td><code>zone</code><br /> <em>string</em></td>
<td>Zone is the Venafi Policy Zone to use for this issuer. All requests made to the Venafi platform will be restricted by the named zone policy. This field is required.</td>
</tr>
</tbody></table>
<h2 id="venafitpp-v1alpha2">VenafiTPP v1alpha2</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>certmanager</code></td>
<td><code>v1alpha2</code></td>
<td><code>VenafiTPP</code></td>
</tr>
</tbody></table>
<p>VenafiTPP defines connection configuration details for a Venafi TPP instance</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#venafiissuer-v1alpha2">VenafiIssuer v1alpha2</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>caBundle</code><br /> <em>string</em></td>
<td>CABundle is a PEM encoded TLS certifiate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates.</td>
</tr>
<tr>
<td><code>credentialsRef</code><br /> *<a href="#localobjectreference-v1">LocalObjectReference</a>*</td>
<td>CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, &#39;username&#39; and &#39;password&#39;.</td>
</tr>
<tr>
<td><code>url</code><br /> <em>string</em></td>
<td>URL is the base URL for the Venafi TPP instance</td>
</tr>
</tbody></table>
<h2 id="weightedpodaffinityterm-v1">WeightedPodAffinityTerm v1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody><tr>
<td><code>core</code></td>
<td><code>v1</code></td>
<td><code>WeightedPodAffinityTerm</code></td>
</tr>
</tbody></table>
<p>The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#podaffinity-v1">PodAffinity v1</a></li>
<li><a href="#podantiaffinity-v1">PodAntiAffinity v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody><tr>
<td><code>podAffinityTerm</code><br /> *<a href="#podaffinityterm-v1">PodAffinityTerm</a>*</td>
<td>Required. A pod affinity term, associated with the corresponding weight.</td>
</tr>
<tr>
<td><code>weight</code><br /> <em>integer</em></td>
<td>weight associated with matching the corresponding podAffinityTerm, in the range 1-100.</td>
</tr>
</tbody></table>
</div>
</div>
<script src="node_modules/jquery/dist/jquery.min.js"></script>
<script src="node_modules/jquery.scrollto/jquery.scrollTo.min.js"></script>
<script src="navData.js"></script>
<script src="scroll.js"></script>
<!--<script src="actions.js"></script>-->
<script src="tabvisibility.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink