From 132c54b8077422b611d6cf130592f32194ab53cd Mon Sep 17 00:00:00 2001 From: Quentin Date: Sat, 5 Dec 2020 18:27:51 +0100 Subject: [PATCH 1/7] wip smoke test --- script/dev-env.sh | 16 ++++++---------- script/test-smoke.sh | 5 +++-- 2 files changed, 9 insertions(+), 12 deletions(-) mode change 100755 => 100644 script/dev-env.sh diff --git a/script/dev-env.sh b/script/dev-env.sh old mode 100755 new mode 100644 index 88d2941f..4c52568a --- a/script/dev-env.sh +++ b/script/dev-env.sh @@ -6,14 +6,10 @@ GARAGE_DEBUG="${REPO_FOLDER}/target/debug/" GARAGE_RELEASE="${REPO_FOLDER}/target/release/" PATH="${GARAGE_DEBUG}:${GARAGE_RELEASE}:$PATH" -ACCESS_KEY=`cat /tmp/garage.s3 |cut -d' ' -f1` -SECRET_KEY=`cat /tmp/garage.s3 |cut -d' ' -f2` - -alias s3grg="s3cmd \ - --host 127.0.0.1:3911 \ - --host-bucket 127.0.0.1:3911 \ - --access_key=$ACCESS_KEY \ - --secret_key=$SECRET_KEY \ - --region=garage \ - --no-ssl" +export AWS_ACCESS_KEY_ID=`cat /tmp/garage.s3 |cut -d' ' -f1` +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 7b462b00..800836b0 100755 --- a/script/test-smoke.sh +++ b/script/test-smoke.sh @@ -15,8 +15,9 @@ source ${SCRIPT_FOLDER}/dev-env.sh 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 get s3://eprouvette/garage.rnd /tmp/garage.dl +s3grg cp s3://eprouvette/garage.rnd /tmp/garage.dl diff /tmp/garage.rnd /tmp/garage.dl +echo "success" From 28055b708fd27ed7407193eacdd5294b1192b067 Mon Sep 17 00:00:00 2001 From: Quentin Date: Sun, 6 Dec 2020 09:13:47 +0100 Subject: [PATCH 2/7] Improve README, add more tests --- README.md | 23 +++++++++++++++-------- script/dev-env.sh | 1 - script/test-smoke.sh | 14 +++++++++----- 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" From 5c3dd9c74a27f82e4ba7f545ae23e3ba614f5d9b Mon Sep 17 00:00:00 2001 From: Quentin Date: Sun, 6 Dec 2020 09:54:11 +0100 Subject: [PATCH 3/7] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e955f1a..1f5a56b1 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ 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. +Bucket management, ACL and other advanced features are not (yet?) handled through the S3 API but through the `garage` CLI. We primarily test `garage` against the `awscli` tool and `nextcloud`. ## Setting up Garage From a12930075dd33c7c18d6ad1afa4000efe55d10d6 Mon Sep 17 00:00:00 2001 From: Quentin Date: Sun, 6 Dec 2020 10:04:17 +0100 Subject: [PATCH 4/7] Test garage list & delete commands --- script/test-smoke.sh | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/script/test-smoke.sh b/script/test-smoke.sh index eaf1556b..3a84b992 100755 --- a/script/test-smoke.sh +++ b/script/test-smoke.sh @@ -13,6 +13,10 @@ ${SCRIPT_FOLDER}/dev-configure.sh ${SCRIPT_FOLDER}/dev-bucket.sh source ${SCRIPT_FOLDER}/dev-env.sh +garage status +garage key list +garage bucket list + 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 @@ -22,6 +26,11 @@ for idx in $(seq 1 3); do s3grg ls s3://eprouvette s3grg cp s3://eprouvette/garage.$idx.rnd /tmp/garage.$idx.dl diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl + s3grg rm s3://eprouvette/garage.$idx.rnd done +garage bucket deny --read --write eprouvette --key $AWS_ACCESS_KEY_ID +garage bucket delete --yes eprouvette +garage key delete --yes $AWS_ACCESS_KEY_ID + echo "success" From d2d1fc676d0fe5b6fe927e4b6f6d2c162581971d Mon Sep 17 00:00:00 2001 From: Quentin Date: Sun, 6 Dec 2020 10:19:01 +0100 Subject: [PATCH 5/7] Test awscli/s3cmd interactions --- README.md | 4 ++-- script/{dev-env.sh => dev-env-aws.sh} | 2 +- script/dev-env-s3cmd.sh | 19 +++++++++++++++++++ script/test-smoke.sh | 26 +++++++++++++++++++++----- 4 files changed, 43 insertions(+), 8 deletions(-) rename script/{dev-env.sh => dev-env-aws.sh} (95%) create mode 100644 script/dev-env-s3cmd.sh diff --git a/README.md b/README.md index 1f5a56b1..8a6363ff 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,9 @@ We propose the following quickstart to setup a full dev. environment as quickly 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 + 7. Run `source ./script/dev-env-aws.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. + 9. You can use the `awsgrg` alias to add, remove, and delete files. Try `awsgrg help`, `awsgrg cp /proc/cpuinfo s3://eprouvette/cpuinfo.txt`, or `awsgrg ls s3://eprouvette`. `awsgrg` 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! diff --git a/script/dev-env.sh b/script/dev-env-aws.sh similarity index 95% rename from script/dev-env.sh rename to script/dev-env-aws.sh index 15f08e2e..c9a57660 100644 --- a/script/dev-env.sh +++ b/script/dev-env-aws.sh @@ -10,5 +10,5 @@ export AWS_ACCESS_KEY_ID=`cat /tmp/garage.s3 |cut -d' ' -f1` export AWS_SECRET_ACCESS_KEY=`cat /tmp/garage.s3 |cut -d' ' -f2` export AWS_DEFAULT_REGION='garage' -alias s3grg="aws s3 \ +alias awsgrg="aws s3 \ --endpoint-url http://127.0.0.1:3911" diff --git a/script/dev-env-s3cmd.sh b/script/dev-env-s3cmd.sh new file mode 100644 index 00000000..88d2941f --- /dev/null +++ b/script/dev-env-s3cmd.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +SCRIPT_FOLDER="`dirname \"${BASH_SOURCE[0]}\"`" +REPO_FOLDER="${SCRIPT_FOLDER}/../" +GARAGE_DEBUG="${REPO_FOLDER}/target/debug/" +GARAGE_RELEASE="${REPO_FOLDER}/target/release/" +PATH="${GARAGE_DEBUG}:${GARAGE_RELEASE}:$PATH" + +ACCESS_KEY=`cat /tmp/garage.s3 |cut -d' ' -f1` +SECRET_KEY=`cat /tmp/garage.s3 |cut -d' ' -f2` + +alias s3grg="s3cmd \ + --host 127.0.0.1:3911 \ + --host-bucket 127.0.0.1:3911 \ + --access_key=$ACCESS_KEY \ + --secret_key=$SECRET_KEY \ + --region=garage \ + --no-ssl" + diff --git a/script/test-smoke.sh b/script/test-smoke.sh index 3a84b992..8a30429d 100755 --- a/script/test-smoke.sh +++ b/script/test-smoke.sh @@ -11,7 +11,8 @@ ${SCRIPT_FOLDER}/dev-clean.sh ${SCRIPT_FOLDER}/dev-cluster.sh > /tmp/garage.log 2>&1 & ${SCRIPT_FOLDER}/dev-configure.sh ${SCRIPT_FOLDER}/dev-bucket.sh -source ${SCRIPT_FOLDER}/dev-env.sh +source ${SCRIPT_FOLDER}/dev-env-aws.sh +source ${SCRIPT_FOLDER}/dev-env-s3cmd.sh garage status garage key list @@ -22,12 +23,27 @@ 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 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 + awsgrg cp /tmp/garage.$idx.rnd s3://eprouvette/garage.$idx.aws + awsgrg ls s3://eprouvette + awsgrg cp s3://eprouvette/garage.$idx.aws /tmp/garage.$idx.dl diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl - s3grg rm s3://eprouvette/garage.$idx.rnd + rm /tmp/garage.$idx.dl + s3grg get s3://eprouvette/garage.$idx.aws /tmp/garage.$idx.dl + diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl + rm /tmp/garage.$idx.dl + awsgrg rm s3://eprouvette/garage.$idx.aws + + s3grg put /tmp/garage.$idx.rnd s3://eprouvette/garage.$idx.s3cmd + s3grg ls s3://eprouvette + s3grg get s3://eprouvette/garage.$idx.s3cmd /tmp/garage.$idx.dl + diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl + rm /tmp/garage.$idx.dl + awsgrg cp s3://eprouvette/garage.$idx.s3cmd /tmp/garage.$idx.dl + diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl + rm /tmp/garage.$idx.dl + s3grg rm s3://eprouvette/garage.$idx.s3cmd done +rm /tmp/garage.{1,2,3}.rnd garage bucket deny --read --write eprouvette --key $AWS_ACCESS_KEY_ID garage bucket delete --yes eprouvette From a92868504f611adb6966a89602a72ae022222116 Mon Sep 17 00:00:00 2001 From: Quentin Date: Sun, 6 Dec 2020 10:23:14 +0100 Subject: [PATCH 6/7] Indentation & comments --- script/test-smoke.sh | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/script/test-smoke.sh b/script/test-smoke.sh index 8a30429d..9b1ca977 100755 --- a/script/test-smoke.sh +++ b/script/test-smoke.sh @@ -23,25 +23,35 @@ 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 for idx in $(seq 1 3); do + # AWS sends awsgrg cp /tmp/garage.$idx.rnd s3://eprouvette/garage.$idx.aws + awsgrg ls s3://eprouvette + awsgrg cp s3://eprouvette/garage.$idx.aws /tmp/garage.$idx.dl diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl - rm /tmp/garage.$idx.dl - s3grg get s3://eprouvette/garage.$idx.aws /tmp/garage.$idx.dl + rm /tmp/garage.$idx.dl + + s3grg get s3://eprouvette/garage.$idx.aws /tmp/garage.$idx.dl diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl - rm /tmp/garage.$idx.dl + rm /tmp/garage.$idx.dl + awsgrg rm s3://eprouvette/garage.$idx.aws - s3grg put /tmp/garage.$idx.rnd s3://eprouvette/garage.$idx.s3cmd - s3grg ls s3://eprouvette - s3grg get s3://eprouvette/garage.$idx.s3cmd /tmp/garage.$idx.dl + # S3CMD sends + s3grg put /tmp/garage.$idx.rnd s3://eprouvette/garage.$idx.s3cmd + + s3grg ls s3://eprouvette + + s3grg get s3://eprouvette/garage.$idx.s3cmd /tmp/garage.$idx.dl diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl - rm /tmp/garage.$idx.dl + rm /tmp/garage.$idx.dl + awsgrg cp s3://eprouvette/garage.$idx.s3cmd /tmp/garage.$idx.dl diff /tmp/garage.$idx.rnd /tmp/garage.$idx.dl - rm /tmp/garage.$idx.dl - s3grg rm s3://eprouvette/garage.$idx.s3cmd + rm /tmp/garage.$idx.dl + + s3grg rm s3://eprouvette/garage.$idx.s3cmd done rm /tmp/garage.{1,2,3}.rnd From e13fd0954395836cd99e7deaeca7d0b7050802ee Mon Sep 17 00:00:00 2001 From: Quentin Date: Sun, 6 Dec 2020 13:33:08 +0100 Subject: [PATCH 7/7] Reduce garage.1.rnd size to store it inline --- script/test-smoke.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/test-smoke.sh b/script/test-smoke.sh index 9b1ca977..111afac9 100755 --- a/script/test-smoke.sh +++ b/script/test-smoke.sh @@ -18,7 +18,7 @@ garage status garage key list garage bucket list -dd if=/dev/urandom of=/tmp/garage.1.rnd bs=512k count=1 +dd if=/dev/urandom of=/tmp/garage.1.rnd bs=1k count=2 # < INLINE_THRESHOLD = 3072 bytes 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