mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
docs: renamed Starter Templates --> Templates
This commit is contained in:
parent
3a3f82b650
commit
2780b9406a
@ -1,15 +0,0 @@
|
|||||||
Cloud Deployment Starter Templates
|
|
||||||
==================================
|
|
||||||
|
|
||||||
We have some "starter 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. A full production node should meet the requirements outlined in the section on :doc:`production node assumptions, components and requirements <../nodes/index>`.
|
|
||||||
|
|
||||||
You don't have to use the tools we use in the starter templates (e.g. Terraform and Ansible). You can use whatever tools you prefer.
|
|
||||||
|
|
||||||
If you find the cloud deployment starter 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 & Federations section).
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
template-terraform-aws
|
|
||||||
template-ansible
|
|
||||||
azure-quickstart-template
|
|
@ -1,6 +1,6 @@
|
|||||||
# Azure Quickstart Template
|
# Azure Quickstart Template
|
||||||
|
|
||||||
If you didn't read the introduction to the [cloud deployment starter 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.
|
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.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
16
docs/server/source/cloud-deployment-templates/index.rst
Normal file
16
docs/server/source/cloud-deployment-templates/index.rst
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
Cloud Deployment Templates
|
||||||
|
==========================
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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 & Federations section).
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
template-terraform-aws
|
||||||
|
template-ansible
|
||||||
|
azure-quickstart-template
|
||||||
|
advanced-node-on-azure
|
@ -1,6 +1,6 @@
|
|||||||
# Template: Ansible Playbook to Run a BigchainDB Node on an Ubuntu Machine
|
# Template: Ansible Playbook to Run a BigchainDB Node on an Ubuntu Machine
|
||||||
|
|
||||||
If you didn't read the introduction to the [cloud deployment starter 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.
|
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.
|
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.
|
||||||
|
|
@ -1,6 +1,6 @@
|
|||||||
# Template: Using Terraform to Provision an Ubuntu Machine on AWS
|
# Template: Using Terraform to Provision an Ubuntu Machine on AWS
|
||||||
|
|
||||||
If you didn't read the introduction to the [cloud deployment starter 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.
|
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.
|
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.
|
||||||
|
|
@ -7,7 +7,7 @@ BigchainDB Server Documentation
|
|||||||
← Back to All BigchainDB Docs <https://docs.bigchaindb.com/en/latest/index.html>
|
← Back to All BigchainDB Docs <https://docs.bigchaindb.com/en/latest/index.html>
|
||||||
introduction
|
introduction
|
||||||
quickstart
|
quickstart
|
||||||
cloud-deployment-starter-templates/index
|
cloud-deployment-templates/index
|
||||||
nodes/index
|
nodes/index
|
||||||
dev-and-test/index
|
dev-and-test/index
|
||||||
server-reference/index
|
server-reference/index
|
||||||
|
@ -8,7 +8,7 @@ Note that there are a few kinds of nodes:
|
|||||||
|
|
||||||
- A **dev/test node** is a node created by a developer working on BigchainDB Server, e.g. for testing new or changed code. A dev/test node is typically run on the developer's local machine.
|
- A **dev/test node** is a node created by a developer working on BigchainDB Server, e.g. for testing new or changed code. A dev/test node is typically run on the developer's local machine.
|
||||||
|
|
||||||
- A **bare-bones node** is a node deployed in the cloud, either as part of a testing cluster or as a starting point before upgrading the node to be production-ready. Our cloud deployment starter templates deploy a bare-bones node, as do our scripts for deploying a testing cluster on AWS.
|
- A **bare-bones node** is a node deployed in the cloud, either as part of a testing cluster or as a starting point before upgrading the node to be production-ready. Our cloud deployment templates deploy a bare-bones node, as do our scripts for deploying a testing cluster on AWS.
|
||||||
|
|
||||||
- A **production node** is a node that is part of a federation's BigchainDB cluster. A production node has the most components and requirements.
|
- A **production node** is a node that is part of a federation's BigchainDB cluster. A production node has the most components and requirements.
|
||||||
|
|
||||||
@ -16,7 +16,7 @@ Note that there are a few kinds of nodes:
|
|||||||
## Setup Instructions for Various Cases
|
## Setup Instructions for Various Cases
|
||||||
|
|
||||||
* [Set up a local stand-alone BigchainDB node for learning and experimenting: Quickstart](quickstart.html)
|
* [Set up a local stand-alone BigchainDB node for learning and experimenting: Quickstart](quickstart.html)
|
||||||
* [Set up and run a bare-bones node in the cloud](cloud-deployment-starter-templates/index.html)
|
* [Set up and run a bare-bones node in the cloud](cloud-deployment-templates/index.html)
|
||||||
* [Set up and run a local dev/test node for developing and testing BigchainDB Server](dev-and-test/setup-run-node.html)
|
* [Set up and run a local dev/test node for developing and testing BigchainDB Server](dev-and-test/setup-run-node.html)
|
||||||
* [Deploy a testing cluster on AWS](clusters-feds/aws-testing-cluster.html)
|
* [Deploy a testing cluster on AWS](clusters-feds/aws-testing-cluster.html)
|
||||||
* [Set up and run a federation (including production nodes)](clusters-feds/set-up-a-federation.html)
|
* [Set up and run a federation (including production nodes)](clusters-feds/set-up-a-federation.html)
|
||||||
|
@ -8,6 +8,6 @@ We make some assumptions about production nodes:
|
|||||||
|
|
||||||
2. Each production node in a federation's cluster is managed by a different person or team.
|
2. Each production node in a federation's cluster is managed by a different person or team.
|
||||||
|
|
||||||
Because of the first assumption, we don't provide a detailed cookbook explaining how to secure a server, or other things that a sysadmin should know. (We do provide some [starter templates](../cloud-deployment-starter-templates/index.html), but those are just a starting point.)
|
Because of the first assumption, we don't provide a detailed cookbook explaining how to secure a server, or other things that a sysadmin should know. (We do provide some [templates](../cloud-deployment-templates/index.html), but those are just a starting point.)
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user