micropelago/garage
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request 'Changed all instances of 'key new' to 'key create' to make it the same as the bucket commands.' (#459) from jpds/garage:key-create-standardize into next

Browse Source 
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/459
This commit is contained in:
Alex 2023-01-04 10:35:49 +00:00
commit 80e4abb98d
8 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/book/connect/apps/index.md
View File

@ -36,7 +36,7 @@ Second, we suppose you have created a key and a bucket.
As a reminder, you can create a key for your nextcloud instance as follow: As a reminder, you can create a key for your nextcloud instance as follow:
```bash ```bash
garage key new --name nextcloud-key garage key create nextcloud-key
``` ```
Keep the Key ID and the Secret key in a pad, they will be needed later. Keep the Key ID and the Secret key in a pad, they will be needed later.
@ -138,7 +138,7 @@ a reasonable trade-off for some instances.
Create a key for Peertube: Create a key for Peertube:
```bash ```bash
garage key new --name peertube-key garage key create peertube-key
``` ```
Keep the Key ID and the Secret key in a pad, they will be needed later. Keep the Key ID and the Secret key in a pad, they will be needed later.
@ -252,7 +252,7 @@ As such, your Garage cluster should be configured appropriately for good perform
This is the usual Garage setup: This is the usual Garage setup:
```bash ```bash
garage key new --name mastodon-key garage key create mastodon-key
garage bucket create mastodon-data garage bucket create mastodon-data
garage bucket allow mastodon-data --read --write --key mastodon-key garage bucket allow mastodon-data --read --write --key mastodon-key
``` ```
@ -378,7 +378,7 @@ Supposing you have a working synapse installation, you can add the module with p
Now create a bucket and a key for your matrix instance (note your Key ID and Secret Key somewhere, they will be needed later): Now create a bucket and a key for your matrix instance (note your Key ID and Secret Key somewhere, they will be needed later):
```bash ```bash
garage key new --name matrix-key garage key create matrix-key
garage bucket create matrix garage bucket create matrix
garage bucket allow matrix --read --write --key matrix-key garage bucket allow matrix --read --write --key matrix-key
``` ```

2
doc/book/connect/backup.md
View File

@ -20,7 +20,7 @@ If you still want to use Borg, you can use it with `rclone mount`.
Create your key and bucket: Create your key and bucket:
```bash ```bash
garage key new my-key garage key create my-key
garage bucket create backup garage bucket create backup
garage bucket allow backup --read --write --key my-key garage bucket allow backup --read --write --key my-key
``` ```

4
doc/book/connect/repositories.md
View File

@ -23,7 +23,7 @@ You can configure a different target for each data type (check `[lfs]` and `[att
Let's start by creating a key and a bucket (your key id and secret will be needed later, keep them somewhere): Let's start by creating a key and a bucket (your key id and secret will be needed later, keep them somewhere):
```bash ```bash
garage key new --name gitea-key garage key create gitea-key
garage bucket create gitea garage bucket create gitea
garage bucket allow gitea --read --write --key gitea-key garage bucket allow gitea --read --write --key gitea-key
``` ```
@ -118,7 +118,7 @@ through another support, like a git repository.
As a first step, we will need to create a bucket on Garage and enabling website access on it: As a first step, we will need to create a bucket on Garage and enabling website access on it:
```bash ```bash
garage key new --name nix-key garage key create nix-key
garage bucket create nix.example.com garage bucket create nix.example.com
garage bucket allow nix.example.com --read --write --key nix-key garage bucket allow nix.example.com --read --write --key nix-key
garage bucket website nix.example.com --allow garage bucket website nix.example.com --allow

2
doc/book/quick-start/_index.md
View File

@ -206,7 +206,7 @@ one key can access multiple buckets, multiple keys can access one bucket.
Create an API key using the following command: Create an API key using the following command:
``` ```
garage key new --name nextcloud-app-key garage key create nextcloud-app-key
``` ```
The output should look as follows: The output should look as follows:

2
script/dev-bucket.sh
View File

@ -10,7 +10,7 @@ NIX_RELEASE="${REPO_FOLDER}/result/bin/"
PATH="${GARAGE_DEBUG}:${GARAGE_RELEASE}:${NIX_RELEASE}:$PATH" PATH="${GARAGE_DEBUG}:${GARAGE_RELEASE}:${NIX_RELEASE}:$PATH"
garage -c /tmp/config.1.toml bucket create eprouvette garage -c /tmp/config.1.toml bucket create eprouvette
KEY_INFO=$(garage -c /tmp/config.1.toml key new --name opérateur) KEY_INFO=$(garage -c /tmp/config.1.toml key create opérateur)
ACCESS_KEY=`echo $KEY_INFO|grep -Po 'GK[a-f0-9]+'` ACCESS_KEY=`echo $KEY_INFO|grep -Po 'GK[a-f0-9]+'`
SECRET_KEY=`echo $KEY_INFO|grep -Po 'Secret key: [a-f0-9]+'|grep -Po '[a-f0-9]+$'` SECRET_KEY=`echo $KEY_INFO|grep -Po 'Secret key: [a-f0-9]+'|grep -Po '[a-f0-9]+$'`
garage -c /tmp/config.1.toml bucket allow eprouvette --read --write --owner --key $ACCESS_KEY garage -c /tmp/config.1.toml bucket allow eprouvette --read --write --owner --key $ACCESS_KEY

2
src/garage/admin.rs
View File

@ -577,7 +577,7 @@ impl AdminRpcHandler {
match cmd { match cmd {
KeyOperation::List => self.handle_list_keys().await, KeyOperation::List => self.handle_list_keys().await,
KeyOperation::Info(query) => self.handle_key_info(query).await, KeyOperation::Info(query) => self.handle_key_info(query).await,
KeyOperation::New(query) => self.handle_create_key(query).await, KeyOperation::Create(query) => self.handle_create_key(query).await,
KeyOperation::Rename(query) => self.handle_rename_key(query).await, KeyOperation::Rename(query) => self.handle_rename_key(query).await,
KeyOperation::Delete(query) => self.handle_delete_key(query).await, KeyOperation::Delete(query) => self.handle_delete_key(query).await,
KeyOperation::Allow(query) => self.handle_allow_key(query).await, KeyOperation::Allow(query) => self.handle_allow_key(query).await,

6
src/garage/cli/structs.rs
View File

@ -331,8 +331,8 @@ pub enum KeyOperation {
Info(KeyOpt), Info(KeyOpt),
/// Create new key /// Create new key
#[structopt(name = "new", version = garage_version())] #[structopt(name = "create", version = garage_version())]
New(KeyNewOpt), Create(KeyNewOpt),
/// Rename key /// Rename key
#[structopt(name = "rename", version = garage_version())] #[structopt(name = "rename", version = garage_version())]
@ -364,7 +364,7 @@ pub struct KeyOpt {
#[derive(Serialize, Deserialize, StructOpt, Debug)] #[derive(Serialize, Deserialize, StructOpt, Debug)]
pub struct KeyNewOpt { pub struct KeyNewOpt {
/// Name of the key /// Name of the key
#[structopt(long = "name", default_value = "Unnamed key")] #[structopt(default_value = "Unnamed key")]
pub name: String, pub name: String,
} }

3
src/garage/tests/common/garage.rs
View File

@ -172,8 +172,7 @@ api_bind_addr = "127.0.0.1:{admin_port}"
let output = self let output = self
.command() .command()
.args(["key", "new"]) .args(["key", "create", name])
.args(["--name", name])
.expect_success_output("Could not create key"); .expect_success_output("Could not create key");
let stdout = String::from_utf8(output.stdout).unwrap(); let stdout = String::from_utf8(output.stdout).unwrap();