Skip to content

Commit

Permalink
Freeze the cert-manager 1.15 docs
Browse files Browse the repository at this point in the history
Following the instructions from the release process
> (final release only) Freeze the docs/ folder by creating a copy , removing the
> pages from that copy that don't make sense to be versioned, and updating the
> manifest.json file:

```bash
export RELEASE=1.15
cp -r content/docs content/v${RELEASE}-docs
rm -rf content/v${RELEASE}-docs/{installation/supported-releases,installation/upgrading,release-notes,contributing}
sed -i.bak "s|docs/|v${RELEASE}-docs/|g" content/v${RELEASE}-docs/manifest.json
cat content/v${RELEASE}-docs/manifest.json \
  | jq 'del(.. | select(.path? | select(.) | test(".*(installation/supported-releases.md|installation/upgrading|release-notes|contributing).*")))' \
  | jq 'del(.. | select(.routes? == []))' >/tmp/manifest \
     && mv /tmp/manifest content/v${RELEASE}-docs/manifest.json
```

Signed-off-by: Richard Wall <[email protected]>
  • Loading branch information
wallrj committed Oct 3, 2024
1 parent b03a93c commit b4e5099
Show file tree
Hide file tree
Showing 185 changed files with 37,576 additions and 0 deletions.
26 changes: 26 additions & 0 deletions content/v1.15-docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: cert-manager
description: |
cert-manager creates TLS certificates for workloads in your Kubernetes or OpenShift cluster and renews the certificates before they expire.
---

cert-manager creates TLS certificates for workloads in your Kubernetes or OpenShift cluster
and renews the certificates before they expire.

cert-manager can obtain certificates from a [variety of certificate authorities](configuration/issuers.md), including:
[Let's Encrypt](configuration/acme/README.md), [HashiCorp Vault](configuration/vault.md),
[Venafi](configuration/venafi.md) and [private PKI](configuration/ca.md).

With cert-manager's [Certificate resource](usage/certificate.md), the private key and certificate are stored in a Kubernetes Secret
which is mounted by an application Pod or used by an Ingress controller.
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) ,
the private key is generated on-demand, before the application starts up;
the private key never leaves the node and it is not stored in a Kubernetes Secret.

![High level overview diagram explaining cert-manager architecture](/images/high-level-overview.svg)

This website provides the full technical documentation for the project, and can be
used as a reference; if you feel that there's anything missing, please let us know
or [raise a PR](https://github.com/cert-manager/website/pulls) to add it.

<img referrerPolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=e661e870-758f-4c78-ac4a-0bad64a05471" />
7 changes: 7 additions & 0 deletions content/v1.15-docs/cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: CLI reference
description: cert-manager CLI documentation
---

View the `--help` output from our various CLI tools, including those which run in containers in your cluster.
This might help if you need to tweak an option or if you need to check which values are valid!
17 changes: 17 additions & 0 deletions content/v1.15-docs/cli/acmesolver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: acmesolver CLI reference
description: "cert-manager acmesolver CLI documentation"
---
```
HTTP server used to solve ACME challenges.
Usage:
acmesolver [flags]
Flags:
--domain string the domain name to verify
-h, --help help for acmesolver
--key string the challenge key to respond with
--listen-port int the port number to listen on for connections (default 8089)
--token string the challenge token to verify against
```
42 changes: 42 additions & 0 deletions content/v1.15-docs/cli/cainjector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: cainjector CLI reference
description: "cert-manager cainjector CLI documentation"
---
```
cert-manager CA injector is a Kubernetes addon to automate the injection of CA data into
webhooks and APIServices from cert-manager certificates.
It will ensure that annotated webhooks and API services always have the correct
CA data from the referenced certificates, which can then be used to serve API
servers and webhook servers.
Usage:
cainjector [flags]
Flags:
--config string Path to a file containing a CAInjectorConfiguration object used to configure the controller
--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)
--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)
--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)
--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)
--enable-profiling Enable profiling for controller.
--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)
--feature-gates mapStringBool A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
AllAlpha=true|false (ALPHA - default=false)
AllBeta=true|false (BETA - default=false)
ServerSideApply=true|false (ALPHA - default=false)
-h, --help help for cainjector
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster.
--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)
--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)
--leader-election-namespace string Namespace used to perform leader election. Only used if leader election is enabled (default "kube-system")
--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)
--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)
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
--logging-format string Sets the log format. Permitted formats: "json" (gated by LoggingBetaOptions), "text". (default "text")
--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.
--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")
-v, --v Level number for the log level verbosity
--vmodule pattern=N,... comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)
```
33 changes: 33 additions & 0 deletions content/v1.15-docs/cli/cmctl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: cmctl CLI reference
description: "cert-manager cmctl CLI documentation"
---
```
cmctl is a CLI tool manage and configure cert-manager resources for Kubernetes
Usage: cmctl [command]
Available Commands:
approve Approve a CertificateRequest
check Check cert-manager components
convert Convert cert-manager config files between different API versions
create Create cert-manager resources
deny Deny a CertificateRequest
experimental Interact with experimental features
help Help about any command
inspect Get details on certificate related resources
renew Mark a Certificate for manual renewal
status Get details on current status of cert-manager resources
upgrade Tools that assist in upgrading cert-manager
version Print the cert-manager CLI version and the deployed cert-manager version
Flags:
-h, --help help for cmctl
--log-flush-frequency duration Maximum number of seconds between log flushes (default 5s)
--logging-format string Sets the log format. Permitted formats: "json" (gated by LoggingBetaOptions), "text". (default "text")
-v, --v Level[=2] number for the log level verbosity
--vmodule pattern=N,... comma-separated list of pattern=N settings for file-filtered logging (only works for text log format)
Use "cmctl [command] --help" for more information about a command.
```
Loading

0 comments on commit b4e5099

Please sign in to comment.