starlingx/docs
Code Issues Proposed changes

shared/strings.txt additions and refactoring

Browse Source 
Additional abbreviations and product names.
New 'minitoc' substitution for use in page contents lists. e.g:
.. contents:: |minitoc|
   :depth: 1
Broke out abbreviations into separate file.
Broke out vendor-specific substitutions into separate file to improve reuse
of common substitutions.
Changes to  doc/source/configuration/intel_n3000_fpga.rst to demonstrate
|minitoc| and some incidental clean-up.

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: I7546e1d59feff213d397341ebde95351bd9ae834
This commit is contained in:
Stone
2021-01-07 10:00:37 -05:00
committed by Ron Stone
parent 40226765f6
commit abf0cd1b68
4 changed files with 196 additions and 174 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
doc/source/_vendor/vendor_strings.txt Normal file
View File

@@ -0,0 +1,46 @@
.. Common string substitutions for brand customization and consistency.
.. NOTE: Do not use underscores in these substitution names.
.. For more information, see
.. https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions
.. Organization name
.. |org| replace:: StarlingX
.. Short and long product names such as "StarlingX" and "Acme Co. StarlingX"
.. |prod| replace:: StarlingX
.. |prod-long| replace:: StarlingX
.. |prod-os| replace:: StarlingX OpenStack
.. |prod-dc| replace:: Distributed Cloud
.. Guide names; will be formatted in italics by default.
.. |node-doc| replace:: :title:`StarlingX Node Configuration and Management`
.. |planning-doc| replace:: :title:`StarlingX Planning`
.. |sec-doc| replace:: :title:`StarlingX Security`
.. |inst-doc| replace:: :title:`StarlingX Installation`
.. |stor-doc| replace:: :title:`StarlingX Storage Configuration and Management`
.. |intro-doc| replace:: :title:`StarlingX Introduction`
.. |fault-doc| replace:: :title:`StarlingX Fault Management`
.. |sysconf-doc| replace:: :title:`StarlingX System Configuration`
.. |backup-doc| replace:: :title:`StarlingX Backup and Restore`
.. |deploy-doc| replace:: :title:`StarlingX Deployment Configurations`
.. |distcloud-doc| replace:: :title:`StarlingX Distributed Cloud`
.. |usertasks-doc| replace:: :title:`StarlingX User Tasks`
.. |admintasks-doc| replace:: :title:`StarlingX Administrator Tasks`
.. |datanet-doc| replace:: :title:`StarlingX Data Networks`
.. Name of downloads location
.. |dnload-loc| replace:: a StarlingX mirror
.. File name prefix, as in stx-remote-cli-<version>.tgz. May also be
used in sample domain names etc.
.. |prefix| replace:: stx
.. space character. Needed for padding in tabular output. Currently
used where |prefix| replacement is a length shorter than 3.
To insert a space, use "replace:: \ \" (with two spaces)
To insert no spaces, use "replace:: \"
.. |s| replace:: \

101
doc/source/configuration/intel_n3000_fpga.rst
View File

