Skip to content

Commit 59bc52a

Browse files
committed
Update README.md
- fix various formatting, additonal notes, and examples - add link to latest release
1 parent 41c29b8 commit 59bc52a

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

+21-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
rpda
22
====
3-
is a RecoverPoint Direct Access utility to enable _direct access_ to the latest image on a copy node
4-
within a consistency group remotely via API.
3+
Is a RecoverPoint Direct Access utility to provide clients a simple CLI to manage _direct access_ testing
4+
on the latest image of a copy node within a consistency group remotely via API.
55
The project is written in Go (golang) and can be compiled to a single binary for ease of deployment.
66

7-
Download latest compiled `x86_64` release binary [here](https://github.com/bcambl/rpda/releases)
7+
Download latest compiled `x86_64` release binary [here](https://github.com/bcambl/rpda/releases/latest)
88

99
## Configuration
10-
A configuration template will be generated upon first execution of `rpda`.
10+
A configuration template will be generated upon first execution of `rpda [command]`.
1111

1212
```
1313
api:
@@ -23,8 +23,8 @@ identifiers:
2323
```
2424

2525
Update the configuration file with variables that suit your site or environment.
26-
The `identifiers` section in the configuration file uses [_regexp_](https://golang.org/pkg/regexp/) to determine the desired copy
27-
for when `--test` or `--dr` are used.
26+
The `identifiers` section in the configuration file uses [_regexp_](https://golang.org/pkg/regexp/) to
27+
determine the desired copy for when `--test` or `--dr` are used.
2828

2929
The following example will work with the default `identifiers` section in the configuration example above.
3030

@@ -45,7 +45,8 @@ EXAMPLE_CONSISTENCY_GROUP_CG:
4545

4646
## User Permissions
4747
An account on the RecoverPoint Appliance is required and the user must have access to administrate desired consistency groups.
48-
When issuing the `--all` option will only administer consistency groups of which the account has access to modify as per RecoverPoint user privledges.
48+
This utility will only administer consistency groups of which the account has access to modify as per RecoverPoint user
49+
privledges when `--all` is used.
4950

5051
## Specifying a Copy
5152
Naming consistency groups using a consistent _naming scheme_ will allow the use of `--test` and `--dr` options by
@@ -62,10 +63,17 @@ One of the following _copy flags_ must be provided:
6263

6364
## Additional Flags
6465

65-
- `--user <username>` will override the `username` specified within the configuration file.
66+
- `--user <username>` will override the `username` specified within the configuration file. _(will prompt for password)_
6667
- `--delay 60`: will introduce a delay of `60` seconds between consistency group changes when using `--all` (default: `0`)
6768
- `--debug`: will produce additional debugging output to assist with troubleshooting & development
6869
- `--check`: will run allow the application to execute _without_ making any changes (`GET` requests only)
70+
- `--help`: will display CLI help and examples
71+
72+
Note:
73+
Each _command_ also has its own `--help`
74+
```
75+
rpda enable --help
76+
```
6977

7078
## Command-Line Examples
7179

@@ -92,7 +100,7 @@ Enable Direct Image Access Mode for the **_Test_ Copy** on **_ALL_** Consistency
92100
rpda enable --all --test
93101
```
94102

95-
Enable Direct Image Access Mode for the **_Test_ Copy** on **_ALL_** Consistency Groups with `30` second delay
103+
Enable Direct Image Access Mode for the **_Test_ Copy** on **_ALL_** Consistency Groups with `30` second **delay**
96104
```
97105
rpda enable --all --test --delay 30
98106
```
@@ -112,7 +120,7 @@ Enable Direct Image Access Mode for the **_DR_ Copy** on Consistency Group `Test
112120
rpda enable --group TestGroup_CG --dr
113121
```
114122

115-
Enable Direct Image Access Mode for a **_User Defined Copy_** (_Example_CN_) on Consistency Group `TestGroup_CG`
123+
Enable Direct Image Access Mode for a **_User Defined Copy_** (`_Example_CN_`) on Consistency Group `TestGroup_CG`
116124
```
117125
rpda enable --group TestGroup_CG --copy Example_CN
118126
```
@@ -143,14 +151,14 @@ Finish Direct Image Access Mode on Consistency Group `TestGroup_CG` for **_DR_ C
143151
rpda finish --group TestGroup_CG --dr
144152
```
145153

146-
Finish Direct Image Access Mode on Consistency Group `TestGroup_CG` for **_User Defined Copy_** (_Example_CN_)
154+
Finish Direct Image Access Mode on Consistency Group `TestGroup_CG` for **_User Defined Copy_** (`_Example_CN_`)
147155
```
148156
rpda finish --group TestGroup_CG --copy Example_CN
149157
```
150158

151159
## Build Instructions
152160

153-
Download latest compiled `x86_64/amd64` release binary [here](https://github.com/bcambl/rpda/releases)
161+
Download latest compiled `x86_64/amd64` release binary [here](https://github.com/bcambl/rpda/releases/latest)
154162

155163
If you would like to compile the project from source, please install the latest version of the
156164
Go programming [here](https://golang.org/dl/).
@@ -165,4 +173,4 @@ Build Project for `x86_64/amd64` Windows
165173
GOOS=windows GOARCH=amd64 go build -ldflags="-s -w" -o rpda.exe main.go
166174
```
167175

168-
Please read more about building the project for other platforms ($GOOS and $GOARCH) [here](https://golang.org/doc/install/source#environment).
176+
Please read more about building the project for other platforms (`$GOOS` and `$GOARCH`) [here](https://golang.org/doc/install/source#environment).

0 commit comments

Comments
 (0)