Backup / recovery documentation

docs/home/HOWTO.md

@@ -77,6 +77,13 @@
   - [How to start working with Apache Ignite Stateful setup](./howto/DATABASES.md#how-to-start-working-with-apache-ignite-stateful-setup)
   - [How to start working with Apache Ignite Stateless setup](./howto/DATABASES.md#how-to-start-working-with-apache-ignite-stateless-setup)
 
+- [Backup and Recovery](./howto/BACKUP.md)
+  - [Epiphany backup and restore](./howto/BACKUP.md#epiphany-backup-and-restore)
+  - [How to perform backup](./howto/BACKUP.md#1-how-to-perform-backup)
+  - [How to store backup](./howto/BACKUP.md#2-how-to-store-backup)
+  - [How to perform recovery](./howto/BACKUP.md#3-how-to-perform-recovery)
+  - [How backup and recovery work](./howto/BACKUP.md#4-how-backup-and-recovery-work)
+
 - [Data and log retention](./howto/RETENTION.md)
   - [Elasticsearch](./howto/RETENTION.md#elasticsearch)
   - [Grafana](./howto/RETENTION.md#grafana)

docs/home/howto/BACKUP.md

@@ -0,0 +1,155 @@
+## Epiphany backup and restore
+
+### Introduction
+
+Epiphany provides solution to create full or partial backup and restore for some components, like:
+
+- [Load Balancer](#load-balancer)
+- [Logging](#logging)
+- [Monitoring](#monitoring)
+- [Postgresql](#postgresql)
+- [RabbitMQ](#rabbitmq)
+- [Kubernetes (only backup)](#kubernetes)
+
+Backup is created directly on the machine where component is running, and it is moved to the ``repository`` host via rsync. On the ``repository`` host backup files are stored in location ``/epibackup/mounted`` mounted on a local filesystem. 
+See [How to store backup](#2-How-to-store-backup) chapter.
+
+## 1. How to perform backup
+
+#### Backup configuration
+
+Copy default configuration for backup from ``defaults/configuration/backup.yml`` into newly created backup.yml config file, and enable backup for chosen components by setting up ``enabled`` parameter to ``true``.
+
+This config may also be attached to cluster-config.yml
+
+```
+kind: configuration/backup
+title: Backup Config
+name: default
+specification:
+  components:
+    load_balancer:
+      enabled: true
+    logging:
+      enabled: false
+    monitoring:
+      enabled: true
+    postgresql:
+      enabled: true
+    rabbitmq:
+      enabled: false
+# Kubernes recovery is not supported at this point.
+# You may create backup by enabling this below, but recovery should be done manually according to Kubernetes documentation.
+    kubernetes:
+      enabled: false
+```
+
+Run ``epicli backup`` command:
+```
+epicli backup -f backup.yml -b build_folder
+```
+
+If backup config is attached to cluster-config.yml use this file instead ``backup.yml``
+
+## 2. How to store backup
+
+Backup location is defined in ``backup`` role as ``backup_destination_host`` and ``backup_destination_dir``.
+Default backup location is defined on ``repository`` host in location ``/epibackup/mounted/``.
+Use ``mounted`` location as mount point and mount storage you want to use. This might be:
+- Azure Blob Storage
+- Amazon S3
+- NAS
+- Any other attached storage
+
+Ensure that mounted location has enough space, is reliable and is well protected against disaster.
+
+### If you don't attach any storage into the mount point location be aware that backups will be store on the local machine. This is not recommended.
+
+## 3. How to perform recovery
+
+### Recovery configuration
+
+Copy existing default configuration from ``defaults/configuration/recovery.yml`` into newly created recovery.yml config file, and set ``enabled`` parameter for component to recovery. It's possible to choose snapshot name by passing date and time part of snapshot name. If snapshot name is not provided, the latest one will be restored.
+
+This config may also be attached to cluster-config.yml
+
+```
+kind: configuration/recovery
+title: Recovery Config
+name: default
+specification:
+  components:
+    load_balancer:
+      enabled: true
+      snapshot_name: latest           #restore latest backup
+    logging:
+      enabled: true
+      snapshot_name: 20200604-150829  #restore selected backup
+    monitoring:
+      enabled: false
+      snapshot_name: latest
+    postgresql:
+      enabled: false
+      snapshot_name: latest
+    rabbitmq:
+      enabled: false
+      snapshot_name: latest
+```
+
+Run ``epicli recovery`` command:
+
+``epicli recovery -f recovery.yml -b build_folder``
+
+If recovery config is attached to cluster-config.yml use this file instead ``recovery.yml``
+
+## 4. How backup and recovery work
+
+### Load Balancer
+
+Load balancer backup includes:
+- Configuration files: ``/etc/haproxy/``
+- SSL certificates: ``/etc/ssl/haproxy/``
+
+Recovery includes all backed up files
+
+
+### Logging
+
+Logging backup includes:
+- Elasticsearch database snapshot
+- Elasticsearch configuration ``/etc/elasticsearch/``
+- Kibana configuration ``/etc/kibana/``
+
+Only single-node Elasticsearch backup is supported. Solution for multi-node Elasticsearch cluster will be added in future release.
+
+### Monitoring
+Monitoring backup includes:
+- Prometheus data snapshot
+- Prometheus configuration ``/etc/prometheus/``
+- Grafana data snapshot
+
+Recovery includes all backed up configurations and snapshots.
+
+### Postgresql
+Postgresql backup includes:
+- Database data and metadata dump using ``pg_dumpall``
+- Configuration files: ``*.conf``
+
+When multinode configuration is used, and failover action has changed database cluster status (one node down, switchover) it's still possible to create backup. But before database restore, cluster needs to be recovered by running ``epicli apply`` and next ``epicli recovery`` to restore database data.
+By default we don't support recovery database configuration from backup since this needs to be done using ``epicli apply`` or manually by copying backed up files accordingly to cluster state. The reason of this is that is very risky to restore configuration files among different database cluster configurations.
+
+### RabbitMQ
+RabbitMQ backup includes:
+- Messages definitions
+- Configuration files: ``/etc/rabbitmq/``
+
+Backup does not include RabbitMQ messages.
+
+Recovery includes all backed up files and configurations.
+
+### Kubernetes
+- Etcd snapshot
+- Public Key Infrastructure ``/etc/kubernetes/pki``
+- Kubeadm configuration files
+
+Epiphany does not support Kubernetes cluster recovery. Use Kubernetes documentation for manual recovery.