Skip to content

Commit 08a9fa2

Browse files
authored
Merge pull request #2995 from replicatedhq/118932
Add docs for updating tls certs in EC installs
2 parents 099751c + 52d9071 commit 08a9fa2

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Updating Custom TLS Certificates in Embedded Cluster Installations
2+
3+
This topic describes how to update custom TLS certificates in Replicated Embedded Cluster installations.
4+
5+
## Update Custom TLS Certificates
6+
7+
Users can provide custom TLS certificates with Embedded Cluster installations and can update TLS certificates through the Admin Console.
8+
9+
:::important
10+
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.
11+
12+
Replicated recommends that you complete this upload process quickly to minimize the vulnerability risk.
13+
:::
14+
15+
To upload a new custom TLS certificate in Embedded Cluster installations:
16+
17+
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:
18+
19+
```bash
20+
sudo ./APP_SLUG shell
21+
```
22+
Where `APP_SLUG` is the unique slug of the installed application.
23+
24+
1. In the shell, run the following command to restore the ability to upload new TLS certificates by adding the `acceptAnonymousUploads` annotation:
25+
26+
```bash
27+
kubectl -n kotsadm annotate secret kotsadm-tls acceptAnonymousUploads=1 --overwrite
28+
```
29+
30+
1. Run the following command to get the name of the kurl-proxy server:
31+
32+
```bash
33+
kubectl get pods -A | grep kurl-proxy | awk '{print $2}'
34+
```
35+
:::note
36+
This server is named `kurl-proxy`, but is used in both Embedded Cluster and kURL installations.
37+
:::
38+
39+
1. Run the following command to delete the kurl-proxy pod. The pod automatically restarts after the command runs.
40+
41+
```bash
42+
kubectl delete pods PROXY_SERVER
43+
```
44+
45+
Replace `PROXY_SERVER` with the name of the kurl-proxy server that you got in the previous step.
46+
47+
1. After the pod has restarted, go to `http://<ip>:30000/tls` in your browser and complete the process in the Admin Console to upload a new certificate.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,7 @@ const sidebars = {
245245
},
246246
'enterprise/embedded-manage-nodes',
247247
'enterprise/updating-embedded',
248+
'enterprise/embedded-tls-certs',
248249
'vendor/embedded-disaster-recovery',
249250
],
250251
},

0 commit comments

Comments
 (0)