doc: add an operations&maintenance section and move some pages there
This commit is contained in:
parent
9233661967
commit
dd7533a260
16 changed files with 38 additions and 19 deletions
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Build your own app"
|
title = "Build your own app"
|
||||||
weight = 4
|
weight = 40
|
||||||
sort_by = "weight"
|
sort_by = "weight"
|
||||||
template = "documentation.html"
|
template = "documentation.html"
|
||||||
+++
|
+++
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Existing integrations"
|
title = "Existing integrations"
|
||||||
weight = 3
|
weight = 30
|
||||||
sort_by = "weight"
|
sort_by = "weight"
|
||||||
template = "documentation.html"
|
template = "documentation.html"
|
||||||
+++
|
+++
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
+++
|
+++
|
||||||
title="Cookbook"
|
title="Cookbook"
|
||||||
template = "documentation.html"
|
template = "documentation.html"
|
||||||
weight = 2
|
weight = 20
|
||||||
sort_by = "weight"
|
sort_by = "weight"
|
||||||
+++
|
+++
|
||||||
|
|
||||||
|
@ -37,7 +37,3 @@ This chapter could also be referred as "Tutorials" or "Best practices".
|
||||||
- **[Monitoring Garage](@/documentation/cookbook/monitoring.md)** This page
|
- **[Monitoring Garage](@/documentation/cookbook/monitoring.md)** This page
|
||||||
explains the Prometheus metrics available for monitoring the Garage
|
explains the Prometheus metrics available for monitoring the Garage
|
||||||
cluster/nodes.
|
cluster/nodes.
|
||||||
|
|
||||||
- **[Recovering from failures](@/documentation/cookbook/recovering.md):** Garage's first selling point is resilience
|
|
||||||
to hardware failures. This section explains how to recover from such a failure in the
|
|
||||||
best possible way.
|
|
||||||
|
|
|
@ -345,7 +345,7 @@ garage layout apply
|
||||||
```
|
```
|
||||||
|
|
||||||
**WARNING:** if you want to use the layout modification commands in a script,
|
**WARNING:** if you want to use the layout modification commands in a script,
|
||||||
make sure to read [this page](@/documentation/reference-manual/layout.md) first.
|
make sure to read [this page](@/documentation/operations/layout.md) first.
|
||||||
|
|
||||||
|
|
||||||
## Using your Garage cluster
|
## Using your Garage cluster
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Design"
|
title = "Design"
|
||||||
weight = 6
|
weight = 70
|
||||||
sort_by = "weight"
|
sort_by = "weight"
|
||||||
template = "documentation.html"
|
template = "documentation.html"
|
||||||
+++
|
+++
|
||||||
|
|
|
@ -61,7 +61,7 @@ Garage prioritizes which nodes to query according to a few criteria:
|
||||||
|
|
||||||
|
|
||||||
For further reading on the cluster structure look at the [gateway](@/documentation/cookbook/gateways.md)
|
For further reading on the cluster structure look at the [gateway](@/documentation/cookbook/gateways.md)
|
||||||
and [cluster layout management](@/documentation/reference-manual/layout.md) pages.
|
and [cluster layout management](@/documentation/operations/layout.md) pages.
|
||||||
|
|
||||||
## Garbage collection
|
## Garbage collection
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Development"
|
title = "Development"
|
||||||
weight = 7
|
weight = 80
|
||||||
sort_by = "weight"
|
sort_by = "weight"
|
||||||
template = "documentation.html"
|
template = "documentation.html"
|
||||||
+++
|
+++
|
||||||
|
|
23
doc/book/operations/_index.md
Normal file
23
doc/book/operations/_index.md
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
+++
|
||||||
|
title = "Operations & Maintenance"
|
||||||
|
weight = 50
|
||||||
|
sort_by = "weight"
|
||||||
|
template = "documentation.html"
|
||||||
|
+++
|
||||||
|
|
||||||
|
This section contains a number of important information on how to best operate a Garage cluster,
|
||||||
|
to ensure integrity and availability of your data:
|
||||||
|
|
||||||
|
- **[Upgrading Garage](@/documentation/operations/upgrading.md):** General instructions on how to
|
||||||
|
upgrade your cluster from one version to the next. Instructions specific for each version upgrade
|
||||||
|
can bef ound in the [working documents](@/documentation/working-documents/_index.md) section.
|
||||||
|
|
||||||
|
- **[Layout management](@/documentation/operations/layout.md):** Best practices for using the `garage layout`
|
||||||
|
commands when adding or removing nodes from your cluster.
|
||||||
|
|
||||||
|
- **[Durability and repairs](@/documentation/operations/durability-repairs.md):** How to check for small things
|
||||||
|
that might be going wrong, and how to recover from such failures.
|
||||||
|
|
||||||
|
- **[Recovering from failures](@/documentation/operations/recovering.md):** Garage's first selling point is resilience
|
||||||
|
to hardware failures. This section explains how to recover from such a failure in the
|
||||||
|
best possible way.
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Durability & Repairs"
|
title = "Durability & Repairs"
|
||||||
weight = 50
|
weight = 30
|
||||||
+++
|
+++
|
||||||
|
|
||||||
To ensure the best durability of your data and to fix any inconsistencies that may
|
To ensure the best durability of your data and to fix any inconsistencies that may
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Cluster layout management"
|
title = "Cluster layout management"
|
||||||
weight = 50
|
weight = 20
|
||||||
+++
|
+++
|
||||||
|
|
||||||
The cluster layout in Garage is a table that assigns to each node a role in
|
The cluster layout in Garage is a table that assigns to each node a role in
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Recovering from failures"
|
title = "Recovering from failures"
|
||||||
weight = 60
|
weight = 40
|
||||||
+++
|
+++
|
||||||
|
|
||||||
Garage is meant to work on old, second-hand hardware.
|
Garage is meant to work on old, second-hand hardware.
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Upgrading Garage"
|
title = "Upgrading Garage"
|
||||||
weight = 70
|
weight = 10
|
||||||
+++
|
+++
|
||||||
|
|
||||||
Garage is a stateful clustered application, where all nodes are communicating together and share data structures.
|
Garage is a stateful clustered application, where all nodes are communicating together and share data structures.
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Quick Start"
|
title = "Quick Start"
|
||||||
weight = 0
|
weight = 10
|
||||||
sort_by = "weight"
|
sort_by = "weight"
|
||||||
template = "documentation.html"
|
template = "documentation.html"
|
||||||
+++
|
+++
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Reference Manual"
|
title = "Reference Manual"
|
||||||
weight = 5
|
weight = 60
|
||||||
sort_by = "weight"
|
sort_by = "weight"
|
||||||
template = "documentation.html"
|
template = "documentation.html"
|
||||||
+++
|
+++
|
||||||
|
|
|
@ -35,7 +35,7 @@ This makes setting up and administering storage clusters, we hope, as easy as it
|
||||||
|
|
||||||
A Garage cluster can very easily evolve over time, as storage nodes are added or removed.
|
A Garage cluster can very easily evolve over time, as storage nodes are added or removed.
|
||||||
Garage will automatically rebalance data between nodes as needed to ensure the desired number of copies.
|
Garage will automatically rebalance data between nodes as needed to ensure the desired number of copies.
|
||||||
Read about cluster layout management [here](@/documentation/reference-manual/layout.md).
|
Read about cluster layout management [here](@/documentation/operations/layout.md).
|
||||||
|
|
||||||
### No RAFT slowing you down
|
### No RAFT slowing you down
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
+++
|
+++
|
||||||
title = "Working Documents"
|
title = "Working Documents"
|
||||||
weight = 8
|
weight = 90
|
||||||
sort_by = "weight"
|
sort_by = "weight"
|
||||||
template = "documentation.html"
|
template = "documentation.html"
|
||||||
+++
|
+++
|
||||||
|
|
Loading…
Reference in a new issue