Merge pull request #121 from fluxcd/git-example-titles

Add sections to Git examples
This commit is contained in:
Stefan Prodan 2020-08-31 13:32:10 +03:00 committed by GitHub
commit 478c7ece74
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions

View File

@ -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: <BASE64>
```
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