Skip to content

Commit

Permalink
docs(README): Add generic backups source Kubernetes docs to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ondrejsika committed Oct 8, 2021
1 parent 46c3257 commit 28e8449
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ Source:
Mongo: <BackupSourceMongoConfiguration>
SingleFile: <BackupSourceSingleFileConfiguration>
KubernetesTLSSecret: <BackupSourceKubernetesTLSSecret>
Kubernetes: <BackupSourceKubernetes>
Middlewares:
- <MiddlewareConfiguration>
- ...
Expand Down Expand Up @@ -184,6 +185,27 @@ Namespace: default
SecretName: tls-example-com
```
#### Example BackupSourceKubernetes Block
Backup all resources (pods)
```yaml
Server: https://kubernetes-api.example.com
Token: foo-bar-baz
Namespace: default
Resource: pod
```
Backup single resource (hello-world pod)
```yaml
Server: https://kubernetes-api.example.com
Token: foo-bar-baz
Namespace: default
Resource: pod
Name: hello-world
```
#### Example BackupSourceSingleFileConfiguration Block
```yaml
Expand Down Expand Up @@ -276,7 +298,7 @@ Emails:
- [x] MongoDB
- [ ] Gitlab
- [ ] Proxmox
- [ ] Kubernetes Resource
- [x] Kubernetes Resource
- [x] Kubernetes TLS Secret
- [ ] Container Image
Expand Down

0 comments on commit 28e8449

Please sign in to comment.