diff --git a/doc/source/cli_ref/system.rst b/doc/source/cli_ref/system.rst index 49dffc64e..1771c52c0 100644 --- a/doc/source/cli_ref/system.rst +++ b/doc/source/cli_ref/system.rst @@ -734,7 +734,7 @@ Controller services management ****************************** The following set of commands enables display of services running on the |prod| -controllers/masters. Optional services can be enabled or disabled using these +controllers. Optional services can be enabled or disabled using these commands. ``servicenode-list`` diff --git a/doc/source/deploy/standard-configuration-with-dedicated-storage.rst b/doc/source/deploy/standard-configuration-with-dedicated-storage.rst index 8bd290b54..3ad5b6fdd 100644 --- a/doc/source/deploy/standard-configuration-with-dedicated-storage.rst +++ b/doc/source/deploy/standard-configuration-with-dedicated-storage.rst @@ -20,10 +20,10 @@ storage, and worker functionalities are deployed on separate physical hosts allowing controller nodes, storage nodes, and worker nodes to scale independently from each other. -The controller nodes provide the master function for the system. Two controller -nodes are required to provide redundancy. The controller nodes' server and -peripheral resources such as CPU cores/speed, memory, storage, and network -interfaces can be scaled to meet requirements. +The controller nodes provide the control-plane function for the +system. Two controller nodes are required to provide redundancy. The controller +nodes' server and peripheral resources such as CPU cores/speed, memory, +storage, and network interfaces can be scaled to meet requirements. Storage nodes provide a large scale Ceph cluster for the storage backend for Kubernetes |PVCs|. They are deployed in replication groups of either two or diff --git a/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst b/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst index 26ec39518..0c27e4655 100644 --- a/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst +++ b/doc/source/deploy_install_guides/r5_release/distributed_cloud/index.rst @@ -29,7 +29,8 @@ are localized for maximum responsiveness. The architecture features: - Centralized orchestration of edge cloud control planes. - Full synchronized control planes at edge clouds (that is, Kubernetes cluster - master and nodes), with greater benefits for local services, such as: + control-plane and worker nodes), with greater benefits for local + services, such as: - Reduced network latency. - Operational availability, even if northbound connectivity diff --git a/doc/source/developer_resources/stx_tsn_in_kata.rst b/doc/source/developer_resources/stx_tsn_in_kata.rst index ffc849310..b04584580 100644 --- a/doc/source/developer_resources/stx_tsn_in_kata.rst +++ b/doc/source/developer_resources/stx_tsn_in_kata.rst @@ -272,7 +272,7 @@ were used to do time synchronization on the TSN network. #. Launch ``ptp4l`` on both the TSN switch and ``Node 2 (Ubuntu)`` to synchronize their PTP clocks. The TSN switch's PTP clock was set as the - master clock by default. + primary clock by default. :: diff --git a/doc/source/guest_integration/kubernetes/install-ptp-notifications.rst b/doc/source/guest_integration/kubernetes/install-ptp-notifications.rst index 6ffda21ac..4af60c8e0 100644 --- a/doc/source/guest_integration/kubernetes/install-ptp-notifications.rst +++ b/doc/source/guest_integration/kubernetes/install-ptp-notifications.rst @@ -22,8 +22,8 @@ asynchronous |PTP| status notifications and pull for the |PTP| state on demand. .. _install-ptp-notifications-ul-ydy-ggf-t4b: -- The |PTP| port must be configured as Subordinate mode \(Slave mode\). For - more information, see, +- The |PTP| port must be configured as Subordinate mode \(Secondary mode\). + For more information, see, .. xbooklink :ref:`|prod-long| System Configuration `: @@ -58,7 +58,7 @@ Use the following steps to install the **ptp-notification** application. ~(keystone_admin)]$ system host-label-assign controller-1 ptp-registration=true #. Assign the |PTP| notification label to the node that is configured with - a Slave |PTP| port. For example: + a Secondary |PTP| port. For example: .. code-block:: none diff --git a/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst b/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst index a30743e3d..c5ef8181e 100644 --- a/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst +++ b/doc/source/guest_integration/kubernetes/integrate-application-with-notification-client-sidecar.rst @@ -33,7 +33,7 @@ The following prerequisites are required before the integration: .. _integrate-the-application-with-notification-client-sidecar-ul-iyd-mxf-t4b: -- The cloud is configured with a node that supports the Subordinate mode \(Slave mode\). +- The cloud is configured with a node that supports the Subordinate mode \(Secondary mode\). - The cloud is labeled with **ptp-registration=true**, and **ptp-notification=true**. diff --git a/doc/source/guest_integration/kubernetes/ptp-notifications-overview.rst b/doc/source/guest_integration/kubernetes/ptp-notifications-overview.rst index 14fab8cdd..0165b687f 100644 --- a/doc/source/guest_integration/kubernetes/ptp-notifications-overview.rst +++ b/doc/source/guest_integration/kubernetes/ptp-notifications-overview.rst @@ -29,7 +29,7 @@ same pod and communicates with the application via a REST API. `__. - Supports the **ptp4l** module and |PTP| port that is configured in - Subordinate mode \(Slave mode\). + Subordinate mode \(Secondary mode\). - The |PTP| status notifications are derived based on the following conditions: @@ -41,19 +41,19 @@ same pod and communicates with the application via a REST API. .. table:: :widths: auto - +---------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Clock Status | Status | Description | - +=====================+===================================================+====================================================================================================================================================+ - | Freerun | Clock is out of sync state | - If portState is not "SLAVE" or ClockClass value is NOT "6, 7 or 135" or timeTraceable flag is FALSE. | - | | | | - | | | - If holdover time exceeds its provided value. | - | | | | - | | | - If PMC, ptp4l.conf, ptp4l or phc2sys are not accessible. | - +---------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Locked | Clock is in sync state | If portState is "SLAVE" and ClockClass value is "6, 7 or 135" and timeTraceable flag is TRUE and PMC, ptp4l.conf, ptp4l or phc2sys are accessible. | - +---------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Holdover | Clock is in holdover state | If the state is transitioned from "Locked" to "Freerun" AND phc2sys is accessible, and holdover time does not expire. | - +---------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Clock Status | Status | Description | + +=====================+===================================================+========================================================================================================================================================+ + | Freerun | Clock is out of sync state | - If portState is not "SECONDARY" or ClockClass value is NOT "6, 7 or 135" or timeTraceable flag is FALSE. | + | | | | + | | | - If holdover time exceeds its provided value. | + | | | | + | | | - If PMC, ptp4l.conf, ptp4l or phc2sys are not accessible. | + +---------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Locked | Clock is in sync state | If portState is "SECONDARY" and ClockClass value is "6, 7 or 135" and timeTraceable flag is TRUE and PMC, ptp4l.conf, ptp4l or phc2sys are accessible. | + +---------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Holdover | Clock is in holdover state | If the state is transitioned from "Locked" to "Freerun" AND phc2sys is accessible, and holdover time does not expire. | + +---------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ **Integrated Containerized Applications** diff --git a/doc/source/node_management/kubernetes/node_interfaces/changing-a-management-interface-to-aggregated-using-the-cli.rst b/doc/source/node_management/kubernetes/node_interfaces/changing-a-management-interface-to-aggregated-using-the-cli.rst index c01169348..5802edea9 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/changing-a-management-interface-to-aggregated-using-the-cli.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/changing-a-management-interface-to-aggregated-using-the-cli.rst @@ -14,7 +14,7 @@ To configure a management |LAG| interface you first need to remove the internal management network type from the existing management Ethernet interface and then add a new |AE| interface, specifying the mgmt network type, ae interface type, 802.3 |AE| mode, transmit hash policy -and the slave interfaces. +and the standby interfaces. .. rubric:: |prereq| diff --git a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst index dff472afb..ee10037a6 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/configuring-aggregated-ethernet-interfaces-using-the-cli.rst @@ -86,7 +86,7 @@ Settings `. **reselect_option** The parameter that specifies the reselection policy for the primary - slave of an aggregated ethernet active standby interface. For + standby of an aggregated ethernet active standby interface. For information on valid values, see :ref:`Link Aggregation Settings `. diff --git a/doc/source/node_management/kubernetes/node_interfaces/link-aggregation-settings.rst b/doc/source/node_management/kubernetes/node_interfaces/link-aggregation-settings.rst index af676dc42..bba0d07df 100644 --- a/doc/source/node_management/kubernetes/node_interfaces/link-aggregation-settings.rst +++ b/doc/source/node_management/kubernetes/node_interfaces/link-aggregation-settings.rst @@ -34,20 +34,20 @@ kernel Ethernet Bonding Driver documentation available online * - Active-backup \(default value\) - - Provides fault tolerance. Only one slave interface at a time is - available. The backup slave interface becomes active only when the - active slave interface fails. + - Provides fault tolerance. Only one standby interface at a time is + available. The backup standby interface becomes active only when the + active standby interface fails. For platform interfaces \(such as, |OAM|, cluster-host, and management interfaces\), the system will select the interface with the lowest - |MAC| address as the primary interface when all slave interfaces are + |MAC| address as the primary interface when all standby interfaces are enabled. - Management, |OAM|, cluster-host, and data interface * - Balanced XOR - Provides aggregated bandwidth and fault tolerance. The same - slave interface is used for each destination |MAC| address. + standby interface is used for each destination |MAC| address. - This mode uses the default transmit policy, where the target slave + This mode uses the default transmit policy, where the target standby interface is determined by calculating the source |MAC| address XOR'd with the destination |MAC| address, modulo 2. @@ -108,15 +108,16 @@ kernel Ethernet Bonding Driver documentation available online * - Always \(default value\) - - The primary slave becomes an active slave whenever it comes back up. + - The primary standby becomes an active standby whenever it comes back up. - |OAM|, internal management, and cluster-host * - Better - - The primary slave becomes active slave whenever it comes back up, if the - speed and the duplex of the primary slave is better than the speed duplex of the current active slave. + - The primary standby becomes active standby whenever it comes back up, + if the speed and the duplex of the primary standby is better than the + speed duplex of the current active standby. - |OAM|, internal management, and cluster-host * - Failure - - The primary slave becomes the active slave only if the current active - slave fails and the primary slave is up. + - The primary standby becomes the active standby only if the current active + standby fails and the primary standby is up. - |OAM|, internal management, and cluster-host ----------------------------------------- diff --git a/doc/source/operations/tsn.rst b/doc/source/operations/tsn.rst index 37600431d..643fa5fd2 100644 --- a/doc/source/operations/tsn.rst +++ b/doc/source/operations/tsn.rst @@ -267,8 +267,8 @@ In the demo * ``ptp4l`` daemons run on both the edge gateway and edge device to sync the PTP clock based on IEEE 802.1AS Generalized Precision Time Protocol (gPTP), - with the edge gateway serving as grandmaster clock and the edge device serving - as slave clock. + with the edge gateway serving as primary clock and the edge device serving + as secondary clock. * ``phc2sys`` daemons run on both devices to synchronize the system clock with the PTP clock. @@ -353,7 +353,7 @@ interfering best-effort traffic enters the system. Time Aware Shaper (TAS) demo ---------------------------- -This demo focuses on the use of IEEE 802.1Qbv or Time Aware Shaper (TAS) and +This demo focuses on the use of |IEEE| 802.1Qbv or Time Aware Shaper (TAS) and the LaunchTime feature of Intel® Ethernet Controller I210 to ensure much more bounded and low latency for period control applications. It includes 3 scenarios: @@ -364,9 +364,9 @@ bounded and low latency for period control applications. It includes 3 scenarios In the demo * ``ptp4l`` daemons run on both the edge gateway and edge device to sync the - PTP clock based on IEEE 802.1AS Generalized Precision Time Protocol (gPTP), - with the edge gateway serving as grandmaster clock and the edge device serving - as slave clock. + PTP clock based on |IEEE| 802.1AS Generalized Precision Time Protocol (gPTP), + with the edge gateway serving as primary clock and the edge device serving + as secondary clock. * ``phc2sys`` daemons run on both devices to synchronize the system clock with the PTP clock. diff --git a/doc/source/planning/kubernetes/the-storage-network.rst b/doc/source/planning/kubernetes/the-storage-network.rst index b2b9e959b..6e707821a 100755 --- a/doc/source/planning/kubernetes/the-storage-network.rst +++ b/doc/source/planning/kubernetes/the-storage-network.rst @@ -9,9 +9,9 @@ Storage Network The storage network is an optional network that is only required if using an external Netapp Trident cluster as a storage backend. -The storage network provides connectivity between all nodes in the -|prod-long| cluster \(controller/master nodes and worker nodes\) and the -Netapp Trident cluster. +The storage network provides connectivity between all nodes in the |prod-long| +cluster \(controller nodes and worker nodes\) and the Netapp +Trident cluster. For the most part, the storage network shares the design considerations applicable to the internal management network. diff --git a/doc/source/security/kubernetes/configure-local-cli-access.rst b/doc/source/security/kubernetes/configure-local-cli-access.rst index 5676ae5ce..dffeaf6b6 100644 --- a/doc/source/security/kubernetes/configure-local-cli-access.rst +++ b/doc/source/security/kubernetes/configure-local-cli-access.rst @@ -5,7 +5,7 @@ Configure Local CLI Access ========================== -You can access the system via a local CLI from the active controller/master +You can access the system via a local CLI from the active controller node's local console or by SSH-ing to the OAM floating IP Address. .. rubric:: |context| diff --git a/doc/source/security/kubernetes/security-default-firewall-rules.rst b/doc/source/security/kubernetes/security-default-firewall-rules.rst index 019de2ede..43f1b2752 100644 --- a/doc/source/security/kubernetes/security-default-firewall-rules.rst +++ b/doc/source/security/kubernetes/security-default-firewall-rules.rst @@ -139,7 +139,7 @@ Where: .. note:: UDP ports 2222 and 2223 are used by the service manager for state - synchronization and heart beating between the controllers/masters. All - messages are authenticated with a SHA512 HMAC. Only packets originating - from the peer controller are permitted; all other packets are dropped. + synchronization and heart beating between the controllers. All messages are + authenticated with a SHA512 HMAC. Only packets originating from the peer + controller are permitted; all other packets are dropped. diff --git a/doc/source/security/kubernetes/the-cert-manager-bootstrap-process.rst b/doc/source/security/kubernetes/the-cert-manager-bootstrap-process.rst index edad9c80f..ab9db1f2d 100644 --- a/doc/source/security/kubernetes/the-cert-manager-bootstrap-process.rst +++ b/doc/source/security/kubernetes/the-cert-manager-bootstrap-process.rst @@ -73,7 +73,7 @@ At a high-level, the default configuration for the two mandatory applications is - nginx-ingress-controller - - Runs as a DaemonSet only on masters/controllers. + - Runs as a DaemonSet only on controllers. - Uses host networking, which means it can use any port numbers. @@ -85,7 +85,7 @@ At a high-level, the default configuration for the two mandatory applications is - cert-manager - - Runs as a Deployment only on masters/controllers. + - Runs as a Deployment only on controllers. - Runs with a podAntiAffinity rule to prevent multiple pods of deployment from running on the same node. diff --git a/doc/source/shared/abbrevs.txt b/doc/source/shared/abbrevs.txt index 930245dd6..f4d6c51ab 100755 --- a/doc/source/shared/abbrevs.txt +++ b/doc/source/shared/abbrevs.txt @@ -44,6 +44,7 @@ .. |FQDNs| replace:: :abbr:`FQDNs (Fully Qualified Domain Names)` .. |GNP| replace:: :abbr:`GNP (Global Network Policy)` .. |ICMP| replace:: :abbr:`ICMP (Internet Control Message Protocol)` +.. |IEEE| replace:: :abbr:`IEEE (Institute of Electrical and Electronics Engineers)` .. |IGMP| replace:: :abbr:`IGMP (Internet Group Management Protocol)` .. |IoT| replace:: :abbr:`IoT (Internet of Things)` .. |IPMI| replace:: :abbr:`IPMI (Intelligent Platform Management Interface)` diff --git a/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst b/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst index 7f5381ed8..4356bd83b 100644 --- a/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst +++ b/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst @@ -188,14 +188,14 @@ To view the |PTP| service configuration, use the following command: - **PTP Role** - |PTP| master/slave interfaces are not defined by default. They must be + |PTP| primary/secondary interfaces are not defined by default. They must be specified by the administrator for each host. - The **ptp\_role** option can be added to interfaces, and can be defined - for master, slave, and none. This option allows administrators to - configure interfaces that can be used for |PTP| services. The master and - slave roles are limited to platform, |SRIOV|, and VF interfaces. Any number - of master and slave interfaces can be specified per host. + The **ptp\_role** option can be added to interfaces, and can be defined for + primary, secondary, and none. This option allows administrators to + configure interfaces that can be used for |PTP| services. The primary and + secondary roles are limited to platform, |SRIOV|, and VF interfaces. Any + number of primary and secondary interfaces can be specified per host. If a host has **clock\_synchronization=ptp**, there must be at least one host interface with a |PTP| role specified. This is enforced during host