doc: quick-start: rework flag description (#1496)

Add a link to the manual install procedure, use a
quote to make the manual install path more visible
and mention the --default-access-key option.

Closes: #1446

Rendered output:

![image](/attachments/84bbe650-daff-40d1-b4bd-629abece27b0)

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1496

doc/api/garage-admin-v2.json

@@ -12,7 +12,7 @@
       "name": "AGPL-3.0",
       "identifier": "AGPL-3.0"
     },
-    "version": "v2.4.0"
+    "version": "v2.3.0"
   },
   "servers": [
     {
@@ -1243,36 +1243,6 @@
         ],
         "description": "List all the buckets on the cluster with their UUID and their global and local aliases.",
         "operationId": "ListBuckets",
-        "parameters": [
-          {
-            "name": "details",
-            "in": "query",
-            "description": "Returned detailed informations in the same format as GetBucketInfo for each bucket",
-            "required": false,
-            "schema": {
-              "type": "boolean"
-            }
-          },
-          {
-            "name": "offset",
-            "in": "query",
-            "description": "Bucket ID of the first bucket to return",
-            "required": false,
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "limit",
-            "in": "query",
-            "description": "Maximum number of buckets to return in a single call",
-            "required": false,
-            "schema": {
-              "type": "integer",
-              "minimum": 0
-            }
-          }
-        ],
         "responses": {
           "200": {
             "description": "Returns the UUID of all the buckets and all their aliases",
@@ -1297,36 +1267,6 @@
         ],
         "description": "Returns all API access keys in the cluster.",
         "operationId": "ListKeys",
-        "parameters": [
-          {
-            "name": "details",
-            "in": "query",
-            "description": "Returned detailed informations in the same format as GetKeyInfo for each bucket",
-            "required": false,
-            "schema": {
-              "type": "boolean"
-            }
-          },
-          {
-            "name": "offset",
-            "in": "query",
-            "description": "Key ID of the first key to return",
-            "required": false,
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "limit",
-            "in": "query",
-            "description": "Maximum number of keys to return in a single call",
-            "required": false,
-            "schema": {
-              "type": "integer",
-              "minimum": 0
-            }
-          }
-        ],
         "responses": {
           "200": {
             "description": "Returns the key identifier (aka `AWS_ACCESS_KEY_ID`) and its associated, human friendly, name if any (otherwise return an empty string)",
@@ -3260,20 +3200,10 @@
         }
       },
       "ListBucketsResponse": {
-        "oneOf": [
+        "type": "array",
-          {
+        "items": {
-            "type": "array",
+          "$ref": "#/components/schemas/ListBucketsResponseItem"
-            "items": {
+        }
-              "$ref": "#/components/schemas/ListBucketsResponseItem"
-            }
-          },
-          {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/GetBucketInfoResponse"
-            }
-          }
-        ]
       },
       "ListBucketsResponseItem": {
         "type": "object",
@@ -3306,20 +3236,10 @@
         }
       },
       "ListKeysResponse": {
-        "oneOf": [
+        "type": "array",
-          {
+        "items": {
-            "type": "array",
+          "$ref": "#/components/schemas/ListKeysResponseItem"
-            "items": {
+        }
-              "$ref": "#/components/schemas/ListKeysResponseItem"
-            }
-          },
-          {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/GetKeyInfoResponse"
-            }
-          }
-        ]
       },
       "ListKeysResponseItem": {
         "type": "object",
@@ -3401,35 +3321,10 @@
           "dbEngine"
         ],
         "properties": {
-          "addr": {
-            "type": [
-              "string",
-              "null"
-            ],
-            "description": "Socket address used by other nodes to connect to this node for RPC"
-          },
-          "dataPartition": {
-            "oneOf": [
-              {
-                "type": "null"
-              },
-              {
-                "$ref": "#/components/schemas/FreeSpaceResp",
-                "description": "Total and available space on the disk partition(s) containing the data\ndirectory(ies)"
-              }
-            ]
-          },
           "dbEngine": {
             "type": "string",
             "description": "database engine used for metadata"
           },
-          "draining": {
-            "type": [
-              "boolean",
-              "null"
-            ],
-            "description": "Whether this node is part of an older layout version and is draining data."
-          },
           "garageFeatures": {
             "type": [
               "array",
@@ -3451,38 +3346,9 @@
             ],
             "description": "hostname of this node"
           },
-          "isUp": {
-            "type": [
-              "boolean",
-              "null"
-            ],
-            "description": "Whether this node is connected in the cluster"
-          },
-          "metadataPartition": {
-            "oneOf": [
-              {
-                "type": "null"
-              },
-              {
-                "$ref": "#/components/schemas/FreeSpaceResp",
-                "description": "Total and available space on the disk partition containing the\nmetadata directory"
-              }
-            ]
-          },
           "nodeId": {
             "type": "string"
           },
-          "role": {
-            "oneOf": [
-              {
-                "type": "null"
-              },
-              {
-                "$ref": "#/components/schemas/NodeAssignedRole",
-                "description": "Role assigned to this node in the current cluster layout"
-              }
-            ]
-          },
           "rustVersion": {
             "type": "string",
             "description": "rustc version with which this garage release was compiled"
@@ -3818,35 +3684,10 @@
                 "dbEngine"
               ],
               "properties": {
-                "addr": {
-                  "type": [
-                    "string",
-                    "null"
-                  ],
-                  "description": "Socket address used by other nodes to connect to this node for RPC"
-                },
-                "dataPartition": {
-                  "oneOf": [
-                    {
-                      "type": "null"
-                    },
-                    {
-                      "$ref": "#/components/schemas/FreeSpaceResp",
-                      "description": "Total and available space on the disk partition(s) containing the data\ndirectory(ies)"
-                    }
-                  ]
-                },
                 "dbEngine": {
                   "type": "string",
                   "description": "database engine used for metadata"
                 },
-                "draining": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ],
-                  "description": "Whether this node is part of an older layout version and is draining data."
-                },
                 "garageFeatures": {
                   "type": [
                     "array",
@@ -3868,38 +3709,9 @@
                   ],
                   "description": "hostname of this node"
                 },
-                "isUp": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ],
-                  "description": "Whether this node is connected in the cluster"
-                },
-                "metadataPartition": {
-                  "oneOf": [
-                    {
-                      "type": "null"
-                    },
-                    {
-                      "$ref": "#/components/schemas/FreeSpaceResp",
-                      "description": "Total and available space on the disk partition containing the\nmetadata directory"
-                    }
-                  ]
-                },
                 "nodeId": {
                   "type": "string"
                 },
-                "role": {
-                  "oneOf": [
-                    {
-                      "type": "null"
-                    },
-                    {
-                      "$ref": "#/components/schemas/NodeAssignedRole",
-                      "description": "Role assigned to this node in the current cluster layout"
-                    }
-                  ]
-                },
                 "rustVersion": {
                   "type": "string",
                   "description": "rustc version with which this garage release was compiled"

doc/book/quick-start/_index.md

@@ -133,12 +133,17 @@ Use the following command to launch the Garage server:
 garage server --single-node --default-bucket
 ```
 
-The `--single-node` flag instructs Garage to automatically configure a single-node cluster without data replication.
+- the `--single-node` flag instructs Garage to automatically configure a
-The `--default-bucket` flag instructs Garage to create a default access key and a default bucket using the environment variables we defined above.
+  single-node cluster without data replication;
-Both flags are optional and can be omitted, in which case you will have to follow manual configuration steps described below.
+- the `--default-bucket` flag instructs Garage to create a default access key
+  and a default bucket using the environment variables we defined above (it
+  implies `--default-access-key`).
 
-**For older versions of Garage (before v2.3.0):** automatic configuration using `--single-node` and `--default-bucket` is not available,
+> You can refer to the [manual configuration
-you must follow the manual configuration steps.
+> steps](#manual-configuration) if:
+>
+> - you decide to no use these optional flags;
+> - you are running an **older version of Garage (before v2.3.0)**.
 
 Alternatively, if you cannot or do not wish to run the Garage binary directly,
 you may use Docker to run Garage in a container using the following command:
@@ -292,7 +297,7 @@ An exhaustive list is maintained in the ["Integrations" > "Browsing tools" secti
 
 
 
-## Manual configuration
+## Manual configuration {#manual-configuration}
 
 This section provides instructions that are equivalent to using the
 `--single-node` and `--default-bucket` flags for automatic configuration.  If

script/dev-bucket.sh

@@ -18,7 +18,7 @@ fi
 
 $GARAGE_BIN -c /tmp/config.1.toml bucket create eprouvette
 if [ "$GARAGE_OLDVER" = "v08" ]; then
-	KEY_INFO=$($GARAGE_BIN -c /tmp/config.1.toml key create opérateur)
+	KEY_INFO=$($GARAGE_BIN -c /tmp/config.1.toml key new --name opérateur)
 	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]+$'`
 elif [ "$GARAGE_OLDVER" = "v1" ]; then

src/api/admin/api.rs

@@ -688,26 +688,11 @@ pub struct ClusterLayoutSkipDeadNodesResponse {
 
 // ---- ListKeys ----
 
-#[derive(Debug, Clone, Serialize, Deserialize, Default, IntoParams)]
+#[derive(Debug, Clone, Serialize, Deserialize)]
-#[into_params(parameter_in = Query)]
+pub struct ListKeysRequest;
-pub struct ListKeysRequest {
-	/// Returned detailed informations in the same format as GetKeyInfo for each bucket
-	#[serde(default)]
-	pub details: bool,
-	/// Key ID of the first key to return
-	#[serde(default)]
-	pub offset: Option<String>,
-	/// Maximum number of keys to return in a single call
-	#[serde(default)]
-	pub limit: Option<usize>,
-}
 
 #[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
-#[serde(untagged)]
+pub struct ListKeysResponse(pub Vec<ListKeysResponseItem>);
-pub enum ListKeysResponse {
-	WithoutDetails(Vec<ListKeysResponseItem>),
-	WithDetails(Vec<GetKeyInfoResponse>),
-}
 
 #[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
 #[serde(rename_all = "camelCase")]
@@ -845,26 +830,11 @@ pub struct DeleteKeyResponse;
 
 // ---- ListBuckets ----
 
-#[derive(Debug, Clone, Serialize, Deserialize, Default, IntoParams)]
+#[derive(Debug, Clone, Serialize, Deserialize)]
-#[into_params(parameter_in = Query)]
+pub struct ListBucketsRequest;
-pub struct ListBucketsRequest {
-	/// Returned detailed informations in the same format as GetBucketInfo for each bucket
-	#[serde(default)]
-	pub details: bool,
-	/// Bucket ID of the first bucket to return
-	#[serde(default)]
-	pub offset: Option<String>,
-	/// Maximum number of buckets to return in a single call
-	#[serde(default)]
-	pub limit: Option<usize>,
-}
 
 #[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
-#[serde(untagged)]
+pub struct ListBucketsResponse(pub Vec<ListBucketsResponseItem>);
-pub enum ListBucketsResponse {
-	WithoutDetails(Vec<ListBucketsResponseItem>),
-	WithDetails(Vec<GetBucketInfoResponse>),
-}
 
 #[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
 #[serde(rename_all = "camelCase")]

src/api/admin/bucket.rs

@@ -3,7 +3,6 @@ use std::sync::Arc;
 use std::time::Duration;
 
 use chrono::DateTime;
-use futures::StreamExt;
 
 use garage_util::crdt::*;
 use garage_util::data::*;
@@ -33,70 +32,47 @@ impl RequestHandler for ListBucketsRequest {
 		garage: &Arc<Garage>,
 		_admin: &Admin,
 	) -> Result<ListBucketsResponse, Error> {
-		let limit = self
-			.limit
-			.unwrap_or_else(|| if self.details { 1000 } else { 10_000 });
-
-		let offset = match self.offset {
-			Some(id) => Some(parse_bucket_id(&id)?),
-			None => None,
-		};
-
 		let buckets = garage
 			.bucket_table
 			.get_range(
 				&EmptyKey,
-				offset,
+				None,
 				Some(DeletedFilter::NotDeleted),
-				limit,
+				1_000_000,
 				EnumerationOrder::Forward,
 			)
 			.await?;
 
-		if self.details {
+		let res = buckets
-			let mut stream = buckets
+			.into_iter()
-				.into_iter()
+			.map(|b| {
-				.map(|b| bucket_info_results(garage, b.id))
+				let state = b.state.as_option().unwrap();
-				.collect::<futures::stream::FuturesOrdered<_>>();
+				ListBucketsResponseItem {
+					id: hex::encode(b.id),
+					created: DateTime::from_timestamp_millis(state.creation_date as i64)
+						.expect("invalid timestamp stored in db"),
+					global_aliases: state
+						.aliases
+						.items()
+						.iter()
+						.filter(|(_, _, a)| *a)
+						.map(|(n, _, _)| n.to_string())
+						.collect::<Vec<_>>(),
+					local_aliases: state
+						.local_aliases
+						.items()
+						.iter()
+						.filter(|(_, _, a)| *a)
+						.map(|((k, n), _, _)| BucketLocalAlias {
+							access_key_id: k.to_string(),
+							alias: n.to_string(),
+						})
+						.collect::<Vec<_>>(),
+				}
+			})
+			.collect::<Vec<_>>();
 
-			let mut res = vec![];
+		Ok(ListBucketsResponse(res))
-			while let Some(next) = stream.next().await {
-				res.push(next?);
-			}
-
-			Ok(ListBucketsResponse::WithDetails(res))
-		} else {
-			let res = buckets
-				.into_iter()
-				.map(|b| {
-					let state = b.state.as_option().unwrap();
-					ListBucketsResponseItem {
-						id: hex::encode(b.id),
-						created: DateTime::from_timestamp_millis(state.creation_date as i64)
-							.expect("invalid timestamp stored in db"),
-						global_aliases: state
-							.aliases
-							.items()
-							.iter()
-							.filter(|(_, _, a)| *a)
-							.map(|(n, _, _)| n.to_string())
-							.collect::<Vec<_>>(),
-						local_aliases: state
-							.local_aliases
-							.items()
-							.iter()
-							.filter(|(_, _, a)| *a)
-							.map(|((k, n), _, _)| BucketLocalAlias {
-								access_key_id: k.to_string(),
-								alias: n.to_string(),
-							})
-							.collect::<Vec<_>>(),
-					}
-				})
-				.collect::<Vec<_>>();
-
-			Ok(ListBucketsResponse::WithoutDetails(res))
-		}
 	}
 }
 

src/api/admin/key.rs

@@ -2,7 +2,6 @@ use std::collections::HashMap;
 use std::sync::Arc;
 
 use chrono::DateTime;
-use futures::StreamExt;
 
 use garage_table::*;
 use garage_util::time::now_msec;
@@ -21,57 +20,37 @@ impl RequestHandler for ListKeysRequest {
 	async fn handle(self, garage: &Arc<Garage>, _admin: &Admin) -> Result<ListKeysResponse, Error> {
 		let now = now_msec();
 
-		let limit = self
+		let res = garage
-			.limit
-			.unwrap_or_else(|| if self.details { 1000 } else { 10_000 });
-
-		let keys = garage
 			.key_table
 			.get_range(
 				&EmptyKey,
-				self.offset,
+				None,
 				Some(KeyFilter::Deleted(DeletedFilter::NotDeleted)),
-				limit,
+				10000,
 				EnumerationOrder::Forward,
 			)
-			.await?;
+			.await?
+			.iter()
+			.map(|k| {
+				let p = k.params().unwrap();
 
-		if self.details {
+				ListKeysResponseItem {
-			let mut stream = keys
+					id: k.key_id.to_string(),
-				.into_iter()
+					name: p.name.get().clone(),
-				.map(|k| key_info_results(garage, k, false))
+					created: p.created.map(|x| {
-				.collect::<futures::stream::FuturesOrdered<_>>();
+						DateTime::from_timestamp_millis(x as i64)
+							.expect("invalid timestamp stored in db")
+					}),
+					expiration: p.expiration.get().inner().map(|x| {
+						DateTime::from_timestamp_millis(x.0 as i64)
+							.expect("invalid timestamp stored in db")
+					}),
+					expired: p.is_expired(now),
+				}
+			})
+			.collect::<Vec<_>>();
 
-			let mut res = vec![];
+		Ok(ListKeysResponse(res))
-			while let Some(next) = stream.next().await {
-				res.push(next?);
-			}
-
-			Ok(ListKeysResponse::WithDetails(res))
-		} else {
-			let res = keys
-				.iter()
-				.map(|k| {
-					let p = k.params().unwrap();
-
-					ListKeysResponseItem {
-						id: k.key_id.to_string(),
-						name: p.name.get().clone(),
-						created: p.created.map(|x| {
-							DateTime::from_timestamp_millis(x as i64)
-								.expect("invalid timestamp stored in db")
-						}),
-						expiration: p.expiration.get().inner().map(|x| {
-							DateTime::from_timestamp_millis(x.0 as i64)
-								.expect("invalid timestamp stored in db")
-						}),
-						expired: p.is_expired(now),
-					}
-				})
-				.collect::<Vec<_>>();
-
-			Ok(ListKeysResponse::WithoutDetails(res))
-		}
 	}
 }
 

src/api/admin/openapi.rs

@@ -364,7 +364,6 @@ fn ClusterLayoutSkipDeadNodes() {}
     path = "/v2/ListKeys",
     tag = "Access key",
     description = "Returns all API access keys in the cluster.",
-    params(ListKeysRequest),
 	responses(
             (status = 200, description = "Returns the key identifier (aka `AWS_ACCESS_KEY_ID`) and its associated, human friendly, name if any (otherwise return an empty string)", body = ListKeysResponse),
             (status = 500, description = "Internal server error")
@@ -454,7 +453,6 @@ fn DeleteKey() {}
     path = "/v2/ListBuckets",
     tag = "Bucket",
     description = "List all the buckets on the cluster with their UUID and their global and local aliases.",
-    params(ListBucketsRequest),
 	responses(
             (status = 200, description = "Returns the UUID of all the buckets and all their aliases", body = ListBucketsResponse),
             (status = 500, description = "Internal server error")
@@ -878,7 +876,7 @@ impl Modify for SecurityAddon {
 #[derive(OpenApi)]
 #[openapi(
     info(
-        version = "v2.4.0",
+        version = "v2.3.0",
         title = "Garage administration API",
         description = "Administrate your Garage cluster programmatically, including status, layout, keys, buckets, and maintenance tasks.
 

src/api/admin/router_v2.rs

@@ -55,10 +55,10 @@ impl AdminApiRequest {
 			POST CreateKey (body),
 			POST ImportKey (body),
 			POST DeleteKey (query::id),
-			GET ListKeys (parse_default(false)::details, query_opt::offset, opt_parse::limit),
+			GET ListKeys (),
 			// Bucket endpoints
 			GET GetBucketInfo (query_opt::id, query_opt::global_alias, query_opt::search),
-			GET ListBuckets (parse_default(false)::details, query_opt::offset, opt_parse::limit),
+			GET ListBuckets (),
 			POST CreateBucket (body),
 			POST DeleteBucket (query::id),
 			POST UpdateBucket (body_field, query::id),
@@ -129,7 +129,7 @@ impl AdminApiRequest {
 			)),
 
 			// Keys
-			Endpoint::ListKeys => Ok(AdminApiRequest::ListKeys(ListKeysRequest::default())),
+			Endpoint::ListKeys => Ok(AdminApiRequest::ListKeys(ListKeysRequest)),
 			Endpoint::GetKeyInfo {
 				id,
 				search,
@@ -161,9 +161,7 @@ impl AdminApiRequest {
 			// Endpoint::DeleteKey { id } => Ok(AdminApiRequest::DeleteKey(DeleteKeyRequest { id })),
 
 			// Buckets
-			Endpoint::ListBuckets => {
+			Endpoint::ListBuckets => Ok(AdminApiRequest::ListBuckets(ListBucketsRequest)),
-				Ok(AdminApiRequest::ListBuckets(ListBucketsRequest::default()))
-			}
 			Endpoint::GetBucketInfo { id, global_alias } => {
 				Ok(AdminApiRequest::GetBucketInfo(GetBucketInfoRequest {
 					id,
@@ -273,9 +271,6 @@ generateQueryParameters! {
 		"accessKeyId" => access_key_id,
 		"showSecretKey" => show_secret_key,
 		"bucketId" => bucket_id,
-		"key" => key,
+		"key" => key
-		"details" => details,
-		"offset" => offset,
-		"limit" => limit
 	]
 }

src/garage/cli/remote/bucket.rs

@@ -31,19 +31,12 @@ impl Cli {
 	}
 
 	pub async fn cmd_list_buckets(&self) -> Result<(), Error> {
-		let mut buckets = match self.api_request(ListBucketsRequest::default()).await? {
+		let mut buckets = self.api_request(ListBucketsRequest).await?;
-			ListBucketsResponse::WithoutDetails(list) => list,
-			_ => {
-				return Err(Error::Message(
-					"Unexpected ListBuckets response format".into(),
-				))
-			}
-		};
 
-		buckets.sort_by_key(|x| x.created);
+		buckets.0.sort_by_key(|x| x.created);
 
 		let mut table = vec!["ID\tCreated\tGlobal aliases\tLocal aliases".to_string()];
-		for bucket in buckets.iter() {
+		for bucket in buckets.0.iter() {
 			table.push(format!(
 				"{:.16}\t{}\t{}\t{}",
 				bucket.id,

src/garage/cli/remote/key.rs

@@ -28,15 +28,12 @@ impl Cli {
 	}
 
 	pub async fn cmd_list_keys(&self) -> Result<(), Error> {
-		let mut keys = match self.api_request(ListKeysRequest::default()).await? {
+		let mut keys = self.api_request(ListKeysRequest).await?;
-			ListKeysResponse::WithoutDetails(list) => list,
-			_ => return Err(Error::Message("Unexpected ListKeys response format".into())),
-		};
 
-		keys.sort_by_key(|x| x.created);
+		keys.0.sort_by_key(|x| x.created);
 
 		let mut table = vec!["ID\tCreated\tName\tExpiration".to_string()];
-		for key in keys.iter() {
+		for key in keys.0.iter() {
 			let exp = if key.expired {
 				Cow::from("expired")
 			} else {
@@ -246,10 +243,7 @@ impl Cli {
 	}
 
 	pub async fn cmd_delete_expired_keys(&self, yes: bool) -> Result<(), Error> {
-		let mut list = match self.api_request(ListKeysRequest::default()).await? {
+		let mut list = self.api_request(ListKeysRequest).await?.0;
-			ListKeysResponse::WithoutDetails(list) => list,
-			_ => return Err(Error::Message("Unexpected ListKeys response format".into())),
-		};
 
 		list.retain(|key| key.expired);
 

src/garage/cli/remote/mod.rs

@@ -110,30 +110,17 @@ impl Cli {
 		Ok(resp.success.into_iter().next().unwrap().1)
 	}
 
-	pub async fn cmd_json_api(
+	pub async fn cmd_json_api(&self, endpoint: String, payload: String) -> Result<(), Error> {
-		&self,
+		let payload: serde_json::Value = if payload == "-" {
-		endpoint: String,
+			serde_json::from_reader(&std::io::stdin())?
-		payload: Option<String>,
-	) -> Result<(), Error> {
-		let request: AdminApiRequest = if let Some(payload) = payload {
-			let payload: serde_json::Value = if payload == "-" {
-				serde_json::from_reader(&std::io::stdin())?
-			} else {
-				serde_json::from_str(&payload)?
-			};
-
-			serde_json::from_value(serde_json::json!({
-				endpoint.clone(): payload,
-			}))?
 		} else {
-			serde_json::from_value(serde_json::json!({
+			serde_json::from_str(&payload)?
-				endpoint.clone(): null,
-			}))
-			.or(serde_json::from_value(serde_json::json!({
-				endpoint.clone(): {},
-			})))?
 		};
 
+		let request: AdminApiRequest = serde_json::from_value(serde_json::json!({
+			endpoint.clone(): payload,
+		}))?;
+
 		let resp = match self
 			.proxy_rpc_endpoint
 			.call(&self.rpc_host, ProxyRpc::Proxy(request), PRIO_NORMAL)

src/garage/cli/structs.rs

@@ -78,7 +78,8 @@ pub enum Command {
 		/// The admin API endpoint to invoke, e.g. `GetClusterStatus`
 		endpoint: String,
 		/// The JSON payload, or `-` to read from `stdin`
-		payload: Option<String>,
+		#[structopt(default_value = "null")]
+		payload: String,
 	},
 
 	/// Generate completions for a shell