GitBook: [#28] text

mobilecoinfoundation · Nov 17, 2021 · aeac200 · aeac200
1 parent 0ffc9e4
commit aeac200
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 30 deletions.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -26,5 +26,6 @@
   * [Provisioning with Azure](sgx-provisioning/provisioning-with-azure.md)
   * [Downloading the Consensus Server Software](sgx-provisioning/downloading-the-consensus-server-software/README.md)
     * [Downloading the Pre-Built Container from Docker Hub](sgx-provisioning/downloading-the-consensus-server-software/downloading-the-pre-built-container-from-docker-hub.md)
-    * [Running the Node](sgx-provisioning/downloading-the-consensus-server-software/running-the-node.md)
-* [Running the Node](running-the-node.md)
+* [Running the Node](running-the-node/README.md)
+  * [Running the Node in a Container (Preferred Method)](running-the-node/running-the-node-in-a-container-preferred-method/README.md)
+    * [Environment Variables: How to Configure Your Node](running-the-node/running-the-node-in-a-container-preferred-method/environment-variables-how-to-configure-your-node.md)
diff --git a/running-the-node.md → running-the-node/README.md b/running-the-node.md → running-the-node/README.md
diff --git a/running-the-node/running-the-node-in-a-container-preferred-method/README.md b/running-the-node/running-the-node-in-a-container-preferred-method/README.md
@@ -0,0 +1,29 @@
+# Running the Node in a Container (Preferred Method)
+
+### Requirements
+
+* TLS Certificates for your Node
+* Node Signer Keys (See Signing Consensus Messages) \[add bookmark]&#x20;
+* Network Configuration File/Consensus config file (network.toml - See Configuring your Node to Connect to Trusted and Untrusted Peers) \[add bookmark]
+* Ledger Storage Location
+* S3 Storage Location
+
+### Entrypoint and Container Processes
+
+Familiarize yourself with the entrypoint for the consensus docker container. \[add bookmark]
+
+{% hint style="info" %}
+It contains multiple processes working together to provide the full Consensus Validator functionality.
+{% endhint %}
+
+These processes are the following:
+
+| Process                 | Function                                                 |
+| ----------------------- | -------------------------------------------------------- |
+| `aesm_service`          | Provides EPID provisioning for the enclave.              |
+| `filebeat`              | Provides logging.                                        |
+| `mc-ledger-migration`   | Performs the ledger migration, if necessary, then stops. |
+| `ledger-distribution`   | Distributes the ledger to S3 archive**.**                |
+| `mc-admin-http-gateway` | Provides the admin panel to the Consensus Service.       |
+| `consensus-service`     | Runs the MobileCoin Consensus Service.                   |
+
diff --git a/...-container-preferred-method/environment-variables-how-to-configure-your-node.md b/...-container-preferred-method/environment-variables-how-to-configure-your-node.md
@@ -0,0 +1,12 @@
+# Environment Variables: How to Configure Your Node
+
+The following environment variables should be provided:
+
+| Variable                     | Value          | Function                                                                                                                                                                                                                                                                      |
+| ---------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `LOCAL_NODE_ID`              | address:port   | Local node name for logging. Should ideally match the value of `peer-responder-id` as provided to consensus-service.                                                                                                                                                          |
+| `NODE_LEDGER_DIR`            | Path to ledger | The location of the ledger. We suggest that this should be persistently stored outside the container and mounted in. On startup, if the contents of `NODE_LEDGER_DIR` are empty, then the origin block from within the container should be copied into the `NODE_LEDGER_DIR`. |
+| `CONSENSUS_ADMIN_URI`        | URI            | The URI for the admin http service which provides a management panel to the consensus service. The gateway is started in the container and is set to listen via this environment variable. Used by mc-admin-http-gateway.                                                     |
+| **AWS\_ACCESS\_KEY\_ID**     | AWS Credential | Should have write access to your S3 ledger archive bucket. Used by ledger-distribution.                                                                                                                                                                                       |
+| **AWS\_SECRET\_ACCESS\_KEY** | AWS Credential | Should have write access to your S3 ledger archive bucket. Used by ledger-distribution.                                                                                                                                                                                       |
+|                              |                |                                                                                                                                                                                                                                                                               |
diff --git a/sgx-provisioning/downloading-the-consensus-server-software/running-the-node.md b/sgx-provisioning/downloading-the-consensus-server-software/running-the-node.md