Document support for bearer token authentication over https in gitrep…

…ositories Signed-off-by: Christian Ihle <[email protected]>
fluxcd · Jan 24, 2023 · 51bb596 · 51bb596
1 parent 04b06dd
commit 51bb596
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/docs/spec/v1beta2/gitrepositories.md b/docs/spec/v1beta2/gitrepositories.md
@@ -131,6 +131,23 @@ data:
   password: <BASE64>
 ```
 
+#### Bearer token authentication
+
+To authenticate towards a Git repository over HTTPS using bearer token
+authentication (in other words: using a `Authorization: Bearer` header), the referenced
+Secret is expected to contain the token in `.data.bearerToken`.
+
+```yaml
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: bearer-token-auth
+type: Opaque
+data:
+  bearerToken: <BASE64>
+```
+
 #### HTTPS Certificate Authority
 
 To provide a Certificate Authority to trust while connecting with a Git