Skip to content

Commit

Permalink
General review/proofreading
Browse files Browse the repository at this point in the history
Signed-off-by: sdarwin <[email protected]>
  • Loading branch information
sdarwin committed Dec 18, 2024
1 parent 28737d7 commit 63d12c5
Show file tree
Hide file tree
Showing 13 changed files with 34 additions and 21 deletions.
7 changes: 7 additions & 0 deletions content/docs/configuration/acme/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ spec:
server: https://acme-staging-v02.api.letsencrypt.org/directory
privateKeySecretRef:
# Secret resource that will be used to store the account's private key.
# This is your identity with your ACME provider. Any secret name
# may be chosen. It will be populated with data automatically,
# so generally nothing further needs to be done with
# the secret. If you lose this identity/secret, you will be able to
# generate a new one and generate certificates for any/all domains
# managed using your previous account, but you will be unable to revoke
# any certificates generated using that previous account.
name: example-issuer-account-key
# Add a single challenge solver, HTTP01 using nginx
solvers:
Expand Down
2 changes: 1 addition & 1 deletion content/docs/configuration/acme/dns01/route53.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ Here's how to set it up:

- `<service-account-name>` name of the `ServiceAccount` object.
- `<service-account-namespace>` namespace of the `ServiceAccount` object.
- `<cert-manager-service-account-name>` name of cert-managers `ServiceAccount` object, as created during cert-manager installation.
- `<cert-manager-service-account-name>` name of cert-manager's `ServiceAccount` object, as created during cert-manager installation.
- `<cert-manager-namespace>` namespace that cert-manager is deployed into.

4. **Create an Issuer or ClusterIssuer**
Expand Down
2 changes: 1 addition & 1 deletion content/docs/installation/best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ By default the cert-manager webhook Deployment has 1 replica, but in production
If the cert-manager webhook is unavailable, all API operations on cert-manager custom resources will fail,
and this will disrupt any software that creates, updates or deletes cert-manager custom resources (including cert-manager itself),
and it may cause other disruptions to your cluster.
So it is *especially* important to keep at multiple replicas of the cert-manager webhook running at all times.
So it is *especially* important to keep multiple replicas of the cert-manager webhook running at all times.

> ℹ️ By contrast, if there is only a single replica of the cert-manager controller, there is less risk of disruption.
> For example, if the Node hosting the single cert-manager controller manager Pod is drained,
Expand Down
4 changes: 2 additions & 2 deletions content/docs/troubleshooting/acme.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Events:

## 2. Troubleshooting Orders

When we run a describe on the `CertificateRequest` resource we see that an `Order` that has
When we run a describe on the `CertificateRequest` resource we see that an `Order` has
been created:

```bash
Expand Down Expand Up @@ -207,7 +207,7 @@ If your challenge self-check fails with a 404 not found error. Make sure to chec
* use `kubectl describe ingress` to check the status of the HTTP01 solver ingress. (unless you use `acme.cert-manager.io/http01-edit-in-place`, then check the same ingress as your domain)

### DNS01 troubleshooting
If you see no error events about your DNS provider you can check the following
If you see no error events about your DNS provider you can check the following.
Check if you can see the `_acme_challenge.domain` TXT DNS record from the public internet, or in your DNS provider's interface.
cert-manager will check if a DNS record has been propagated by querying the cluster's DNS solver. If you are able to see it from the public internet but not from inside the cluster you might want to change [the DNS server for self-check](../configuration/acme/dns01/README.md#setting-nameservers-for-dns01-self-check) as some cloud providers overwrite DNS internally.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/trust/trust-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ install trust-manager.

## Usage

trust-manager is intentionally simple, adding just one new Kubernetes `CustomResourceDefintion`: `Bundle`.
trust-manager is intentionally simple, adding just one new Kubernetes `CustomResourceDefinition`: `Bundle`.

A `Bundle` represents a set of X.509 certificates that should be distributed across a cluster.

Expand Down
4 changes: 2 additions & 2 deletions content/docs/tutorials/acme/migrating-from-kube-lego.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: 'cert-manager tutorials: Migrating from kube-lego'
[kube-lego](https://github.com/jetstack/kube-lego) is an older Jetstack project
for obtaining TLS certificates from Let's Encrypt (or another ACME server).

Since cert-managers release, kube-lego has been gradually deprecated in favor
Since cert-manager's release, kube-lego has been gradually deprecated in favor
of this project. There are a number of key differences between the two:

| Feature | kube-lego | cert-manager |
Expand Down Expand Up @@ -229,4 +229,4 @@ I1025 21:54:02.869269 1 sync.go:206] Certificate my-example-certificate sc
```
Here we can see cert-manager has verified the existing TLS certificate and
scheduled it to be renewed in 292 hours time.
scheduled it to be renewed in 292 hours time.
2 changes: 1 addition & 1 deletion content/docs/tutorials/acme/nginx-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ sample deployment and an associated service:
```yaml file=./example/service.yaml
```
You can create download and reference these files locally, or you can
You can download and reference these files locally, or you can
reference them from the GitHub source repository for this documentation.
To install the example service from the tutorial files straight from GitHub, do
the following:
Expand Down
2 changes: 1 addition & 1 deletion content/docs/tutorials/certificate-defaults/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -531,7 +531,7 @@ To instead only need to specify the configuration important to them, for example
```
🔗 <a href="cert-test-minimal.yaml">`cert-test-minimal.yaml`</a>
With this policy we achieved our objective and have enabled users to submit minimal `Certifiate` resources.
With this policy we achieved our objective and have enabled users to submit minimal `Certificate` resources.
This completes our fifth [use case](#use-cases), with only a single field contained within the specification, the `dnsNames` entry.
Every other specified field was automatically defaulted using Kyverno with `ClusterPolicy` which would typically be setup by a platform administrator.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ metadata:
# This tells Google Cloud to create an External Load Balancer to realize this Ingress
kubernetes.io/ingress.class: gce
# This enables HTTP connections from Internet clients
# Since "true" is the default, does not need to be set.
kubernetes.io/ingress.allow-http: "true"
# This tells Google Cloud to associate the External Load Balancer with the static IP which we created earlier
kubernetes.io/ingress.global-static-ip-name: web-ip
Expand Down Expand Up @@ -277,7 +278,7 @@ At this point we have a Google load balancer which is forwarding HTTP traffic to
> configured and for Internet clients to be routed to your web server.
> Refer to the [Troubleshooting](#troubleshooting) section if it takes longer.
>
> 🔰 Read about how to [Use a static IP addresses for HTTP(S) load balancers via Ingress annotation](https://cloud.google.com/kubernetes-engine/docs/concepts/ingress-xlb#static_ip_addresses_for_https_load_balancers).
> 🔰 Read about how to [Use static IP addresses for HTTP(S) load balancers via Ingress annotation](https://cloud.google.com/kubernetes-engine/docs/concepts/ingress-xlb#static_ip_addresses_for_https_load_balancers).
>
> 🔰 Read a [Summary of external Ingress annotations for GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress#summary_of_external_ingress_annotations).
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ trusted `ca-certificates.crt` is present.
lrwxrwxrwx 1 root root 26 Apr 14 15:12 ca-certificates.crt -> ..data/ca-certificates.crt
```

