From edbe5deb466de8c66fb838d6f990b3df10460876 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Mon, 15 May 2017 15:25:01 +0200 Subject: [PATCH] docs: moved old cloud depl. templates to Appendices & edited intros --- .../azure-quickstart-template.md | 2 +- docs/server/source/appendices/index.rst | 3 +++ .../template-ansible.md | 4 ++-- .../template-terraform-aws.md | 4 ++-- .../cloud-deployment-templates/index.rst | 18 +++++++++--------- docs/server/source/index.rst | 4 ++-- 6 files changed, 19 insertions(+), 16 deletions(-) rename docs/server/source/{cloud-deployment-templates => appendices}/azure-quickstart-template.md (93%) rename docs/server/source/{cloud-deployment-templates => appendices}/template-ansible.md (94%) rename docs/server/source/{cloud-deployment-templates => appendices}/template-terraform-aws.md (95%) diff --git a/docs/server/source/cloud-deployment-templates/azure-quickstart-template.md b/docs/server/source/appendices/azure-quickstart-template.md similarity index 93% rename from docs/server/source/cloud-deployment-templates/azure-quickstart-template.md rename to docs/server/source/appendices/azure-quickstart-template.md index 1bf35a31..59f52fd3 100644 --- a/docs/server/source/cloud-deployment-templates/azure-quickstart-template.md +++ b/docs/server/source/appendices/azure-quickstart-template.md @@ -1,6 +1,6 @@ # Azure Quickstart Template -If you didn't read the introduction to the [cloud deployment templates](index.html), please do that now. The main point is that they're not for deploying a production node; they can be used as a starting point. +This page outlines how to run a single BigchainDB node on the Microsoft Azure public cloud, with RethinkDB as the database backend. It uses an Azure Quickstart Template. That template is dated because we now recommend using MongoDB instead of RethinkDB. That's why we moved this page to the Appendices. Note: There was an Azure quickstart template in the `blockchain` directory of Microsoft's `Azure/azure-quickstart-templates` repository on GitHub. It's gone now; it was replaced by the one described here. diff --git a/docs/server/source/appendices/index.rst b/docs/server/source/appendices/index.rst index 1c969c05..f5931e64 100755 --- a/docs/server/source/appendices/index.rst +++ b/docs/server/source/appendices/index.rst @@ -18,6 +18,9 @@ Appendices backend commands aws-setup + template-terraform-aws + template-ansible + azure-quickstart-template generate-key-pair-for-ssh firewall-notes ntp-notes diff --git a/docs/server/source/cloud-deployment-templates/template-ansible.md b/docs/server/source/appendices/template-ansible.md similarity index 94% rename from docs/server/source/cloud-deployment-templates/template-ansible.md rename to docs/server/source/appendices/template-ansible.md index f296a2cf..508d0555 100644 --- a/docs/server/source/cloud-deployment-templates/template-ansible.md +++ b/docs/server/source/appendices/template-ansible.md @@ -1,9 +1,9 @@ # Template: Ansible Playbook to Run a BigchainDB Node on an Ubuntu Machine -If you didn't read the introduction to the [cloud deployment templates](index.html), please do that now. The main point is that they're not for deploying a production node; they can be used as a starting point. - This page explains how to use [Ansible](https://www.ansible.com/) to install, configure and run all the software needed to run a one-machine BigchainDB node on a server running Ubuntu 16.04. +**Note: We're not actively maintaining the associated Ansible files (e.g. playbooks). They are RethinkDB-specific, even though we now recommend using MongoDB. You may find the old Ansible stuff useful nevertheless, which is why we moved this page to the Appendices rather than deleting it.** + ## Install Ansible diff --git a/docs/server/source/cloud-deployment-templates/template-terraform-aws.md b/docs/server/source/appendices/template-terraform-aws.md similarity index 95% rename from docs/server/source/cloud-deployment-templates/template-terraform-aws.md rename to docs/server/source/appendices/template-terraform-aws.md index d4a22e83..055a5ee3 100644 --- a/docs/server/source/cloud-deployment-templates/template-terraform-aws.md +++ b/docs/server/source/appendices/template-terraform-aws.md @@ -1,8 +1,8 @@ # Template: Using Terraform to Provision an Ubuntu Machine on AWS -If you didn't read the introduction to the [cloud deployment templates](index.html), please do that now. The main point is that they're not for deploying a production node; they can be used as a starting point. +This page explains a way to use [Terraform](https://www.terraform.io/) to provision an Ubuntu machine (i.e. an EC2 instance with Ubuntu 16.04) and other resources on [AWS](https://aws.amazon.com/). That machine can then be used to host a one-machine BigchainDB node, for example. -This page explains a way to use [Terraform](https://www.terraform.io/) to provision an Ubuntu machine (i.e. an EC2 instance with Ubuntu 16.04) and other resources on [AWS](https://aws.amazon.com/). That machine can then be used to host a one-machine BigchainDB node. +**Note: We're not actively maintaining the associated Terraform files. You may find them useful nevertheless, which is why we moved this page to the Appendices rather than deleting it.** ## Install Terraform diff --git a/docs/server/source/cloud-deployment-templates/index.rst b/docs/server/source/cloud-deployment-templates/index.rst index 41eec0ed..34a4b28b 100644 --- a/docs/server/source/cloud-deployment-templates/index.rst +++ b/docs/server/source/cloud-deployment-templates/index.rst @@ -1,18 +1,18 @@ -Cloud Deployment Templates -========================== +Production Deployment Template +============================== -We have some "templates" to deploy a basic, working, but bare-bones BigchainDB node on various cloud providers. They should *not* be used as-is to deploy a node for production. They can be used as a starting point. +This section outlines how *we* deploy production BigchainDB nodes and clusters +on Microsoft Azure +using Kubernetes. +We improve it constantly. +You may choose to use it as a template or reference for your own deployment, +but *we make no claim that it is suitable for your purposes*. +Feel free change things to suit your needs or preferences. -You don't have to use the tools we use in the templates. You can use whatever tools you prefer. - -If you find the cloud deployment templates for nodes helpful, then you may also be interested in our scripts for :doc:`deploying a testing cluster on AWS <../clusters-feds/aws-testing-cluster>` (documented in the Clusters section). .. toctree:: :maxdepth: 1 - template-terraform-aws - template-ansible - azure-quickstart-template template-kubernetes-azure node-on-kubernetes add-node-on-kubernetes diff --git a/docs/server/source/index.rst b/docs/server/source/index.rst index bf45aca0..0dee9174 100644 --- a/docs/server/source/index.rst +++ b/docs/server/source/index.rst @@ -7,14 +7,14 @@ BigchainDB Server Documentation ← Back to All BigchainDB Docs introduction quickstart - cloud-deployment-templates/index production-nodes/index + clusters-feds/index + cloud-deployment-templates/index dev-and-test/index server-reference/index http-client-server-api websocket-event-stream-api drivers-clients/index - clusters-feds/index data-models/index schema/transaction schema/vote