Skip to content

Commit e917db7

Browse files
committed
feat: add CLI subcommand to update admin console TLS certificates
Signed-off-by: Evans Mungai <[email protected]>
1 parent f6ed71c commit e917db7

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

docs/enterprise/embedded-tls-certs.mdx

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,42 @@ This topic describes how to update custom TLS certificates in Replicated Embedde
44

55
## Update Custom TLS Certificates
66

7-
Users can provide custom TLS certificates with Embedded Cluster installations and can update TLS certificates through the Admin Console.
7+
Users can provide custom TLS certificates with Embedded Cluster installations and can update TLS certificates using the CLI or through the Admin Console.
8+
9+
### Update Using the CLI (Recommended)
10+
11+
:::note
12+
The `admin-console update-tls` command is available in Embedded Cluster v2.14.0 and later.
13+
:::
14+
15+
The `admin-console update-tls` command provides a secure way to update TLS certificates for the Admin Console. This method updates the `kotsadm-tls` Kubernetes secret directly. Pods watching this secret automatically reload the TLS configuration, so no restart is required.
16+
17+
To update TLS certificates using the CLI:
18+
19+
1. SSH onto a controller node where Embedded Cluster is installed. Ensure the TLS certificate and key files are present on the node.
20+
21+
1. Run the following command to update the TLS certificate and key:
22+
23+
```bash
24+
sudo ./APP_SLUG admin-console update-tls --tls-cert PATH_TO_CERT --tls-key PATH_TO_KEY
25+
```
26+
27+
Replace:
28+
- `APP_SLUG` with the unique slug of the installed application.
29+
- `PATH_TO_CERT` with the path to the TLS certificate file.
30+
- `PATH_TO_KEY` with the path to the TLS key file.
31+
32+
### Update Using the Admin Console
33+
34+
You can also update TLS certificates through the Admin Console. This method requires temporarily enabling anonymous uploads.
835

936
:::important
1037
Adding the `acceptAnonymousUploads` annotation temporarily creates a vulnerability for an attacker to maliciously upload TLS certificates. After TLS certificates have been uploaded, the vulnerability is closed again.
1138

12-
Replicated recommends that you complete this upload process quickly to minimize the vulnerability risk.
39+
Replicated recommends using the CLI method above when possible. If you use this method, complete the upload process quickly to minimize the vulnerability risk.
1340
:::
1441

15-
To upload a new custom TLS certificate in Embedded Cluster installations:
42+
To upload a new custom TLS certificate through the Admin Console:
1643

1744
1. SSH onto a controller node where Embedded Cluster is installed. Then, run the following command to start a shell so that you can access the cluster with kubectl:
1845

0 commit comments

Comments
 (0)