Note that normally this container image the output would look something
Note that normally the output would look something
like the following, when there is no volume overriding this directory:

```
Expand Down Expand Up @@ -242,7 +242,7 @@ having to pass the additional `--cacert` flag:

Based on the example above, Kubernetes is able to mount over the top of the
default CA certificate bundle. You can use this with applications assuming you
know where the default locations they retrieve CA certificates from.
know the default locations from where they retrieve CA certificates.

For example with `Go` your application is configurable with either
`SSL_CERT_FILE` or `SSL_CERT_DIR` to point to the default CA certificate
Expand Down
6 changes: 3 additions & 3 deletions content/docs/usage/csi.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ certificate will be unique to each Pod and will be stored on disk to the node
that the Pod is scheduled to.

The life cycle of the certificate key pair matches that of the Pod; the certificate is issued
when the Pod is creation, and destroyed during termination.
when the Pod is created, and destroyed during termination.

This driver also handles renewal of live certificates on the fly.

Expand Down Expand Up @@ -70,8 +70,8 @@ node, containing that Pods information as well as the attributes detailed from
the in-line volume attributes. From this, the driver will generate a private key
as well as a certificate request based upon that key using information built
from the volume attributes. The driver will create a `CertificateRequest`
resource in the same namespace in the Pod that, if valid, cert-manager will
return a signed certificate.
resource in the same namespace as the Pod. If the request is valid, cert-manager
will return a signed certificate.

The resulting signed certificate and generated key will be written to that
node's file system to be mounted to the Pods file system. Since the driver needs
Expand Down
2 changes: 1 addition & 1 deletion content/docs/usage/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ meet the following requirements:

| Field | Requirement |
|--------------------------------|-------------------------------------------------------------|
| `tls.hostname` | Must not be empty. |
| `hostname` | Must not be empty. |
| `tls.mode` | Must be set to `Terminate`. `Passthrough` is not supported. |
| `tls.certificateRef.name` | Cannot be left empty. |
| `tls.certificateRef.kind` | If specified, must be set to `Secret`. |
Expand Down
15 changes: 10 additions & 5 deletions content/docs/usage/ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,10 +187,11 @@ Besides the annotation, it is necessary that each ingress possess a unique `tls.
The ingress-shim sub-component is deployed automatically as part of
installation.

If you would like to use the old
[kube-lego](https://github.com/jetstack/kube-lego) `kubernetes.io/tls-acme:
"true"` annotation for fully automated TLS, you will need to configure a default
`Issuer` when deploying cert-manager. This can be done by adding the following
The old [kube-lego](https://github.com/jetstack/kube-lego) `kubernetes.io/tls-acme: "true"`
annotation is an alternate method to fully automated TLS.
If this annotation is set, the other annotations are not needed,
but in order to use it you will need to configure a default Issuer when deploying cert-manager.
This can be done by adding the following
`--set` when deploying using Helm:

```bash
Expand All @@ -212,7 +213,11 @@ In the above example, cert-manager will create `Certificate` resources that
reference the `ClusterIssuer` `letsencrypt-prod` for all Ingresses that have a
`kubernetes.io/tls-acme: "true"` annotation.
Issuers configured via annotations have a preference over the default issuer. If a default issuer is configured via CLI flags and a `cert-manager.io/cluster-issuer` or `cert-manager.io/issuer` annotation also has been added to an Ingress, the created `Certificate` will refer to the issuer configured via annotation.
Issuers configured via specific annotations have a preference over the default issuer. If a default issuer is configured via CLI flags and a `cert-manager.io/cluster-issuer` or `cert-manager.io/issuer` annotation also has been added to an Ingress, the created `Certificate` will refer to the issuer configured via annotation.
When `kubernetes.io/tls-acme: "true"` hasn't been set, automatic certificate deployment may still occur based on the `cert-manager.io/issuer`, `cert-manager.io/issuer-kind`, and `cert-manager.io/issuer-group` annotations.
If all annotations are absent, then manual deployment is necessary: create Certificate resources directly, and assign the resulting Secret to the Ingress.
For more information on deploying cert-manager, read the [installation
guide](../installation/README.md).
Expand Down

0 comments on commit 63d12c5

Please sign in to comment.