From 045136f9a69a9ee2ad271ca12362817a5a95828d Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Thu, 23 Aug 2018 09:44:12 +0200 Subject: [PATCH] Problem: Not clear that simple-network-setup (old name) is the analog of Kubernetes Deployment template (#2475) Solution: Rename it the "Simple Deployment Template" & fix all refs --- docs/server/source/index.rst | 2 +- docs/server/source/introduction.md | 2 +- .../k8s-deployment-template/architecture.rst | 2 +- .../bigchaindb-network-on-kubernetes.rst | 2 +- .../source/k8s-deployment-template/index.rst | 4 +++- .../node-config-map-and-secrets.rst | 2 +- .../node-on-kubernetes.rst | 2 +- .../tectonic-azure.rst | 2 +- .../template-kubernetes-azure.rst | 2 +- .../upgrade-on-kubernetes.rst | 2 +- .../k8s-deployment-template/workflow.rst | 2 +- .../source/network-operations/index.rst | 12 ----------- .../simple-deployment-template/index.rst | 20 +++++++++++++++++++ .../network-setup.md | 0 14 files changed, 33 insertions(+), 23 deletions(-) delete mode 100644 docs/server/source/network-operations/index.rst create mode 100644 docs/server/source/simple-deployment-template/index.rst rename docs/server/source/{network-operations => simple-deployment-template}/network-setup.md (100%) diff --git a/docs/server/source/index.rst b/docs/server/source/index.rst index e21fdaad..ced2a433 100644 --- a/docs/server/source/index.rst +++ b/docs/server/source/index.rst @@ -12,9 +12,9 @@ BigchainDB Server Documentation ← Back to All BigchainDB Docs introduction quickstart - network-operations/index production-nodes/index networks + simple-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 bd15d61e..d71f30cc 100644 --- a/docs/server/source/introduction.md +++ b/docs/server/source/introduction.md @@ -22,7 +22,7 @@ Note that there are a few kinds of nodes: - [Quickstart](quickstart.html) - [Set up a local BigchainDB node for development, experimenting and testing](https://docs.bigchaindb.com/projects/contributing/en/latest/dev-setup-coding-and-contribution-process/index.html) -- [Set up and run a BigchainDB network](network-operations/index.html) +- [Set up and run a BigchainDB network](simple-deployment-template/index.html) ## Can I Help? diff --git a/docs/server/source/k8s-deployment-template/architecture.rst b/docs/server/source/k8s-deployment-template/architecture.rst index 62079bc3..95a2cf8f 100644 --- a/docs/server/source/k8s-deployment-template/architecture.rst +++ b/docs/server/source/k8s-deployment-template/architecture.rst @@ -12,7 +12,7 @@ Architecture of a BigchainDB Node Running in a Kubernetes Cluster (three for the master and two for your app's containers). Therefore we don't recommend using Kubernetes to run a BigchainDB node if that's the only thing the Kubernetes cluster will be running. - Instead, see **How to Set Up a BigchainDB Network**. + Instead, see our :ref:`simple-deployment-template`. If your organization already *has* a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful. diff --git a/docs/server/source/k8s-deployment-template/bigchaindb-network-on-kubernetes.rst b/docs/server/source/k8s-deployment-template/bigchaindb-network-on-kubernetes.rst index 0af0649e..4f40f9c3 100644 --- a/docs/server/source/k8s-deployment-template/bigchaindb-network-on-kubernetes.rst +++ b/docs/server/source/k8s-deployment-template/bigchaindb-network-on-kubernetes.rst @@ -14,7 +14,7 @@ Kubernetes Template: Deploying a BigchainDB network (three for the master and two for your app's containers). Therefore we don't recommend using Kubernetes to run a BigchainDB node if that's the only thing the Kubernetes cluster will be running. - Instead, see **How to Set Up a BigchainDB Network**. + Instead, see our :ref:`simple-deployment-template`. If your organization already *has* a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful. diff --git a/docs/server/source/k8s-deployment-template/index.rst b/docs/server/source/k8s-deployment-template/index.rst index abc1de07..17174815 100644 --- a/docs/server/source/k8s-deployment-template/index.rst +++ b/docs/server/source/k8s-deployment-template/index.rst @@ -3,6 +3,8 @@ SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) Code is Apache-2.0 and docs are CC-BY-4.0 +.. _kubernetes-deployment-template: + Kubernetes Deployment Template ============================== @@ -12,7 +14,7 @@ Kubernetes Deployment Template (three for the master and two for your app's containers). Therefore we don't recommend using Kubernetes to run a BigchainDB node if that's the only thing the Kubernetes cluster will be running. - Instead, see **How to Set Up a BigchainDB Network**. + Instead, see our :ref:`simple-deployment-template`. If your organization already *has* a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful. diff --git a/docs/server/source/k8s-deployment-template/node-config-map-and-secrets.rst b/docs/server/source/k8s-deployment-template/node-config-map-and-secrets.rst index cbd18008..92c9d585 100644 --- a/docs/server/source/k8s-deployment-template/node-config-map-and-secrets.rst +++ b/docs/server/source/k8s-deployment-template/node-config-map-and-secrets.rst @@ -14,7 +14,7 @@ How to Configure a BigchainDB Node (three for the master and two for your app's containers). Therefore we don't recommend using Kubernetes to run a BigchainDB node if that's the only thing the Kubernetes cluster will be running. - Instead, see **How to Set Up a BigchainDB Network**. + Instead, see our :ref:`simple-deployment-template`. If your organization already *has* a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful. diff --git a/docs/server/source/k8s-deployment-template/node-on-kubernetes.rst b/docs/server/source/k8s-deployment-template/node-on-kubernetes.rst index c2735563..30d40497 100644 --- a/docs/server/source/k8s-deployment-template/node-on-kubernetes.rst +++ b/docs/server/source/k8s-deployment-template/node-on-kubernetes.rst @@ -14,7 +14,7 @@ Kubernetes Template: Deploy a Single BigchainDB Node (three for the master and two for your app's containers). Therefore we don't recommend using Kubernetes to run a BigchainDB node if that's the only thing the Kubernetes cluster will be running. - Instead, see **How to Set Up a BigchainDB Network**. + Instead, see our :ref:`simple-deployment-template`. If your organization already *has* a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful. diff --git a/docs/server/source/k8s-deployment-template/tectonic-azure.rst b/docs/server/source/k8s-deployment-template/tectonic-azure.rst index 01b571c8..be3bca61 100644 --- a/docs/server/source/k8s-deployment-template/tectonic-azure.rst +++ b/docs/server/source/k8s-deployment-template/tectonic-azure.rst @@ -12,7 +12,7 @@ Walkthrough: Deploy a Kubernetes Cluster on Azure using Tectonic by CoreOS (three for the master and two for your app's containers). Therefore we don't recommend using Kubernetes to run a BigchainDB node if that's the only thing the Kubernetes cluster will be running. - Instead, see **How to Set Up a BigchainDB Network**. + Instead, see our :ref:`simple-deployment-template`. If your organization already *has* a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful. diff --git a/docs/server/source/k8s-deployment-template/template-kubernetes-azure.rst b/docs/server/source/k8s-deployment-template/template-kubernetes-azure.rst index 410797a1..5fb1af4e 100644 --- a/docs/server/source/k8s-deployment-template/template-kubernetes-azure.rst +++ b/docs/server/source/k8s-deployment-template/template-kubernetes-azure.rst @@ -12,7 +12,7 @@ Template: Deploy a Kubernetes Cluster on Azure (three for the master and two for your app's containers). Therefore we don't recommend using Kubernetes to run a BigchainDB node if that's the only thing the Kubernetes cluster will be running. - Instead, see **How to Set Up a BigchainDB Network**. + Instead, see our :ref:`simple-deployment-template`. If your organization already *has* a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful. diff --git a/docs/server/source/k8s-deployment-template/upgrade-on-kubernetes.rst b/docs/server/source/k8s-deployment-template/upgrade-on-kubernetes.rst index 870642ae..31d20ed5 100644 --- a/docs/server/source/k8s-deployment-template/upgrade-on-kubernetes.rst +++ b/docs/server/source/k8s-deployment-template/upgrade-on-kubernetes.rst @@ -12,7 +12,7 @@ Kubernetes Template: Upgrade all Software in a BigchainDB Node (three for the master and two for your app's containers). Therefore we don't recommend using Kubernetes to run a BigchainDB node if that's the only thing the Kubernetes cluster will be running. - Instead, see **How to Set Up a BigchainDB Network**. + Instead, see our :ref:`simple-deployment-template`. If your organization already *has* a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful. diff --git a/docs/server/source/k8s-deployment-template/workflow.rst b/docs/server/source/k8s-deployment-template/workflow.rst index 028d539f..5ee76809 100644 --- a/docs/server/source/k8s-deployment-template/workflow.rst +++ b/docs/server/source/k8s-deployment-template/workflow.rst @@ -14,7 +14,7 @@ Overview (three for the master and two for your app's containers). Therefore we don't recommend using Kubernetes to run a BigchainDB node if that's the only thing the Kubernetes cluster will be running. - Instead, see **How to Set Up a BigchainDB Network**. + Instead, see our :ref:`simple-deployment-template`. If your organization already *has* a big Kubernetes cluster running many containers, and your organization has people who know Kubernetes, then this Kubernetes deployment template might be helpful. diff --git a/docs/server/source/network-operations/index.rst b/docs/server/source/network-operations/index.rst deleted file mode 100644 index 938bbff4..00000000 --- a/docs/server/source/network-operations/index.rst +++ /dev/null @@ -1,12 +0,0 @@ - -.. Copyright BigchainDB GmbH and BigchainDB contributors - SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) - Code is Apache-2.0 and docs are CC-BY-4.0 - -How to Set Up and Run a BigchainDB Network -========================================== - -.. toctree:: - :maxdepth: 1 - - network-setup diff --git a/docs/server/source/simple-deployment-template/index.rst b/docs/server/source/simple-deployment-template/index.rst new file mode 100644 index 00000000..90ca20ef --- /dev/null +++ b/docs/server/source/simple-deployment-template/index.rst @@ -0,0 +1,20 @@ + +.. Copyright BigchainDB GmbH and BigchainDB contributors + SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) + Code is Apache-2.0 and docs are CC-BY-4.0 + +.. _simple-deployment-template: + +Simple Deployment Template +========================== + +This section describes *one* way to deploy a BigchainDB network. +You can modify it as you see fit. +It's "simple" in the sense that each BigchainDB node is installed +and run on a single virtual machine (or real machine). +We also have a :ref:`kubernetes-deployment-template` (not simple). + +.. toctree:: + :maxdepth: 1 + + network-setup diff --git a/docs/server/source/network-operations/network-setup.md b/docs/server/source/simple-deployment-template/network-setup.md similarity index 100% rename from docs/server/source/network-operations/network-setup.md rename to docs/server/source/simple-deployment-template/network-setup.md