Skip to content

Commit 7f6322b

Browse files
committed
README updates
1 parent e6e2304 commit 7f6322b

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,23 @@ This provides real time, continuous backups, and keeps detailled changes history
1010

1111
## Usage
1212

13-
Just dump the cluster's content and exit:
13+
To dump the cluster content once and exit:
1414
```bash
1515
katafygio --dump-only --local-dir /tmp/clusterdump/
1616
```
1717

18-
Create a local git repository in /tmp/kfdump and continuously save the cluster content:
18+
To create a local git repository and continuously save the cluster content:
1919
```bash
2020
katafygio --local-dir /tmp/kfdump
2121
```
2222

23-
Same, but also continously push the local repository to a remote:
23+
Same, but also continuously push to a remote repository:
2424
```bash
2525
katafygio --git-url https://user:[email protected]/myorg/myrepos.git --local-dir /tmp/kfdump
2626
```
2727

2828
Filtering out irrelevant objects (esp. ReplicaSets and Pods) with `-x` or `-y`
29-
will help to keep resources usage low and git history concise.
29+
will help to keep resources usage low, and a concise git history. Eg.:
3030

3131

3232
```bash
@@ -47,7 +47,7 @@ You can also use the [docker image](https://hub.docker.com/r/bpineau/katafygio/)
4747

4848
```
4949
Backup Kubernetes cluster as yaml files in a git repository.
50-
The --exclude-kind and --exclude-object may be specified several times.
50+
--exclude-kind (-x) and --exclude-object (-y) may be specified several times.
5151
5252
Usage:
5353
katafygio [flags]
@@ -78,15 +78,15 @@ Flags:
7878

7979
## Config file and env variables
8080

81-
All settings can be passed by cli, or environment variable, or in a yaml configuration file
82-
(thanks to Viper and Cobra libs). The environment are the same as cli options, in uppercase,
83-
prefixed by "KF", and with underscore instead of dashs. ie.:
81+
All settings can be passed by command line options, or environment variable, or in a yaml
82+
configuration file (thanks to Viper and Cobra libs). The environment are the same as cli options,
83+
in uppercase, prefixed by "KF", and with underscore instead of dashs. ie.:
8484

8585
```
8686
export KF_GIT_URL=https://user:[email protected]/myorg/myrepos.git
8787
export KF_LOCAL_DIR=/tmp/kfdump
8888
89-
# exception: kube config path may be passed as such (for kubectl compatibility)
89+
# exception, for kubectl compatibility:
9090
export KUBECONFIG=/tmp/kconfig
9191
```
9292

@@ -99,6 +99,8 @@ make deps
9999
make build
100100
```
101101

102+
You can also use pre-build binaries from the [releases](https://github.com/bpineau/katafygio/releases) page, or the [docker image](https://hub.docker.com/r/bpineau/katafygio/).
103+
102104
## See Also
103105

104106
* [Heptio Ark](https://github.com/heptio/ark) does sophisticated clusters backups, including volumes

cmd/execute.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ var (
5050
Use: appName,
5151
Short: "Backup Kubernetes cluster as yaml files",
5252
Long: "Backup Kubernetes cluster as yaml files in a git repository.\n" +
53-
"The --exclude-kind and --exclude-object may be specified several times.",
53+
"--exclude-kind (x) and --exclude-object (-y) may be specified several times.",
5454

5555
RunE: func(cmd *cobra.Command, args []string) error {
5656
conf := &config.KfConfig{

0 commit comments

Comments
 (0)