aboutsummaryrefslogtreecommitdiff
path: root/doc/book/operations/_index.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2023-06-14 12:08:02 +0200
committerAlex Auvolat <alex@adnab.me>2023-06-14 12:39:40 +0200
commitdd7533a260291a25d69b8e7afa423df9e0d6a30c (patch)
tree1b1c6a54aae4b83280a19c4b169f324ad3f6e562 /doc/book/operations/_index.md
parent92336619679712a0aa5cf3ea2e115c706f99ff22 (diff)
downloadgarage-dd7533a260291a25d69b8e7afa423df9e0d6a30c.tar.gz
garage-dd7533a260291a25d69b8e7afa423df9e0d6a30c.zip
doc: add an operations&maintenance section and move some pages there
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.