weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
bb7d2f5f4e
cert-manager/docs/generated/reference/output/reference/api-docs/index.html
James Munnelly 77796efb3b Update reference docs 
Signed-off-by: James Munnelly <james@munnelly.eu>
2018-12-04 13:57:27 +00:00

2375 lines
78 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-v1alpha1" class="nav-item">Certificate v1alpha1</a></li></ul><ul><li class="nav-level-1"><a href="#clusterissuer-v1alpha1" class="nav-item">ClusterIssuer v1alpha1</a></li></ul><ul><li class="nav-level-1"><a href="#issuer-v1alpha1" class="nav-item">Issuer v1alpha1</a></li></ul><ul><li class="nav-level-1"><a href="#order-v1alpha1" class="nav-item">Order v1alpha1</a></li></ul><ul><li class="nav-level-1"><a href="#challenge-v1alpha1" class="nav-item">Challenge v1alpha1</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="#acmecertificateconfig-v1alpha1" class="nav-item">ACMECertificateConfig v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuer-v1alpha1" class="nav-item">ACMEIssuer v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01config-v1alpha1" class="nav-item">ACMEIssuerDNS01Config v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01provider-v1alpha1" class="nav-item">ACMEIssuerDNS01Provider v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01provideracmedns-v1alpha1" class="nav-item">ACMEIssuerDNS01ProviderAcmeDNS v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerakamai-v1alpha1" class="nav-item">ACMEIssuerDNS01ProviderAkamai v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerazuredns-v1alpha1" class="nav-item">ACMEIssuerDNS01ProviderAzureDNS v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerclouddns-v1alpha1" class="nav-item">ACMEIssuerDNS01ProviderCloudDNS v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providercloudflare-v1alpha1" class="nav-item">ACMEIssuerDNS01ProviderCloudflare v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerdigitalocean-v1alpha1" class="nav-item">ACMEIssuerDNS01ProviderDigitalOcean v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerrfc2136-v1alpha1" class="nav-item">ACMEIssuerDNS01ProviderRFC2136 v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerdns01providerroute53-v1alpha1" class="nav-item">ACMEIssuerDNS01ProviderRoute53 v1alpha1</a></li><li class="nav-level-2"><a href="#acmeissuerhttp01config-v1alpha1" class="nav-item">ACMEIssuerHTTP01Config v1alpha1</a></li><li class="nav-level-2"><a href="#caissuer-v1alpha1" class="nav-item">CAIssuer v1alpha1</a></li><li class="nav-level-2"><a href="#certificatecondition-v1alpha1" class="nav-item">CertificateCondition v1alpha1</a></li><li class="nav-level-2"><a href="#dns01solverconfig-v1alpha1" class="nav-item">DNS01SolverConfig v1alpha1</a></li><li class="nav-level-2"><a href="#domainsolverconfig-v1alpha1" class="nav-item">DomainSolverConfig v1alpha1</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="#http01solverconfig-v1alpha1" class="nav-item">HTTP01SolverConfig v1alpha1</a></li><li class="nav-level-2"><a href="#initializer-v1" class="nav-item">Initializer v1</a></li><li class="nav-level-2"><a href="#initializers-v1" class="nav-item">Initializers v1</a></li><li class="nav-level-2"><a href="#issuercondition-v1alpha1" class="nav-item">IssuerCondition v1alpha1</a></li><li class="nav-level-2"><a href="#listmeta-v1" class="nav-item">ListMeta 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-v1alpha1" class="nav-item">ObjectReference v1alpha1</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="#secretkeyselector-v1alpha1" class="nav-item">SecretKeySelector v1alpha1</a></li><li class="nav-level-2"><a href="#selfsignedissuer-v1alpha1" class="nav-item">SelfSignedIssuer v1alpha1</a></li><li class="nav-level-2"><a href="#solverconfig-v1alpha1" class="nav-item">SolverConfig v1alpha1</a></li><li class="nav-level-2"><a href="#status-v1" class="nav-item">Status v1</a></li><li class="nav-level-2"><a href="#statuscause-v1" class="nav-item">StatusCause v1</a></li><li class="nav-level-2"><a href="#statusdetails-v1" class="nav-item">StatusDetails v1</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="#vaultapprole-v1alpha1" class="nav-item">VaultAppRole v1alpha1</a></li><li class="nav-level-2"><a href="#vaultauth-v1alpha1" class="nav-item">VaultAuth v1alpha1</a></li><li class="nav-level-2"><a href="#vaultissuer-v1alpha1" class="nav-item">VaultIssuer v1alpha1</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://cert-manager.readthedocs.io/">official documentation</a>.</p>
<hr>
<h1 id="certificate-v1alpha1">Certificate v1alpha1</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> <em><a href="#objectmeta-v1">ObjectMeta</a></em></td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> <em><a href="#certificatespec-v1alpha1">CertificateSpec</a></em></td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> <em><a href="#certificatestatus-v1alpha1">CertificateStatus</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="certificatespec-v1alpha1">CertificateSpec v1alpha1</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificate-v1alpha1">Certificate v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>acme</code><br /> <em><a href="#acmecertificateconfig-v1alpha1">ACMECertificateConfig</a></em></td>
<td>ACME contains configuration specific to ACME Certificates. Notably, this contains details on how the domain names listed on this Certificate resource should be &#39;solved&#39;, i.e. mapping HTTP01 and DNS01 providers to DNS names.</td>
</tr>
<tr>
<td><code>commonName</code><br /> <em>string</em></td>
<td>CommonName is a common name to be used on the Certificate</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</td>
</tr>
<tr>
<td><code>duration</code><br /> <em><a href="#duration-v1">Duration</a></em></td>
<td>Certificate default Duration</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;signing&#39; usage is set</td>
</tr>
<tr>
<td><code>issuerRef</code><br /> <em><a href="#objectreference-v1alpha1">ObjectReference</a></em></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>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 /> <em><a href="#duration-v1">Duration</a></em></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>
</tbody>
</table>
<h3 id="certificatestatus-v1alpha1">CertificateStatus v1alpha1</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificate-v1alpha1">Certificate v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>conditions</code><br /> <em><a href="#certificatecondition-v1alpha1">CertificateCondition</a> array</em></td>
<td></td>
</tr>
<tr>
<td><code>lastFailureTime</code><br /> <em><a href="#time-v1">Time</a></em></td>
<td></td>
</tr>
<tr>
<td><code>notAfter</code><br /> <em><a href="#time-v1">Time</a></em></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-v1alpha1">ClusterIssuer v1alpha1</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> <em><a href="#objectmeta-v1">ObjectMeta</a></em></td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> <em><a href="#issuerspec-v1alpha1">IssuerSpec</a></em></td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> <em><a href="#issuerstatus-v1alpha1">IssuerStatus</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<hr>
<h1 id="issuer-v1alpha1">Issuer v1alpha1</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> <em><a href="#objectmeta-v1">ObjectMeta</a></em></td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> <em><a href="#issuerspec-v1alpha1">IssuerSpec</a></em></td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> <em><a href="#issuerstatus-v1alpha1">IssuerStatus</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="issuerspec-v1alpha1">IssuerSpec v1alpha1</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#clusterissuer-v1alpha1">ClusterIssuer v1alpha1</a></li>
<li><a href="#issuer-v1alpha1">Issuer v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>acme</code><br /> <em><a href="#acmeissuer-v1alpha1">ACMEIssuer</a></em></td>
<td></td>
</tr>
<tr>
<td><code>ca</code><br /> <em><a href="#caissuer-v1alpha1">CAIssuer</a></em></td>
<td></td>
</tr>
<tr>
<td><code>selfSigned</code><br /> <em><a href="#selfsignedissuer-v1alpha1">SelfSignedIssuer</a></em></td>
<td></td>
</tr>
<tr>
<td><code>vault</code><br /> <em><a href="#vaultissuer-v1alpha1">VaultIssuer</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="issuerstatus-v1alpha1">IssuerStatus v1alpha1</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#clusterissuer-v1alpha1">ClusterIssuer v1alpha1</a></li>
<li><a href="#issuer-v1alpha1">Issuer v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>acme</code><br /> <em><a href="#acmeissuerstatus-v1alpha1">ACMEIssuerStatus</a></em></td>
<td></td>
</tr>
<tr>
<td><code>conditions</code><br /> <em><a href="#issuercondition-v1alpha1">IssuerCondition</a> array</em></td>
<td></td>
</tr>
</tbody>
</table>
<hr>
<h1 id="order-v1alpha1">Order v1alpha1</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>Order</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/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> <em><a href="#objectmeta-v1">ObjectMeta</a></em></td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> <em><a href="#orderspec-v1alpha1">OrderSpec</a></em></td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> <em><a href="#orderstatus-v1alpha1">OrderStatus</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="orderspec-v1alpha1">OrderSpec v1alpha1</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#order-v1alpha1">Order v1alpha1</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 on of CommonName or a DNSName must be set. This field must match the corresponding field on the DER encoded CSR.</td>
</tr>
<tr>
<td><code>config</code><br /> <em><a href="#domainsolverconfig-v1alpha1">DomainSolverConfig</a> array</em></td>
<td>Config specifies a mapping from DNS identifiers to how those identifiers should be solved when performing ACME challenges. A config entry must exist for each domain listed in DNSNames and CommonName.</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 on of CommonName or a DNSName must be set. This field must match the corresponding field on the DER encoded CSR.</td>
</tr>
<tr>
<td><code>issuerRef</code><br /> <em><a href="#objectreference-v1alpha1">ObjectReference</a></em></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-v1alpha1">OrderStatus v1alpha1</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#order-v1alpha1">Order v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<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>challenges</code><br /> <em><a href="#challengespec-v1alpha1">ChallengeSpec</a> array</em></td>
<td>Challenges is a list of ChallengeSpecs for Challenges that must be created in order to complete this Order.</td>
</tr>
<tr>
<td><code>failureTime</code><br /> <em><a href="#time-v1">Time</a></em></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-v1alpha1">Challenge v1alpha1</h1>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>Challenge</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/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>metadata</code><br /> <em><a href="#objectmeta-v1">ObjectMeta</a></em></td>
<td></td>
</tr>
<tr>
<td><code>spec</code><br /> <em><a href="#challengespec-v1alpha1">ChallengeSpec</a></em></td>
<td></td>
</tr>
<tr>
<td><code>status</code><br /> <em><a href="#challengestatus-v1alpha1">ChallengeStatus</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="challengespec-v1alpha1">ChallengeSpec v1alpha1</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#challenge-v1alpha1">Challenge v1alpha1</a></li>
<li><a href="#orderstatus-v1alpha1">OrderStatus v1alpha1</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>config</code><br /> <em><a href="#solverconfig-v1alpha1">SolverConfig</a></em></td>
<td>Config specifies the solver configuration for this challenge.</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 /> <em><a href="#objectreference-v1alpha1">ObjectReference</a></em></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>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-v1alpha1">ChallengeStatus v1alpha1</h3>
<aside class="notice">
Appears In:
<ul>
<li><a href="#challenge-v1alpha1">Challenge v1alpha1</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="acmecertificateconfig-v1alpha1">ACMECertificateConfig v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>ACMECertificateConfig</code></td>
</tr>
</tbody>
</table>
<p>ACMECertificateConfig contains the configuration for the ACME certificate provider</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificatespec-v1alpha1">CertificateSpec v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>config</code><br /> <em><a href="#domainsolverconfig-v1alpha1">DomainSolverConfig</a> array</em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="acmeissuer-v1alpha1">ACMEIssuer v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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-v1alpha1">IssuerSpec v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>dns01</code><br /> <em><a href="#acmeissuerdns01config-v1alpha1">ACMEIssuerDNS01Config</a></em></td>
<td>DNS-01 config</td>
</tr>
<tr>
<td><code>email</code><br /> <em>string</em></td>
<td>Email is the email for this account</td>
</tr>
<tr>
<td><code>http01</code><br /> <em><a href="#acmeissuerhttp01config-v1alpha1">ACMEIssuerHTTP01Config</a></em></td>
<td>HTTP-01 config</td>
</tr>
<tr>
<td><code>privateKeySecretRef</code><br /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></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>
</tbody>
</table>
<h2 id="acmeissuerdns01config-v1alpha1">ACMEIssuerDNS01Config v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>ACMEIssuerDNS01Config</code></td>
</tr>
</tbody>
</table>
<p>ACMEIssuerDNS01Config is a structure containing the ACME DNS configuration options</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmeissuer-v1alpha1">ACMEIssuer v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>providers</code><br /> <em><a href="#acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider</a> array</em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>ACMEIssuerDNS01Provider</code></td>
</tr>
</tbody>
</table>
<p>ACMEIssuerDNS01Provider contains configuration for a DNS provider that can be used to solve ACME DNS01 challenges.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmeissuerdns01config-v1alpha1">ACMEIssuerDNS01Config v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>acmedns</code><br /> <em><a href="#acmeissuerdns01provideracmedns-v1alpha1">ACMEIssuerDNS01ProviderAcmeDNS</a></em></td>
<td></td>
</tr>
<tr>
<td><code>akamai</code><br /> <em><a href="#acmeissuerdns01providerakamai-v1alpha1">ACMEIssuerDNS01ProviderAkamai</a></em></td>
<td></td>
</tr>
<tr>
<td><code>azuredns</code><br /> <em><a href="#acmeissuerdns01providerazuredns-v1alpha1">ACMEIssuerDNS01ProviderAzureDNS</a></em></td>
<td></td>
</tr>
<tr>
<td><code>clouddns</code><br /> <em><a href="#acmeissuerdns01providerclouddns-v1alpha1">ACMEIssuerDNS01ProviderCloudDNS</a></em></td>
<td></td>
</tr>
<tr>
<td><code>cloudflare</code><br /> <em><a href="#acmeissuerdns01providercloudflare-v1alpha1">ACMEIssuerDNS01ProviderCloudflare</a></em></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 /> <em><a href="#acmeissuerdns01providerdigitalocean-v1alpha1">ACMEIssuerDNS01ProviderDigitalOcean</a></em></td>
<td></td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>Name is the name of the DNS provider, which should be used to reference this DNS provider configuration on Certificate resources.</td>
</tr>
<tr>
<td><code>rfc2136</code><br /> <em><a href="#acmeissuerdns01providerrfc2136-v1alpha1">ACMEIssuerDNS01ProviderRFC2136</a></em></td>
<td></td>
</tr>
<tr>
<td><code>route53</code><br /> <em><a href="#acmeissuerdns01providerroute53-v1alpha1">ACMEIssuerDNS01ProviderRoute53</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="acmeissuerdns01provideracmedns-v1alpha1">ACMEIssuerDNS01ProviderAcmeDNS v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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="#acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>accountSecretRef</code><br /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td></td>
</tr>
<tr>
<td><code>host</code><br /> <em>string</em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="acmeissuerdns01providerakamai-v1alpha1">ACMEIssuerDNS01ProviderAkamai v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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="#acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>accessTokenSecretRef</code><br /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td></td>
</tr>
<tr>
<td><code>clientSecretSecretRef</code><br /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td></td>
</tr>
<tr>
<td><code>clientTokenSecretRef</code><br /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td></td>
</tr>
<tr>
<td><code>serviceConsumerDomain</code><br /> <em>string</em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="acmeissuerdns01providerazuredns-v1alpha1">ACMEIssuerDNS01ProviderAzureDNS v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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="#acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider v1alpha1</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 /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></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-v1alpha1">ACMEIssuerDNS01ProviderCloudDNS v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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="#acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider v1alpha1</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 /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="acmeissuerdns01providercloudflare-v1alpha1">ACMEIssuerDNS01ProviderCloudflare v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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="#acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>apiKeySecretRef</code><br /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td></td>
</tr>
<tr>
<td><code>email</code><br /> <em>string</em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="acmeissuerdns01providerdigitalocean-v1alpha1">ACMEIssuerDNS01ProviderDigitalOcean v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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="#acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>tokenSecretRef</code><br /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="acmeissuerdns01providerrfc2136-v1alpha1">ACMEIssuerDNS01ProviderRFC2136 v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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="#acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider v1alpha1</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 /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></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-v1alpha1">ACMEIssuerDNS01ProviderRoute53 v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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="#acmeissuerdns01provider-v1alpha1">ACMEIssuerDNS01Provider v1alpha1</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></td>
</tr>
<tr>
<td><code>hostedZoneID</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>region</code><br /> <em>string</em></td>
<td></td>
</tr>
<tr>
<td><code>secretAccessKeySecretRef</code><br /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="acmeissuerhttp01config-v1alpha1">ACMEIssuerHTTP01Config v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>ACMEIssuerHTTP01Config</code></td>
</tr>
</tbody>
</table>
<p>ACMEIssuerHTTP01Config is a structure containing the ACME HTTP configuration options</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmeissuer-v1alpha1">ACMEIssuer v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>serviceType</code><br /> <em>string</em></td>
<td>Optional service type for Kubernetes solver service</td>
</tr>
</tbody>
</table>
<h2 id="caissuer-v1alpha1">CAIssuer v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>CAIssuer</code></td>
</tr>
</tbody>
</table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#issuerspec-v1alpha1">IssuerSpec v1alpha1</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-v1alpha1">CertificateCondition v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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-v1alpha1">CertificateStatus v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>lastTransitionTime</code><br /> <em><a href="#time-v1">Time</a></em></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="dns01solverconfig-v1alpha1">DNS01SolverConfig v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>DNS01SolverConfig</code></td>
</tr>
</tbody>
</table>
<p>DNS01SolverConfig contains solver configuration for DNS01 challenges.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#domainsolverconfig-v1alpha1">DomainSolverConfig v1alpha1</a></li>
<li><a href="#solverconfig-v1alpha1">SolverConfig v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>provider</code><br /> <em>string</em></td>
<td>Provider is the name of the DNS01 challenge provider to use, as configure on the referenced Issuer or ClusterIssuer resource.</td>
</tr>
</tbody>
</table>
<h2 id="domainsolverconfig-v1alpha1">DomainSolverConfig v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>DomainSolverConfig</code></td>
</tr>
</tbody>
</table>
<p>DomainSolverConfig contains solver configuration for a set of domains.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmecertificateconfig-v1alpha1">ACMECertificateConfig v1alpha1</a></li>
<li><a href="#orderspec-v1alpha1">OrderSpec v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>dns01</code><br /> <em><a href="#dns01solverconfig-v1alpha1">DNS01SolverConfig</a></em></td>
<td>DNS01 contains DNS01 challenge solving configuration</td>
</tr>
<tr>
<td><code>domains</code><br /> <em>string array</em></td>
<td>Domains is the list of domains that this SolverConfig applies to.</td>
</tr>
<tr>
<td><code>http01</code><br /> <em><a href="#http01solverconfig-v1alpha1">HTTP01SolverConfig</a></em></td>
<td>HTTP01 contains HTTP01 challenge solving configuration</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-v1alpha1">CertificateSpec v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Duration</code><br /> <em>integer</em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="http01solverconfig-v1alpha1">HTTP01SolverConfig v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>HTTP01SolverConfig</code></td>
</tr>
</tbody>
</table>
<p>HTTP01SolverConfig contains solver configuration for HTTP01 challenges.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#domainsolverconfig-v1alpha1">DomainSolverConfig v1alpha1</a></li>
<li><a href="#solverconfig-v1alpha1">SolverConfig v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>ingress</code><br /> <em>string</em></td>
<td>Ingress is the name of an Ingress resource that will be edited to include the ACME HTTP01 &#39;well-known&#39; challenge path in order to solve HTTP01 challenges. If this field is specified, &#39;ingressClass&#39; <strong>must not</strong> be specified.</td>
</tr>
<tr>
<td><code>ingressClass</code><br /> <em>string</em></td>
<td>IngressClass is the ingress class that should be set on new ingress resources that are created in order to solve HTTP01 challenges. This field should be used when using an ingress controller such as nginx, which &#39;flattens&#39; ingress configuration instead of maintaining a 1:1 mapping between loadbalancer IP:ingress resources. If this field is not set, and &#39;ingress&#39; is not set, then ingresses without an ingress class set will be created to solve HTTP01 challenges. If this field is specified, &#39;ingress&#39; <strong>must not</strong> be specified.</td>
</tr>
</tbody>
</table>
<h2 id="initializer-v1">Initializer 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>Initializer</code></td>
</tr>
</tbody>
</table>
<p>Initializer is information about an initializer that has not yet completed.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#initializers-v1">Initializers v1</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 process that is responsible for initializing this object.</td>
</tr>
</tbody>
</table>
<h2 id="initializers-v1">Initializers 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>Initializers</code></td>
</tr>
</tbody>
</table>
<p>Initializers tracks the progress of initialization.</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>pending</code><br /> <em><a href="#initializer-v1">Initializer</a> array</em> <br /> <strong>patch type</strong>: <em>merge</em> <br /> <strong>patch merge key</strong>: <em>name</em></td>
<td>Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.</td>
</tr>
<tr>
<td><code>result</code><br /> <em><a href="#status-v1">Status</a></em></td>
<td>If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.</td>
</tr>
</tbody>
</table>
<h2 id="issuercondition-v1alpha1">IssuerCondition v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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-v1alpha1">IssuerStatus v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>lastTransitionTime</code><br /> <em><a href="#time-v1">Time</a></em></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="listmeta-v1">ListMeta 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>ListMeta</code></td>
</tr>
</tbody>
</table>
<p>ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#status-v1">Status v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>continue</code><br /> <em>string</em></td>
<td>continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.</td>
</tr>
<tr>
<td><code>resourceVersion</code><br /> <em>string</em></td>
<td>String that identifies the server&#39;s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency">https://git.k8s.io/community/contributors/devel/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.</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="#certificate-v1alpha1">Certificate v1alpha1</a></li>
<li><a href="#challenge-v1alpha1">Challenge v1alpha1</a></li>
<li><a href="#clusterissuer-v1alpha1">ClusterIssuer v1alpha1</a></li>
<li><a href="#issuer-v1alpha1">Issuer v1alpha1</a></li>
<li><a href="#order-v1alpha1">Order v1alpha1</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 /> <em><a href="#time-v1">Time</a></em></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/api-conventions.md#metadata">https://git.k8s.io/community/contributors/devel/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 /> <em><a href="#time-v1">Time</a></em></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/api-conventions.md#metadata">https://git.k8s.io/community/contributors/devel/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/api-conventions.md#idempotency">https://git.k8s.io/community/contributors/devel/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>initializers</code><br /> <em><a href="#initializers-v1">Initializers</a></em></td>
<td>An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven&#39;t explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.</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>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 /> <em><a href="#ownerreference-v1">OwnerReference</a> array</em> <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/api-conventions.md#concurrency-control-and-consistency">https://git.k8s.io/community/contributors/devel/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.</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-v1alpha1">ObjectReference v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>ObjectReference</code></td>
</tr>
</tbody>
</table>
<p>ObjectReference is a reference to an object with a given name and kind.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificatespec-v1alpha1">CertificateSpec v1alpha1</a></li>
<li><a href="#challengespec-v1alpha1">ChallengeSpec v1alpha1</a></li>
<li><a href="#orderspec-v1alpha1">OrderSpec v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<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. Currently, an owning object must be in the same namespace, 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/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/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="secretkeyselector-v1alpha1">SecretKeySelector v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>SecretKeySelector</code></td>
</tr>
</tbody>
</table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#acmeissuer-v1alpha1">ACMEIssuer v1alpha1</a></li>
<li><a href="#acmeissuerdns01provideracmedns-v1alpha1">ACMEIssuerDNS01ProviderAcmeDNS v1alpha1</a></li>
<li><a href="#acmeissuerdns01providerakamai-v1alpha1">ACMEIssuerDNS01ProviderAkamai v1alpha1</a></li>
<li><a href="#acmeissuerdns01providerazuredns-v1alpha1">ACMEIssuerDNS01ProviderAzureDNS v1alpha1</a></li>
<li><a href="#acmeissuerdns01providerclouddns-v1alpha1">ACMEIssuerDNS01ProviderCloudDNS v1alpha1</a></li>
<li><a href="#acmeissuerdns01providercloudflare-v1alpha1">ACMEIssuerDNS01ProviderCloudflare v1alpha1</a></li>
<li><a href="#acmeissuerdns01providerdigitalocean-v1alpha1">ACMEIssuerDNS01ProviderDigitalOcean v1alpha1</a></li>
<li><a href="#acmeissuerdns01providerrfc2136-v1alpha1">ACMEIssuerDNS01ProviderRFC2136 v1alpha1</a></li>
<li><a href="#acmeissuerdns01providerroute53-v1alpha1">ACMEIssuerDNS01ProviderRoute53 v1alpha1</a></li>
<li><a href="#vaultapprole-v1alpha1">VaultAppRole v1alpha1</a></li>
<li><a href="#vaultauth-v1alpha1">VaultAuth v1alpha1</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-v1alpha1">SelfSignedIssuer v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>SelfSignedIssuer</code></td>
</tr>
</tbody>
</table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#issuerspec-v1alpha1">IssuerSpec v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td></td>
</tr>
</tbody>
</table>
<h2 id="solverconfig-v1alpha1">SolverConfig v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>SolverConfig</code></td>
</tr>
</tbody>
</table>
<p>SolverConfig is a container type holding the configuration for either a HTTP01 or DNS01 challenge. Only one of HTTP01 or DNS01 should be non-nil.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#challengespec-v1alpha1">ChallengeSpec v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>dns01</code><br /> <em><a href="#dns01solverconfig-v1alpha1">DNS01SolverConfig</a></em></td>
<td>DNS01 contains DNS01 challenge solving configuration</td>
</tr>
<tr>
<td><code>http01</code><br /> <em><a href="#http01solverconfig-v1alpha1">HTTP01SolverConfig</a></em></td>
<td>HTTP01 contains HTTP01 challenge solving configuration</td>
</tr>
</tbody>
</table>
<h2 id="status-v1">Status 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>Status</code></td>
</tr>
</tbody>
</table>
<p>Status is a return value for calls that don&#39;t return other objects.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#initializers-v1">Initializers 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 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/api-conventions.md#resources">https://git.k8s.io/community/contributors/devel/api-conventions.md#resources</a></td>
</tr>
<tr>
<td><code>code</code><br /> <em>integer</em></td>
<td>Suggested HTTP return code for this status, 0 if not set.</td>
</tr>
<tr>
<td><code>details</code><br /> <em><a href="#statusdetails-v1">StatusDetails</a></em></td>
<td>Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.</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/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>message</code><br /> <em>string</em></td>
<td>A human-readable description of the status of this operation.</td>
</tr>
<tr>
<td><code>metadata</code><br /> <em><a href="#listmeta-v1">ListMeta</a></em></td>
<td>Standard list metadata. More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>reason</code><br /> <em>string</em></td>
<td>A machine-readable description of why this operation is in the &#34;Failure&#34; status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.</td>
</tr>
<tr>
<td><code>status</code><br /> <em>string</em></td>
<td>Status of the operation. One of: &#34;Success&#34; or &#34;Failure&#34;. More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status">https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status</a></td>
</tr>
</tbody>
</table>
<h2 id="statuscause-v1">StatusCause 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>StatusCause</code></td>
</tr>
</tbody>
</table>
<p>StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#statusdetails-v1">StatusDetails v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>field</code><br /> <em>string</em></td>
<td>The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: &#34;name&#34; - the field &#34;name&#34; on the current resource &#34;items[0].name&#34; - the field &#34;name&#34; on the first array entry in &#34;items&#34;</td>
</tr>
<tr>
<td><code>message</code><br /> <em>string</em></td>
<td>A human-readable description of the cause of the error. This field may be presented as-is to a reader.</td>
</tr>
<tr>
<td><code>reason</code><br /> <em>string</em></td>
<td>A machine-readable description of the cause of the error. If this value is empty there is no information available.</td>
</tr>
</tbody>
</table>
<h2 id="statusdetails-v1">StatusDetails 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>StatusDetails</code></td>
</tr>
</tbody>
</table>
<p>StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.</p>
<aside class="notice">
Appears In:
<ul>
<li><a href="#status-v1">Status v1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>causes</code><br /> <em><a href="#statuscause-v1">StatusCause</a> array</em></td>
<td>The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.</td>
</tr>
<tr>
<td><code>group</code><br /> <em>string</em></td>
<td>The group attribute of the resource associated with the status StatusReason.</td>
</tr>
<tr>
<td><code>kind</code><br /> <em>string</em></td>
<td>The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: <a href="https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds">https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds</a></td>
</tr>
<tr>
<td><code>name</code><br /> <em>string</em></td>
<td>The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).</td>
</tr>
<tr>
<td><code>retryAfterSeconds</code><br /> <em>integer</em></td>
<td>If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.</td>
</tr>
<tr>
<td><code>uid</code><br /> <em>string</em></td>
<td>UID of the resource. (when there is a single resource which can be described). 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="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>
<aside class="notice">
Appears In:
<ul>
<li><a href="#certificatecondition-v1alpha1">CertificateCondition v1alpha1</a></li>
<li><a href="#certificatestatus-v1alpha1">CertificateStatus v1alpha1</a></li>
<li><a href="#issuercondition-v1alpha1">IssuerCondition v1alpha1</a></li>
<li><a href="#objectmeta-v1">ObjectMeta v1</a></li>
<li><a href="#orderstatus-v1alpha1">OrderStatus v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td></td>
</tr>
</tbody>
</table>
<h2 id="vaultapprole-v1alpha1">VaultAppRole v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>VaultAppRole</code></td>
</tr>
</tbody>
</table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#vaultauth-v1alpha1">VaultAuth v1alpha1</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 /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="vaultauth-v1alpha1">VaultAuth v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</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-v1alpha1">VaultIssuer v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>appRole</code><br /> <em><a href="#vaultapprole-v1alpha1">VaultAppRole</a></em></td>
<td>This Secret contains a AppRole and Secret</td>
</tr>
<tr>
<td><code>tokenSecretRef</code><br /> <em><a href="#secretkeyselector-v1alpha1">SecretKeySelector</a></em></td>
<td>This Secret contains the Vault token key</td>
</tr>
</tbody>
</table>
<h2 id="vaultissuer-v1alpha1">VaultIssuer v1alpha1</h2>
<table>
<thead>
<tr>
<th>Group</th>
<th>Version</th>
<th>Kind</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>certmanager</code></td>
<td><code>v1alpha1</code></td>
<td><code>VaultIssuer</code></td>
</tr>
</tbody>
</table>
<aside class="notice">
Appears In:
<ul>
<li><a href="#issuerspec-v1alpha1">IssuerSpec v1alpha1</a></li>
</ul></aside>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>auth</code><br /> <em><a href="#vaultauth-v1alpha1">VaultAuth</a></em></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>
</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