aboutsummaryrefslogtreecommitdiff
path: root/doc/book/operations/_index.md
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2023-06-14 10:57:32 +0000
committerAlex <alex@adnab.me>2023-06-14 10:57:32 +0000
commit5e291c64b3539c11cd4f107852686c7865b8b036 (patch)
tree62e8bf6e275ce045e29baf7a660706899e54ed8e /doc/book/operations/_index.md
parent01346143ca09eab262f0d8f8a0a744c2f6d667cc (diff)
parent9092c71a01311f8f7174fa03facdb4d95a7b1389 (diff)
downloadgarage-5e291c64b3539c11cd4f107852686c7865b8b036.tar.gz
garage-5e291c64b3539c11cd4f107852686c7865b8b036.zip
Merge pull request 'Documentation updates' (#587) from doc-updates into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/587
Diffstat (limited to 'doc/book/operations/_index.md')
-rw-r--r--doc/book/operations/_index.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/book/operations/_index.md b/doc/book/operations/_index.md
new file mode 100644
index 00000000..16d0e9d5
--- /dev/null
+++ b/doc/book/operations/_index.md
@@ -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.