aboutsummaryrefslogtreecommitdiff
path: root/doc/book/src/development
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2021-03-18 10:39:55 +0100
committerAlex <alex@adnab.me>2021-03-18 10:39:55 +0100
commit5b659b28ce6bef15072d2fc93f777aa8ff73b2d8 (patch)
treee7ec9ec9dae459aeb6a99b35c537d46745053ec0 /doc/book/src/development
parent6a3dcf39740cda27e61b93582b6fea66991ec4f2 (diff)
parentea21c544343afeb37e96678089bcd535e64982a7 (diff)
downloadgarage-5b659b28ce6bef15072d2fc93f777aa8ff73b2d8.tar.gz
garage-5b659b28ce6bef15072d2fc93f777aa8ff73b2d8.zip
Merge pull request 'Add a `mdbook` documentation to present garage and help user on-boarding' (#45) from feature/mdbook into master
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/45
Diffstat (limited to 'doc/book/src/development')
-rw-r--r--doc/book/src/development/devenv.md17
-rw-r--r--doc/book/src/development/index.md4
2 files changed, 21 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..d6b5e38b
--- /dev/null
+++ b/doc/book/src/development/index.md
@@ -0,0 +1,4 @@
+# Development
+
+Now that you are a Garage expert, you want to enhance it, you are in the right place!
+We discuss here how to hack on Garage, how we manage its development, etc.