From 76d399e94f896533cd2505d1b1d732be4f486b21 Mon Sep 17 00:00:00 2001 From: Quentin Dufour Date: Mon, 22 Jan 2024 11:01:47 +0100 Subject: [PATCH] cookbook skeleton --- content/documentation/cookbook/_index.md | 48 +++++++++++++------ .../documentation/cookbook/autodiscovery.md | 6 +++ content/documentation/cookbook/backups.md | 6 +++ .../cookbook/garage-cluster-storage.md | 6 +++ content/documentation/cookbook/ldap.md | 6 +++ .../documentation/cookbook/manual-hardened.md | 6 +++ .../documentation/cookbook/observability.md | 6 +++ .../documentation/cookbook/orchestrators.md | 6 +++ .../documentation/cookbook/service-manager.md | 6 +++ .../cookbook/single-node-garage-storage.md | 7 +++ content/documentation/cookbook/smtp-server.md | 6 +++ .../cookbook/static-user-management.md | 7 +++ .../documentation/cookbook/tls-encryption.md | 6 +++ content/documentation/cookbook/updates.md | 6 +++ 14 files changed, 113 insertions(+), 15 deletions(-) create mode 100644 content/documentation/cookbook/autodiscovery.md create mode 100644 content/documentation/cookbook/backups.md create mode 100644 content/documentation/cookbook/garage-cluster-storage.md create mode 100644 content/documentation/cookbook/ldap.md create mode 100644 content/documentation/cookbook/manual-hardened.md create mode 100644 content/documentation/cookbook/observability.md create mode 100644 content/documentation/cookbook/orchestrators.md create mode 100644 content/documentation/cookbook/service-manager.md create mode 100644 content/documentation/cookbook/single-node-garage-storage.md create mode 100644 content/documentation/cookbook/smtp-server.md create mode 100644 content/documentation/cookbook/static-user-management.md create mode 100644 content/documentation/cookbook/tls-encryption.md create mode 100644 content/documentation/cookbook/updates.md diff --git a/content/documentation/cookbook/_index.md b/content/documentation/cookbook/_index.md index 5f47046..f210986 100644 --- a/content/documentation/cookbook/_index.md +++ b/content/documentation/cookbook/_index.md @@ -5,23 +5,41 @@ sort_by = "weight" template = "documentation.html" +++ -## Minimal deployment - - Static user management - - Single-node Garage storage - - TLS encryption - - Integration with a service manager - - SMTP server integration (MTA) +This cookbook will guide you from your first steps +to a real deployment of Aerogramme. -## Standard deployment - - LDAP user management - - Garage cluster storage - - Integration in an orchestrator - - Auto-discovery +## Single-node, minimal deployment + +A minimal deployment will allow you to deploy Aerogramme on a single-server +in a way that it works for a small production deployment. +However, as Aerogramme is a distributed-first server, +you will not benefit from all of its nice properties, and many manual +work will be required. + + - [Static user management](@/documentation/cookbook/static-user-management.md) + - [Local storage](@/documentation/cookbook/single-node-garage-storage.md) + - [TLS encryption](@/documentation/cookbook/tls-encryption.md) + - [Integration with a service manager](@/documentation/cookbook/service-manager.md) (systemd or docker) + - [SMTP server integration](@/documentation/cookbook/smtp-server.md) (MTA) + +## Multi-nodes, standard deployment + +Aerogramme is intended for multi-nodes deployment. This guide +will cover the specificities introduced by a multi-node deployment. + + - [LDAP user management](@/documentation/cookbook/ldap.md) + - [Distributed storage](@/documentation/cookbook/garage-cluster-storage.md) + - [Orchestrators](@/documentation/cookbook/orchestrators.md) + - [Auto-discovery](@/documentation/cookbook/autodiscovery.md) ## Lifecycle - - Updates - - Observability - - Backups + +Hopefully you will love Aerogramme, and thus you will have to do some maintainance on it. + + - [Updates](@/documentation/cookbook/updates.md) + - [Observability](@/documentation/cookbook/observability.md) + - [Backups](@/documentation/cookbook/backups.md) ## Hardened flavor - - Manual configuration + + - [Manual configuration](@/documentation/cookbook/manual-hardened.md) diff --git a/content/documentation/cookbook/autodiscovery.md b/content/documentation/cookbook/autodiscovery.md new file mode 100644 index 0000000..3be869a --- /dev/null +++ b/content/documentation/cookbook/autodiscovery.md @@ -0,0 +1,6 @@ ++++ +title = "Auto-discovery" +weight = 90 ++++ + +Todo diff --git a/content/documentation/cookbook/backups.md b/content/documentation/cookbook/backups.md new file mode 100644 index 0000000..4e7637d --- /dev/null +++ b/content/documentation/cookbook/backups.md @@ -0,0 +1,6 @@ ++++ +title = "Backups" +weight = 120 ++++ + +Todo diff --git a/content/documentation/cookbook/garage-cluster-storage.md b/content/documentation/cookbook/garage-cluster-storage.md new file mode 100644 index 0000000..8532440 --- /dev/null +++ b/content/documentation/cookbook/garage-cluster-storage.md @@ -0,0 +1,6 @@ ++++ +title = "Distributed Storage" +weight = 70 ++++ + +Todo diff --git a/content/documentation/cookbook/ldap.md b/content/documentation/cookbook/ldap.md new file mode 100644 index 0000000..b1de164 --- /dev/null +++ b/content/documentation/cookbook/ldap.md @@ -0,0 +1,6 @@ ++++ +title = "LDAP User Management" +weight = 60 ++++ + +LDAP diff --git a/content/documentation/cookbook/manual-hardened.md b/content/documentation/cookbook/manual-hardened.md new file mode 100644 index 0000000..1bbe069 --- /dev/null +++ b/content/documentation/cookbook/manual-hardened.md @@ -0,0 +1,6 @@ ++++ +title = "Hardened configuration" +weight = 130 ++++ + +Todo diff --git a/content/documentation/cookbook/observability.md b/content/documentation/cookbook/observability.md new file mode 100644 index 0000000..fce5ff0 --- /dev/null +++ b/content/documentation/cookbook/observability.md @@ -0,0 +1,6 @@ ++++ +title = "Observability" +weight = 110 ++++ + +Todo diff --git a/content/documentation/cookbook/orchestrators.md b/content/documentation/cookbook/orchestrators.md new file mode 100644 index 0000000..780f922 --- /dev/null +++ b/content/documentation/cookbook/orchestrators.md @@ -0,0 +1,6 @@ ++++ +title = "Orchestrators" +weight = 80 ++++ + +Todo diff --git a/content/documentation/cookbook/service-manager.md b/content/documentation/cookbook/service-manager.md new file mode 100644 index 0000000..1962966 --- /dev/null +++ b/content/documentation/cookbook/service-manager.md @@ -0,0 +1,6 @@ ++++ +title = "Service Managers (eg. systemd)" +weight = 40 ++++ + +Todo diff --git a/content/documentation/cookbook/single-node-garage-storage.md b/content/documentation/cookbook/single-node-garage-storage.md new file mode 100644 index 0000000..09a9561 --- /dev/null +++ b/content/documentation/cookbook/single-node-garage-storage.md @@ -0,0 +1,7 @@ ++++ +title = "Local storage" +weight = 20 ++++ + +Todo + diff --git a/content/documentation/cookbook/smtp-server.md b/content/documentation/cookbook/smtp-server.md new file mode 100644 index 0000000..7b57fd1 --- /dev/null +++ b/content/documentation/cookbook/smtp-server.md @@ -0,0 +1,6 @@ ++++ +title = "SMTP servers" +weight = 50 ++++ + +Todo diff --git a/content/documentation/cookbook/static-user-management.md b/content/documentation/cookbook/static-user-management.md new file mode 100644 index 0000000..c78bd0f --- /dev/null +++ b/content/documentation/cookbook/static-user-management.md @@ -0,0 +1,7 @@ ++++ +title = "Static User Management" +weight = 10 ++++ + +Todo + diff --git a/content/documentation/cookbook/tls-encryption.md b/content/documentation/cookbook/tls-encryption.md new file mode 100644 index 0000000..9f05fe7 --- /dev/null +++ b/content/documentation/cookbook/tls-encryption.md @@ -0,0 +1,6 @@ ++++ +title = "TLS" +weight = 30 ++++ + +Todo diff --git a/content/documentation/cookbook/updates.md b/content/documentation/cookbook/updates.md new file mode 100644 index 0000000..b866252 --- /dev/null +++ b/content/documentation/cookbook/updates.md @@ -0,0 +1,6 @@ ++++ +title = "Updates" +weight = 100 ++++ + +Todo