aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorQuentin <quentin@deuxfleurs.fr>2020-11-29 17:27:49 +0100
committerQuentin <quentin@deuxfleurs.fr>2020-11-29 17:27:49 +0100
commit54c3a023f0febb68824be51a9b35a2457373ad07 (patch)
tree3d680e52e32be2106210203afaacf34f8e1dbcc6 /README.md
parent15f409d4044471992609d0cbf9e430b22c9e08a9 (diff)
downloadgarage-54c3a023f0febb68824be51a9b35a2457373ad07.tar.gz
garage-54c3a023f0febb68824be51a9b35a2457373ad07.zip
Use aws cli version 2
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index 9325bcae..a33e2850 100644
--- a/README.md
+++ b/README.md
@@ -20,14 +20,15 @@ Our main use case is to provide a distributed storage layer for small-scale self
We propose the following quickstart to setup a full dev. environment as quickly as possible:
- 1. Setup a rust/cargo environment and install `awscli`. eg. `dnf install rust cargo awscli`
- 2. Run `cargo build` to build the project
- 3. Run `./script/dev-cluster.sh` to launch a test cluster (feel free to read the script)
- 4. Run `./script/dev-configure.sh` to configure your test cluster with default values (same datacenter, 100 tokens)
- 5. Run `./script/dev-bucket.sh` to create a bucket named `eprouvette` and an API key that will be stored in `/tmp/garage.s3`
- 6. Run `source ./script/dev-env.sh` to configure your CLI environment
- 7. You can use `garage` to manage the cluster. Try `garage --help`.
- 8. You can use `s3grg` to add, remove, and delete files. Try `s3grg --help`, `s3grg cp /proc/cpuinfo s3://eprouvette/cpuinfo.txt`, `s3grg ls s3://eprouvette`. `s3grg` is a wrapper on the `aws s3` subcommand configured with the previously generated API key (the one in `/tmp/garage.s3`).
+ 1. Setup a rust/cargo environment. eg. `dnf install rust cargo`
+ 2. Install awscli v2 by following the guide [here](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html).
+ 3. Run `cargo build` to build the project
+ 4. Run `./script/dev-cluster.sh` to launch a test cluster (feel free to read the script)
+ 5. Run `./script/dev-configure.sh` to configure your test cluster with default values (same datacenter, 100 tokens)
+ 6. Run `./script/dev-bucket.sh` to create a bucket named `eprouvette` and an API key that will be stored in `/tmp/garage.s3`
+ 7. Run `source ./script/dev-env.sh` to configure your CLI environment
+ 8. You can use `garage` to manage the cluster. Try `garage --help`.
+ 9. You can use `s3grg` to add, remove, and delete files. Try `s3grg --help`, `s3grg cp /proc/cpuinfo s3://eprouvette/cpuinfo.txt`, `s3grg ls s3://eprouvette`. `s3grg` is a wrapper on the `aws s3` subcommand configured with the previously generated API key (the one in `/tmp/garage.s3`).
Now you should be ready to start hacking on garage!