Skip to content

Commit 6000062

Browse files
committed
Add sections to Git examples
1 parent 3c3d381 commit 6000062

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/spec/v1alpha1/gitrepositories.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,8 @@ When specified, `spec.ignore` overrides the default exclusion list.
162162

163163
## Spec examples
164164

165+
### Checkout strategies
166+
165167
Pull the master branch of a public repository every minute:
166168

167169
```yaml
@@ -231,7 +233,9 @@ spec:
231233
semver: ">=3.1.0-rc.1 <3.2.0"
232234
```
233235

234-
HTTPS authentication (requires a secret with `username` and `password` fields):
236+
### HTTPS authentication
237+
238+
HTTPS authentication requires a Kubernetes secret with `username` and `password` fields:
235239

236240
```yaml
237241
apiVersion: source.toolkit.fluxcd.io/v1alpha1
@@ -254,7 +258,11 @@ data:
254258
password: <BASE64>
255259
```
256260

257-
SSH authentication (requires a secret with `identity` and `known_hosts` fields):
261+
> **Note:** that self-signed certificates are not supported.
262+
263+
### SSH authentication
264+
265+
SSH authentication requires a Kubernetes secret with `identity` and `known_hosts` fields:
258266

259267
```yaml
260268
apiVersion: source.toolkit.fluxcd.io/v1alpha1
@@ -293,6 +301,8 @@ kubectl create secret generic ssh-credentials \
293301
--from-file=./known_hosts
294302
```
295303

304+
### GPG signature verification
305+
296306
Verify the OpenPGP signature for the commit that master branch HEAD points to:
297307

298308
```yaml

0 commit comments

Comments
 (0)