From 600006293d7e8399988043757c12b56ec9ca936f Mon Sep 17 00:00:00 2001 From: stefanprodan Date: Mon, 31 Aug 2020 13:17:50 +0300 Subject: [PATCH] Add sections to Git examples --- docs/spec/v1alpha1/gitrepositories.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/spec/v1alpha1/gitrepositories.md b/docs/spec/v1alpha1/gitrepositories.md index 9bc3825a..250b213b 100644 --- a/docs/spec/v1alpha1/gitrepositories.md +++ b/docs/spec/v1alpha1/gitrepositories.md @@ -162,6 +162,8 @@ When specified, `spec.ignore` overrides the default exclusion list. ## Spec examples +### Checkout strategies + Pull the master branch of a public repository every minute: ```yaml @@ -231,7 +233,9 @@ spec: semver: ">=3.1.0-rc.1 <3.2.0" ``` -HTTPS authentication (requires a secret with `username` and `password` fields): +### HTTPS authentication + +HTTPS authentication requires a Kubernetes secret with `username` and `password` fields: ```yaml apiVersion: source.toolkit.fluxcd.io/v1alpha1 @@ -254,7 +258,11 @@ data: password: ``` -SSH authentication (requires a secret with `identity` and `known_hosts` fields): +> **Note:** that self-signed certificates are not supported. + +### SSH authentication + +SSH authentication requires a Kubernetes secret with `identity` and `known_hosts` fields: ```yaml apiVersion: source.toolkit.fluxcd.io/v1alpha1 @@ -293,6 +301,8 @@ kubectl create secret generic ssh-credentials \ --from-file=./known_hosts ``` +### GPG signature verification + Verify the OpenPGP signature for the commit that master branch HEAD points to: ```yaml