Skip to content

Commit

Permalink
Merge pull request #33 from pengweisong/fix-readme
Browse files Browse the repository at this point in the history
fix readme and update dependency then release
  • Loading branch information
critical27 authored Feb 15, 2022
2 parents 079e7c7 + be5723d commit f921587
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ bin/br version
--s3.endpoint string S3 Option: set the S3 endpoint URL, please specify the http or https scheme explicitly
--s3.region string S3 Option: set region or location to upload or download backup
--s3.secret_key string S3 Option: set secret key for access id
--debug Output log in debug level or not
```

For example, the command below will conduct a full backup operation of entire cluster whose meta service's address is `127.0.0.1:9559`, upload the backup files to local `/home/nebula/backup` or S3 URL `s3://127.0.0.1:9000/br-test/backup`.
Expand Down Expand Up @@ -103,6 +104,7 @@ bin/br version
example:
for local - "local:///the/local/path/to/backup"
for s3 - "s3://example/url/to/the/backup"
--debug Output log in debug level or not
```

For example, the command below will list the information of existing backups in local path `/home/nebula/backup` or S3 URL `s3://127.0.0.1:9000/br-test/backup`
Expand Down Expand Up @@ -150,6 +152,7 @@ bin/br version
--s3.endpoint string S3 Option: set the S3 endpoint URL, please specify the http or https scheme explicitly
--s3.region string S3 Option: set region or location to upload or download backup
--s3.secret_key string S3 Option: set secret key for access id
--debug Output log in debug level or not
```

For example, the command below will conduct a restore operation, which restore to the cluster whose meta service address is `127.0.0.1:9559`, from local disk in path `/home/nebula/backup/BACKUP_2021_12_08_18_38_08` or s3 URL `s3://127.0.0.1:9000/br-test/backupu/BACKUP_2021_12_08_18_38_08`
Expand Down Expand Up @@ -186,12 +189,13 @@ bin/br version
--s3.endpoint string S3 Option: set the S3 endpoint URL, please specify the http or https scheme explicitly
--s3.region string S3 Option: set region or location to upload or download backup
--s3.secret_key string S3 Option: set secret key for access id
--debug Output log in debug level or not
```

For example:
```bash
# for local
br cleanup --meta "127.0.0.1:9559" --s3.endpoint "http://127.0.0.1:9000" --storage="local:///home/nebula/backup/" --name BACKUP_2021_12_08_18_38_08
br cleanup --meta "127.0.0.1:9559" --storage="local:///home/nebula/backup/" --name BACKUP_2021_12_08_18_38_08

# for s3
br cleanup --meta "127.0.0.1:9559" --s3.endpoint "http://127.0.0.1:9000" --storage="s3://br-test/backup/" --s3.access_key=minioadmin --s3.secret_key=minioadmin --name=BACKUP_2021_12_08_18_38_08
Expand Down
4 changes: 2 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ require (
github.com/spf13/cobra v1.1.1
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.7.0
github.com/vesoft-inc/nebula-agent v0.1.1-0.20220208095610-fe80654911f8
github.com/vesoft-inc/nebula-go/v3 v3.0.0-20220119024722-ab348afbb79d
github.com/vesoft-inc/nebula-agent v0.1.1
github.com/vesoft-inc/nebula-go/v3 v3.0.0
golang.org/x/sys v0.0.0-20211124211545-fe61309f8881 // indirect
)
8 changes: 4 additions & 4 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -223,10 +223,10 @@ github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5Cc
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw=
github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
github.com/vesoft-inc/nebula-agent v0.1.1-0.20220208095610-fe80654911f8 h1:UY7ygJyfzpYWIsdLpLJTf1yjh3FhW8xRYBNQg1OL77o=
github.com/vesoft-inc/nebula-agent v0.1.1-0.20220208095610-fe80654911f8/go.mod h1:uA6GJsvhNdTZkLQp1grX74fUm6TWi7EWA2AEWNeHzNU=
github.com/vesoft-inc/nebula-go/v3 v3.0.0-20220119024722-ab348afbb79d h1:spO7OAtYI1wiqBiJ9417pKhqx0IkqFAFdFQFPm4JIrs=
github.com/vesoft-inc/nebula-go/v3 v3.0.0-20220119024722-ab348afbb79d/go.mod h1:+sXv05jYQBARdTbTcIEsWVXCnF/6ttOlDK35xQ6m54s=
github.com/vesoft-inc/nebula-agent v0.1.1 h1:HGrKJV02uLQydgBTn8/eVdyxkY3cLGC1B5ra/xet52Y=
github.com/vesoft-inc/nebula-agent v0.1.1/go.mod h1:JovCbyojVT665zWtlsss9SL9cVX969XKkZKO3NhrcMQ=
github.com/vesoft-inc/nebula-go/v3 v3.0.0 h1:ii5T3vps4xAQZkzPvGn6NuiUWlH/rm1zdIS5VTEA71A=
github.com/vesoft-inc/nebula-go/v3 v3.0.0/go.mod h1:+sXv05jYQBARdTbTcIEsWVXCnF/6ttOlDK35xQ6m54s=
github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU=
go.etcd.io/bbolt v1.3.2/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU=
go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU=
Expand Down

0 comments on commit f921587

Please sign in to comment.