@@ -2,11 +2,10 @@
Host FPGA Configuration - Intel N3000 Host FPGA Configuration - Intel N3000
===================================== =====================================
This guide describes how to configure and integrate an Intel N3000 This guide describes how to configure and integrate an Intel N3000 |FPGA|
:abbr:`FPGA (Field Programmable Gate Array)` :abbr:`PAC (Programmable Acceleration Card)` |PAC| on StarlingX.
on StarlingX.
.. contents:: .. contents:: |minitoc|
:local: :local:
:depth: 1 :depth: 1
@@ -15,15 +14,15 @@ Overview
-------- --------
The `Intel FPGA PAC N3000 <https://www.intel.com/content/www/us/en/programmable/products/boards_and_kits/dev-kits/altera/intel-fpga-pac-n3000/overview.html>`_ contains two Intel The `Intel FPGA PAC N3000 <https://www.intel.com/content/www/us/en/programmable/products/boards_and_kits/dev-kits/altera/intel-fpga-pac-n3000/overview.html>`_ contains two Intel
XL710 NICs, memory, and an Intel FPGA. The system discovers and inventories the XL710 |NICs|, memory, and an Intel |FPGA|. The system discovers and inventories the
device as a NIC, with the XL710 ports available in the host port list and host device as a |NIC|, with the XL710 ports available in the host port list and host
interface list. interface list.
-------------------- --------------------
Update device images Update device images
-------------------- --------------------
The Intel FPGA PAC N3000 as shipped from the factory is expected to have The Intel |FPGA| |PAC| N3000 as shipped from the factory is expected to have
production BMC and factory images. The following procedure describes how to production BMC and factory images. The following procedure describes how to
update the user image on a host. update the user image on a host.
@@ -35,35 +34,35 @@ Device image types:
* functional-key: The functional device image performs the desired work on * functional-key: The functional device image performs the desired work on
behalf of the application. If a rootkey device image has been written to the behalf of the application. If a rootkey device image has been written to the
hardware, then the functional image will only be accepted if it has been hardware, then the functional image will only be accepted if it has been
signed by a :abbr:`CSK (code-signing key)` generated from the root key which has signed by a |CSK| generated from the root key which has
not been revoked. not been revoked.
* key-revocation: The key-revocation device image will revoke a CSK. If a * key-revocation: The key-revocation device image will revoke a |CSK|. If a
root-key device image has been written to the hardware, then the root-key device image has been written to the hardware, then the
key-revocation device image will only be accepted if it has been signed by key-revocation device image will only be accepted if it has been signed by
the root key. the root key.
The following items are specific to the Intel FPGA PAC N3000: The following items are specific to the Intel |FPGA| |PAC| N3000:
* The root-key image is called the *root entry hash bitstream* and can only be * The root-key image is called the *root entry hash bitstream* and can only be
set once. set once.
* The functional device image is known as the *user image*. * The functional device image is known as the *user image*.
* The key-revocation device image is known as the *CSK ID cancellation * The key-revocation device image is known as the *CSK ID cancellation
bitstream*. bitstream*.
* CSKs are revoked by specifying an integer CSK ID. * |CSKs| are revoked by specifying an integer |CSK| ID.
* 128 CSK ID cancellation slots exist. * 128 |CSK| ID cancellation slots exist.
For the Intel FPGA PAC N3000, a CSK is revoked by specifying an integer ID, and For the Intel |FPGA| |PAC| N3000, a |CSK| is revoked by specifying an integer
all CSKs with that ID will be revoked. Writing the root-key device image or a ID, and all |CSKs| with that ID will be revoked. Writing the root-key device
key-revocation device image is essentially permanent. Reverting to factory image or a key-revocation device image is essentially permanent. Reverting to
status requires physical access to the card and specialized equipment. factory status requires physical access to the card and specialized equipment.
#. Upload the device image. #. Upload the device image.
To upload a root-key device image: To upload a root-key device image:
:: .. code-block:: none
~(keystone_admin)$ system device-image-upload imagefile root-key pci_vendor ~(keystone_admin)$ system device-image-upload imagefile root-key pci_vendor
pci_device --key-signature key_signature --name imagename --description pci_device --key-signature key_signature --name imagename --description
@@ -71,7 +70,7 @@ status requires physical access to the card and specialized equipment.
To upload a functional device image: To upload a functional device image:
:: .. code-block:: none
~(keystone_admin)$ system device-image-upload imagefile functional pci_vendor ~(keystone_admin)$ system device-image-upload imagefile functional pci_vendor
pci_device --functional bitstream_id --name imagename --description description pci_device --functional bitstream_id --name imagename --description description
@@ -79,7 +78,7 @@ status requires physical access to the card and specialized equipment.
To upload a revocation key device image: To upload a revocation key device image:
:: .. code-block:: none
~(keystone_admin)$ system device-image-upload imagefile key-revocation ~(keystone_admin)$ system device-image-upload imagefile key-revocation
pci_vendor pci_device --revoke-key-id revoke_key_id --name imagename -- pci_vendor pci_device --revoke-key-id revoke_key_id --name imagename --
@@ -87,7 +86,7 @@ status requires physical access to the card and specialized equipment.
where: where:
:: .. code-block:: none
imagefile # The filepath of the binary device image file. imagefile # The filepath of the binary device image file.
pci_vendor # The hexadecimal string identifying the PCI vendor ID of the device this image applies to. pci_vendor # The hexadecimal string identifying the PCI vendor ID of the device this image applies to.
@@ -101,20 +100,20 @@ status requires physical access to the card and specialized equipment.
#. Assign a device label to the device. #. Assign a device label to the device.
Labels are key-value pairs that are assigned to host PCI devices and are Labels are key-value pairs that are assigned to host |PCI| devices and are
used to specify attributes of the devices. Labels can be used to identify used to specify attributes of the devices. Labels can be used to identify
certain properties of the PCI devices where the same device image can be certain properties of the |PCI| devices where the same device image can be
used. used.
The command syntax is: The command syntax is:
:: .. code-block:: none
system host-device-label-assign [--overwrite] hostname_or_id pci_name_or_address system host-device-label-assign [--overwrite] hostname_or_id pci_name_or_address
name=value [name=value ...] name=value [name=value ...]
Overwrite the label using the ``--overwrite`` option. This option Overwrite the label using the ``--overwrite`` option. This option is not
is not allowed while the image update is in progress after running allowed while the image update is in progress after running
``host-device-image-update``. Once assigned, a device label can be ``host-device-image-update``. Once assigned, a device label can be
referenced by multiple ``device-image-apply`` commands. referenced by multiple ``device-image-apply`` commands.
@@ -130,19 +129,19 @@ status requires physical access to the card and specialized equipment.
* Apply a device image to all supported devices: * Apply a device image to all supported devices:
:: .. code-block:: none
~(keystone_admin)$ system device-image-apply image_uuid ~(keystone_admin)$ system device-image-apply image_uuid
* Alternatively, apply a device image to devices with a specified label: * Alternatively, apply a device image to devices with a specified label:
:: .. code-block:: none
~(keystone_admin)$ system device-image-apply image_uuid key1=value1 ~(keystone_admin)$ system device-image-apply image_uuid key1=value1
#. Write pending device images on the host to hardware. #. Write pending device images on the host to hardware.
:: .. code-block:: none
~(keystone)admin)$ system host-device-image-update hostname ~(keystone)admin)$ system host-device-image-update hostname
@@ -156,7 +155,7 @@ status requires physical access to the card and specialized equipment.
Root and revocation key updates can be expected to take 1-2 minutes. Root and revocation key updates can be expected to take 1-2 minutes.
Functional image updates can take approximately 40 minutes for the Intel Functional image updates can take approximately 40 minutes for the Intel
FPGA PAC N3000. |FPGA| |PAC| N3000.
* Once a device update is complete, ``system device-image-state-list`` * Once a device update is complete, ``system device-image-state-list``
will show the status as completed for that device/image. will show the status as completed for that device/image.
@@ -170,8 +169,8 @@ status requires physical access to the card and specialized equipment.
#. (Optional) Upload, apply, and update any additional key-revocation device #. (Optional) Upload, apply, and update any additional key-revocation device
images or functional device images as needed. images or functional device images as needed.
New device images can be uploaded as needed, and already-uploaded images can New device images can be uploaded as needed, and already-uploaded images
be applied with new labels. Devices can also have new labels applied to can be applied with new labels. Devices can also have new labels applied to
them, and any device images with matching labels will be automatically them, and any device images with matching labels will be automatically
applied. applied.
@@ -179,9 +178,9 @@ status requires physical access to the card and specialized equipment.
Device management commands Device management commands
-------------------------- --------------------------
This section lists the commands used to control the Intel FPGA PAC N3000. This section lists the commands used to control the Intel |FPGA| |PAC| N3000.
:: .. code-block:: none
Listing uploaded device images Listing uploaded device images
system device-image-list system device-image-list
@@ -208,15 +207,15 @@ This section lists the commands used to control the Intel FPGA PAC N3000.
Enable Forward Error Correction Enable Forward Error Correction
------------------------------- -------------------------------
The Intel FPGA PAC N3000 supports :abbr:`FEC (forward error correction)` The Intel |FPGA| |PAC| N3000 supports |FEC| capabilities, which are exposed as
capabilities, which are exposed as a PCI device. The PCI device can be used by a a |PCI| device. The |PCI| device can be used by a `DPDK
`DPDK <https://www.dpdk.org/>`_ enabled container application to perform accelerated 5G LDPC encoding and <https://www.dpdk.org/>`_ enabled container application to perform accelerated
decoding operations. 5G LDPC encoding and decoding operations.
After the FPGA device is programmed, the list of host devices shows the FEC After the |FPGA| device is programmed, the list of host devices shows the |FEC|
device with device ID 0xd8f, as shown below. device with device ID 0xd8f, as shown below.
:: .. code-block:: none
system host-device-list <worker-node> system host-device-list <worker-node>
@@ -227,12 +226,12 @@ device with device ID 0xd8f, as shown below.
+------------------+--------------+----------+-----------+-----------+---------------------------+-------------------------+-------------------------------------+-----------+---------+ +------------------+--------------+----------+-----------+-----------+---------------------------+-------------------------+-------------------------------------+-----------+---------+
... ...
To enable the FEC device for SR-IOV, set the number of virtual functions (VFs) To enable the |FEC| device for |SRIOV|, set the number of |VFs| and set the
and set the appropriate userspace drivers for the physical function (PF) and VF. appropriate userspace drivers for the |PF| and |VF|.
For example: For example:
:: .. code-block:: none
system host-lock <worker> system host-lock <worker>
system host-device-modify <worker> <name> --driver <vf driver> --vf-driver <vf driver> -N <number of vfs> system host-device-modify <worker> <name> --driver <vf driver> --vf-driver <vf driver> -N <number of vfs>
@@ -245,16 +244,16 @@ For example:
- igb_uio - igb_uio
- vfio - vfio
To pass the FEC device to a container, enter the following requests/limits To pass the |FEC| device to a container, enter the following requests/limits
into the pod specification: into the pod specification:
:: .. code-block:: none
intel.com/intel_fpga_fec: '<number of vfs>' intel.com/intel_fpga_fec: '<number of vfs>'
For example: For example:
:: .. code-block:: none
apiVersion: v1 apiVersion: v1
kind: Pod kind: Pod
@@ -293,10 +292,10 @@ For example:
Configure NICs for SR-IOV Configure NICs for SR-IOV
------------------------- -------------------------
You can configure the Intel XL710 NICs for SR-IOV by first identifying the NICs You can configure the Intel XL710 NICs for |SRIOV| by first identifying the
on the Intel FPGA PAC N3000 using the following command: |NICs| on the Intel |FPGA| |PAC| N3000 using the following command:
:: .. code-block:: none
system host-port-list <worker> system host-port-list <worker>
@@ -307,12 +306,12 @@ on the Intel FPGA PAC N3000 using the following command:
+--------------------------------------+------------+----------+--------------+--------+-----------+-------------+------------------------------------------------+ +--------------------------------------+------------+----------+--------------+--------+-----------+-------------+------------------------------------------------+
... ...
Next, set the number of virtual functions (VFs) and set the appropriate Next, set the number of |VFs| and set the appropriate
userspace drivers for the VF. userspace drivers for the |VF|.
For example: For example:
:: .. code-block:: none
system host-lock <worker> system host-lock <worker>
system host-if-list -a <worker> system host-if-list -a <worker>

