Skip to content

Commit 05b2beb

Browse files
committed
doc: describe self signed certificate lifetime configuration
1 parent 8b30710 commit 05b2beb

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

modules/guides/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@
55
** xref:viewing-and-verifying-sboms.adoc[]
66
** xref:enabling-verification-of-image-signatures.adoc[]
77
** xref:kubernetes-cluster-domain.adoc[]
8+
** xref:secret-lifetime.adoc[]
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
= Self signed certificate lifetime
2+
:description: Customize the lifetime of self signed certificates.
3+
4+
Self signed certificates generated by the xref:secret-operator:index.adoc[secret operator] usually have a short lifetime of 24 hours.
5+
In practice this means that Pods have to be restarted daily in order to avoid using expired certificates.
6+
But in high load production environments, reloading Pods can be a costly operation.
7+
It can disrupt services and in some cases even lead to data loss.
8+
To avoid frequent restarts, the lifetime of the self signed certificates can be increased as needed.
9+
Here is an example for configuring the lifetime of self signed certificates to 7 days in a HDFS stacklet:
10+
11+
[source,yaml]
12+
----
13+
---
14+
apiVersion: hdfs.stackable.tech/v1alpha1
15+
kind: HdfsCluster
16+
metadata:
17+
name: hdfs
18+
spec:
19+
nameNodes:
20+
config:
21+
requestedSecretLifetime: 7d # <1>
22+
roleGroups:
23+
default:
24+
replicas: 2
25+
dataNodes:
26+
config:
27+
requestedSecretLifetime: 7d # <2>
28+
roleGroups:
29+
default:
30+
replicas: 2
31+
journalNodes:
32+
roleGroups:
33+
default:
34+
replicas: 3
35+
config:
36+
requestedSecretLifetime: 7d # <3>
37+
----
38+
<1> The lifetime of the self signed certificates for *all* NameNode groups is set to 7 days.
39+
<2> The lifetime of the self signed certificates for *all* DataNode groups is set to 7 days.
40+
<3> The lifetime of the self signed certificates for the `default` JournalNode group is set to 7 days.
41+
42+
NOTE: The configuration for the journal nodes is done at group level for demonstration purposes.
43+
44+
Even though operators allow setting this property to a value of your choice, the secret operator will not exceed the `maxCertificateLifetime` value specifed in the referenced secret class.
45+
46+
Similarly to the example above, users can configure the lifetime of self signed certificates for the following product Stacklets:
47+
* Apache Druid
48+
* Apache Hadoop
49+
* Apache HBase
50+
* Apache Nifi
51+
* Apache Spark
52+
* Apache Zookeeper
53+
* Trino

0 commit comments

Comments
 (0)