Skip to content

Commit f62c4a6

Browse files
docs: Improve the documentation of the annotation "secrets.stackable.tech/backend.autotls.cert.domain-components-in-subject-dn"
1 parent e3bf527 commit f62c4a6

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

docs/modules/secret-operator/pages/volume.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,21 +176,29 @@ Jittering may be disabled by setting the jitter factor to 0.
176176

177177
If set to `"true"`, the domain components of the Pod's fully qualified domain name (FQDN) are appended to the subject distinguished name (DN) of the TLS certificate.
178178

179-
For example, the subject DN could look as follows:
179+
For example, the subject DN could look as follows for a StatefulSet Pod:
180180

181181
```
182182
CN=generated certificate for pod, DC=my-pod-0, DC=my-statefulset-service, DC=my-namespace, DC=svc, DC=cluster, DC=local
183183
```
184184

185+
The service name is not part of the domain components if the Pod spec does not contain a subdomain, e.g. for Deployments and Jobs:
186+
187+
```
188+
CN=generated certificate for pod, DC=my-job-pod-7c5xx, DC=my-namespace, DC=svc, DC=cluster, DC=local
189+
190+
```
191+
185192
[NOTE]
186193
====
187194
Many products use the string representation of distinguished names as described in https://www.ietf.org/rfc/rfc4514.txt[RFC 4514{external-link-icon}^].
188195
The string representation starts with the last element of the sequence and moving backwards toward the first.
189196
190-
The example above becomes:
197+
The examples above become:
191198
192199
```
193200
DC=local,DC=cluster,DC=svc,DC=my-namespace,DC=my-statefulset-service,DC=my-pod-0,CN=generated certificate for pod
201+
DC=local,DC=cluster,DC=svc,DC=my-namespace,DC=my-job-pod-7c5xx,CN=generated certificate for pod
194202
```
195203
196204
Attribute names can be in upper or lower case, with or without spaces between them.

rust/operator-binary/src/backend/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ pub struct SecretVolumeSelector {
132132
/// If set to `"true"`, the domain components of the Pod's fully qualified domain name (FQDN)
133133
/// are appended to the subject distinguished name (DN) of the TLS certificate.
134134
///
135-
/// For example, the subject DN could look as follows:
135+
/// For example, the subject DN could look as follows for a StatefulSet Pod:
136136
///
137137
/// `CN=generated certificate for pod, DC=my-pod-0, DC=my-statefulset-service, DC=my-namespace, DC=svc, DC=cluster, DC=local`
138138
#[serde(

0 commit comments

Comments
 (0)