Skip to content

Commit c3a3b16

Browse files
docs: Add maintenance pages (#824)
* docs(maintenance): Add CRD maintenance page * docs(maintenance): Add EoS check page * docs(nav): Add maintenance nav links * chore: Apply suggestion Co-authored-by: Malte Sander <malte.sander.it@gmail.com> * chore: Apply suggestion Co-authored-by: Malte Sander <malte.sander.it@gmail.com> * chore: Apply suggestion Co-authored-by: Malte Sander <malte.sander.it@gmail.com> --------- Co-authored-by: Malte Sander <malte.sander.it@gmail.com>
1 parent 8d4feec commit c3a3b16

File tree

3 files changed

+59
-0
lines changed

3 files changed

+59
-0
lines changed

modules/concepts/nav.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,7 @@
2626
*** xref:observability/logging.adoc[Logging]
2727
*** xref:observability/containerdebug.adoc[Container environment]
2828
*** xref:observability/telemetry.adoc[Telemetry]
29+
** Maintenance
30+
*** xref:maintenance/crds.adoc[CRD maintenance]
31+
*** xref:maintenance/eos.adoc[End-of-Support check]
2932
** xref:container-images.adoc[]
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
= CustomResourceDefinition (CRD) maintenance
2+
:k8s-webhook-config: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#configure-customresourcedefinition-to-use-conversion-webhooks
3+
4+
Starting with SDP 25.11.0, specific operators now manage their own CRD lifecycle independently of Helm or other deployment tools.
5+
The primary reason for this is that the operator is able to inject a {k8s-webhook-config}[conversion webhook configuration] with an up-to-date `caBundle`.
6+
The operator automatically generates a dedicated CA and leaf certificate for the conversion webhook, rotating them every 24 hours.
7+
To maintain secure communication, the operator must continuously inject the up-to-date caBundle into the CRD's webhook configuration.
8+
9+
This maintenance process can be disabled via a Helm value if desired.
10+
11+
[WARNING]
12+
====
13+
It should be noted that when CRD maintenance is disabled, the operator will not deploy and manage the CRDs.
14+
The CRDs need to be deployed manually and the conversion webhook is disabled.
15+
As a result, only custom resources of the stored version can be used.
16+
Only use this setting if you know what you are doing!
17+
====
18+
19+
[NOTE]
20+
====
21+
The following section describe the available fields as well as their default and supported values.
22+
====
23+
24+
[source,yaml]
25+
----
26+
maintenance:
27+
customResourceDefinitions:
28+
maintain: true # <1>
29+
----
30+
31+
<1> Boolean: `true`, `false`
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
= End-of-Support (EoS) check
2+
3+
Starting with SDP 25.11.0, operators emit a warning message on startup and in a regular interval when it may have reached end-of-support.
4+
Most of the operators reach end-of-support one year after they have been released, which roughly translates to three SDP releases.
5+
This is in accordance with our xref:compliance:policies.adoc[support policy].
6+
7+
The interval can be adjusted or the check can be disabled completely via Helm values.
8+
9+
[NOTE]
10+
====
11+
The following sections describe the available fields as well as their default and supported values.
12+
====
13+
14+
[source,yaml]
15+
----
16+
maintenance:
17+
endOfSupportCheck:
18+
enabled: true # <1>
19+
mode: offline # <2>
20+
interval: 24h # <3>
21+
----
22+
23+
<1> Boolean: `true`, `false`
24+
<2> Enum: `offline` (currently no other options available)
25+
<3> Duration: Any duration according to xref:reference:duration.adoc[this format]

0 commit comments

Comments
 (0)