Run //hack:update-reference-docs
Signed-off-by: James Munnelly <james@munnelly.eu>
This commit is contained in:
James Munnelly
parent
81d8d20c66
commit
e9441e6fdc
@ -11,7 +11,7 @@
|
||||
<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 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="#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="#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="#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="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="#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="#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>
|
||||
@ -306,6 +306,271 @@ Appears In:
|
||||
</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 'ACME' 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>certificateURL</code><br /> <em>string</em></td>
|
||||
<td>CertificateURL is a URL that can be used to retrieve a copy of the signed TLS certificate for this order. It will be populated automatically once the order has completed successfully and the certificate is available for retrieval.</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. The order resource will be automatically deleted after 30 minutes has passed since the failure time.</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 'success' and 'expired' are 'final'</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 'ACME' 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. "dns01" or "http01"</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 '*.example.com'</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 'presented'. This <em>does not</em> imply the self check is passing. Only that the values have been 'submitted' 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>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 'state' 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>
|
||||
@ -1009,6 +1274,7 @@ Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#domainsolverconfig-v1alpha1">DomainSolverConfig v1alpha1</a></li>
|
||||
<li><a href="#solverconfig-v1alpha1">SolverConfig v1alpha1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
<table>
|
||||
@ -1048,6 +1314,7 @@ Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#acmecertificateconfig-v1alpha1">ACMECertificateConfig v1alpha1</a></li>
|
||||
<li><a href="#orderspec-v1alpha1">OrderSpec v1alpha1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
<table>
|
||||
@ -1095,6 +1362,7 @@ Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#domainsolverconfig-v1alpha1">DomainSolverConfig v1alpha1</a></li>
|
||||
<li><a href="#solverconfig-v1alpha1">SolverConfig v1alpha1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
<table>
|
||||
@ -1322,8 +1590,10 @@ 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>
|
||||
@ -1423,6 +1693,8 @@ 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>
|
||||
@ -1590,6 +1862,49 @@ Appears In:
|
||||
</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>
|
||||
@ -1788,6 +2103,7 @@ Appears In:
|
||||
<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>
|
||||
|
||||
@ -1 +1 @@
|
||||
(function(){navData = {"toc":[{"section":"-strong-field-definitions-strong-","subsections":[{"section":"vaultissuer-v1alpha1"},{"section":"vaultauth-v1alpha1"},{"section":"vaultapprole-v1alpha1"},{"section":"time-v1"},{"section":"statusdetails-v1"},{"section":"statuscause-v1"},{"section":"status-v1"},{"section":"selfsignedissuer-v1alpha1"},{"section":"secretkeyselector-v1alpha1"},{"section":"ownerreference-v1"},{"section":"objectreference-v1alpha1"},{"section":"objectmeta-v1"},{"section":"listmeta-v1"},{"section":"issuercondition-v1alpha1"},{"section":"initializers-v1"},{"section":"initializer-v1"},{"section":"http01solverconfig-v1alpha1"},{"section":"domainsolverconfig-v1alpha1"},{"section":"dns01solverconfig-v1alpha1"},{"section":"certificatecondition-v1alpha1"},{"section":"caissuer-v1alpha1"},{"section":"acmeissuerhttp01config-v1alpha1"},{"section":"acmeissuerdns01providerroute53-v1alpha1"},{"section":"acmeissuerdns01providerrfc2136-v1alpha1"},{"section":"acmeissuerdns01providercloudflare-v1alpha1"},{"section":"acmeissuerdns01providerclouddns-v1alpha1"},{"section":"acmeissuerdns01providerazuredns-v1alpha1"},{"section":"acmeissuerdns01providerakamai-v1alpha1"},{"section":"acmeissuerdns01provideracmedns-v1alpha1"},{"section":"acmeissuerdns01provider-v1alpha1"},{"section":"acmeissuerdns01config-v1alpha1"},{"section":"acmeissuer-v1alpha1"},{"section":"acmecertificateconfig-v1alpha1"}]},{"section":"-strong-old-api-versions-strong-","subsections":[]},{"section":"issuer-v1alpha1","subsections":[]},{"section":"clusterissuer-v1alpha1","subsections":[]},{"section":"certificate-v1alpha1","subsections":[]},{"section":"-strong-cert-manager-strong-","subsections":[]}],"flatToc":["vaultissuer-v1alpha1","vaultauth-v1alpha1","vaultapprole-v1alpha1","time-v1","statusdetails-v1","statuscause-v1","status-v1","selfsignedissuer-v1alpha1","secretkeyselector-v1alpha1","ownerreference-v1","objectreference-v1alpha1","objectmeta-v1","listmeta-v1","issuercondition-v1alpha1","initializers-v1","initializer-v1","http01solverconfig-v1alpha1","domainsolverconfig-v1alpha1","dns01solverconfig-v1alpha1","certificatecondition-v1alpha1","caissuer-v1alpha1","acmeissuerhttp01config-v1alpha1","acmeissuerdns01providerroute53-v1alpha1","acmeissuerdns01providerrfc2136-v1alpha1","acmeissuerdns01providercloudflare-v1alpha1","acmeissuerdns01providerclouddns-v1alpha1","acmeissuerdns01providerazuredns-v1alpha1","acmeissuerdns01providerakamai-v1alpha1","acmeissuerdns01provideracmedns-v1alpha1","acmeissuerdns01provider-v1alpha1","acmeissuerdns01config-v1alpha1","acmeissuer-v1alpha1","acmecertificateconfig-v1alpha1","-strong-field-definitions-strong-","-strong-old-api-versions-strong-","issuer-v1alpha1","clusterissuer-v1alpha1","certificate-v1alpha1","-strong-cert-manager-strong-"]};})();
|
||||
(function(){navData = {"toc":[{"section":"-strong-field-definitions-strong-","subsections":[{"section":"vaultissuer-v1alpha1"},{"section":"vaultauth-v1alpha1"},{"section":"vaultapprole-v1alpha1"},{"section":"time-v1"},{"section":"statusdetails-v1"},{"section":"statuscause-v1"},{"section":"status-v1"},{"section":"solverconfig-v1alpha1"},{"section":"selfsignedissuer-v1alpha1"},{"section":"secretkeyselector-v1alpha1"},{"section":"ownerreference-v1"},{"section":"objectreference-v1alpha1"},{"section":"objectmeta-v1"},{"section":"listmeta-v1"},{"section":"issuercondition-v1alpha1"},{"section":"initializers-v1"},{"section":"initializer-v1"},{"section":"http01solverconfig-v1alpha1"},{"section":"domainsolverconfig-v1alpha1"},{"section":"dns01solverconfig-v1alpha1"},{"section":"certificatecondition-v1alpha1"},{"section":"caissuer-v1alpha1"},{"section":"acmeissuerhttp01config-v1alpha1"},{"section":"acmeissuerdns01providerroute53-v1alpha1"},{"section":"acmeissuerdns01providerrfc2136-v1alpha1"},{"section":"acmeissuerdns01providercloudflare-v1alpha1"},{"section":"acmeissuerdns01providerclouddns-v1alpha1"},{"section":"acmeissuerdns01providerazuredns-v1alpha1"},{"section":"acmeissuerdns01providerakamai-v1alpha1"},{"section":"acmeissuerdns01provideracmedns-v1alpha1"},{"section":"acmeissuerdns01provider-v1alpha1"},{"section":"acmeissuerdns01config-v1alpha1"},{"section":"acmeissuer-v1alpha1"},{"section":"acmecertificateconfig-v1alpha1"}]},{"section":"-strong-old-api-versions-strong-","subsections":[]},{"section":"challenge-v1alpha1","subsections":[]},{"section":"order-v1alpha1","subsections":[]},{"section":"issuer-v1alpha1","subsections":[]},{"section":"clusterissuer-v1alpha1","subsections":[]},{"section":"certificate-v1alpha1","subsections":[]},{"section":"-strong-cert-manager-strong-","subsections":[]}],"flatToc":["vaultissuer-v1alpha1","vaultauth-v1alpha1","vaultapprole-v1alpha1","time-v1","statusdetails-v1","statuscause-v1","status-v1","solverconfig-v1alpha1","selfsignedissuer-v1alpha1","secretkeyselector-v1alpha1","ownerreference-v1","objectreference-v1alpha1","objectmeta-v1","listmeta-v1","issuercondition-v1alpha1","initializers-v1","initializer-v1","http01solverconfig-v1alpha1","domainsolverconfig-v1alpha1","dns01solverconfig-v1alpha1","certificatecondition-v1alpha1","caissuer-v1alpha1","acmeissuerhttp01config-v1alpha1","acmeissuerdns01providerroute53-v1alpha1","acmeissuerdns01providerrfc2136-v1alpha1","acmeissuerdns01providercloudflare-v1alpha1","acmeissuerdns01providerclouddns-v1alpha1","acmeissuerdns01providerazuredns-v1alpha1","acmeissuerdns01providerakamai-v1alpha1","acmeissuerdns01provideracmedns-v1alpha1","acmeissuerdns01provider-v1alpha1","acmeissuerdns01config-v1alpha1","acmeissuer-v1alpha1","acmecertificateconfig-v1alpha1","-strong-field-definitions-strong-","-strong-old-api-versions-strong-","challenge-v1alpha1","order-v1alpha1","issuer-v1alpha1","clusterissuer-v1alpha1","certificate-v1alpha1","-strong-cert-manager-strong-"]};})();
|
||||
Loading…
Reference in New Issue
Block a user