aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQuentin <quentin@deuxfleurs.fr>2020-12-06 09:13:47 +0100
committerQuentin <quentin@deuxfleurs.fr>2020-12-06 09:13:47 +0100
commit28055b708fd27ed7407193eacdd5294b1192b067 (patch)
treeb8c623de381b1d7e01b8789649aae2b93b1310ed
parent132c54b8077422b611d6cf130592f32194ab53cd (diff)
downloadgarage-28055b708fd27ed7407193eacdd5294b1192b067.tar.gz
garage-28055b708fd27ed7407193eacdd5294b1192b067.zip
Improve README, add more tests
-rw-r--r--README.md23
-rw-r--r--script/dev-env.sh1
-rwxr-xr-xscript/test-smoke.sh14
3 files changed, 24 insertions, 14 deletions
diff --git a/README.md b/README.md
index 10dcc0cd..5e955f1a 100644
--- a/README.md
+++ b/README.md
@@ -20,17 +20,24 @@ 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 s3cmd. eg. `dnf install rust cargo s3cmd`
- 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 `éprouvette` 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 put /proc/cpuinfo s3://éprouvette/cpuinfo.txt`, `s3grg ls s3://éprouvette`. `s3grg` is a wrapper on `s3cmd` 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 the `s3grg` alias to add, remove, and delete files. Try `s3grg help`, `s3grg cp /proc/cpuinfo s3://eprouvette/cpuinfo.txt`, or `s3grg ls s3://eprouvette`. `s3grg` is a wrapper on the `aws s3` command pre-configured with the previously generated API key (the one in `/tmp/garage.s3`) and localhost as the endpoint.
Now you should be ready to start hacking on garage!
+## S3 compatibility
+
+Only a subset of S3 is supported: adding, listing, getting and deleting files in a bucket.
+Bucket management, ACL and other advanced features are not (yet?) handled through the S3 API but through `garage` CLI.
+We primarily test `garage` against the `awscli` tool and `nextcloud`.
+
## Setting up Garage
Use the `genkeys.sh` script to generate TLS keys for encrypting communications between Garage nodes.
diff --git a/script/dev-env.sh b/script/dev-env.sh
index 4c52568a..15f08e2e 100644
--- a/script/dev-env.sh
+++ b/script/dev-env.sh
@@ -11,5 +11,4 @@ export AWS_SECRET_ACCESS_KEY=`cat /tmp/garage.s3 |cut -d' ' -f2`
export AWS_DEFAULT_REGION='garage'
alias s3grg="aws s3 \
- --debug \
--endpoint-url http://127.0.0.1:3911"
diff --git a/script/test-smoke.sh b/script/test-smoke.sh
index 800836b0..eaf1556b 100755
--- a/script/test-smoke.sh
+++ b/script/test-smoke.sh
@@ -13,11 +13,15 @@ ${SCRIPT_FOLDER}/dev-configure.sh
${SCRIPT_FOLDER}/dev-bucket.sh
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.1.rnd bs=512k count=1
+dd if=/dev/urandom of=/tmp/garage.2.rnd bs=1M count=5
+dd if=/dev/urandom of=/tmp/garage.3.rnd bs=1M count=10
-s3grg cp /tmp/garage.rnd s3://eprouvette/
-s3grg ls s3://eprouvette
-s3grg cp s3://eprouvette/garage.rnd /tmp/garage.dl
+for idx in $(seq 1 3); do
+ s3grg cp /tmp/garage.$idx.rnd s3://eprouvette/
+ s3grg ls s3://eprouvette
+ s3grg cp s3://eprouvette/garage.$idx.rnd /tmp/garage.$idx.dl
+ diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl
+done
-diff /tmp/garage.rnd /tmp/garage.dl
echo "success"