aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/development
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2021-03-17 16:15:18 +0100
committerQuentin Dufour <quentin@deuxfleurs.fr>2021-03-17 16:15:18 +0100
commit002538f92c1d9f95f2d699337f7d891c6aa0c9a4 (patch)
tree054aac5ce5e637c7baf3d15238c8c0c1ed8e97f4 /doc/book/src/development
parentc50113acf3fd61dcb77bc01bd6e9f226f813bf76 (diff)
downloadgarage-002538f92c1d9f95f2d699337f7d891c6aa0c9a4.tar.gz
garage-002538f92c1d9f95f2d699337f7d891c6aa0c9a4.zip
Refactor file organization
Diffstat (limited to 'doc/book/src/development')
-rw-r--r--doc/book/src/development/devenv.md17
-rw-r--r--doc/book/src/development/index.md1
2 files changed, 18 insertions, 0 deletions
diff --git a/doc/book/src/development/devenv.md b/doc/book/src/development/devenv.md
new file mode 100644
index 00000000..6cb7c554
--- /dev/null
+++ b/doc/book/src/development/devenv.md
@@ -0,0 +1,17 @@
+# Setup your development environment
+
+We propose the following quickstart to setup a full dev. environment as quickly as possible:
+
+ 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-aws.sh` to configure your CLI environment
+ 8. You can use `garage` to manage the cluster. Try `garage --help`.
+ 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/doc/book/src/development/index.md b/doc/book/src/development/index.md
new file mode 100644
index 00000000..459110d3
--- /dev/null
+++ b/doc/book/src/development/index.md
@@ -0,0 +1 @@
+# Development