Skip to content

Commit 3214ccd

Browse files
committed
Add Git mTLS config to API docs
Signed-off-by: Stefan Prodan <[email protected]>
1 parent b549fec commit 3214ccd

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/spec/v1/gitrepositories.md

+25
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,31 @@ data:
177177
ca.crt: <BASE64>
178178
```
179179

180+
#### HTTPS Mutual TLS authentication
181+
182+
To authenticate towards a Git repository over HTTPS using mutual TLS,
183+
the referenced Secret's `.data` should contain the following keys:
184+
185+
* `tls.crt` and `tls.key`, to specify the client certificate and private key used
186+
for TLS client authentication. These must be used in conjunction, i.e.
187+
specifying one without the other will lead to an error.
188+
* `ca.crt`, to specify the CA certificate used to verify the server, which is
189+
required if the server is using a self-signed certificate.
190+
191+
```yaml
192+
---
193+
apiVersion: v1
194+
kind: Secret
195+
metadata:
196+
name: https-tls-certs
197+
namespace: default
198+
type: Opaque
199+
data:
200+
tls.crt: <BASE64>
201+
tls.key: <BASE64>
202+
ca.crt: <BASE64>
203+
```
204+
180205
#### SSH authentication
181206

182207
To authenticate towards a Git repository over SSH, the referenced Secret is

0 commit comments

Comments
 (0)