Skip to content

Commit

Permalink
docs: consolidate certificate management articles
Browse files Browse the repository at this point in the history
Move around some docs.

Signed-off-by: Steve Francis <steve.francis@talos-systems.com>
Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
  • Loading branch information
steverfrancis authored and smira committed Jan 30, 2024
1 parent 9c14dea commit ee0fb5e
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 78 deletions.
2 changes: 1 addition & 1 deletion website/content/v1.7/learn-more/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ It also handles the automatic rotation of server-side certificates.

However, client certificates such as `talosconfig` and `kubeconfig` are the user's responsibility, and by default, they have a validity period of 1 year.

To renew the `talosconfig` certificate, the follow [this process]({{< relref "../talos-guides/configuration/managing-pki" >}}).
To renew the `talosconfig` certificate, the follow [this process]({{< relref "../talos-guides/howto/cert-management" >}}).
To renew `kubeconfig`, use `talosctl kubeconfig` command, and the time-to-live (TTL) is defined in the [configuration]({{< relref "../reference/configuration/#adminkubeconfigconfig" >}}).

## How can I set the timezone of my Talos Linux clusters?
Expand Down
72 changes: 0 additions & 72 deletions website/content/v1.7/talos-guides/configuration/managing-pki.md

This file was deleted.

71 changes: 66 additions & 5 deletions website/content/v1.7/talos-guides/howto/cert-management.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,75 @@
---
title: "How to manage certificate lifetimes with Talos Linux"
title: "How to manage PKI and certificate lifetimes with Talos Linux"
aliases:

- ../../guides/managing-pki
- ../../guides/configuration/managing-pki
---

Talos Linux automatically manages and rotates all server side certs for etcd, Kubernetes, and the Talos API.
Talos Linux automatically manages and rotates all server side certificates for etcd, Kubernetes, and the Talos API.
Note however that the kubelet needs to be restarted at least once a year in order for the certificates to be rotated.
Any upgrade/reboot of the node will suffice for this effect.

Client certs (`talosconfig` and `kubeconfig`) are the user's responsibility.
You can check the Kubernetes certificates with the command `talosctl get KubernetesDynamicCerts -o yaml` on the controlplane.

Client certificates (`talosconfig` and `kubeconfig`) are the user's responsibility.
Each time you download the `kubeconfig` file from a Talos Linux cluster, the client certificate is regenerated giving you a kubeconfig which is valid for a year.

The `talosconfig` file should be renewed at least once a year, using the `talosctl config new` command.
The `talosconfig` file should be renewed at least once a year, using the `talosctl config new` command, as shown below, or by one of the other methods.

## Generating New Client Configuration

### Using Controlplane Node

If you have a valid (not expired) `talosconfig` with `os:admin` role,
a new client configuration file can be generated with `talosctl config new` against
any controlplane node:

```shell
talosctl -n CP1 config new talosconfig-reader --roles os:reader --crt-ttl 24h
```

A specific [role]({{< relref "../configuration/rbac.md" >}}) and certificate lifetime can be specified.

### From Secrets Bundle

If a secrets bundle (`secrets.yaml` from `talosctl gen secrets`) was saved while
[generating machine configuration]({{< relref "../../introduction/getting-started/#configure-talos ">}}):

```shell
talosctl gen config --with-secrets secrets.yaml --output-types talosconfig -o talosconfig <cluster-name> https://<cluster-endpoint>
```

> Note: `<cluster-name>` and `<cluster-endpoint>` arguments don't matter, as they are not used for `talosconfig`.
### From Control Plane Machine Configuration

In order to create a new key pair for client configuration, you will need the root Talos API CA.
The base64 encoded CA can be found in the control plane node's configuration file.
Save the the CA public key, and CA private key as `ca.crt`, and `ca.key` respectively:

```shell
yq eval .machine.ca.crt controlplane.yaml | base64 -d > ca.crt
yq eval .machine.ca.key controlplane.yaml | base64 -d > ca.key
```

Now, run the following commands to generate a certificate:

```bash
talosctl gen key --name admin
talosctl gen csr --key admin.key --ip 127.0.0.1
talosctl gen crt --ca ca --csr admin.csr --name admin
```

Put the base64-encoded files to the respective location to the `talosconfig`:

```yaml
context: mycluster
contexts:
mycluster:
endpoints:
- CP1
- CP2
ca: <base64-encoded ca.crt>
crt: <base64-encoded admin.crt>
key: <base64-encoded admin.key>
```

0 comments on commit ee0fb5e

Please sign in to comment.