Skip to content

Commit 1e4ab08

Browse files
authored
Merge pull request #53516 from ShaunaDiaz/OSDOCS-4652
OSDOCS-4652: adding Additional information assembly and mods to Configuration
2 parents 5af4302 + 532942a commit 1e4ab08

File tree

5 files changed

+59
-0
lines changed

5 files changed

+59
-0
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ Distros: microshift
106106
Topics:
107107
- Name: Configuring
108108
File: microshift-using-config-tools
109+
- Name: Additional information
110+
File: microshift-things-to-know
109111
---
110112
Name: Networking
111113
Dir: microshift_networking

images/microshift-cert-rotation.png

66.5 KB
Loading
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_content-type: ASSEMBLY
2+
[id="microshift-things-to-know"]
3+
= About responsive restarts and security certificates
4+
include::_attributes/attributes-microshift.adoc[]
5+
:context: microshift-configuring
6+
toc::[]
7+
8+
{product-title} responds to system configuration changes and restarts after alterations are detected, including IP address changes, clock adjustments, and security certificate age.
9+
10+
[id="microshift-ip-address-clock-changes_{context}"]
11+
== IP address changes or clock adjustments
12+
{product-title} depends on device IP addresses and system-wide clock settings to remain consistent during its runtime. However, these settings may occasionally change on edge devices, such as DHCP or Network Time Protocol (NTP) updates.
13+
14+
When such changes occur, some {product-title} components may stop functioning properly. To mitigate this situation, {product-title} monitors the IP address and system time and restarts if either setting change is detected.
15+
16+
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.
17+
18+
include::modules/microshift-certificate-lifetime.adoc[leveloffset=+1]
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift/microshift-things-to-know.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="microshift-certificate-lifetime_{context}"]
7+
= Security certificate lifetime
8+
{product-title} certificates are separated into two basic groups:
9+
10+
. Short-lived certificates having certificate validity of one year.
11+
. Long-lived certificates having certificate validity of 10 years.
12+
13+
Most server or leaf certificates are short-lived.
14+
15+
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.
16+
17+
[id="microshift-certificate-rotation_{context}"]
18+
== Certificate rotation
19+
As certificates age, {product-title} can be restarted to rotate certificates. A certificate that is close to expiring might also automatically cause a restart. Read the following situation overviews to understand the actions at each moment in time:
20+
21+
. Green zone:
22+
.. When a short-term certificate is 5 months old, no rotation occurs.
23+
.. When a long-term certificate is 8.5 years old, no rotation occurs.
24+
25+
. Yellow zone:
26+
.. When a short-term certificate is 8 months old, it is rotated when {product-title} starts or restarts.
27+
.. When a long-term certificate is 9 years old, it is rotated when {product-title} starts or restarts.
28+
29+
. Red zone
30+
.. When a short-term certificate is 8 months old, {product-title} restarts to rotate and apply a new certificate.
31+
.. When a long-term certificate is 9 years old, {product-title} restarts to rotate and apply a new certificate.
32+
33+
[NOTE]
34+
====
35+
If the rotated certificate is a Certificate Authority, all of the certificates it signed rotate.
36+
====
37+
38+
.Stoplight timeline of {product-title} certificate validity.
39+
image::microshift-cert-rotation.png[<{product-title} graph with symbolic green-yellow-red stoplight map of certificates>]

0 commit comments

Comments
 (0)