diff options
author | Alex Auvolat <alex@adnab.me> | 2021-05-28 18:00:59 +0200 |
---|---|---|
committer | Alex Auvolat <alex@adnab.me> | 2021-05-28 18:00:59 +0200 |
commit | ebd21b325e7c30b58d6b3ab621f08cd1bffb0c6d (patch) | |
tree | 7b99578b1157082c478f8378b512f1a601a8d26b /doc/book/src/getting_started/06_bucket.md | |
parent | b9127dd6f88d3c66181ef6748167efd94283ff41 (diff) | |
download | garage-ebd21b325e7c30b58d6b3ab621f08cd1bffb0c6d.tar.gz garage-ebd21b325e7c30b58d6b3ab621f08cd1bffb0c6d.zip |
Write documentation on configuration file and other improvements
Diffstat (limited to 'doc/book/src/getting_started/06_bucket.md')
-rw-r--r-- | doc/book/src/getting_started/06_bucket.md | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/book/src/getting_started/06_bucket.md b/doc/book/src/getting_started/06_bucket.md new file mode 100644 index 00000000..b4a2d81d --- /dev/null +++ b/doc/book/src/getting_started/06_bucket.md @@ -0,0 +1,74 @@ +# Create buckets and keys + +*We use a command named `garagectl` which is in fact an alias you must define as explained in the [Control the daemon](./daemon.md) section.* + +In this section, we will suppose that we want to create a bucket named `nextcloud-bucket` +that will be accessed through a key named `nextcloud-app-key`. + +Don't forget that `help` command and `--help` subcommands can help you anywhere, the CLI tool is self-documented! Two examples: + +``` +garagectl help +garagectl bucket allow --help +``` + +## Create a bucket + +Fine, now let's create a bucket (we imagine that you want to deploy nextcloud): + +``` +garagectl bucket create nextcloud-bucket +``` + +Check that everything went well: + +``` +garagectl bucket list +garagectl bucket info nextcloud-bucket +``` + +## Create an API key + +Now we will generate an API key to access this bucket. +Note that API keys are independent of buckets: one key can access multiple buckets, multiple keys can access one bucket. + +Now, let's start by creating a key only for our PHP application: + +``` +garagectl key new --name nextcloud-app-key +``` + +You will have the following output (this one is fake, `key_id` and `secret_key` were generated with the openssl CLI tool): + +``` +Key name: nextcloud-app-key +Key ID: GK3515373e4c851ebaad366558 +Secret key: 7d37d093435a41f2aab8f13c19ba067d9776c90215f56614adad6ece597dbb34 +Authorized buckets: +``` + +Check that everything works as intended: + +``` +garagectl key list +garagectl key info nextcloud-app-key +``` + +## Allow a key to access a bucket + +Now that we have a bucket and a key, we need to give permissions to the key on the bucket! + +``` +garagectl bucket allow \ + --read \ + --write + nextcloud-bucket \ + --key nextcloud-app-key +``` + +You can check at any times allowed keys on your bucket with: + +``` +garagectl bucket info nextcloud-bucket +``` + |