91
doc/source/shared/abbrevs.txt Normal file
View File

@@ -0,0 +1,91 @@
.. Common and domain-specific abbreviations.
.. Plural forms must be defined separately from singular as
.. replacements like |PVC|s won't work.
.. Please keep this list alphabetical.
.. |ACL| replace:: :abbr:`ACL (Access Control List)`
.. |AE| replace:: :abbr:`AE (Aggregated Ethernet)`
.. |AIO| replace:: :abbr:`AIO (All-In-One)`
.. |AVP| replace:: :abbr:`AVP (Accelerated Virtual Port)`
.. |AWS| replace:: :abbr:`AWS (Amazon Web Services)`
.. |BGP| replace:: :abbr:`BGP (Border Gateway Protocol)`
.. |BMC| replace:: :abbr:`BMC (Board Management Controller)`
.. |BMCs| replace:: :abbr:`BMCs (Board Management Controllers)`
.. |BOOTP| replace:: :abbr:`BOOTP (Boot Protocol)`
.. |BPDU| replace:: :abbr:`BPDU (Bridge Protocol Data Unit)`
.. |BPDUs| replace:: :abbr:`BPDUs (Bridge Protocol Data Units)`
.. |CA| replace:: :abbr:`CA (Certificate Authority)`
.. |CNI| replace:: :abbr:`CNI (Container Networking Interface)`
.. |CoW| replace:: :abbr:`CoW (Copy on Write)`
.. |CSK| replace:: :abbr:`CSK (Code Signing Key)`
.. |CSKs| replace:: :abbr:`CSKs (Code Signing Keys)`
.. |DHCP| replace:: :abbr:`DHCP (Dynamic Host Configuration Protoco)`
.. |DPDK| replace:: :abbr:`DPDK (Data Plane Development Kit)`
.. |DRBD| replace:: :abbr:`DRBD (Distributed Replicated Block Device)`
.. |DSCP| replace:: :abbr:`DSCP (Differentiated Services Code Point)`
.. |DVR| replace:: :abbr:`DVR (Distributed Virtual Router)`
.. |FEC| replace:: :abbr:`FEC (Forward Error Correction)`
.. |FPGA| replace:: :abbr:`FPGA (Field Programmable Gate Array)`
.. |FQDN| replace:: :abbr:`FQDN (Fully Qualified Domain Name)`
.. |GNP| replace:: :abbr:`GNP (Global Network Policy)`
.. |IGMP| replace:: :abbr:`IGMP (Internet Group Management Protocol)`
.. |IPMI| replace:: :abbr:`IPMI (Intelligent Platform Management Interface)`
.. |LACP| replace:: :abbr:`LACP (Link Aggregation Control Protocol)`
.. |LAG| replace:: :abbr:`LAG (Link Aggregation)`
.. |LDAP| replace:: :abbr:`LDAP (Lightweight Directory Access Protocol)`
.. |LDPC| replace:: :abbr:`LDPC (Low-Density Parity Check)`
.. |LLDP| replace:: :abbr:`LLDP (Link Layer Discovery Protocol)`
.. |MAC| replace:: :abbr:`MAC (Media Access Control)`
.. |MEC| replace:: :abbr:`MEC (Multi-access Edge Computing)`
.. |MLD| replace:: :abbr:`MLD (Multicast Listener Discovery)`
.. |MNFA| replace:: :abbr:`MNFA (Multi-Node Failure Avoidance)`
.. |MOTD| replace:: :abbr:`MOTD (Message of the Day)`
.. |MTU| replace:: :abbr:`MTU (Maximum Transmission Unit)`
.. |NIC| replace:: :abbr:`NIC (Network Interface Card)`
.. |NICs| replace:: :abbr:`NICs (Network Interface Cards)`
.. |NTP| replace:: :abbr:`NTP (Network Time Protocol)`
.. |NUMA| replace:: :abbr:`NUMA (Non-Uniform Memory Access)`
.. |NVMe| replace:: :abbr:`NVMe (Non-Volatile Memory express)`
.. |OAM| replace:: :abbr:`OAM (Operations, administration and management)`
.. |OSD| replace:: :abbr:`OSD (Object Storage Device)`
.. |OSDs| replace:: :abbr:`OSDs (Object Storage Devices)`
.. |PAC| replace:: :abbr:`PAC (Programmable Acceleration Card)`
.. |PCI| replace:: :abbr:`PCI (Peripheral Component Interconnect)`
.. |PDU| replace:: :abbr:`PDU (Packet Data Unit)`
.. |PF| replace:: :abbr:`PF (Physical Function)`
.. |PHB| replace:: :abbr:`PHB (Per-Hop Behavior)`
.. |PTP| replace:: :abbr:`PTP (Precision Time Protocol)`
.. |PVC| replace:: :abbr:`PVC (Persistent Volume Claim)`
.. |PVCs| replace:: :abbr:`PVCs (Persistent Volume Claims)`
.. |PXE| replace:: :abbr:`PXE (Preboot Execution Environment)`
.. |QoS| replace:: :abbr:`QoS (Quality of Service)`
.. |RAID| replace:: :abbr:`RAID (Redundant Array of Inexpensive Disks)`
.. |RPC| replace:: :abbr:`RPC (Remote Procedure Call)`
.. |SAS| replace:: :abbr:`SAS (Serial Attached SCSI)`
.. |SATA| replace:: :abbr:`SATA (Serial AT Attachment)`
.. |SNAT| replace:: :abbr:`SNAT (Source Network Address Translation)`
.. |SNMP| replace:: :abbr:`SNMP (Simple Network Management Protocol)`
.. |SRIOV| replace:: :abbr:`SR-IOV (Single Root I/O Virtualization)`
.. |SSD| replace:: :abbr:`SSD (Solid State Drive)`
.. |SSDs| replace:: :abbr:`SSDs (Solid State Drives)`
.. |SSH| replace:: :abbr:`SSH (Secure Shell)`
.. |SSL| replace:: :abbr:`SSL (Secure Socket Layer)`
.. |STP| replace:: :abbr:`STP (Spanning Tree Protocol)`
.. |TPM| replace:: :abbr:`TPM (Trusted Platform Module)`
.. |TFTP| replace:: :abbr:`TFTP (Trivial File Transfer Protocol)`
.. |ToR| replace:: :abbr:`ToR (Top-of-Rack)`
.. |UDP| replace:: :abbr:`UDP (User Datagram Protocol)`
.. |UEFI| replace:: :abbr:`UEFI (Unified Extensible Firmware Interface)`
.. |VF| replace:: :abbr:`VF (Virtual Function)`
.. |VFs| replace:: :abbr:`VFs (Virtual Functions)`
.. |VLAN| replace:: :abbr:`VLAN (Virtual Local Area Network)`
.. |VLANs| replace:: :abbr:`VLANs (Virtual Local Area Networks)`
.. |VM| replace:: :abbr:`VM (Virtual Machine)`
.. |VMs| replace:: :abbr:`VMs (Virtual Machines)`
.. |VNC| replace:: :abbr:`VNC (Virtual Network Computing)`
.. |VPC| replace:: :abbr:`VPC (Virtual Port Channel)`
.. |VXLAN| replace:: :abbr:`VXLAN (Virtual eXtensible Local Area Network)`
.. |VXLANs| replace:: :abbr:`VXLANs (Virtual eXtensible Local Area Networks)`
.. |XML| replace:: :abbr:`XML (eXtensible Markup Language)`
.. |YAML| replace:: :abbr:`YAML (YAML Ain't Markup Language)`

