From b3689ea0c916eb1e3947b0835697d6360da04f58 Mon Sep 17 00:00:00 2001 From: troymc Date: Mon, 8 Aug 2016 18:16:41 +0200 Subject: [PATCH] docs: renamed deploy-on-aws to aws-testing-cluster --- .../appendices/example-rethinkdb-storage-setups.md | 2 +- .../{deploy-on-aws.md => aws-testing-cluster.md} | 12 ++++++++---- docs/source/clusters-feds/index.rst | 2 +- docs/source/clusters-feds/set-up-a-federation.md | 2 +- docs/source/introduction.md | 2 +- 5 files changed, 12 insertions(+), 8 deletions(-) rename docs/source/clusters-feds/{deploy-on-aws.md => aws-testing-cluster.md} (95%) diff --git a/docs/source/appendices/example-rethinkdb-storage-setups.md b/docs/source/appendices/example-rethinkdb-storage-setups.md index 2c863034..0fc4c273 100755 --- a/docs/source/appendices/example-rethinkdb-storage-setups.md +++ b/docs/source/appendices/example-rethinkdb-storage-setups.md @@ -2,7 +2,7 @@ ## Example Amazon EC2 Setups -We have some scripts for [deploying a _test_ BigchainDB cluster on AWS](../clusters-feds/deploy-on-aws.html). Those scripts include command sequences to set up storage for RethinkDB. +We have some scripts for [deploying a _test_ BigchainDB cluster on AWS](../clusters-feds/aws-testing-cluster.html). Those scripts include command sequences to set up storage for RethinkDB. In particular, look in the file [/deploy-cluster-aws/fabfile.py](https://github.com/bigchaindb/bigchaindb/blob/master/deploy-cluster-aws/fabfile.py), under `def prep_rethinkdb_storage(USING_EBS)`. Note that there are two cases: 1. **Using EBS ([Amazon Elastic Block Store](https://aws.amazon.com/ebs/)).** This is always an option, and for some instance types ("EBS-only"), it's the only option. diff --git a/docs/source/clusters-feds/deploy-on-aws.md b/docs/source/clusters-feds/aws-testing-cluster.md similarity index 95% rename from docs/source/clusters-feds/deploy-on-aws.md rename to docs/source/clusters-feds/aws-testing-cluster.md index 5dae4116..bfc4ddca 100644 --- a/docs/source/clusters-feds/deploy-on-aws.md +++ b/docs/source/clusters-feds/aws-testing-cluster.md @@ -1,12 +1,16 @@ -# Deploy a Cluster on AWS +# Deploy a Testing Cluster on AWS -This section explains a way to deploy a cluster of BigchainDB nodes on Amazon Web Services (AWS). We use some Bash and Python scripts to launch several instances (virtual servers) on Amazon Elastic Compute Cloud (EC2). Then we use Fabric to install RethinkDB and BigchainDB on all those instances. +This section explains a way to deploy a cluster of BigchainDB nodes on Amazon Web Services (AWS) for testing purposes. ## Why? -You might ask why one would want to deploy a centrally-controlled BigchainDB cluster. Isn't BigchainDB supposed to be decentralized, where each node is controlled by a different person or organization? +Why would anyone want to deploy a centrally-controlled BigchainDB cluster? Isn't BigchainDB supposed to be decentralized, where each node is controlled by a different person or organization? -Yes! These scripts are for deploying _test_ clusters, not production clusters. +Yes! These scripts are for deploying a testing cluster, not a production cluster. + +## How? + +We use some Bash and Python scripts to launch several instances (virtual servers) on Amazon Elastic Compute Cloud (EC2). Then we use Fabric to install RethinkDB and BigchainDB on all those instances. ## Python Setup diff --git a/docs/source/clusters-feds/index.rst b/docs/source/clusters-feds/index.rst index 433aa2cd..cf5196d3 100644 --- a/docs/source/clusters-feds/index.rst +++ b/docs/source/clusters-feds/index.rst @@ -9,7 +9,7 @@ BigchainDB Clusters & Federations set-up-a-federation backup - deploy-on-aws + aws-testing-cluster monitoring future-docs \ No newline at end of file diff --git a/docs/source/clusters-feds/set-up-a-federation.md b/docs/source/clusters-feds/set-up-a-federation.md index d7b4028a..c139eb4a 100644 --- a/docs/source/clusters-feds/set-up-a-federation.md +++ b/docs/source/clusters-feds/set-up-a-federation.md @@ -1,6 +1,6 @@ # Set Up a Federation -This section is about how to set up a BigchainDB _federation_, where each node is operated by a different operator. If you want to set up and run a BigchainDB cluster on AWS (where all nodes are operated by you), then see [the section about that](deploy-on-aws.html). +This section is about how to set up a BigchainDB _federation_, where each node is operated by a different operator. If you want to set up and run a testing cluster on AWS (where all nodes are operated by you), then see [the section about that](aws-testing-cluster.html). ## Initial Checklist diff --git a/docs/source/introduction.md b/docs/source/introduction.md index 5257c348..d95bb04c 100644 --- a/docs/source/introduction.md +++ b/docs/source/introduction.md @@ -9,7 +9,7 @@ You can read about the motivations, goals and high-level architecture in the [Bi * [Set up a stand-alone BigchainDB node for learning and experimenting: Quickstart](quickstart.html) * [Set up and run a dev/test node](dev-and-test/setup-run-node.html) -* [Deploy a cluster on AWS](clusters-feds/deploy-on-aws.html) +* [Deploy a testing cluster on AWS](clusters-feds/aws-testing-cluster.html) * [Set up and run a federation](clusters-feds/set-up-a-federation.html) (i.a. an organization with a BigchainDB cluster) (Instructions for setting up a client will be provided once there's a public testnet.)