Deuxfleurs/garage
44
56
Fork 74
Code Issues 100 Pull requests 14 Releases 30 Wiki Activity

Support website publishing #7

Merged
lx merged 61 commits from feature/website into master 2021-01-15 16:49:51 +00:00
Conversation 3 Commits 61 Files changed 17 +11 -10
2 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 54c3a023f0 - Show all commits

17
README.md
View file

@ -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: 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` 1. Setup a rust/cargo environment. eg. `dnf install rust cargo`
2. Run `cargo build` to build the project 2. Install awscli v2 by following the guide [here](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html).
3. Run `./script/dev-cluster.sh` to launch a test cluster (feel free to read the script) 3. Run `cargo build` to build the project
4. Run `./script/dev-configure.sh` to configure your test cluster with default values (same datacenter, 100 tokens) 4. Run `./script/dev-cluster.sh` to launch a test cluster (feel free to read the script)
5. Run `./script/dev-bucket.sh` to create a bucket named `eprouvette` and an API key that will be stored in `/tmp/garage.s3` 5. Run `./script/dev-configure.sh` to configure your test cluster with default values (same datacenter, 100 tokens)
6. Run `source ./script/dev-env.sh` to configure your CLI environment 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. You can use `garage` to manage the cluster. Try `garage --help`. 7. Run `source ./script/dev-env.sh` to configure your CLI environment
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`). 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! Now you should be ready to start hacking on garage!

4
script/test-smoke.sh
View file

@ -15,8 +15,8 @@ source ${SCRIPT_FOLDER}/dev-env.sh
dd if=/dev/urandom of=/tmp/garage.rnd bs=1M count=10 dd if=/dev/urandom of=/tmp/garage.rnd bs=1M count=10
s3grg put /tmp/garage.rnd s3://eprouvette/ s3grg cp /tmp/garage.rnd s3://eprouvette/
s3grg ls s3://eprouvette s3grg ls s3://eprouvette
s3grg get s3://eprouvette/garage.rnd /tmp/garage.dl s3grg cp s3://eprouvette/garage.rnd /tmp/garage.dl
diff /tmp/garage.rnd /tmp/garage.dl diff /tmp/garage.rnd /tmp/garage.dl