diff --git a/gp-scripts/README.md b/gp-scripts/README.md index 947467e..a875028 100644 --- a/gp-scripts/README.md +++ b/gp-scripts/README.md @@ -4,6 +4,22 @@ e.g. brick-do.sh -v ge-pacs -c "sudo ls -alh" -p "/ge-pacs/data" +Where `-p` is optional + +``` +# brick-do.sh --help + +A little helper script to exeucte commands on single bricks. + +Usage: [OPTION] +Mandatory: + -c|--COMMAND COMMAND the command to execute + -v|--volume VOLUME the volume of the bricks + +Optionial: + -p|--brick-path BRICK_PATH in case the command needs to be run in a + subdirectory of the brick path +``` # checkup.sh Run a quick test on the cluster and do some sanity checks. Most checks are intended to be reviewed by a human being.