Add Git mTLS config to API docs

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
This commit is contained in:
Stefan Prodan 2025-04-22 10:37:23 +03:00
parent b549fec2e7
commit 3214ccd11c
No known key found for this signature in database
GPG Key ID: 3299AEB0E4085BAF
1 changed files with 25 additions and 0 deletions

View File

@ -177,6 +177,31 @@ data:
ca.crt: <BASE64>
```
#### HTTPS Mutual TLS authentication
To authenticate towards a Git repository over HTTPS using mutual TLS,
the referenced Secret's `.data` should contain the following keys:
* `tls.crt` and `tls.key`, to specify the client certificate and private key used
for TLS client authentication. These must be used in conjunction, i.e.
specifying one without the other will lead to an error.
* `ca.crt`, to specify the CA certificate used to verify the server, which is
required if the server is using a self-signed certificate.
```yaml
---
apiVersion: v1
kind: Secret
metadata:
name: https-tls-certs
namespace: default
type: Opaque
data:
tls.crt: <BASE64>
tls.key: <BASE64>
ca.crt: <BASE64>
```
#### SSH authentication
To authenticate towards a Git repository over SSH, the referenced Secret is