Skip to content

Commit 8abfedb

Browse files
Update documentation for clarity and formatting improvements
1 parent e6a1361 commit 8abfedb

File tree

4 files changed

+11
-12
lines changed

4 files changed

+11
-12
lines changed

docs/ARCHITECTURE.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
- **WORKSPACES**: System-specific configuration and credentials management
1010
- **Reporting Engine**: Generates detailed HTML test reports
1111

12-
13-
1412
## Architecture
1513

1614
### High-Level Framework Structure
@@ -81,7 +79,8 @@ graph TB
8179
```
8280

8381
## Directory Structure
84-
```
82+
83+
```plain
8584
src/
8685
├── module_utils/ # Shared utilities and constants
8786
├── modules/ # Custom Ansible modules
@@ -119,4 +118,4 @@ sequenceDiagram
119118
Framework->>Reporting: Generate Failure Report
120119
Reporting-->>User: Failure Report
121120
end
122-
```
121+
```

docs/DB_HIGH_AVAILABILITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616
| Secondary Node Kill | Process | The Secondary Node Kill test examines cluster resilience by forcefully terminating HANA processes on the secondary node using the kill -9 signal. The test validates that the primary node maintains normal operation while the secondary node undergoes recovery, ensuring cluster stability and proper data synchronization after the recovery process completes. | [node-kill.md](./pseudocode/node-kill.md) |
1717
| Secondary Echo B | System | The Secondary Echo B test simulates an uncontrolled system crash on the secondary HANA node by executing the 'echo b' command, triggering an immediate reboot without proper shutdown procedures. The test validates that the primary node maintains operation, verifies cluster stability, and ensures system replication resumes correctly after the secondary node recovers. | [echo-b.md](./pseudocode/echo-b.md) |
1818
| Filesystem Freeze | Storage | The Filesystem Freeze test validates cluster behavior when the primary node's filesystem becomes unresponsive. It simulates a storage issue by freezing the filesystem on the primary node running HANA database, which triggers automatic failover to the secondary node. The test verifies proper cluster reaction, resource migration, and data consistency after recovery. | [freeze-filesystem.md](./pseudocode/freeze-filesystem.md) |
19-
| SBD Fencing | Fencing | Validates cluster fencing mechanism by killing the SBD inquisitor process on the primary node. Tests proper fence detection, node isolation, and automated failover to ensure cluster integrity during hardware or communication failures. | [sbd-fencing.md](./pseudocode/sbd-fencing.md) |
19+
| SBD Fencing | Fencing | Validates cluster fencing mechanism by killing the SBD inquisitor process on the primary node. Tests proper fence detection, node isolation, and automated failover to ensure cluster integrity during hardware or communication failures. | [sbd-fencing.md](./pseudocode/sbd-fencing.md) |

docs/HIGH_AVAILABILITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ In summary, SAP High Availability testing is an integral part of the overall SAP
3232

3333
#### Optional Components
3434

35-
- **Analytics Integration** [Telemetry Setup Information](./docs/TELEMETRY_SETUP.md)
35+
- **Analytics Integration** [Telemetry Setup Information](./TELEMETRY_SETUP.md)
3636
- Azure Log Analytics
3737
- Azure Data Explorer
3838

@@ -232,4 +232,4 @@ cd WORKSPACES/SYSTEM/<SYSTEM_CONFIG_NAME>/quality_assurance/
232232

233233
## Additional Resources
234234

235-
- [Azure SAP Documentation](https://docs.microsoft.com/azure/sap)
235+
- [Azure SAP Documentation](https://docs.microsoft.com/azure/sap)

docs/TELEMETRY_SETUP.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This guide outlines the steps to create an Azure Data Explorer (Kusto) cluster a
77
## Azure Data Explorer (Kusto) Cluster Setup
88

99
1. **Log in to the Azure Portal:**
10-
Navigate to https://portal.azure.com and sign in with your Azure credentials.
10+
Navigate to [Azure Portal](https://portal.azure.com) and sign in with your Azure credentials.
1111

1212
2. **Create a Resource Group:**
1313
- Click on "Resource groups" in the left navigation pane.
@@ -43,12 +43,12 @@ This guide outlines the steps to create an Azure Data Explorer (Kusto) cluster a
4343
- **adx_cluster_fqdn:** Azure Data Explorer Cluster FQDN [Data Ingestion URI].
4444
- **adx_database_name:** Azure Data Explorer Database Name [Database Name]
4545
- **adx_client_id:** Azure Data Explorer Client ID [MSI Client ID]
46-
- **telemetry_table_name:** Name of the table in the ADX database [SAP_AUTOMATION_QA]
46+
- **telemetry_table_name:** Name of the table in the ADX database SAP_AUTOMATION_QA
4747

4848
## Azure Log Analytics Workspace Setup
4949

5050
1. **Log in to the Azure Portal:**
51-
Use https://portal.azure.com with your credentials.
51+
Login to [Azure Portal](https://portal.azure.com) with your credentials.
5252

5353
2. **Create a Resource Group (if needed):**
5454
If you haven't already created a resource group for Log Analytics, follow the same step as above.
@@ -65,7 +65,7 @@ This guide outlines the steps to create an Azure Data Explorer (Kusto) cluster a
6565
4. **Assign Azure Roles for Data Ingestion:**
6666
To ingest or work with data in a Log Analytics Workspace, assign the following roles:
6767
- **Log Analytics Contributor:** Grants permissions to submit and manage data in the workspace.
68-
68+
6969
To assign a role:
7070
- Navigate to the Log Analytics Workspace resource.
7171
- Click on "Access control (IAM)."
@@ -75,4 +75,4 @@ This guide outlines the steps to create an Azure Data Explorer (Kusto) cluster a
7575
5. **Parameters**
7676
- **laws_workspace_id:** Log Analytics Workspace ID [Workspace ID]
7777
- **laws_shared_key:** Log Analytics Shared Key [Primary Key]
78-
- **telemetry_table_name:** Name of the table in Log Analytics [SAP_AUTOMATION_QA]
78+
- **telemetry_table_name:** Name of the table in Log Analytics SAP_AUTOMATION_QA

0 commit comments

Comments
 (0)