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