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

Rename subsections and add docker compose file

Browse Source
This commit is contained in:
Alex Auvolat 2022-11-16 13:33:33 +01:00
parent a7af0c8af9
commit fc8f795bba
No known key found for this signature in database
GPG Key ID: 0E496D15096376BE
2 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/book/cookbook/monitoring.md
View File

@ -56,7 +56,7 @@ We detail below the list of exposed metrics and their meaning.
## List of exported metrics ## List of exported metrics
### API endpoints ### Metrics of the API endpoints
#### `api_admin_request_counter` (counter) #### `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. Same as for S3, for the K2V API.
### Web endpoint ### Metrics of the Web endpoint
#### `web_request_counter` (counter) #### `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) #### `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) #### `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) #### `table_gc_todo_queue_length` (gauge)

15
doc/book/cookbook/real-world.md
View File

@ -164,6 +164,21 @@ It should be restarted automatically at each reboot.
Please note that we use host networking as otherwise Docker containers Please note that we use host networking as otherwise Docker containers
can not communicate with IPv6. 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, Upgrading between Garage versions should be supported transparently,
but please check the relase notes before doing so! but please check the relase notes before doing so!
To upgrade, simply stop and remove this container and To upgrade, simply stop and remove this container and