format

Author: Ethan-Arrowood

docs/SUMMARY.md

@@ -6,9 +6,9 @@ Harper is designed for minimal administrative effort, and with managed services
 
 As a distributed database, data protection and recovery can benefit from different data protection strategies than a traditional single-server database. But multiple aspects of data protection and recovery should be considered:
 
-* Availability: As a distributed database Harper is intrinsically built for high-availability and a cluster will continue to run even with complete server(s) failure. This is the first and primary defense for protecting against any downtime or data loss. Harper provides fast horizontal scaling functionality with node cloning, which facilitates ease of establishing high availability clusters.
-* [Audit log](logging/audit-logging.md): Harper defaults to tracking data changes so malicious data changes can be found, attributed, and reverted. This provides security-level defense against data loss, allowing for fine-grained isolation and reversion of individual data without the large-scale reversion/loss of data associated with point-in-time recovery approaches.
-* Snapshots: When used as a source-of-truth database for crucial data, we recommend using snapshot tools to regularly snapshot databases as a final backup/defense against data loss (this should only be used as a last resort in recovery). Harper has a [`get_backup`](../developers/operations-api/databases-and-tables.md#get-backup) operation, which provides direct support for making and retrieving database snapshots. An HTTP request can be used to get a snapshot. Alternatively, volume snapshot tools can be used to snapshot data at the OS/VM level. Harper can also provide scripts for replaying transaction logs from snapshots to facilitate point-in-time recovery when necessary (often customization may be preferred in certain recovery situations to minimize data loss).
+- Availability: As a distributed database Harper is intrinsically built for high-availability and a cluster will continue to run even with complete server(s) failure. This is the first and primary defense for protecting against any downtime or data loss. Harper provides fast horizontal scaling functionality with node cloning, which facilitates ease of establishing high availability clusters.
+- [Audit log](logging/audit-logging.md): Harper defaults to tracking data changes so malicious data changes can be found, attributed, and reverted. This provides security-level defense against data loss, allowing for fine-grained isolation and reversion of individual data without the large-scale reversion/loss of data associated with point-in-time recovery approaches.
+- Snapshots: When used as a source-of-truth database for crucial data, we recommend using snapshot tools to regularly snapshot databases as a final backup/defense against data loss (this should only be used as a last resort in recovery). Harper has a [`get_backup`](../developers/operations-api/databases-and-tables.md#get-backup) operation, which provides direct support for making and retrieving database snapshots. An HTTP request can be used to get a snapshot. Alternatively, volume snapshot tools can be used to snapshot data at the OS/VM level. Harper can also provide scripts for replaying transaction logs from snapshots to facilitate point-in-time recovery when necessary (often customization may be preferred in certain recovery situations to minimize data loss).
 
 ### Horizontal Scaling with Node Cloning
 
@@ -17,10 +17,11 @@ Harper provides rapid horizontal scaling capabilities through [node cloning func
 ### Monitoring
 
 Harper provides robust capabilities for analytics and observability to facilitate effective and informative monitoring:
-* Analytics provides statistics on usage, request counts, load, memory usage with historical tracking. The analytics data can be [accessed through querying](../technical-details/reference/analytics.md).
-* A large variety of real-time statistics about load, system information, database metrics, thread usage can be retrieved through the [`system_information` API](../developers/operations-api/utilities.md).
-* Information about the current cluster configuration and status can be found in the [cluster APIs](../developers/operations-api/clustering.md).
-* Analytics and system information can easily be exported to Prometheus with our [Prometheus exporter component](https://github.com/HarperDB-Add-Ons/prometheus_exporter), making it easy visualize and monitor Harper with Graphana.
+
+- Analytics provides statistics on usage, request counts, load, memory usage with historical tracking. The analytics data can be [accessed through querying](../technical-details/reference/analytics.md).
+- A large variety of real-time statistics about load, system information, database metrics, thread usage can be retrieved through the [`system_information` API](../developers/operations-api/utilities.md).
+- Information about the current cluster configuration and status can be found in the [cluster APIs](../developers/operations-api/clustering.md).
+- Analytics and system information can easily be exported to Prometheus with our [Prometheus exporter component](https://github.com/HarperDB-Add-Ons/prometheus_exporter), making it easy visualize and monitor Harper with Graphana.
 
 ### Replication Transaction Logging
 

docs/administration/administration.md

@@ -1,9 +1,9 @@
 # Clone Node
 
-Clone node is a configurable node script that when pointed to another instance of Harper will create a clone of that 
-instance's config, databases and setup full replication. If it is run in a location where there is no existing Harper install, 
+Clone node is a configurable node script that when pointed to another instance of Harper will create a clone of that
+instance's config, databases and setup full replication. If it is run in a location where there is no existing Harper install,
 it will, along with cloning, install Harper. If it is run in a location where there is another Harper instance, it will
-only clone config, databases and replication that do not already exist. 
+only clone config, databases and replication that do not already exist.
 
 Clone node is triggered when Harper is installed or started with certain environment or command line (CLI) variables set (see below).
 
@@ -14,34 +14,36 @@ To start clone run `harperdb` in the CLI with either of the following variables
 
 #### Environment variables
 
-* `HDB_LEADER_URL` - The URL of the leader node's operation API (usually port 9925).
-* `HDB_LEADER_USERNAME` - The leader node admin username.
-* `HDB_LEADER_PASSWORD` - The leader node admin password.
-* `REPLICATION_HOSTNAME` - _(optional)_ The clones replication hostname. This value will be added to `replication.hostname` on the clone node. If this value is not set, replication will not be set up between the leader and clone.
+- `HDB_LEADER_URL` - The URL of the leader node's operation API (usually port 9925).
+- `HDB_LEADER_USERNAME` - The leader node admin username.
+- `HDB_LEADER_PASSWORD` - The leader node admin password.
+- `REPLICATION_HOSTNAME` - _(optional)_ The clones replication hostname. This value will be added to `replication.hostname` on the clone node. If this value is not set, replication will not be set up between the leader and clone.
 
 For example:
+
 ```
 HDB_LEADER_URL=https://node-1.my-domain.com:9925 REPLICATION_HOSTNAME=node-1.my-domain.com HDB_LEADER_USERNAME=... HDB_LEADER_PASSWORD=... harperdb
 ```
 
 #### Command line variables
 
-* `--HDB_LEADER_URL` - The URL of the leader node's operation API (usually port 9925).
-* `--HDB_LEADER_USERNAME` - The leader node admin username.
-* `--HDB_LEADER_PASSWORD` - The leader node admin password.
-* `--REPLICATION_HOSTNAME` - _(optional)_ The clones clustering host. This value will be added to `replication.hostname` on the clone node. If this value is not set, replication will not be set up between the leader and clone.
+- `--HDB_LEADER_URL` - The URL of the leader node's operation API (usually port 9925).
+- `--HDB_LEADER_USERNAME` - The leader node admin username.
+- `--HDB_LEADER_PASSWORD` - The leader node admin password.
+- `--REPLICATION_HOSTNAME` - _(optional)_ The clones clustering host. This value will be added to `replication.hostname` on the clone node. If this value is not set, replication will not be set up between the leader and clone.
 
 For example:
+
 ```
 harperdb --HDB_LEADER_URL https://node-1.my-domain.com:9925 --REPLICATION_HOSTNAME node-1.my-domain.com --HDB_LEADER_USERNAME ... --HDB_LEADER_PASSWORD ...
 ```
 
-Each time clone is run it will set a value `cloned: true` in `harperdb-config.yaml`. This value will prevent clone from 
-running again. If you want to run clone again set this value to `false`. If Harper is started with the clone variables 
+Each time clone is run it will set a value `cloned: true` in `harperdb-config.yaml`. This value will prevent clone from
+running again. If you want to run clone again set this value to `false`. If Harper is started with the clone variables
 still present and `cloned` is true, Harper will just start as normal.
 
-Clone node does not require any additional configuration apart from the variables referenced above. 
-However, if you wish to set any configuration during clone this can be done by passing the config as environment/CLI 
+Clone node does not require any additional configuration apart from the variables referenced above.
+However, if you wish to set any configuration during clone this can be done by passing the config as environment/CLI
 variables or cloning overtop of an existing `harperdb-config.yaml` file.
 
 More can be found in the Harper config documentation [here](../deployments/configuration.md).
@@ -51,10 +53,10 @@ More can be found in the Harper config documentation [here](../deployments/confi
 To set any specific (optional) clone config, including the exclusion of any database and/or replication, there is a file
 called `clone-node-config.yaml` that can be used.
 
-The file must be located in the `ROOTPATH` directory of your clone (the `hdb` directory where you clone will be installed. 
+The file must be located in the `ROOTPATH` directory of your clone (the `hdb` directory where you clone will be installed.
 If the directory does not exist, create one and add the file to it).
 
-The config available in `clone-node-config.yaml` is: 
+The config available in `clone-node-config.yaml` is:
 
 ```yaml
 databaseConfig:
@@ -68,27 +70,27 @@ componentConfig:
     - name: null
 ```
 
-_Note: only include the configuration that you are using. If no clone config file is provided nothing will be excluded, 
+_Note: only include the configuration that you are using. If no clone config file is provided nothing will be excluded,
 unless it already exists on the clone._
 
 `databaseConfig` - Set any databases or tables that you wish to exclude from cloning.
 
-`componentConfig` - Set any components that you do not want cloned. Clone node will not clone the component code, 
+`componentConfig` - Set any components that you do not want cloned. Clone node will not clone the component code,
 it will only clone the component reference that exists in the leader harperdb-config file.
 
 ### Cloning configuration
 
-Clone node will not clone any configuration that is classed as unique to the leader node. This includes `replication.hostname`, `replication.url`,`clustering.nodeName`, 
-`rootPath` and any other path related values, for example `storage.path`, `logging.root`, `componentsRoot`, 
+Clone node will not clone any configuration that is classed as unique to the leader node. This includes `replication.hostname`, `replication.url`,`clustering.nodeName`,
+`rootPath` and any other path related values, for example `storage.path`, `logging.root`, `componentsRoot`,
 any authentication certificate/key paths.
 
 ### Cloning system database
 
-Harper uses a database called `system` to store operational information. Clone node will only clone the user and role 
+Harper uses a database called `system` to store operational information. Clone node will only clone the user and role
 tables from this database. It will also set up replication on this table, which means that any existing and future user and roles
 that are added will be replicated throughout the cluster.
 
-Cloning the user and role tables means that once clone node is complete, the clone will share the same login credentials with 
+Cloning the user and role tables means that once clone node is complete, the clone will share the same login credentials with
 the leader.
 
 ### Replication
@@ -103,20 +105,21 @@ If cloning with replication, the leader's JWT private and public keys will be cl
 
 ### Cloning overtop of an existing Harper instance
 
-Clone node will not overwrite any existing config, database or replication. It will write/clone any config database or replication 
-that does not exist on the node it is running on. 
+Clone node will not overwrite any existing config, database or replication. It will write/clone any config database or replication
+that does not exist on the node it is running on.
 
-An example of how this can be useful is if you want to set Harper config before the clone is created. To do this you 
-would create a harperdb-config.yaml file in your local `hdb` root directory with the config you wish to set. Then 
+An example of how this can be useful is if you want to set Harper config before the clone is created. To do this you
+would create a harperdb-config.yaml file in your local `hdb` root directory with the config you wish to set. Then
 when clone is run it will append the missing config to the file and install Harper with the desired config.
 
-Another useful example could be retroactively adding another database to an existing instance. Running clone on 
-an existing instance could create a full clone of another database and set up replication between the database on the 
+Another useful example could be retroactively adding another database to an existing instance. Running clone on
+an existing instance could create a full clone of another database and set up replication between the database on the
 leader and the clone.
 
 ### Cloning steps
 
 Clone node will execute the following steps when ran:
+
 1. Look for an existing Harper install. It does this by using the default (or user provided) `ROOTPATH`.
 2. If an existing instance is found it will check for a `harperdb-config.yaml` file and search for the `cloned` value. If the value exists and is `true` clone will skip the clone logic and start Harper.
 3. Clone harperdb-config.yaml values that don't already exist (excluding values unique to the leader node).

docs/administration/cloning.md

@@ -1,13 +1,17 @@
 # Harper Studio
+
 Harper Studio is the web-based GUI for Harper. Studio enables you to administer, navigate, and monitor all of your Harper instances in a simple, user-friendly interface without any knowledge of the underlying Harper API. It’s free to sign up, get started today!
 
 [Sign up for free!](https://studio.harperdb.io/sign-up)
 
 Harper now includes a simplified local Studio that is packaged with all Harper installations and served directly from the instance. It can be enabled in the [configuration file](../../deployments/configuration.md#localstudio). This section is dedicated to the hosted Studio accessed at [studio.harperdb.io](https://studio.harperdb.io).
 
 ---
+
 ## How does Studio Work?
+
 While Harper Studio is web based and hosted by us, all database interactions are performed on the Harper instance the studio is connected to. The Harper Studio loads in your browser, at which point you login to your Harper instances. Credentials are stored in your browser cache and are not transmitted back to Harper. All database interactions are made via the Harper Operations API directly from your browser to your instance.
 
 ## What type of instances can I manage?
-Harper Studio enables users to manage both Harper Cloud instances and privately hosted instances all from a single UI. All Harper instances feature identical behavior whether they are hosted by us or by you.
+
+Harper Studio enables users to manage both Harper Cloud instances and privately hosted instances all from a single UI. All Harper instances feature identical behavior whether they are hosted by us or by you.

docs/administration/harper-studio/README.md

@@ -1,22 +1,23 @@
 # Create a Studio Account
+
 Start at the [Harper Studio sign up page](https://studio.harperdb.io/sign-up).
 
-1) Provide the following information:
-   * First Name
-   * Last Name
-   * Email Address
-   * Subdomain
-   
-     *Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https://c1-demo.harperdbcloud.com.*
-   * Coupon Code (optional)
-2) Review the Privacy Policy and Terms of Service.
-3) Click the sign up for free button.
-4) You will be taken to a new screen to add an account password. Enter your password.
-  *Passwords must be a minimum of 8 characters with at least 1 lower case character, 1 upper case character, 1 number, and 1 special character.*
-5) Click the add account password button.
+1. Provide the following information:
+   - First Name
+   - Last Name
+   - Email Address
+   - Subdomain
 
-You will receive a Studio welcome email confirming your registration.
+     _Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https://c1-demo.harperdbcloud.com._
 
+   - Coupon Code (optional)
 
+2. Review the Privacy Policy and Terms of Service.
+3. Click the sign up for free button.
+4. You will be taken to a new screen to add an account password. Enter your password.
+   _Passwords must be a minimum of 8 characters with at least 1 lower case character, 1 upper case character, 1 number, and 1 special character._
+5. Click the add account password button.
+
+You will receive a Studio welcome email confirming your registration.
 
-Note: Your email address will be used as your username and cannot be changed.
+Note: Your email address will be used as your username and cannot be changed.

docs/administration/harper-studio/create-account.md

@@ -2,6 +2,4 @@
 
 Enabling mixed content is required in cases where you would like to connect the Harper Studio to Harper Instances via HTTP. This should not be used for production systems, but may be convenient for development and testing purposes. Doing so will allow your browser to reach HTTP traffic, which is considered insecure, through an HTTPS site like the Studio.
 
-
-
-A comprehensive guide is provided by Adobe [here](https://experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).
+A comprehensive guide is provided by Adobe [here](https://experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).