Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Removed Azure placeholder page. Clarified what Terraform does.

Browse Source
This commit is contained in:
troymc 2016-08-29 16:44:27 +02:00
parent 46e70d0c7f
commit 5afd4c9b17
4 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/source/prod-node-depl-tplt/index.rst
View File

@ -8,5 +8,4 @@ Production Node Deployment Template
install-terraform
install-ansible
prov-one-m-aws
prov-one-m-azure
start-one-m-node
run-one-m-node

12
docs/source/prod-node-depl-tplt/prov-one-m-aws.md
View File

@ -1,6 +1,14 @@
# Provision a One-Machine Node on AWS
This page describes how to provision the resources needed for a one-machine BigchainDB node on AWS using Terraform.
We have an example Terraform configuration (set of files) to provision all the resources needed to run a one-machine BigchainDB node on AWS:
* An instance on EC2
* A security group
* An EBS volume
* An elastic IP address
This page explains how to use Terraform to deploy our example Terraform configuration.
## Get Set
@ -31,7 +39,7 @@ terraform apply
Terraform will report its progress as it provisions all the resources. Once it's done, you can go to the Amazon EC2 web console and see the instance, its security group, its elastic IP, and its attached storage volumes (one for the root directory and one for RethinkDB storage).
At this point, there is no software installed on the instance except for Ubuntu 14.04 and whatever else came with the Amazon Machine Image (AMI) specified in the configuration. The next step is to use Ansible to install and configure all the necessary software.
At this point, there is no software installed on the instance except for Ubuntu 14.04 and whatever else came with the Amazon Machine Image (AMI) specified in the Terraform configuration (files). The next step is to use Ansible to install, configure and run all the necessary software.
## Optional: "Destroy"

3
docs/source/prod-node-depl-tplt/prov-one-m-azure.md
View File

@ -1,3 +0,0 @@
# Provision a One-Machine Node on Azure
This is just a placeholder so you can see the future structure of these docs.

19
docs/source/prod-node-depl-tplt/start-one-m-node.md → docs/source/prod-node-depl-tplt/run-one-m-node.md
View File

@ -1,6 +1,10 @@
# Start a One-Machine Node
# Run a One-Machine Node
In this step, we will install, configure and run all the software necessary to run BigchainDB, all on one machine.
We have an example Ansible playbook to install, configure and run a basic BigchainDB node on Ubuntu 14.04. It's in `.../bigchaindb/ntools/one-m/ansible/one-m-node.yml`.
When you run the playbook (as per the instructions below), it ensures all the necessary software is installed, configured and running. It can be used to get a BigchainDB node set up on a bare Ubuntu 14.04 machine, but it can also be used to ensure that everything is okay on a running BigchainDB node. (If you run the playbook against a host where everything is okay, then it won't change anything on that host.)
This page explains how to use our example Ansible playbook.
## Create an Ansible Inventory File
@ -20,7 +24,7 @@ but replace `192.0.2.128` with the IP address of the host.
## Run the Ansible Playbook
The next step is to run the Ansible playbook `one-m-node.yml`:
The next step is to run the Ansible playbook named `one-m-node.yml`:
```text
# cd to the directory .../bigchaindb/ntools/one-m/ansible
ansible-playbook -i hosts --private-key ~/.ssh/<key-name> one-m-node.yml
@ -30,7 +34,14 @@ where `<key-name>` should be replaced by the name of the SSH private key you cre
What did you just do? Running that playbook ensures all the software necessary for a one-machine BigchainDB node is installed, configured, and running properly. You can run that playbook on a regular schedule to ensure that the system stays properly configured. If something is okay, it does nothing; it only takes action when something is not as-desired.
Note: At the time of writing (Aug. 25, 2016), the playbook isn't complete, so not all of the above happens yet.
## Some Notes on the One-Machine Node You Just Got Running
* It ensures that the installed version of RethinkDB is `2.3.4~0trusty`. You can change that by changing the installation task.
* It uses a very basic RethinkDB configuration file based on `bigchaindb/ntools/one-m/ansible/roles/rethinkdb/templates/rethinkdb.conf.j2`.
* If you edit the RethinkDB configuration file, then running the Ansible playbook will **not** restart RethinkDB for you. You must do that manually. (You could just stop it using `sudo killall -9 rethinkdb` and then run the playbook to get it started again.)
* It generates and uses a default BigchainDB configuration file, which is stores in `~/.bigchaindb` (the default location).
* If you edit the BigchainDB configuration file, then running the Ansible playbook will **not* restart BigchainDB for you. You must do that manually. (You could just stop it using `sudo killall -9 bigchaindb` and then run the playbook to get it started again.)
## Optional: Create an Ansible Config File