Skip to content

Commit 44098cf

Browse files
authored
Merge pull request #1857 from cappyzawa/docs/mtls-documentation-unification
docs: unify mTLS authentication section titles
2 parents 93b9048 + a651665 commit 44098cf

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/spec/v1/buckets.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -843,20 +843,20 @@ See [Provider](#provider) for more (provider specific) examples.
843843

844844
See [Provider](#provider) for more (provider specific) examples.
845845

846-
### Cert secret reference
846+
### Mutual TLS Authentication
847847

848848
`.spec.certSecretRef.name` is an optional field to specify a secret containing
849-
TLS certificate data. The secret can contain the following keys:
849+
TLS certificate data for mutual TLS authentication.
850+
851+
To authenticate towards a bucket using mutual TLS,
852+
the referenced Secret's `.data` should contain the following keys:
850853

851854
* `tls.crt` and `tls.key`, to specify the client certificate and private key used
852855
for TLS client authentication. These must be used in conjunction, i.e.
853856
specifying one without the other will lead to an error.
854857
* `ca.crt`, to specify the CA certificate used to verify the server, which is
855858
required if the server is using a self-signed certificate.
856859

857-
If the server is using a self-signed certificate and has TLS client
858-
authentication enabled, all three values are required.
859-
860860
The Secret should be of type `Opaque` or `kubernetes.io/tls`. All the files in
861861
the Secret are expected to be [PEM-encoded][pem-encoding]. Assuming you have
862862
three files; `client.key`, `client.crt` and `ca.crt` for the client private key,

docs/spec/v1/helmrepositories.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -439,20 +439,20 @@ deprecated. Please use [`.spec.certSecretRef`](#cert-secret-reference) instead.
439439
If the controller uses the secret specified by this field to configure TLS, then
440440
a deprecation warning will be logged.
441441

442-
### Cert secret reference
442+
### Mutual TLS Authentication
443443

444444
`.spec.certSecretRef.name` is an optional field to specify a secret containing
445-
TLS certificate data. The secret can contain the following keys:
445+
TLS certificate data for mutual TLS authentication.
446+
447+
To authenticate towards a Helm repository using mutual TLS,
448+
the referenced Secret's `.data` should contain the following keys:
446449

447450
* `tls.crt` and `tls.key`, to specify the client certificate and private key used
448451
for TLS client authentication. These must be used in conjunction, i.e.
449452
specifying one without the other will lead to an error.
450453
* `ca.crt`, to specify the CA certificate used to verify the server, which is
451454
required if the server is using a self-signed certificate.
452455

453-
If the server is using a self-signed certificate and has TLS client
454-
authentication enabled, all three values are required.
455-
456456
The Secret should be of type `Opaque` or `kubernetes.io/tls`. All the files in
457457
the Secret are expected to be [PEM-encoded][pem-encoding]. Assuming you have
458458
three files; `client.key`, `client.crt` and `ca.crt` for the client private key,

docs/spec/v1/ocirepositories.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -287,20 +287,20 @@ provide a `secretRef` nor `serviceAccountName`.
287287
For a complete guide on how to set up authentication for cloud providers,
288288
see the integration [docs](/flux/integrations/).
289289

290-
### Cert secret reference
290+
### Mutual TLS Authentication
291291

292292
`.spec.certSecretRef.name` is an optional field to specify a secret containing
293-
TLS certificate data. The secret can contain the following keys:
293+
TLS certificate data for mutual TLS authentication.
294+
295+
To authenticate towards an OCI repository using mutual TLS,
296+
the referenced Secret's `.data` should contain the following keys:
294297

295298
* `tls.crt` and `tls.key`, to specify the client certificate and private key used
296299
for TLS client authentication. These must be used in conjunction, i.e.
297300
specifying one without the other will lead to an error.
298301
* `ca.crt`, to specify the CA certificate used to verify the server, which is
299302
required if the server is using a self-signed certificate.
300303

301-
If the server is using a self-signed certificate and has TLS client
302-
authentication enabled, all three values are required.
303-
304304
The Secret should be of type `Opaque` or `kubernetes.io/tls`. All the files in
305305
the Secret are expected to be [PEM-encoded][pem-encoding]. Assuming you have
306306
three files; `client.key`, `client.crt` and `ca.crt` for the client private key,

0 commit comments

Comments
 (0)