From b6f7e6307a8a2e9b46fa98f18d2c0ff0ad42f2fa Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Wed, 7 Jun 2017 16:45:42 +0200 Subject: [PATCH] Redid PR #1493 --- docs/server/source/index.rst | 2 +- docs/server/source/introduction.md | 10 +++++++--- .../add-node-on-kubernetes.rst | 0 .../ca-installation.rst | 0 .../client-tls-certificate.rst | 0 .../cloud-manager.rst | 0 .../easy-rsa.rst | 0 .../index.rst | 0 .../log-analytics.rst | 0 .../node-config-map-and-secrets.rst | 0 .../node-on-kubernetes.rst | 0 .../revoke-tls-certificate.rst | 0 .../server-tls-certificate.rst | 0 .../template-kubernetes-azure.rst | 0 .../upgrade-on-kubernetes.rst | 0 .../workflow.rst | 0 .../server/source/production-nodes/node-assumptions.md | 2 +- docs/server/source/production-nodes/setup-run-node.md | 2 +- 18 files changed, 10 insertions(+), 6 deletions(-) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/add-node-on-kubernetes.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/ca-installation.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/client-tls-certificate.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/cloud-manager.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/easy-rsa.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/index.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/log-analytics.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/node-config-map-and-secrets.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/node-on-kubernetes.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/revoke-tls-certificate.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/server-tls-certificate.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/template-kubernetes-azure.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/upgrade-on-kubernetes.rst (100%) rename docs/server/source/{cloud-deployment-templates => production-deployment-template}/workflow.rst (100%) diff --git a/docs/server/source/index.rst b/docs/server/source/index.rst index 0dee9174..1dc80857 100644 --- a/docs/server/source/index.rst +++ b/docs/server/source/index.rst @@ -9,7 +9,7 @@ BigchainDB Server Documentation quickstart production-nodes/index clusters-feds/index - cloud-deployment-templates/index + production-deployment-template/index dev-and-test/index server-reference/index http-client-server-api diff --git a/docs/server/source/introduction.md b/docs/server/source/introduction.md index 02cf5ecf..70066da2 100644 --- a/docs/server/source/introduction.md +++ b/docs/server/source/introduction.md @@ -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 **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 **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. - A **production node** is a node that is part of a consortium's BigchainDB cluster. A production node has the most components and requirements. @@ -16,11 +16,15 @@ Note that there are a few kinds of nodes: ## Setup Instructions for Various Cases * [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-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) -* [Deploy a testing cluster on AWS](clusters-feds/aws-testing-cluster.html) * [Set up and run a cluster (including production nodes)](clusters-feds/set-up-a-cluster.html) +There are some old RethinkDB-based deployment instructions as well: + +* [Deploy a bare-bones RethinkDB-based node on Azure](appendices/azure-quickstart-template.html) +* [Deploy a bare-bones RethinkDB-based node on any Ubuntu machine with Ansible](appendices/template-ansible.html) +* [Deploy a RethinkDB-based testing cluster on AWS](clusters-feds/aws-testing-cluster.html) + Instructions for setting up a client will be provided once there's a public test net. diff --git a/docs/server/source/cloud-deployment-templates/add-node-on-kubernetes.rst b/docs/server/source/production-deployment-template/add-node-on-kubernetes.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/add-node-on-kubernetes.rst rename to docs/server/source/production-deployment-template/add-node-on-kubernetes.rst diff --git a/docs/server/source/cloud-deployment-templates/ca-installation.rst b/docs/server/source/production-deployment-template/ca-installation.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/ca-installation.rst rename to docs/server/source/production-deployment-template/ca-installation.rst diff --git a/docs/server/source/cloud-deployment-templates/client-tls-certificate.rst b/docs/server/source/production-deployment-template/client-tls-certificate.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/client-tls-certificate.rst rename to docs/server/source/production-deployment-template/client-tls-certificate.rst diff --git a/docs/server/source/cloud-deployment-templates/cloud-manager.rst b/docs/server/source/production-deployment-template/cloud-manager.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/cloud-manager.rst rename to docs/server/source/production-deployment-template/cloud-manager.rst diff --git a/docs/server/source/cloud-deployment-templates/easy-rsa.rst b/docs/server/source/production-deployment-template/easy-rsa.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/easy-rsa.rst rename to docs/server/source/production-deployment-template/easy-rsa.rst diff --git a/docs/server/source/cloud-deployment-templates/index.rst b/docs/server/source/production-deployment-template/index.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/index.rst rename to docs/server/source/production-deployment-template/index.rst diff --git a/docs/server/source/cloud-deployment-templates/log-analytics.rst b/docs/server/source/production-deployment-template/log-analytics.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/log-analytics.rst rename to docs/server/source/production-deployment-template/log-analytics.rst diff --git a/docs/server/source/cloud-deployment-templates/node-config-map-and-secrets.rst b/docs/server/source/production-deployment-template/node-config-map-and-secrets.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/node-config-map-and-secrets.rst rename to docs/server/source/production-deployment-template/node-config-map-and-secrets.rst diff --git a/docs/server/source/cloud-deployment-templates/node-on-kubernetes.rst b/docs/server/source/production-deployment-template/node-on-kubernetes.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/node-on-kubernetes.rst rename to docs/server/source/production-deployment-template/node-on-kubernetes.rst diff --git a/docs/server/source/cloud-deployment-templates/revoke-tls-certificate.rst b/docs/server/source/production-deployment-template/revoke-tls-certificate.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/revoke-tls-certificate.rst rename to docs/server/source/production-deployment-template/revoke-tls-certificate.rst diff --git a/docs/server/source/cloud-deployment-templates/server-tls-certificate.rst b/docs/server/source/production-deployment-template/server-tls-certificate.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/server-tls-certificate.rst rename to docs/server/source/production-deployment-template/server-tls-certificate.rst diff --git a/docs/server/source/cloud-deployment-templates/template-kubernetes-azure.rst b/docs/server/source/production-deployment-template/template-kubernetes-azure.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/template-kubernetes-azure.rst rename to docs/server/source/production-deployment-template/template-kubernetes-azure.rst diff --git a/docs/server/source/cloud-deployment-templates/upgrade-on-kubernetes.rst b/docs/server/source/production-deployment-template/upgrade-on-kubernetes.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/upgrade-on-kubernetes.rst rename to docs/server/source/production-deployment-template/upgrade-on-kubernetes.rst diff --git a/docs/server/source/cloud-deployment-templates/workflow.rst b/docs/server/source/production-deployment-template/workflow.rst similarity index 100% rename from docs/server/source/cloud-deployment-templates/workflow.rst rename to docs/server/source/production-deployment-template/workflow.rst diff --git a/docs/server/source/production-nodes/node-assumptions.md b/docs/server/source/production-nodes/node-assumptions.md index 9d52aa5a..136b6415 100644 --- a/docs/server/source/production-nodes/node-assumptions.md +++ b/docs/server/source/production-nodes/node-assumptions.md @@ -13,4 +13,4 @@ We make some assumptions about production nodes: You can use RethinkDB when building prototypes, but we don't advise or support using it in production. -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.) +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, but those are just starting points. diff --git a/docs/server/source/production-nodes/setup-run-node.md b/docs/server/source/production-nodes/setup-run-node.md index 6e7ddbea..0370f229 100644 --- a/docs/server/source/production-nodes/setup-run-node.md +++ b/docs/server/source/production-nodes/setup-run-node.md @@ -2,7 +2,7 @@ This is a page of general guidelines for setting up a production BigchainDB node. Before continuing, make sure you've read the pages about production node [assumptions](node-assumptions.html), [components](node-components.html) and [requirements](node-requirements.html). -Note: These are just guidelines. You can modify them to suit your needs. For example, if you want to initialize the MongoDB replica set before installing BigchainDB, you _can_ do that. If you'd prefer to use Docker and Kubernetes, you can (and [we have a template](../cloud-deployment-templates/node-on-kubernetes.html)). We don't cover all possible setup procedures here. +Note: These are just guidelines. You can modify them to suit your needs. For example, if you want to initialize the MongoDB replica set before installing BigchainDB, you _can_ do that. If you'd prefer to use Docker and Kubernetes, you can (and [we have a template](../production-deployment-template/index.html)). We don't cover all possible setup procedures here. ## Security Guidelines