Skip to content

Commit be51ef9

Browse files
./scripts/freeze-docs 1.17
As per the cert-manager release process: * https://cert-manager.io/docs/contributing/release-process/ > (final release only) Freeze the docs/ folder by running the following script: > > # From the website repository, on the master branch. > ./scripts/freeze-docs 1.16 > > This copies the docs/ folder to a versioned folder (e.g. v1.15-docs) and removes any folders which should not be present in versioned docs. Signed-off-by: Richard Wall <[email protected]>
1 parent 70d6b60 commit be51ef9

File tree

120 files changed

+30746
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+30746
-0
lines changed

content/v1.17-docs/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: cert-manager
3+
description: |
4+
cert-manager creates TLS certificates for workloads in your Kubernetes or OpenShift cluster and renews the certificates before they expire.
5+
---
6+
7+
cert-manager creates TLS certificates for workloads in your Kubernetes or OpenShift cluster
8+
and renews the certificates before they expire.
9+
10+
cert-manager can obtain certificates from a [variety of certificate authorities](configuration/issuers.md), including:
11+
[Let's Encrypt](configuration/acme/README.md), [HashiCorp Vault](configuration/vault.md),
12+
[Venafi](configuration/venafi.md) and [private PKI](configuration/ca.md).
13+
14+
With cert-manager's [Certificate resource](usage/certificate.md), the private key and certificate are stored in a Kubernetes Secret
15+
which is mounted by an application Pod or used by an Ingress controller.
16+
With [csi-driver](usage/csi-driver/README.md), [csi-driver-spiffe](usage/csi-driver-spiffe/README.md), or [istio-csr](usage/istio-csr/README.md) ,
17+
the private key is generated on-demand, before the application starts up;
18+
the private key never leaves the node and it is not stored in a Kubernetes Secret.
19+
20+
![High level overview diagram explaining cert-manager architecture](/images/high-level-overview.svg)
21+
22+
This website provides the full technical documentation for the project, and can be
23+
used as a reference; if you feel that there's anything missing, please let us know
24+
or [raise a PR](https://github.com/cert-manager/website/pulls) to add it.
25+
26+
<img referrerPolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=e661e870-758f-4c78-ac4a-0bad64a05471" />

content/v1.17-docs/cli/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: CLI reference
3+
description: cert-manager CLI documentation
4+
---
5+
6+
View the `--help` output from our various CLI tools, including those which run in containers in your cluster.
7+
This might help if you need to tweak an option or if you need to check which values are valid!
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: acmesolver CLI reference
3+
description: "cert-manager acmesolver CLI documentation"
4+
---
5+
```
6+
HTTP server used to solve ACME challenges.
7+
8+
Usage:
9+
acmesolver [flags]
10+
11+
Flags:
12+
--domain string the domain name to verify
13+
-h, --help help for acmesolver
14+
--key string the challenge key to respond with
15+
--listen-port int the port number to listen on for connections (default 8089)
16+
--token string the challenge token to verify against
17+
```
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: cainjector CLI reference
3+
description: "cert-manager cainjector CLI documentation"
4+
---
5+
```
6+
7+
cert-manager CA injector is a Kubernetes addon to automate the injection of CA data into
8+
webhooks and APIServices from cert-manager certificates.
9+
10+
It will ensure that annotated webhooks and API services always have the correct
11+
CA data from the referenced certificates, which can then be used to serve API
12+
servers and webhook servers.
13+
14+
Usage:
15+
cainjector [flags]
16+
17+
Flags:
18+
--config string Path to a file containing a CAInjectorConfiguration object used to configure the controller
19+
--enable-apiservices-injectable Inject CA data to annotated APIServices. This functionality is not required if cainjector is only used as cert-manager's internal component and setting it to false might reduce memory consumption (default true)
20+
--enable-certificates-data-source Enable configuring cert-manager.io Certificate resources as potential sources for CA data. Requires cert-manager.io Certificate CRD to be installed. This data source can be disabled to reduce memory consumption if you only use cainjector as part of cert-manager's installation (default true)
21+
--enable-customresourcedefinitions-injectable Inject CA data to annotated CustomResourceDefinitions. This functionality is not required if cainjecor is only used as cert-manager's internal component and setting it to false might slightly reduce memory consumption (default true)
22+
--enable-mutatingwebhookconfigurations-injectable Inject CA data to annotated MutatingWebhookConfigurations. This functionality is required for cainjector to work correctly as cert-manager's internal component (default true)
23+
--enable-profiling Enable profiling for controller.
24+
--enable-validatingwebhookconfigurations-injectable Inject CA data to annotated ValidatingWebhookConfigurations. This functionality is required for cainjector to correctly function as cert-manager's internal component (default true)
25+
--feature-gates mapStringBool A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
26+
AllAlpha=true|false (ALPHA - default=false)
27+
AllBeta=true|false (BETA - default=false)
28+
CAInjectorMerging=true|false (ALPHA - default=false)
29+
ServerSideApply=true|false (ALPHA - default=false)
30+
-h, --help help for cainjector
31+
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster.
32+
--leader-elect If true, cainjector will perform leader election between instances to ensure no more than one instance of cainjector operates at a time (default true)
33+
--leader-election-lease-duration duration The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. (default 1m0s)
34+
--leader-election-namespace string Namespace used to perform leader election. Only used if leader election is enabled (default "kube-system")
35+
--leader-election-renew-deadline duration The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. (default 40s)
36+
--leader-election-retry-period duration The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 15s)
37+
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
38+
--logging-format string Sets the log format. Permitted formats: "json" (gated by LoggingBetaOptions), "text". (default "text")
39+
--metrics-dynamic-serving-ca-secret-name string name of the secret used to store the CA that signs serving certificates
40+
--metrics-dynamic-serving-ca-secret-namespace string namespace of the secret used to store the CA that signs metrics serving certificates
41+
--metrics-dynamic-serving-dns-names strings DNS names that should be present on certificates generated by the metrics dynamic serving CA
42+
--metrics-dynamic-serving-leaf-duration duration leaf duration of metrics serving certificates (default 168h0m0s)
43+
--metrics-listen-address string The host and port that the metrics endpoint should listen on. The value '0' disables the metrics server (default "0.0.0.0:9402")
44+
--metrics-tls-cert-file string path to the file containing the TLS certificate to serve metrics with
45+
--metrics-tls-cipher-suites strings Comma-separated list of cipher suites for the metrics server. If omitted, the default Go cipher suites will be used. Possible values: TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA
46+
--metrics-tls-min-version string Minimum TLS version supported by the metrics server. If omitted, the default Go minimum version will be used. Possible values: VersionTLS10, VersionTLS11, VersionTLS12, VersionTLS13
47+
--metrics-tls-private-key-file string path to the file containing the TLS private key to serve metrics with
48+
--namespace string If set, this limits the scope of cainjector to a single namespace. If set, cainjector will not update resources with certificates outside of the configured namespace.
49+
--profiler-address string The host and port that Go profiler should listen on, i.e localhost:6060. Ensure that profiler is not exposed on a public address. Profiler will be served at /debug/pprof. (default "localhost:6060")
50+
-v, --v Level number for the log level verbosity
51+
--vmodule pattern=N,... comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)
52+
```

content/v1.17-docs/cli/cmctl.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: cmctl CLI reference
3+
description: "cert-manager cmctl CLI documentation"
4+
---
5+
```
6+
7+
cmctl is a CLI tool manage and configure cert-manager resources for Kubernetes
8+
9+
Usage: cmctl [command]
10+
11+
Available Commands:
12+
approve Approve a CertificateRequest
13+
check Check cert-manager components
14+
convert Convert cert-manager config files between different API versions
15+
create Create cert-manager resources
16+
deny Deny a CertificateRequest
17+
experimental Interact with experimental features
18+
help Help about any command
19+
inspect Get details on certificate related resources
20+
renew Mark a Certificate for manual renewal
21+
status Get details on current status of cert-manager resources
22+
upgrade Tools that assist in upgrading cert-manager
23+
version Print the cert-manager CLI version and the deployed cert-manager version
24+
25+
Flags:
26+
-h, --help help for cmctl
27+
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
28+
--logging-format string Sets the log format. Permitted formats: "json" (gated by LoggingBetaOptions), "text". (default "text")
29+
-v, --v Level[=2] number for the log level verbosity
30+
--vmodule pattern=N,... comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)
31+
32+
Use "cmctl [command] --help" for more information about a command.
33+
```

0 commit comments

Comments
 (0)