From 993f9d73b1275d59aef2fc9245b504e6196e6c14 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 20 Nov 2020 20:50:43 +0100 Subject: Quicker dev with more scripts --- README.md | 27 +++++++-------------------- 1 file changed, 7 insertions(+), 20 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f170f2ca..f9d33159 100644 --- a/README.md +++ b/README.md @@ -20,27 +20,14 @@ 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 + 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 `./example/dev-cluster.sh` to launch a test cluster (feel free to read the script) - 4. Set a convenient alias `alias grg=./target/debug/garage` - 5. Get your node IDs with `grg status` - 6. Configure them, eg. `grg node configure -d dc1 -n 10 dd79867e0f5a9e08` - 7. Create a bucket, eg. `grg bucket create éprouvette` - 8. Create a key, eg. `grg key new --name opérateur` - 9. Bind the key with the bucket, eg. `grg bucket allow éprouvette --read --write --key GK108acc0d179b13826e54442b` - 10. Install s3cmd, eg. `dnf install s3cmd` - 11. s3cmd example command: - -```bash -s3cmd \ - --host 127.0.0.1:3900 \ - --access_key=GK108acc0d179b13826e54442b \ - --secret_key=f52aac5722c48f038ddf8612d1e91e8d0a9535048f1f1cd402cd0416f9f8807f \ - --region=garage \ - --no-ssl \ - ls s3://éprouvette -``` + 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 API key stored in `/tmp/garage.s3` + 6. Run `source ./script/dev-env.sh` to configure your environment: + - `garage` to manage the cluster. Try `garage --help`. + - `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 previous API key (the one in `/tmp/garage.s3`). Now you should be ready to start hacking on garage! -- cgit v1.2.3 From c4bc2ce8cc4fe09cb10ca9d7a785333d58f3a1d0 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 20 Nov 2020 20:51:40 +0100 Subject: Fix tabs --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f9d33159..0177e2df 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,11 @@ We propose the following quickstart to setup a full dev. environment as quickly 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 API key stored in `/tmp/garage.s3` - 6. Run `source ./script/dev-env.sh` to configure your environment: - - `garage` to manage the cluster. Try `garage --help`. - - `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 previous API key (the one in `/tmp/garage.s3`). + 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 API key stored in `/tmp/garage.s3` + 6. Run `source ./script/dev-env.sh` to configure your environment: + - `garage` to manage the cluster. Try `garage --help`. + - `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 previous API key (the one in `/tmp/garage.s3`). Now you should be ready to start hacking on garage! -- cgit v1.2.3 From a8675aa65eda3b7cc708dbfb3eb52e4d300c8c2f Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 20 Nov 2020 20:57:44 +0100 Subject: Improve wording --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0177e2df..c5f4f10a 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,8 @@ We propose the following quickstart to setup a full dev. environment as quickly 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 API key stored in `/tmp/garage.s3` - 6. Run `source ./script/dev-env.sh` to configure your environment: + 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: - `garage` to manage the cluster. Try `garage --help`. - `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 previous API key (the one in `/tmp/garage.s3`). -- cgit v1.2.3 From c460359061f7dba8367051fd6159f1fa8239a7aa Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 20 Nov 2020 20:58:48 +0100 Subject: Sub list do not work with gitea --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c5f4f10a..85d9174d 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,9 @@ We propose the following quickstart to setup a full dev. environment as quickly 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: - - `garage` to manage the cluster. Try `garage --help`. - - `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 previous API key (the one 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 previous API key (the one in `/tmp/garage.s3`). Now you should be ready to start hacking on garage! -- cgit v1.2.3 From 165cef3785862a622c5b4bc027ba16527970a814 Mon Sep 17 00:00:00 2001 From: Quentin Date: Fri, 20 Nov 2020 20:59:33 +0100 Subject: Fix wording again! --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 85d9174d..10dcc0cd 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ We propose the following quickstart to setup a full dev. environment as quickly 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 previous API key (the one in `/tmp/garage.s3`). + 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`). Now you should be ready to start hacking on garage! -- cgit v1.2.3