@@ -452,15 +452,37 @@ flux create secret oci ghcr-auth \
452
452
--password=${GITHUB_PAT}
453
453
` ` `
454
454
455
- # ### TLS authentication
455
+ **Note**: Support for specifying TLS authentication data using this API
456
+ has been deprecated. Please use [`.spec.certSecretRef`](#cert-secret-reference)
457
+ instead. If the controller uses the secret specfied by this field to configure
458
+ TLS, then a `DeprecationWarning` event will be emitted.
459
+
460
+ # ## Cert secret reference
456
461
457
462
**Note:** TLS authentication is not yet supported by OCI Helm repositories.
458
463
459
- To provide TLS credentials to use while connecting with the Helm repository,
460
- the referenced Secret is expected to contain `.data.certFile` and
461
- ` .data.keyFile` , and/or `.data.caFile` values.
464
+ ` .spec.certSecretRef.name` is an optional field to specify a secret containing TLS
465
+ certificate data. The secret can contain the following keys :
462
466
463
- For example :
467
+ * `certFile` and `keyFile`: The client certificate and private key used for TLS client
468
+ authentication. These must be used in conjunction, i.e. specifying one without the other
469
+ will lead to an error.
470
+ * `caFile`: The CA certificate used to verify the server, which is required if
471
+ the server is using a self-signed certificate.
472
+
473
+ If the server is using a self-signed certificate and has TLS client authentication enabled,
474
+ all three values are required.
475
+
476
+ All the files in the secret are expected to be [PEM-encoded][pem-encoding]. Assuming you have
477
+ three files; `client.key`, `client.crt` and `ca.crt` for the client private key, client
478
+ certificate and the CA certificate respectively, you can generate the required secret using
479
+ the `flux creat secret helm` command :
480
+
481
+ ` ` ` bash
482
+ flux create secret helm tls --key-file=client.key --cert-file=client.crt --ca-file=ca.crt
483
+ ` ` `
484
+
485
+ Example usage :
464
486
465
487
` ` ` yaml
466
488
---
@@ -472,7 +494,7 @@ metadata:
472
494
spec:
473
495
interval: 5m0s
474
496
url: https://example.com
475
- secretRef :
497
+ certSecretRef :
476
498
name: example-tls
477
499
---
478
500
apiVersion: v1
0 commit comments