Glossary updates

- conditionalize "StarlingX" term to US builds.
- auto lex-sort list.
Incorporate patchset 1 review comments.
Incorporate patchset 2 review comments.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id1a27f1e333e9e07278b09eade1358a6134e899e
This commit is contained in:
Ron Stone
2022-07-05 14:25:21 -04:00
parent c1ca27a18f
commit 53641fb610
2 changed files with 141 additions and 118 deletions

View File

@@ -5,161 +5,183 @@ Basic Terminology
The following definitions describe key concepts and terminology that are The following definitions describe key concepts and terminology that are
commonly used in the |org| community and in this documentation. commonly used in the |org| community and in this documentation.
All-in-one Controller Node .. glossary::
A single physical node that provides a controller function, worker function, :sorted:
and storage function.
Bare Metal All-in-one Controller Node
A node running without hypervisors (for example, application workloads run A single physical node that provides a controller function, worker
directly on the operating system which runs directly on the hardware). function, and storage function.
Worker Bare Metal
A node within a |prod| edge cloud that is dedicated to running application A node running without Kubelet or hypervisors (for example, application
workloads. There can be 0 to |max-workers| worker nodes in a |prod| edge cloud. workloads run directly on the operating system which runs directly on
the hardware).
- Runs virtual switch for realizing virtual networks. Worker
- Provides L3 routing and NET services. A node within a |prod| edge cloud that is dedicated to running application
workloads. There can be 0 to |max-workers| worker nodes in a |prod| edge
cloud.
In a configuration running OpenStack, a worker node is labeled as 'compute' In a configuration running OpenStack, a worker node:
and may be referred to as a compute node.
Controller - is labeled as 'compute'
A node within a |prod| edge cloud that runs the cloud management software - may be referred to as a compute node.
(*control plane*). There can be either one or two controller nodes in a - runs virtual switch for realizing virtual networks.
|prod| edge cloud. - provides L3 routing and NET services.
- Runs cloud control functions for managing cloud resources.
- Runs all OpenStack control functions, such as 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.
Data Network(s) Controller
Networks on which the OpenStack / Neutron provider networks are realized and A node within a |prod| edge cloud that runs the cloud management software
become the VM tenant networks. (*control plane*). There can be either one or two controller nodes in a
|prod| edge cloud.
Only worker-type and all-in-one-type nodes are required to be connected to - Runs cloud control functions for managing cloud resources.
the data network(s). These node types require one or more interface(s) on the - Runs all Kubernetes control functions such as kube-apiserver,
data network(s). kube-controller-manager and kube-schedule
- Runs all OpenStack control functions, such as 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.
Deployment Tools Data Network(s)
Tools that make the process of distributing, installing, and managing Networks attached to pci-passthrough and/or sriov interfaces that are made
updates. available to hosted containers or hosted |VMs| for pci-passthrough and/or |SRIOV|
interfaces.
Edge Computing Networks attached to data interfaces of the OpenStack vSwitch, on which the
The delivery of computing capabilities to the logical extremes of a network OpenStack / Neutron provider networks are realized and become the |VM| tenant
in order to improve the performance, operating cost and reliability of networks.
applications and services. By shortening the distance between devices and the
resources that serve them, and also reducing network hops, edge computing
mitigates the latency and bandwidth constraints of today's Internet, ushering
in new classes of applications.
From `Open Glossary of Edge Computing <https://github.com/State-of-the- Only worker-type and all-in-one-type nodes, which host end-user containers
Edge/glossary/blob/master/edge-glossary.md#edge-computing>`_ and/or |VMs| would have data network(s) attached.
Infra Network In the case of openstack-compute labelled worker nodes, a data network MUST be
A deprecated optional network that was historically used for access to the attached to at lease one 'data' (vSwitch) interface.
storage cluster.
If this optional network is used, all node types are required to be connected Deployment Tools
to the INFRA network. Tools that make the process of distributing, installing, and managing
updates.
IoT (Internet of Things) Edge Computing
A system of computing devices that can operate with little/no human The delivery of computing capabilities to the logical extremes of a
interaction. network in order to improve the performance, operating cost and
reliability of applications and services. By shortening the distance
between devices and the resources that serve them, and also reducing
network hops, edge computing mitigates the latency and bandwidth
constraints of today's Internet, ushering in new classes of applications.
IPMI Network From `Open Glossary of Edge Computing <https://github.com/State-of-the-
An optional network on which Intelligent Platform Management Interface Edge/glossary/blob/master/edge-glossary.md#edge-computing>`_
(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. Infra Network
A deprecated optional network that was historically used for access to the
storage cluster.
Kubernetes Cluster If this optional network is used, all node types are required to be
A set of machines that has a common control plane for running orchestrated connected to the INFRA network.
applications.
Management Network IoT (Internet of Things)
A private network (that is, not connected externally), typically 10GE, used A system of computing devices that can operate with little/no human
for the following: interaction.
- Internal OpenStack / |prod| monitoring and control. IPMI Network
- VM I/O access to a storage cluster. 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.
All nodes are required to be connected to the management network. You can optionally connect all node types to the |IPMI| network.
Node Kubernetes Cluster
A computer that is usually a server-class system. A set of machines that has a common control plane for running orchestrated
applications.
Node Interfaces Management Network
All nodes' network interfaces can, in general, optionally be either: A private network (that is, not connected externally), typically 10GE,
used for the following:
- Untagged single port. - Internal StarlingX Infrastructure management monitoring and control
- Untagged two-port LAG and optionally split between redundant L2 switches - in the case of openstack, it is also used by |VM| I/O access to
running vPC (Virtual Port-Channel), also known as multichassis virtualized disks in Ceph Storage Cluster
EtherChannel (MEC).
- VLAN on either single-port ETH interface or two-port LAG interface.
|OAM| Network All nodes are required to be connected to the management network.
The network on which all external |prod| platform APIs are exposed,
(that is, REST APIs, Horizon web server, |SSH|, and |SNMP|), typically 1GE.
Only controller type nodes are required to be connected to the OAM network. Node
A computer that is usually a server-class system.
Open Source StarlingX Node Interfaces
A set of services that can be used to build cloud infrastructure. The source All nodes' network interfaces can, in general, optionally be either:
code of the services is available under an open source license that allows
access and re-distribution of the codebase. The software components are
created and maintained with an open development process through
collaboration.
PXEBoot Network - Untagged single port.
An optional network for controllers to boot/install other nodes over the - Untagged two-port LAG and optionally split between redundant L2 switches
network. running vPC (Virtual Port-Channel), also known as multichassis
EtherChannel (MEC).
- VLAN on either single-port ETH interface or two-port LAG interface.
By default, controllers use the management network for boot/install of other |OAM| Network
nodes in the OpenStack cloud. If this optional network is used, all node The network on which all external |prod| platform APIs are exposed, (that
types are required to be connected to the PXEBoot network. is, REST APIs, Horizon web server, |SSH|, and |SNMP|), typically 1GE.
A PXEBoot network is required for a variety of special case situations: Only controller type nodes are required to be connected to the OAM
network.
- Cases where the management network must be IPv6: .. only:: starlingx
- IPv6 does not support PXEBoot. Therefore, you must configure an IPv4 Open Source StarlingX
PXEBoot network. A set of services that can be used to build cloud infrastructure. The
source code of the services is available under an open source license
that allows access and re-distribution of the codebase. The software
components are created and maintained with an open development process
through collaboration.
- Cases where the management network must be |VLAN| tagged: PXEBoot Network
An optional network for controllers to boot/install other nodes over the
network.
- Most server's BIOS do not support PXEBooting over tagged networks. By default, controllers use the management network for boot/install of
Therefore, you must configure an untagged PXEBoot network. other nodes in the OpenStack cloud. If this optional network is used, all
node types are required to be connected to the PXEBoot network.
- Cases where a management network must be shared across regions but A PXEBoot network is required for a variety of special case situations:
individual regions' controllers want to only network boot/install nodes of
their own region:
- You must configure separate, per-region PXEBoot networks. - Cases where the management network must be IPv6:
|prod| - IPv6 does not support PXEBoot. Therefore, you must configure an IPv4
|prod| is an open source, complete cloud infrastructure software stack PXEBoot network.
for the edge used by the most demanding applications in industrial |IoT|,
telecom, and other use cases. The platform creates a fusion between OpenStack
and Kubernetes to provide a robust and flexible environment for all kinds of
workloads, let them be containerized, virtualized or bare metal.
Storage - Cases where the management network must be |VLAN| tagged:
A node within a |prod| edge cloud that is dedicated to providing file
and object storage to application workloads. There can be 0 or more storage
nodes within a |prod| edge cloud.
- Runs CEPH distributed storage software. - Most server's BIOS do not support PXEBooting over tagged networks.
- Part of an HA multi-node CEPH storage cluster supporting a replication Therefore, you must configure an untagged PXEBoot network.
factor of two or three, journal caching, and class tiering.
- Provides HA persistent storage for images, virtual volumes (that is, block
storage), and object storage.
Virtualization - Cases where a management network must be shared across regions but
The act of creating a virtual version of CPU, network or storage device. individual regions' controllers want to only network boot/install nodes
of their own region:
- You must configure separate, per-region PXEBoot networks.
|prod|
|prod| is an open source, complete cloud infrastructure software stack for
the edge used by the most demanding applications in industrial |IoT|,
telecom, and other use cases. The platform creates a fusion between
OpenStack and Kubernetes to provide a robust and flexible environment for
all kinds of workloads, let them be containerized, virtualized or bare
metal.
Storage
A node within a |prod| edge cloud that is dedicated to providing file and
object storage to application workloads. There can be 0 or more storage
nodes within a |prod| edge cloud.
- 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 (that is,
block storage), and object storage.
Virtualization
The act of creating a virtual version of CPU, network or storage device.
Virtual Machines (VM)
An instance of a node provided by software (a hypervisor), which runs
within the host operating system and hardware.
Virtual Machines (VM)
An instance of a node provided by software (a hypervisor), which runs within
the host operating system and hardware.

View File

@@ -54,6 +54,7 @@
.. |GNSS| replace:: :abbr:`GNSS (Global Navigation Satellite System)` .. |GNSS| replace:: :abbr:`GNSS (Global Navigation Satellite System)`
.. |GCC| replace:: :abbr:`GCC (GNU Compiler Collection)` .. |GCC| replace:: :abbr:`GCC (GNU Compiler Collection)`
.. |GPU| replace:: :abbr:`GPU (Graphics Processing Unit)` .. |GPU| replace:: :abbr:`GPU (Graphics Processing Unit)`
.. |HA| replace:: :abbr:`HA (High Availability)`
.. |ICA| replace:: :abbr:`ICA (Intermediate Certificate Authority)` .. |ICA| replace:: :abbr:`ICA (Intermediate Certificate Authority)`
.. |ICAs| replace:: :abbr:`ICAs (Intermediate Certificate Authorities)` .. |ICAs| replace:: :abbr:`ICAs (Intermediate Certificate Authorities)`
.. |ICMP| replace:: :abbr:`ICMP (Internet Control Message Protocol)` .. |ICMP| replace:: :abbr:`ICMP (Internet Control Message Protocol)`