starlingx/docs
Code Issues Proposed changes

Glossary updates

Browse Source 
- 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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
doc/source/introduction/terms.rst
View File

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

1
doc/source/shared/abbrevs.txt
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)`