Skip to content

Commit d4891dc

Browse files
committed
docs(maintenance): Add CRD maintenance page
1 parent 8d4feec commit d4891dc

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

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+
Since SDP 25.11.0 some operators maintain the CRD on their own without relying on 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 generates a CA (and a leaf certificate) used by the conversion webhook automatically which is additionally rotated every 24 hours.
7+
This requires the operator to continuously update the `caBundle` field of the 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`

0 commit comments

Comments
 (0)