From 9b67fc5dd58d4371ef7b6b553dab5db5f74bc430 Mon Sep 17 00:00:00 2001 From: Ashley Davis Date: Fri, 20 Jan 2023 19:14:00 +0000 Subject: [PATCH] update committed docs + add new api-ref intro v1.11 CLI docs, etc have more updates because their updates weren't committed - they're regenerated at build time so the deployed version was correct, but committing here makes the repo better match reality Signed-off-by: Ashley Davis --- content/docs/cli/controller.md | 2 + content/docs/cli/webhook.md | 1 + content/docs/reference/api-docs.md | 43 ++++++++++++------- content/v1.10-docs/reference/api-docs.md | 16 +++---- content/v1.11-docs/cli/controller.md | 2 + content/v1.11-docs/cli/webhook.md | 1 + content/v1.11-docs/reference/api-docs.md | 43 ++++++++++++------- content/v1.8-docs/reference/api-docs.md | 17 +++++--- content/v1.9-docs/reference/api-docs.md | 16 +++---- .../postprocess/api-doc-postprocess.js | 4 ++ scripts/gendocs/templates/members.tpl | 3 +- scripts/gendocs/templates/pkg.tpl | 7 +-- scripts/gendocs/templates/type.tpl | 13 ++++-- 13 files changed, 105 insertions(+), 63 deletions(-) diff --git a/content/docs/cli/controller.md b/content/docs/cli/controller.md index 36661b86c0b..768ffb05ccd 100644 --- a/content/docs/cli/controller.md +++ b/content/docs/cli/controller.md @@ -20,6 +20,7 @@ Flags: --acme-http01-solver-resource-limits-memory string Defines the resource limits Memory size when spawning new ACME HTTP01 challenge solver pods. (default "64Mi") --acme-http01-solver-resource-request-cpu string Defines the resource request CPU size when spawning new ACME HTTP01 challenge solver pods. (default "10m") --acme-http01-solver-resource-request-memory string Defines the resource request Memory size when spawning new ACME HTTP01 challenge solver pods. (default "64Mi") + --acme-http01-solver-run-as-non-root Defines the ability to run the http01 solver as root for troubleshooting issues (default true) --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files (no effect when -logtostderr=true) --auto-certificate-annotations strings The annotation consumed by the ingress-shim controller to indicate a ingress is requesting a certificate (default [kubernetes.io/tls-acme]) @@ -45,6 +46,7 @@ Flags: LiteralCertificateSubject=true|false (ALPHA - default=false) ServerSideApply=true|false (ALPHA - default=false) StableCertificateRequestName=true|false (ALPHA - default=false) + UseCertificateRequestBasicConstraints=true|false (ALPHA - default=false) ValidateCAA=true|false (ALPHA - default=false) -h, --help help for cert-manager-controller --issuer-ambient-credentials Whether an issuer may make use of ambient credentials. 'Ambient Credentials' are credentials drawn from the environment, metadata services, or local files which are not explicitly configured in the Issuer API object. When this flag is enabled, the following sources for credentials are also used: AWS - All sources the Go SDK defaults to, notably including any EC2 IAM roles available via instance metadata. diff --git a/content/docs/cli/webhook.md b/content/docs/cli/webhook.md index d4d7d35d062..f4d6ef30c33 100644 --- a/content/docs/cli/webhook.md +++ b/content/docs/cli/webhook.md @@ -26,6 +26,7 @@ Flags: LiteralCertificateSubject=true|false (ALPHA - default=false) ServerSideApply=true|false (ALPHA - default=false) StableCertificateRequestName=true|false (ALPHA - default=false) + UseCertificateRequestBasicConstraints=true|false (ALPHA - default=false) ValidateCAA=true|false (ALPHA - default=false) --healthz-port int port number to listen on for insecure healthz connections (default 6080) -h, --help help for webhook diff --git a/content/docs/reference/api-docs.md b/content/docs/reference/api-docs.md index 1eccf291108..35d0f49d6ca 100644 --- a/content/docs/reference/api-docs.md +++ b/content/docs/reference/api-docs.md @@ -1,10 +1,10 @@ --- title: API Reference description: >- - Learn about the cert-manager API which includes Custom Resources such as - Certificate, CertificateRequest, Issuer and ClusterIssuer. + cert-manager API documentation, including Custom Resources such as + Certificate, CertificateRequest, Issuer and ClusterIssuer --- -Learn about the cert-manager API which includes Custom Resources such as Certificate, CertificateRequest, Issuer and ClusterIssuer. +

cert-manager API documentation, including various Custom Resource Definitions

Packages: