aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/book/cookbook/monitoring.md10
-rw-r--r--doc/book/cookbook/real-world.md15
2 files changed, 20 insertions, 5 deletions
diff --git a/doc/book/cookbook/monitoring.md b/doc/book/cookbook/monitoring.md
index 0a3a33e7..fd014c4e 100644
--- a/doc/book/cookbook/monitoring.md
+++ b/doc/book/cookbook/monitoring.md
@@ -56,7 +56,7 @@ We detail below the list of exposed metrics and their meaning.
## List of exported metrics
-### API endpoints
+### Metrics of the API endpoints
#### `api_admin_request_counter` (counter)
@@ -107,7 +107,7 @@ api_s3_request_duration_count{api_endpoint="CreateMultipartUpload"} 1
Same as for S3, for the K2V API.
-### Web endpoint
+### Metrics of the Web endpoint
#### `web_request_counter` (counter)
@@ -137,7 +137,7 @@ web_error_counter{method="GET",status_code="404 Not Found"} 64
```
-### Data block manager
+### Metrics of the data block manager
#### `block_bytes_read`, `block_bytes_written` (counter)
@@ -199,7 +199,7 @@ block_resync_errored_blocks 0
```
-### RPC (remote procedure calls) between nodes
+### Metrics related to RPCs (remote procedure calls) between nodes
#### `rpc_netapp_request_counter` (counter)
@@ -236,7 +236,7 @@ rpc_duration_count{from="<this node>",rpc_endpoint="garage_block/manager.rs/Rpc"
```
-### Metadata table manager
+### Metrics of the metadata table manager
#### `table_gc_todo_queue_length` (gauge)
diff --git a/doc/book/cookbook/real-world.md b/doc/book/cookbook/real-world.md
index 6fe7e547..f0fe3bd1 100644
--- a/doc/book/cookbook/real-world.md
+++ b/doc/book/cookbook/real-world.md
@@ -164,6 +164,21 @@ It should be restarted automatically at each reboot.
Please note that we use host networking as otherwise Docker containers
can not communicate with IPv6.
+If you want to use `docker-compose`, you may use the following `docker-compose.yml` file as a reference:
+
+```yaml
+version: "3"
+services:
+ garage:
+ image: dxflrs/garage:v0.8.0
+ network_mode: "host"
+ restart: unless-stopped
+ volumes:
+ - /etc/garage.toml:/etc/garage.toml
+ - /var/lib/garage/meta:/var/lib/garage/meta
+ - /var/lib/garage/data:/var/lib/garage/data
+```
+
Upgrading between Garage versions should be supported transparently,
but please check the relase notes before doing so!
To upgrade, simply stop and remove this container and