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
This commit is contained in:
Troy McConaghy 2018-08-23 09:44:12 +02:00 committed by Shahbaz Nazir
parent 90f2fdfc23
commit 045136f9a6
14 changed files with 33 additions and 23 deletions

View File

@ -12,9 +12,9 @@ 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
network-operations/index
production-nodes/index production-nodes/index
networks networks
simple-deployment-template/index
dev-and-test/index dev-and-test/index
server-reference/index server-reference/index
http-client-server-api http-client-server-api

View File

@ -22,7 +22,7 @@ Note that there are a few kinds of nodes:
- [Quickstart](quickstart.html) - [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 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? ## Can I Help?

View File

@ -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). (three for the master and two for your app's containers).
Therefore we don't recommend using Kubernetes to run a BigchainDB node Therefore we don't recommend using Kubernetes to run a BigchainDB node
if that's the only thing the Kubernetes cluster will be running. 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, If your organization already *has* a big Kubernetes cluster running many containers,
and your organization has people who know Kubernetes, and your organization has people who know Kubernetes,
then this Kubernetes deployment template might be helpful. then this Kubernetes deployment template might be helpful.

View File

@ -14,7 +14,7 @@ Kubernetes Template: Deploying a BigchainDB network
(three for the master and two for your app's containers). (three for the master and two for your app's containers).
Therefore we don't recommend using Kubernetes to run a BigchainDB node Therefore we don't recommend using Kubernetes to run a BigchainDB node
if that's the only thing the Kubernetes cluster will be running. 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, If your organization already *has* a big Kubernetes cluster running many containers,
and your organization has people who know Kubernetes, and your organization has people who know Kubernetes,
then this Kubernetes deployment template might be helpful. then this Kubernetes deployment template might be helpful.

View File

@ -3,6 +3,8 @@
SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0) SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)
Code is Apache-2.0 and docs are CC-BY-4.0 Code is Apache-2.0 and docs are CC-BY-4.0
.. _kubernetes-deployment-template:
Kubernetes Deployment Template Kubernetes Deployment Template
============================== ==============================
@ -12,7 +14,7 @@ Kubernetes Deployment Template
(three for the master and two for your app's containers). (three for the master and two for your app's containers).
Therefore we don't recommend using Kubernetes to run a BigchainDB node Therefore we don't recommend using Kubernetes to run a BigchainDB node
if that's the only thing the Kubernetes cluster will be running. 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, If your organization already *has* a big Kubernetes cluster running many containers,
and your organization has people who know Kubernetes, and your organization has people who know Kubernetes,
then this Kubernetes deployment template might be helpful. then this Kubernetes deployment template might be helpful.

View File

@ -14,7 +14,7 @@ How to Configure a BigchainDB Node
(three for the master and two for your app's containers). (three for the master and two for your app's containers).
Therefore we don't recommend using Kubernetes to run a BigchainDB node Therefore we don't recommend using Kubernetes to run a BigchainDB node
if that's the only thing the Kubernetes cluster will be running. 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, If your organization already *has* a big Kubernetes cluster running many containers,
and your organization has people who know Kubernetes, and your organization has people who know Kubernetes,
then this Kubernetes deployment template might be helpful. then this Kubernetes deployment template might be helpful.

View File

@ -14,7 +14,7 @@ Kubernetes Template: Deploy a Single BigchainDB Node
(three for the master and two for your app's containers). (three for the master and two for your app's containers).
Therefore we don't recommend using Kubernetes to run a BigchainDB node Therefore we don't recommend using Kubernetes to run a BigchainDB node
if that's the only thing the Kubernetes cluster will be running. 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, If your organization already *has* a big Kubernetes cluster running many containers,
and your organization has people who know Kubernetes, and your organization has people who know Kubernetes,
then this Kubernetes deployment template might be helpful. then this Kubernetes deployment template might be helpful.

View File

@ -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). (three for the master and two for your app's containers).
Therefore we don't recommend using Kubernetes to run a BigchainDB node Therefore we don't recommend using Kubernetes to run a BigchainDB node
if that's the only thing the Kubernetes cluster will be running. 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, If your organization already *has* a big Kubernetes cluster running many containers,
and your organization has people who know Kubernetes, and your organization has people who know Kubernetes,
then this Kubernetes deployment template might be helpful. then this Kubernetes deployment template might be helpful.

View File

@ -12,7 +12,7 @@ Template: Deploy a Kubernetes Cluster on Azure
(three for the master and two for your app's containers). (three for the master and two for your app's containers).
Therefore we don't recommend using Kubernetes to run a BigchainDB node Therefore we don't recommend using Kubernetes to run a BigchainDB node
if that's the only thing the Kubernetes cluster will be running. 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, If your organization already *has* a big Kubernetes cluster running many containers,
and your organization has people who know Kubernetes, and your organization has people who know Kubernetes,
then this Kubernetes deployment template might be helpful. then this Kubernetes deployment template might be helpful.

View File

@ -12,7 +12,7 @@ Kubernetes Template: Upgrade all Software in a BigchainDB Node
(three for the master and two for your app's containers). (three for the master and two for your app's containers).
Therefore we don't recommend using Kubernetes to run a BigchainDB node Therefore we don't recommend using Kubernetes to run a BigchainDB node
if that's the only thing the Kubernetes cluster will be running. 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, If your organization already *has* a big Kubernetes cluster running many containers,
and your organization has people who know Kubernetes, and your organization has people who know Kubernetes,
then this Kubernetes deployment template might be helpful. then this Kubernetes deployment template might be helpful.

View File

@ -14,7 +14,7 @@ Overview
(three for the master and two for your app's containers). (three for the master and two for your app's containers).
Therefore we don't recommend using Kubernetes to run a BigchainDB node Therefore we don't recommend using Kubernetes to run a BigchainDB node
if that's the only thing the Kubernetes cluster will be running. 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, If your organization already *has* a big Kubernetes cluster running many containers,
and your organization has people who know Kubernetes, and your organization has people who know Kubernetes,
then this Kubernetes deployment template might be helpful. then this Kubernetes deployment template might be helpful.

View File

@ -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

View File

@ -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