Skip to content

Commit e3bf527

Browse files
docs: Document the annotation "secrets.stackable.tech/backend.autotls.cert.domain-components-in-subject-dn"
1 parent 7d945c1 commit e3bf527

2 files changed

Lines changed: 36 additions & 0 deletions

File tree

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,36 @@ For example, given a requested lifetime of 1 day and a jitter factor of 0.2, the
166166

167167
Jittering may be disabled by setting the jitter factor to 0.
168168

169+
=== `secrets.stackable.tech/backend.autotls.cert.domain-components-in-subject-dn`
170+
171+
*Required*: false
172+
173+
*Default value*: `"false"`
174+
175+
*Backends*: xref:secretclass.adoc#backend-autotls[]
176+
177+
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.
178+
179+
For example, the subject DN could look as follows:
180+
181+
```
182+
CN=generated certificate for pod, DC=my-pod-0, DC=my-statefulset-service, DC=my-namespace, DC=svc, DC=cluster, DC=local
183+
```
184+
185+
[NOTE]
186+
====
187+
Many products use the string representation of distinguished names as described in https://www.ietf.org/rfc/rfc4514.txt[RFC 4514{external-link-icon}^].
188+
The string representation starts with the last element of the sequence and moving backwards toward the first.
189+
190+
The example above becomes:
191+
192+
```
193+
DC=local,DC=cluster,DC=svc,DC=my-namespace,DC=my-statefulset-service,DC=my-pod-0,CN=generated certificate for pod
194+
```
195+
196+
Attribute names can be in upper or lower case, with or without spaces between them.
197+
====
198+
169199
=== `secrets.stackable.tech/backend.cert-manager.cert.lifetime`
170200

171201
*Required*: false

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,12 @@ pub struct SecretVolumeSelector {
129129
)]
130130
pub autotls_cert_jitter_factor: f64,
131131

132+
/// If set to `"true"`, the domain components of the Pod's fully qualified domain name (FQDN)
133+
/// are appended to the subject distinguished name (DN) of the TLS certificate.
134+
///
135+
/// For example, the subject DN could look as follows:
136+
///
137+
/// `CN=generated certificate for pod, DC=my-pod-0, DC=my-statefulset-service, DC=my-namespace, DC=svc, DC=cluster, DC=local`
132138
#[serde(
133139
rename = "secrets.stackable.tech/backend.autotls.cert.domain-components-in-subject-dn",
134140
deserialize_with = "SecretVolumeSelector::deserialize_str_as_bool",

0 commit comments

Comments
 (0)