132
doc/source/shared/strings.txt
View File

@@ -3,29 +3,13 @@
.. For more information, see .. For more information, see
.. https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions .. https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions
.. Organization name
.. |org| replace:: StarlingX
.. Short and long product names such as "StarlingX" and "Acme Co. StarlingX" .. Load vendor-specific strings
.. |prod| replace:: StarlingX .. include:: /_vendor/vendor_strings.txt
.. |prod-long| replace:: StarlingX
.. |prod-os| replace:: StarlingX OpenStack .. Load abbreviations list
.. include:: /shared/abbrevs.txt
.. Guide names; will be formatted in italics by default.
.. |node-doc| replace:: :title:`StarlingX Node Configuration and Management`
.. |planning-doc| replace:: :title:`StarlingX Planning`
.. |sec-doc| replace:: :title:`StarlingX Security`
.. |inst-doc| replace:: :title:`StarlingX Installation`
.. |stor-doc| replace:: :title:`StarlingX Storage Configuration and Management`
.. |intro-doc| replace:: :title:`StarlingX Introduction`
.. |fault-doc| replace:: :title:`StarlingX Fault Management`
.. |sysconf-doc| replace:: :title:`StarlingX System Configuration`
.. |backup-doc| replace:: :title:`StarlingX Backup and Restore`
.. |deploy-doc| replace:: :title:`StarlingX Deployment Configurations`
.. |distcloud-doc| replace:: :title:`StarlingX Distributed Cloud`
.. |usertasks-doc| replace:: :title:`StarlingX User Tasks`
.. |admintasks-doc| replace:: :title:`StarlingX Administrator Tasks`
.. |datanet-doc| replace:: :title:`StarlingX Data Networks`
.. Task-oriented headings that should not appear in TOC .. Task-oriented headings that should not appear in TOC
.. These are used with the .. rubric:: directive. For example: .. These are used with the .. rubric:: directive. For example:
@@ -38,21 +22,11 @@
.. |result| replace:: Results .. |result| replace:: Results
.. |eg| replace:: Example .. |eg| replace:: Example
.. Name of downloads location .. File-level minitoc label. Used with .. contents:: directive, as in
.. |dnload-loc| replace:: a StarlingX mirror .. .. contents:: |minitoc|
.. :depth: 1
.. File name prefix, as in stx-remote-cli-<version>.tgz. May also be
used in sample domain names etc.
.. |prefix| replace:: stx
.. space character. Needed for padding in tabular output. Currently
used where |prefix| replacement is a length shorter than 3.
To insert a space, use "replace:: \ \" (with two spaces)
To insert no spaces, use "replace:: \"
.. |s| replace:: \
.. |minitoc| replace:: **In this section:**
.. Table row alternation inline override. Alternation styling is confused .. Table row alternation inline override. Alternation styling is confused
.. by spans. Applies to all tables in an rST file. .. by spans. Applies to all tables in an rST file.
@@ -60,91 +34,3 @@
.. |row-alt-off| raw:: html .. |row-alt-off| raw:: html
<style>table.docutils tr.row-odd {background-color: #fff;}</style> <style>table.docutils tr.row-odd {background-color: #fff;}</style>
.. Common and domain-specific abbreviations.
.. Plural forms must be defined seperately from singular as
.. replacements like |PVC|s won't work.
.. Please keep this list alphabetical.
.. |ACL| replace:: :abbr:`ACL (Access Control List)`
.. |AE| replace:: :abbr:`AE (Aggregated Ethernet)`
.. |AIO| replace:: :abbr:`AIO (All-In-One)`
.. |AVP| replace:: :abbr:`AVP (Accelerated Virtual Port)`
.. |AWS| replace:: :abbr:`AWS (Amazon Web Services)`
.. |BGP| replace:: :abbr:`BGP (Border Gateway Protocol)`
.. |BMC| replace:: :abbr:`BMC (Board Management Controller)`
.. |BMCs| replace:: :abbr:`BMCs (Board Management Controllers)`
.. |BOOTP| replace:: :abbr:`BOOTP (Boot Protocol)`
.. |BPDU| replace:: :abbr:`BPDU (Bridge Protocol Data Unit)`
.. |BPDUs| replace:: :abbr:`BPDUs (Bridge Protocol Data Units)`
.. |CA| replace:: :abbr:`CA (Certificate Authority)`
.. |CNI| replace:: :abbr:`CNI (Container Networking Interface)`
.. |CoW| replace:: :abbr:`CoW (Copy on Write)`
.. |CSK| replace:: :abbr:`CSK (Code Signing Key)`
.. |CSKs| replace:: :abbr:`CSKs (Code Signing Keys)`
.. |DHCP| replace:: :abbr:`DHCP (Dynamic Host Configuration Protoco)`
.. |DPDK| replace:: :abbr:`DPDK (Data Plane Development Kit)`
.. |DRBD| replace:: :abbr:`DRBD (Distributed Replicated Block Device)`
.. |DSCP| replace:: :abbr:`DSCP (Differentiated Services Code Point)`
.. |DVR| replace:: :abbr:`DVR (Distributed Virtual Router)`
.. |FEC| replace:: :abbr:`FEC (Forward Error Correction)`
.. |FPGA| replace:: :abbr:`FPGA (Field Programmable Gate Array)`
.. |FQDN| replace:: :abbr:`FQDN (Fully Qualified Domain Name)`
.. |GNP| replace:: :abbr:`GNP (Global Network Policy)`
.. |IGMP| replace:: :abbr:`IGMP (Internet Group Management Protocol)`
.. |IPMI| replace:: :abbr:`IPMI (Intelligent Platform Management Interface)`
.. |LACP| replace:: :abbr:`LACP (Link Aggregation Control Protocol)`
.. |LAG| replace:: :abbr:`LAG (Link Aggregation)`
.. |LDAP| replace:: :abbr:`LDAP (Lightweight Directory Access Protocol)`
.. |LDPC| replace:: :abbr:`LDPC (Low-Density Parity Check)`
.. |LLDP| replace:: :abbr:`LLDP (Link Layer Discovery Protocol)`
.. |MAC| replace:: :abbr:`MAC (Media Access Control)`
.. |MEC| replace:: :abbr:`MEC (Multi-access Edge Computing)`
.. |MLD| replace:: :abbr:`MLD (Multicast Listener Discovery)`
.. |MNFA| replace:: :abbr:`MNFA (Multi-Node Failure Avoidance)`
.. |MOTD| replace:: :abbr:`MOTD (Message of the Day)`
.. |MTU| replace:: :abbr:`MTU (Maximum Transmission Unit)`
.. |NIC| replace:: :abbr:`NIC (Network Interface Card)`
.. |NICs| replace:: :abbr:`NICs (Network Interface Cards)`
.. |NTP| replace:: :abbr:`NTP (Network Time Protocol)`
.. |NUMA| replace:: :abbr:`NUMA (Non-Uniform Memory Access)`
.. |NVMe| replace:: :abbr:`NVMe (Non-Volatile Memory express)`
.. |OAM| replace:: :abbr:`OAM (Operations, administration and management)`
.. |OSD| replace:: :abbr:`OSD (Object Storage Device)`
.. |OSDs| replace:: :abbr:`OSDs (Object Storage Devices)`
.. |PAC| replace:: :abbr:`PAC (Programmable Acceleration Card)`
.. |PCI| replace:: :abbr:`PCI (Peripheral Component Interconnect)`
.. |PDU| replace:: :abbr:`PDU (Packet Data Unit)`
.. |PHB| replace:: :abbr:`PHB (Per-Hop Behavior)`
.. |PTP| replace:: :abbr:`PTP (Precision Time Protocol)`
.. |PVC| replace:: :abbr:`PVC (Persistent Volume Claim)`
.. |PVCs| replace:: :abbr:`PVCs (Persistent Volume Claims)`
.. |PXE| replace:: :abbr:`PXE (Preboot Execution Environment)`
.. |QoS| replace:: :abbr:`QoS (Quality of Service)`
.. |RAID| replace:: :abbr:`RAID (Redundant Array of Inexpensive Disks)`
.. |RPC| replace:: :abbr:`RPC (Remote Procedure Call)`
.. |SAS| replace:: :abbr:`SAS (Serial Attached SCSI)`
.. |SATA| replace:: :abbr:`SATA (Serial AT Attachment)`
.. |SNAT| replace:: :abbr:`SNAT (Source Network Address Translation)`
.. |SNMP| replace:: :abbr:`SNMP (Simple Network Management Protocol)`
.. |SRIOV| replace:: :abbr:`SR-IOV (Single Root I/O Virtualization)`
.. |SSD| replace:: :abbr:`SSD (Solid State Drive)`
.. |SSDs| replace:: :abbr:`SSDs (Solid State Drives)`
.. |SSH| replace:: :abbr:`SSH (Secure Shell)`
.. |SSL| replace:: :abbr:`SSL (Secure Socket Layer)`
.. |STP| replace:: :abbr:`STP (Spanning Tree Protocol)`
.. |TPM| replace:: :abbr:`TPM (Trusted Platform Module)`
.. |ToR| replace:: :abbr:`ToR (Top-of-Rack)`
.. |UDP| replace:: :abbr:`UDP (User Datagram Protocol)`
.. |UEFI| replace:: :abbr:`UEFI (Unified Extensible Firmware Interface)`
.. |VF| replace:: :abbr:`VF (Virtual Function)`
.. |VFs| replace:: :abbr:`VFs (Virtual Functions)`
.. |VLAN| replace:: :abbr:`VLAN (Virtual Local Area Network)`
.. |VLANs| replace:: :abbr:`VLANs (Virtual Local Area Networks)`
.. |VM| replace:: :abbr:`VM (Virtual Machine)`
.. |VMs| replace:: :abbr:`VMs (Virtual Machines)`
.. |VNC| replace:: :abbr:`VNC (Virtual Network Computing)`
.. |VPC| replace:: :abbr:`VPC (Virtual Port Channel)`
.. |VXLAN| replace:: :abbr:`VXLAN (Virtual eXtensible Local Area Network)`
.. |VXLANs| replace:: :abbr:`VXLANs (Virtual eXtensible Local Area Networks)`