diff --git a/doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst b/doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst index 29a2e8ac4..273c0fb5f 100644 --- a/doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst +++ b/doc/source/backup/kubernetes/restoring-starlingx-system-data-and-storage.rst @@ -11,7 +11,7 @@ You can perform a system restore (controllers, workers, including or excluding storage nodes) of a |prod| cluster from a previous system backup and bring it back to the operational state it was when the backup procedure took place. -There are two restore modes- optimized restore and legacy restore. Optimized restore +There are two restore modes; optimized restore and legacy restore. Optimized restore must be used on |AIO-SX| and legacy restore must be used on systems that are not |AIO-SX|. .. rubric:: |context| @@ -22,7 +22,7 @@ start immediately. |prod| specific applications must be re-applied once a storage cluster is configured. Everything is restored as it was when the backup was created, except for -optional data if not defined.- +optional data if not defined. See :ref:`Back Up System Data ` for more details on the backup. @@ -141,8 +141,8 @@ conditions are in place: .. note:: - This is mandatory for |AIO-SX| (optimized) deployments. For legacy - patches it is only mandatory if either the exclude_patches + This is mandatory for |AIO-SX| optimized restore deployments. For legacy + restore deployments it is only mandatory if either the exclude_patches (backup) or skip_patches_restore (restore) flags are used. It is recommended to restore subclouds only when there is an existing diff --git a/doc/source/introduction/terms.rst b/doc/source/introduction/terms.rst index 3345b5cdf..b174694f0 100644 --- a/doc/source/introduction/terms.rst +++ b/doc/source/introduction/terms.rst @@ -12,24 +12,16 @@ commonly used in the |org| community and in this documentation. A single physical node that provides a controller function, worker function, and storage function. + All-in-one Simplex (optimized) restore + Optimized restore indicates that the restore is done using restore_mode=optimized + set. This is mandatory and applies only for |AIO-SX| (optimized) restore + deployments. + Bare Metal A node running without Kubelet or hypervisors (for example, application workloads run directly on the operating system which runs directly on the hardware). - Worker - 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' - - may be referred to as a compute node. - - runs virtual switch for realizing virtual networks. - - provides L3 routing and NET services. - - Controller A node within a |prod| edge cloud that runs the cloud management software (*control plane*). There can be either one or two controller nodes in a @@ -43,6 +35,9 @@ commonly used in the |org| community and in this documentation. - Can be part of a two-node |HA| control node cluster for running control functions either active/active or active/standby. + |CSM| Observability + An OpenTelemetry agent that collects array-level metrics for Dell storage. + Data Network(s) Networks attached to pci-passthrough and/or sriov interfaces that are made available to hosted containers or hosted |VMs| for pci-passthrough and/or |SRIOV| @@ -62,6 +57,11 @@ commonly used in the |org| community and in this documentation. Tools that make the process of distributing, installing, and managing updates. + Downgrade + The process of moving from a higher version or a newer release of a + software, firmware, or operating system to a lower version or an older + release. + Elliptic Curve Digital Signature Algorithm (ECDSA) ECDSA is an asymmetric key encryption algorithm that uses Elliptic curve @@ -110,6 +110,11 @@ commonly used in the |org| community and in this documentation. All nodes are required to be connected to the management network. + Multi-host (legacy) restore + Legacy restore indicates that the restore is done without using + ``restore_mode=optimized``. Legacy restore is mandatory for multi-host + systems like |AIO-DX| or Standard. + Node A computer that is usually a server-class system. @@ -138,6 +143,26 @@ commonly used in the |org| community and in this documentation. components are created and maintained with an open development process through collaboration. + Precheck + A system state checks intended to confirm the system health for an + impending operation. This check can be performed at any time prior to the + system operation execution, but is intended to be executed just prior to + confirming that it can be scheduled before actually attempting the operation. + + Prestaging + System software media is prepopulated on the system in preparation for an + impending operation. *Prestaging* is currently supported for installation + and upgrade operation. + + Preinstallation + New deployments for a system that is installed in the factory. + *Preinstallation* also refers to software media that is installed alongside + the existing deployment in preparation for an upgrade. + + Prometheus + An open source software application that is used to monitor and alert + events. For more information, see ``__. + PXEBoot Network An optional network for controllers to boot/install other nodes over the network. @@ -164,6 +189,20 @@ commonly used in the |org| community and in this documentation. - You must configure separate, per-region PXEBoot networks. + Rollback + The process of reverting changes made to a system or database to a + previous state. For |prod|, *Rollback* is a capability that is supported + during an upgrade or update. + + Restore + Bringing back a system or data from a backup or a previously saved state. + For |prod|, *Restore* can be used for current release (*N*) or (*N*-1). + + Shared NIC + A single physical port that can be shared by two or more system networks (oam, mgmt., + cluster-host, pxeboot and data) + For more information, see :ref:`sriov-port-sharing`. + StarlingX StarlingX is an open source, complete cloud infrastructure software stack for the edge used by the most demanding applications in industrial |IoT|, @@ -183,6 +222,9 @@ commonly used in the |org| community and in this documentation. - Provides |HA| persistent storage for images, virtual volumes (that is, block storage), and object storage. + Unity XT + A simple, fast, flexible, and all-inclusive unified storage platform. + Virtualization The act of creating a virtual version of CPU, network or storage device. @@ -190,47 +232,15 @@ commonly used in the |org| community and in this documentation. An instance of a node provided by software (a hypervisor), which runs within the host operating system and hardware. - Rollback - The process of reverting changes made to a system or database to a - previous state. For |prod|, *Rollback* is a capability that is supported - during an upgrade or update. + Worker + 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. - Restore - Bringing back a system or data from a backup or a previously saved state. - For |prod|, *Restore* can be used for current release (*N*) or (*N*-1). + In a configuration running OpenStack, a worker node: - Downgrade - The process of moving from a higher version or a newer release of a - software, firmware, or operating system to a lower version or an older - release. + - 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. - Precheck - A system state checks intended to confirm the system health for an - impending operation. This check can be performed at any time prior to the - system operation execution, but is intended to be executed just prior to - confirming that it can be scheduled before actually attempting the operation. - - Prestaging - System software media is prepopulated on the system in preparation for an - impending operation. *Prestaging* is currently supported for installation - and upgrade operation. - - Preinstallation - New deployments for a system that is installed in the factory. - *Preinstallation* also refers to software media that is installed alongside - the existing deployment in preparation for an upgrade. - - Shared NIC - A single physical port that can be shared by two or more system networks (oam, mgmt., - cluster-host, pxeboot and data) - For more information, see :ref:`sriov-port-sharing`. - - |CSM| Observability - An OpenTelemetry agent that collects array-level metrics for Dell storage. - - Prometheus - An open source software application that is used to monitor and alert - events. For more information, see ``__. - - Unity XT - A simple, fast, flexible, and all-inclusive unified storage platform.