Skip to content

Commit 6a2792a

Browse files
authored
Merge pull request #91079 from tmalove/ms-osdocs-13277-tlove
OSDOCS#13277: Clarify certificate rotation, including not rotating CAs
2 parents 9c73b5a + a6cc04e commit 6a2792a

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

microshift_troubleshooting/microshift-things-to-know.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,8 @@ When such changes occur, some {microshift-short} components may stop functioning
1717

1818
The threshold for clock changes is a time adjustment of greater than 10 seconds in either direction. Smaller drifts on regular time adjustments performed by the Network Time Protocol (NTP) service do not cause a restart.
1919

20-
include::modules/microshift-certificate-lifetime.adoc[leveloffset=+1]
20+
include::modules/microshift-certificate-lifetime.adoc[leveloffset=+1]
21+
[role="_additional-resources"]
22+
.Additional resources
23+
24+
* xref:../microshift_configuring/microshift_auth_security/microshift-custom-ca.adoc#microshift-custom-ca[Configuring custom certificate authorities].

modules/microshift-certificate-lifetime.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@
1111
. Short-lived certificates having certificate validity of one year.
1212
. Long-lived certificates having certificate validity of 10 years.
1313

14-
Most server or leaf certificates are short-term.
14+
Most server or leaf certificates are short-lived.
1515

1616
An example of a long-lived certificate is the client certificate for `system:admin user` authentication, or the certificate of the signer of the `kube-apiserver` external serving certificate.
1717

1818
[id="microshift-certificate-rotation_{context}"]
1919
== Certificate rotation
2020
Certificates that are expired or close to their expiration dates need to be rotated to ensure continued {microshift-short} operation. When {microshift-short} restarts for any reason, certificates that are close to expiring are rotated. A certificate that is set to expire imminently, or has expired, can cause an automatic {microshift-short} restart to perform a rotation.
2121

22-
[NOTE]
22+
[IMPORTANT]
2323
====
24-
If the rotated certificate is a Certificate Authority, all of the certificates it signed rotate.
24+
If the rotated certificate is a {microshift-short} certificate authority (CA), then all of the signed certificates rotate. If you created any custom CAs, ensure the CAs manually rotate.
2525
====
2626

2727
[id="microshift-st-certificate-rotation_{context}"]
@@ -48,4 +48,4 @@ The following situations describe {microshift-short} actions during long-term ce
4848
.. When a long-term certificate is 8.5 to 9 years old, it is rotated when {microshift-short} starts or restarts.
4949

5050
. Automatic restart for rotation:
51-
.. When a long-term certificate is more than 9 years old, {microshift-short} can automatically restart to rotate and apply a new certificate.
51+
.. When a long-term certificate is more than 9 years old, {microshift-short} might automatically restart so that it can rotate and apply a new certificate.

modules/microshift-custom-ca-proc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ apiServer:
4242
<2> Add the full path to the certificate key.
4343
<3> Optional. Add a list of explicit DNS names. Leading wildcards are allowed. If no names are provided, the implicit names are extracted from the certificates.
4444
45-
. Restart the {microshift-service} to apply the certificates by running the following command:
45+
. Restart the {microshift-short} to apply the certificates by running the following command:
4646
+
4747
[source,terminal]
4848
----

0 commit comments

Comments
 (0)