Minor update on HA detail design to align with the latest implementation. (#2044)

* Minor update on HA detail design to align with the latest implementation. #2044

Author: r12f

doc/smart-switch/high-availability/smart-switch-ha-detailed-design.md

@@ -9,58 +9,59 @@
 | 0.5 | 06/03/2024 | Riff Jiang | Added DASH BFD probe state update workflow and DB schema. |
 | 0.6 | 03/23/2025 | Riff Jiang | Split DPU table into DPU and REMOTE_DPU. Add FEATURE table. |
 
-- [1. High level data flow](#1-high-level-data-flow)
-  - [1.1. Upstream config programming path](#11-upstream-config-programming-path)
-  - [1.2. State generation and handling path](#12-state-generation-and-handling-path)
-- [2. Database Schema](#2-database-schema)
-  - [2.1. External facing configuration tables](#21-external-facing-configuration-tables)
-    - [2.1.1. CONFIG\_DB (per-NPU)](#211-config_db-per-npu)
-      - [2.1.1.1. DPU / vDPU definitions](#2111-dpu--vdpu-definitions)
-      - [2.1.1.2. HA global configurations](#2112-ha-global-configurations)
-    - [2.1.2. APPL\_DB (per-NPU)](#212-appl_db-per-npu)
-      - [2.1.2.1. HA set configurations](#2121-ha-set-configurations)
-      - [2.1.2.2. HA scope configurations](#2122-ha-scope-configurations)
-      - [2.1.2.3. ENI placement table (scope = `eni` only)](#2123-eni-placement-table-scope--eni-only)
-    - [2.1.3. DPU\_APPL\_DB (per-DPU)](#213-dpu_appl_db-per-dpu)
-      - [2.1.3.1. DASH object tables](#2131-dash-object-tables)
-  - [2.2. External facing state tables](#22-external-facing-state-tables)
-    - [2.2.1. STATE\_DB (per-NPU)](#221-state_db-per-npu)
-      - [2.2.1.1. HA scope state](#2211-ha-scope-state)
-        - [2.2.1.1.1. Table key](#22111-table-key)
-        - [2.2.1.1.2. Basic information](#22112-basic-information)
-        - [2.2.1.1.3. HA related states](#22113-ha-related-states)
-        - [2.2.1.1.4. Aggregated health signals for this HA scope](#22114-aggregated-health-signals-for-this-ha-scope)
-        - [2.2.1.1.5. Ongoing HA operation state](#22115-ongoing-ha-operation-state)
-  - [2.3. Tables used by HA internally](#23-tables-used-by-ha-internally)
-    - [2.3.1. DPU\_APPL\_DB (per-DPU)](#231-dpu_appl_db-per-dpu)
-      - [2.3.1.1. HA set configurations](#2311-ha-set-configurations)
-      - [2.3.1.2. HA scope configurations](#2312-ha-scope-configurations)
-      - [2.3.1.3. Flow sync sessions](#2313-flow-sync-sessions)
-    - [2.3.2. APPL\_DB (per-NPU)](#232-appl_db-per-npu)
-      - [2.3.2.1. DASH\_ENI\_FORWARD\_TABLE](#2321-dash_eni_forward_table)
-    - [2.3.3. CHASSIS\_STATE\_DB (per-NPU)](#233-chassis_state_db-per-npu)
-      - [2.3.3.1. DPU / vDPU state](#2331-dpu--vdpu-state)
-    - [2.3.4. DPU\_STATE\_DB (per-DPU)](#234-dpu_state_db-per-dpu)
-      - [2.3.4.1. HA set state](#2341-ha-set-state)
-      - [2.3.4.2. HA scope state](#2342-ha-scope-state)
-      - [2.3.4.3. Flow sync session states](#2343-flow-sync-session-states)
-      - [2.3.4.4. DASH BFD probe state](#2344-dash-bfd-probe-state)
-- [3. Telemetry](#3-telemetry)
-  - [3.1. HA state and related health signals](#31-ha-state-and-related-health-signals)
-  - [3.2. Traffic forwarding related](#32-traffic-forwarding-related)
-    - [3.2.1. NPU-to-DPU probe status (Per-HA Scope)](#321-npu-to-dpu-probe-status-per-ha-scope)
-    - [3.2.2. NPU-to-DPU tunnel counters (Per-HA Scope)](#322-npu-to-dpu-tunnel-counters-per-ha-scope)
-  - [3.3. DPU traffic handling related](#33-dpu-traffic-handling-related)
-    - [3.3.1. DPU level counters (Per-DPU)](#331-dpu-level-counters-per-dpu)
-    - [3.3.2. ENI-level traffic counters (Per-ENI)](#332-eni-level-traffic-counters-per-eni)
-    - [3.3.3. ENI-level pipeline drop counters (Per-ENI)](#333-eni-level-pipeline-drop-counters-per-eni)
-    - [3.3.4. ENI-level flow operation counters (Per-ENI)](#334-eni-level-flow-operation-counters-per-eni)
-  - [3.4. Flow sync counters](#34-flow-sync-counters)
-    - [3.4.1. Data plane channel probing (Per-HA Set)](#341-data-plane-channel-probing-per-ha-set)
-    - [3.4.2. Inline flow sync (Per-ENI)](#342-inline-flow-sync-per-eni)
-    - [3.4.3. Bulk sync related counters (Per-HA Set)](#343-bulk-sync-related-counters-per-ha-set)
-- [4. SAI APIs](#4-sai-apis)
-- [5. CLI commands](#5-cli-commands)
+1. [1. High level data flow](#1-high-level-data-flow)
+   1. [1.1. Upstream config programming path](#11-upstream-config-programming-path)
+   2. [1.2. State generation and handling path](#12-state-generation-and-handling-path)
+2. [2. Database Schema](#2-database-schema)
+   1. [2.1. External facing configuration tables](#21-external-facing-configuration-tables)
+      1. [2.1.1. CONFIG\_DB (per-NPU)](#211-config_db-per-npu)
+         1. [2.1.1.1. DPU / vDPU definitions](#2111-dpu--vdpu-definitions)
+         2. [2.1.1.2. HA global configurations](#2112-ha-global-configurations)
+      2. [2.1.2. APPL\_DB (per-NPU)](#212-appl_db-per-npu)
+         1. [2.1.2.1. HA set configurations](#2121-ha-set-configurations)
+         2. [2.1.2.2. HA scope configurations](#2122-ha-scope-configurations)
+         3. [2.1.2.3. ENI placement table (scope = `eni` only)](#2123-eni-placement-table-scope--eni-only)
+      3. [2.1.3. DPU\_APPL\_DB (per-DPU)](#213-dpu_appl_db-per-dpu)
+         1. [2.1.3.1. DASH object tables](#2131-dash-object-tables)
+      4. [2.1.4. FEATURE](#214-feature)
+   2. [2.2. External facing state tables](#22-external-facing-state-tables)
+      1. [2.2.1. STATE\_DB (per-NPU)](#221-state_db-per-npu)
+         1. [2.2.1.1. HA scope state](#2211-ha-scope-state)
+            1. [2.2.1.1.1. Table key](#22111-table-key)
+            2. [2.2.1.1.2. Basic information](#22112-basic-information)
+            3. [2.2.1.1.3. HA related states](#22113-ha-related-states)
+            4. [2.2.1.1.4. Aggregated health signals for this HA scope](#22114-aggregated-health-signals-for-this-ha-scope)
+            5. [2.2.1.1.5. Ongoing HA operation state](#22115-ongoing-ha-operation-state)
+   3. [2.3. Tables used by HA internally](#23-tables-used-by-ha-internally)
+      1. [2.3.1. DPU\_APPL\_DB (per-DPU)](#231-dpu_appl_db-per-dpu)
+         1. [2.3.1.1. HA set configurations](#2311-ha-set-configurations)
+         2. [2.3.1.2. HA scope configurations](#2312-ha-scope-configurations)
+         3. [2.3.1.3. Flow sync sessions](#2313-flow-sync-sessions)
+      2. [2.3.2. APPL\_DB (per-NPU)](#232-appl_db-per-npu)
+         1. [2.3.2.1. DASH\_ENI\_FORWARD\_TABLE](#2321-dash_eni_forward_table)
+      3. [2.3.3. CHASSIS\_STATE\_DB (per-NPU)](#233-chassis_state_db-per-npu)
+         1. [2.3.3.1. DPU / vDPU state](#2331-dpu--vdpu-state)
+      4. [2.3.4. DPU\_STATE\_DB (per-DPU)](#234-dpu_state_db-per-dpu)
+         1. [2.3.4.1. HA set state](#2341-ha-set-state)
+         2. [2.3.4.2. HA scope state](#2342-ha-scope-state)
+         3. [2.3.4.3. Flow sync session states](#2343-flow-sync-session-states)
+         4. [2.3.4.4. DASH BFD probe state](#2344-dash-bfd-probe-state)
+3. [3. Telemetry](#3-telemetry)
+   1. [3.1. HA state and related health signals](#31-ha-state-and-related-health-signals)
+   2. [3.2. Traffic forwarding related](#32-traffic-forwarding-related)
+      1. [3.2.1. NPU-to-DPU probe status (Per-HA Scope)](#321-npu-to-dpu-probe-status-per-ha-scope)
+      2. [3.2.2. NPU-to-DPU tunnel counters (Per-HA Scope)](#322-npu-to-dpu-tunnel-counters-per-ha-scope)
+   3. [3.3. DPU traffic handling related](#33-dpu-traffic-handling-related)
+      1. [3.3.1. DPU level counters (Per-DPU)](#331-dpu-level-counters-per-dpu)
+      2. [3.3.2. ENI-level traffic counters (Per-ENI)](#332-eni-level-traffic-counters-per-eni)
+      3. [3.3.3. ENI-level pipeline drop counters (Per-ENI)](#333-eni-level-pipeline-drop-counters-per-eni)
+      4. [3.3.4. ENI-level flow operation counters (Per-ENI)](#334-eni-level-flow-operation-counters-per-eni)
+   4. [3.4. Flow sync counters](#34-flow-sync-counters)
+      1. [3.4.1. Data plane channel probing (Per-HA Set)](#341-data-plane-channel-probing-per-ha-set)
+      2. [3.4.2. Inline flow sync (Per-ENI)](#342-inline-flow-sync-per-eni)
+      3. [3.4.3. Bulk sync related counters (Per-HA Set)](#343-bulk-sync-related-counters-per-ha-set)
+4. [4. SAI APIs](#4-sai-apis)
+5. [5. CLI commands](#5-cli-commands)
 
 ## 1. High level data flow
 
@@ -527,7 +528,7 @@ When a HA set configuration on NPU side contains a local DPU, `hamgrd` will crea
 | | | version | Config version. |
 | | | vip_v4 | IPv4 Data path VIP. |
 | | | vip_v6 | IPv6 Data path VIP. |
-| | | owner | Owner of HA state machine. It can be `controller`, `switch`. |
+| | | owner | Owner of HA state machine. It can be `dpu`, `switch`. |
 | | | scope | Scope of HA set. It can be `dpu`, `eni`. |
 | | | local_npu_ip | The IP address of local NPU. It can be IPv4 or IPv6. Used for setting up the BFD session. |
 | | | local_ip | The IP address of local DPU. It can be IPv4 or IPv6. |
@@ -614,8 +615,10 @@ DPU state table stores the health states of each DPU. These data are collected b
 | DASH_HA_SCOPE_STATE | | | State of each HA scope. |
 | | \<HA_SCOPE_ID\> | | HA scope ID. It can be the HA set ID or ENI ID, depending on the which HA mode is used. |
 | | | last_updated_time | The last update time of this state in milliseconds. |
-| | | ha_role | The current HA role confirmed by ASIC. Please refer to the HA states defined in HA HLD. |
+| | | ha_role | The current HA role confirmed by ASIC. Please refer to the HA roles defined in HA HLD. |
 | | | ha_role_start_time | The time when HA role is moved into current one in milliseconds. |
+| | | ha_state | Please refer to the HA states defined in HA HLD. |
+| | | ha_state_start_time | The time when HA state is moved into current one in milliseconds. |
 | | | ha_term | The current term confirmed by ASIC. |
 | | | activate_role_pending | DPU is pending on role activation. |
 | | | flow_reconcile_pending | Flow reconcile is requested and pending approval. |