From dcf0c9a372aeb8eec1a84db9edbad92b86ce6d60 Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Wed, 4 Aug 2021 08:51:01 -0400 Subject: [PATCH] Deploy folder structure Move content under deploy/kubernetes as per convention. This is required for DS builds. Signed-off-by: Ron Stone Change-Id: I5da5b554ea274cbd3b1a2c0f47bf649df1080173 --- doc/source/deploy/index.rs1 | 15 ------- doc/source/deploy/index.rst | 41 ++++++++++-------- .../{ => kubernetes}/common-components.rst | 0 .../deploy-edgeworker-nodes.rst | 0 ...-configuration-with-controller-storage.rst | 0 ...ptions-all-in-one-duplex-configuration.rst | 0 ...ptionsall-in-one-simplex-configuration.rst | 0 .../{ => kubernetes}/deployment-options.rst | 0 .../figures/edgeworker-deployment.png | Bin ...uster-deployment-configuration-options.png | Bin doc/source/deploy/kubernetes/index.rst | 26 +++++++++++ ...d-configuration-with-dedicated-storage.rst | 0 .../worker-function-performance-profiles.rst | 0 doc/source/releasenotes/r5_release.rst | 2 +- 14 files changed, 49 insertions(+), 35 deletions(-) delete mode 100644 doc/source/deploy/index.rs1 rename doc/source/deploy/{ => kubernetes}/common-components.rst (100%) rename doc/source/deploy/{ => kubernetes}/deploy-edgeworker-nodes.rst (100%) rename doc/source/deploy/{ => kubernetes}/deployment-and-configuration-options-standard-configuration-with-controller-storage.rst (100%) rename doc/source/deploy/{ => kubernetes}/deployment-config-options-all-in-one-duplex-configuration.rst (100%) rename doc/source/deploy/{ => kubernetes}/deployment-config-optionsall-in-one-simplex-configuration.rst (100%) rename doc/source/deploy/{ => kubernetes}/deployment-options.rst (100%) rename doc/source/deploy/{ => kubernetes}/figures/edgeworker-deployment.png (100%) rename doc/source/deploy/{ => kubernetes}/figures/kubernetes-cluster-deployment-configuration-options.png (100%) create mode 100644 doc/source/deploy/kubernetes/index.rst rename doc/source/deploy/{ => kubernetes}/standard-configuration-with-dedicated-storage.rst (100%) rename doc/source/deploy/{ => kubernetes}/worker-function-performance-profiles.rst (100%) diff --git a/doc/source/deploy/index.rs1 b/doc/source/deploy/index.rs1 deleted file mode 100644 index eec85670c..000000000 --- a/doc/source/deploy/index.rs1 +++ /dev/null @@ -1,15 +0,0 @@ -============================================ -|prod-long| Deployment Configuration Options -============================================ - -- Deployment Options - - - :ref:`Deployment Options ` - -- :ref:`Common Components ` -- :ref:`All-in-one Simplex Configuration ` -- :ref:`All-in-one Duplex Configuration ` -- :ref:`Standard Configuration with Controller Storage ` -- :ref:`Standard Configuration with Dedicated Storage ` -- :ref:`Worker Function Performance Profiles ` - diff --git a/doc/source/deploy/index.rst b/doc/source/deploy/index.rst index 16c57e0f9..bcc31600c 100644 --- a/doc/source/deploy/index.rst +++ b/doc/source/deploy/index.rst @@ -1,26 +1,29 @@ -.. Deployment Configurations file, created by - sphinx-quickstart on Thu Sep 3 15:14:59 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. _deployment-index: ========================= Deployment Configurations ========================= +A variety of |prod-long| deployment configuration options are supported. + +**All-in-one Simplex** + A single physical server providing all three cloud functions \(controller, + worker and storage\). + +**All-in-one Duplex \(up to 50 worker nodes\)** + Two HA-protected physical servers, both running all three cloud functions + \(controller, worker and storage\), optionally with up to 50 worker nodes + added to the cluster. + +**Standard with Storage Cluster on Controller Nodes** + A two node HA controller + storage node cluster, managing up to 200 worker + nodes. + +**Standard with Storage Cluster on dedicated Storage Nodes** + A two node HA controller node cluster with a 2-9 node Ceph storage + cluster, managing up to 200 worker nodes. + .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - deployment-options - common-components - deployment-config-optionsall-in-one-simplex-configuration - deployment-config-options-all-in-one-duplex-configuration - deployment-and-configuration-options-standard-configuration-with-controller-storage - standard-configuration-with-dedicated-storage - worker-function-performance-profiles - -.. only:: starlingx - - .. toctree:: - :maxdepth: 1 - - deploy-edgeworker-nodes + kubernetes/index \ No newline at end of file diff --git a/doc/source/deploy/common-components.rst b/doc/source/deploy/kubernetes/common-components.rst similarity index 100% rename from doc/source/deploy/common-components.rst rename to doc/source/deploy/kubernetes/common-components.rst diff --git a/doc/source/deploy/deploy-edgeworker-nodes.rst b/doc/source/deploy/kubernetes/deploy-edgeworker-nodes.rst similarity index 100% rename from doc/source/deploy/deploy-edgeworker-nodes.rst rename to doc/source/deploy/kubernetes/deploy-edgeworker-nodes.rst diff --git a/doc/source/deploy/deployment-and-configuration-options-standard-configuration-with-controller-storage.rst b/doc/source/deploy/kubernetes/deployment-and-configuration-options-standard-configuration-with-controller-storage.rst similarity index 100% rename from doc/source/deploy/deployment-and-configuration-options-standard-configuration-with-controller-storage.rst rename to doc/source/deploy/kubernetes/deployment-and-configuration-options-standard-configuration-with-controller-storage.rst diff --git a/doc/source/deploy/deployment-config-options-all-in-one-duplex-configuration.rst b/doc/source/deploy/kubernetes/deployment-config-options-all-in-one-duplex-configuration.rst similarity index 100% rename from doc/source/deploy/deployment-config-options-all-in-one-duplex-configuration.rst rename to doc/source/deploy/kubernetes/deployment-config-options-all-in-one-duplex-configuration.rst diff --git a/doc/source/deploy/deployment-config-optionsall-in-one-simplex-configuration.rst b/doc/source/deploy/kubernetes/deployment-config-optionsall-in-one-simplex-configuration.rst similarity index 100% rename from doc/source/deploy/deployment-config-optionsall-in-one-simplex-configuration.rst rename to doc/source/deploy/kubernetes/deployment-config-optionsall-in-one-simplex-configuration.rst diff --git a/doc/source/deploy/deployment-options.rst b/doc/source/deploy/kubernetes/deployment-options.rst similarity index 100% rename from doc/source/deploy/deployment-options.rst rename to doc/source/deploy/kubernetes/deployment-options.rst diff --git a/doc/source/deploy/figures/edgeworker-deployment.png b/doc/source/deploy/kubernetes/figures/edgeworker-deployment.png similarity index 100% rename from doc/source/deploy/figures/edgeworker-deployment.png rename to doc/source/deploy/kubernetes/figures/edgeworker-deployment.png diff --git a/doc/source/deploy/figures/kubernetes-cluster-deployment-configuration-options.png b/doc/source/deploy/kubernetes/figures/kubernetes-cluster-deployment-configuration-options.png similarity index 100% rename from doc/source/deploy/figures/kubernetes-cluster-deployment-configuration-options.png rename to doc/source/deploy/kubernetes/figures/kubernetes-cluster-deployment-configuration-options.png diff --git a/doc/source/deploy/kubernetes/index.rst b/doc/source/deploy/kubernetes/index.rst new file mode 100644 index 000000000..d94594237 --- /dev/null +++ b/doc/source/deploy/kubernetes/index.rst @@ -0,0 +1,26 @@ +.. Deployment Configurations file, created by + sphinx-quickstart on Thu Sep 3 15:14:59 2020. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +======== +Contents +======== + +.. toctree:: + :maxdepth: 1 + + deployment-options + common-components + deployment-config-optionsall-in-one-simplex-configuration + deployment-config-options-all-in-one-duplex-configuration + deployment-and-configuration-options-standard-configuration-with-controller-storage + standard-configuration-with-dedicated-storage + worker-function-performance-profiles + +.. only:: starlingx + + .. toctree:: + :maxdepth: 1 + + deploy-edgeworker-nodes diff --git a/doc/source/deploy/standard-configuration-with-dedicated-storage.rst b/doc/source/deploy/kubernetes/standard-configuration-with-dedicated-storage.rst similarity index 100% rename from doc/source/deploy/standard-configuration-with-dedicated-storage.rst rename to doc/source/deploy/kubernetes/standard-configuration-with-dedicated-storage.rst diff --git a/doc/source/deploy/worker-function-performance-profiles.rst b/doc/source/deploy/kubernetes/worker-function-performance-profiles.rst similarity index 100% rename from doc/source/deploy/worker-function-performance-profiles.rst rename to doc/source/deploy/kubernetes/worker-function-performance-profiles.rst diff --git a/doc/source/releasenotes/r5_release.rst b/doc/source/releasenotes/r5_release.rst index 5db6bf913..b5d70c3e5 100644 --- a/doc/source/releasenotes/r5_release.rst +++ b/doc/source/releasenotes/r5_release.rst @@ -99,7 +99,7 @@ associated user guides (if applicable). They usually do not meet worker nodes' minimum requirements but now they can be managed by StarlingX. - Guide: :doc:`Deploy Edgeworker Nodes ` + Guide: :doc:`Deploy Edgeworker Nodes ` * SNMP v3 support