#1796: documentation

CHANGELOG.md

@@ -27,6 +27,9 @@ SessionManager.
 - File System - ability to emulate a node's file system during a simulation
 - Example notebooks - There is currently 1 jupyter notebook which walks through using PrimAITE
   1. Creating a simulation - this notebook explains how to build up a simulation using the Python package. (WIP)
+- Database:
+  - `DatabaseClient` and `DatabaseService` created to allow emulation of database actions
+  - Ability to `backup_database` and `restore_backup` for a `DatabaseService`
 - Red Agent Services:
   - Data Manipulator Bot - A red agent service which sends a payload to a target machine. (By default this payload is a SQL query that breaks a database)
 - DNS Services: `DNSClient` and `DNSServer`

docs/source/simulation_components/system/database_client_server.rst

@@ -60,6 +60,12 @@ Usage
 - Retrieve results in a dictionary.
 - Disconnect when finished.
 
+To create database backups:
+
+- Configure the backup server the ``DatabaseService`` by providing the Backup server ``IPv4Address`` with ``configure_backup``
+- Create a backup using ``backup_database``. This fails if the backup server is not configured.
+- Restore a backup using ``restore_backup``. By default, this uses the database created via ``backup_database``.
+
 Implementation
 ^^^^^^^^^^^^^^