diff --git a/doc/source/installation_guide/controller_storage.rst b/doc/source/installation_guide/controller_storage.rst index 1c3bf71c5..f38f21f2b 100644 --- a/doc/source/installation_guide/controller_storage.rst +++ b/doc/source/installation_guide/controller_storage.rst @@ -4,6 +4,18 @@ StarlingX/Installation Guide Virtual Environment/Controller Storage =================================================================== +---------------------- +Deployment Terminology +---------------------- + +.. include:: deployment_terminology.rst + :start-after: incl-standard-controller-deployment-terminology: + :end-before: incl-standard-controller-deployment-terminology-end: + +.. include:: deployment_terminology.rst + :start-after: incl-common-deployment-terminology: + :end-before: incl-common-deployment-terminology-end: + ----------------- Preparing Servers ----------------- diff --git a/doc/source/installation_guide/dedicated_storage.rst b/doc/source/installation_guide/dedicated_storage.rst index 9c37ae773..706a3e25f 100644 --- a/doc/source/installation_guide/dedicated_storage.rst +++ b/doc/source/installation_guide/dedicated_storage.rst @@ -4,6 +4,23 @@ StarlingX/Installation Guide Virtual Environment/Dedicated Storage ================================================================== +---------------------- +Deployment Terminology +---------------------- + +.. include:: deployment_terminology.rst + :start-after: incl-standard-controller-deployment-terminology: + :end-before: incl-standard-controller-deployment-terminology-end: + +.. include:: deployment_terminology.rst + :start-after: incl-dedicated-storage-deployment-terminology: + :end-before: incl-dedicated-storage-deployment-terminology-end: + +.. include:: deployment_terminology.rst + :start-after: incl-common-deployment-terminology: + :end-before: incl-common-deployment-terminology-end: + + ----------------- Preparing Servers ----------------- diff --git a/doc/source/installation_guide/deployment_terminology.rst b/doc/source/installation_guide/deployment_terminology.rst new file mode 100644 index 000000000..90a628eac --- /dev/null +++ b/doc/source/installation_guide/deployment_terminology.rst @@ -0,0 +1,119 @@ +.. _incl-simplex-deployment-terminology: + +**All-In-One Controller Node** + A single physical node that provides a Controller Function, Compute + Function, and Storage Function. + +.. _incl-simplex-deployment-terminology-end: + + +.. _incl-standard-controller-deployment-terminology: + +**Controller Node / Function** + A node that runs Cloud Control Function for managing Cloud Resources. + + - Runs Cloud Control Functions for managing Cloud Resources. + - Runs all OpenStack Control Functions (e.g. managing Images, Virtual + Volumes, Virtual Network, and Virtual Machines). + - Can be part of a two-node HA Control Node Cluster for running Control + Functions either Active/Active or Active/Standby. + +**Compute ( & Network ) Node / Function** + A node that hosts applications in Virtual Machines using Compute Resources + such as CPU, Memory, and Disk. + + - Runs Virtual Switch for realizing virtual networks. + - Provides L3 Routing and NET Services. + +.. _incl-standard-controller-deployment-terminology-end: + + +.. _incl-dedicated-storage-deployment-terminology: + +**Storage Node / Function** + A node that contains a set of Disks (e.g. SATA, SAS, SSD, and/or NVMe). + + - Runs CEPH Distributed Storage Software. + - Part of an HA multi-node CEPH Storage Cluster supporting a replication + factor of two or three, Journal Caching, and Class Tiering. + - Provides HA Persistent Storage for Images, Virtual Volumes + (i.e. Block Storage), and Object Storage. + +.. _incl-dedicated-storage-deployment-terminology-end: + +.. _incl-common-deployment-terminology: + +**OAM Network** + The network on which all external StarlingX Platform APIs are exposed, + (i.e. REST APIs, Horizon Web Server, SSH, and SNMP), typically 1GE. + + Only Controller type nodes are required to be connected to the OAM + Network. + +**Management Network** + A private network (i.e. not connected externally), tipically 10GE, + used for the following: + + - Internal OpenStack / StarlingX monitoring and control. + - VM I/O access to a storage cluster. + + All nodes are required to be connected to the Management Network. + +**Data Network(s)** + Networks on which the OpenStack / Neutron Provider Networks are realized + and become the VM Tenant Networks. + + Only Compute type and All-in-One type nodes are required to be connected + to the Data Network(s); these node types require one or more interface(s) + on the Data Network(s). + +**IPMI Network** + An optional network on which IPMI interfaces of all nodes are connected. + The network must be reachable using L3/IP from the Controller's OAM + Interfaces. + + You can optionally connect all node types to the IPMI Network. + +**PXEBoot Network** + An optional network for Controllers to boot/install other nodes over the + network. + + By default, Controllers use the Management Network for boot/install of other + nodes in the openstack cloud. If this optional network is used, all node + types are required to be connected to the PXEBoot Network. + + A PXEBoot network is required for a variety of special case situations: + + - Cases where the Management Network must be IPv6: + + - IPv6 does not support PXEBoot. Therefore, IPv4 PXEBoot network must be + configured. + + - Cases where the Management Network must be VLAN tagged: + + - Most Server's BIOS do not support PXEBooting over tagged networks. + Therefore, you must configure an untagged PXEBoot network. + + - Cases where a Management Network must be shared across regions but + individual regions' Controllers want to only network boot/install nodes + of their own region: + + - You must configure separate, per-region PXEBoot Networks. + +**Infra Network** + A deprecated optional network that was historically used for access to the + Storage cluster. + + If this optional network is used, all node types are required to be + connected to the INFRA Network, + +**Node Interfaces** + All Nodes' Network Interfaces can, in general, optionally be either: + + - Untagged single port. + - Untagged two-port LAG and optionally split between redudant L2 Switches + running vPC (Virtual Port-Channel), also known as multichassis + EtherChannel (MEC). + - VLAN on either single-port ETH interface or two-port LAG interface. + +.. _incl-common-deployment-terminology-end: diff --git a/doc/source/installation_guide/duplex.rst b/doc/source/installation_guide/duplex.rst index 39c6bd6de..ef3606fa9 100644 --- a/doc/source/installation_guide/duplex.rst +++ b/doc/source/installation_guide/duplex.rst @@ -4,6 +4,23 @@ StarlingX/Installation Guide Virtual Environment/Duplex ======================================================= +---------------------- +Deployment Terminology +---------------------- + +.. include:: deployment_terminology.rst + :start-after: incl-simplex-deployment-terminology: + :end-before: incl-simplex-deployment-terminology-end: + +.. include:: deployment_terminology.rst + :start-after: incl-standard-controller-deployment-terminology: + :end-before: incl-standard-controller-deployment-terminology-end: + +.. include:: deployment_terminology.rst + :start-after: incl-common-deployment-terminology: + :end-before: incl-common-deployment-terminology-end: + + ----------------- Preparing Servers ----------------- diff --git a/doc/source/installation_guide/simplex.rst b/doc/source/installation_guide/simplex.rst index 961deaf60..eb5950cb3 100644 --- a/doc/source/installation_guide/simplex.rst +++ b/doc/source/installation_guide/simplex.rst @@ -4,6 +4,22 @@ StarlingX/Installation Guide Virtual Environment/Simplex ======================================================== +---------------------- +Deployment Terminology +---------------------- + +.. include:: deployment_terminology.rst + :start-after: incl-simplex-deployment-terminology: + :end-before: incl-simplex-deployment-terminology-end: + +.. include:: deployment_terminology.rst + :start-after: incl-standard-controller-deployment-terminology: + :end-before: incl-standard-controller-deployment-terminology-end: + +.. include:: deployment_terminology.rst + :start-after: incl-common-deployment-terminology: + :end-before: incl-common-deployment-terminology-end: + ----------------- Preparing Servers -----------------