Hotfix update that includes some minor bug fixes and improvements in docs (Azure#62)

Author: devanshjainms

.github/dependabot.yml

@@ -6,8 +6,14 @@ updates:
     directory: /
     schedule:
       interval: daily
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-minor"]
 
   - package-ecosystem: pip
     directory: /
     schedule:
       interval: daily
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-minor"]

.github/workflows/codeql.yml

@@ -46,14 +46,14 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@d68b2d4edb4189fd2a5366ac14e72027bd4b37dd # v3.28.2
+        uses: github/codeql-action/init@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
         with:
           languages: ${{ matrix.language }}
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@d68b2d4edb4189fd2a5366ac14e72027bd4b37dd # v3.28.2
+        uses: github/codeql-action/autobuild@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@d68b2d4edb4189fd2a5366ac14e72027bd4b37dd # v3.28.2
+        uses: github/codeql-action/analyze@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
         with:
           category: "/language:${{matrix.language}}"

.github/workflows/ossf-scoreboard.yml

@@ -50,6 +50,6 @@ jobs:
           retention-days: 5
 
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@d68b2d4edb4189fd2a5366ac14e72027bd4b37dd # v3.28.2
+        uses: github/codeql-action/upload-sarif@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
         with:
           sarif_file: results.sarif

.github/workflows/trivy.yml

@@ -36,7 +36,7 @@ jobs:
         output: report-fs.sarif
 
     - name: Upload Trivy report (fs) GitHub Security
-      uses: github/codeql-action/upload-sarif@9e8d0789d4a0fa9ceb6b1738f7e269594bdd67f0 # v3.28.9
+      uses: github/codeql-action/upload-sarif@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
       with:
         sarif_file: report-fs.sarif
         category: 'fs'

README.md

@@ -1,17 +1,22 @@
 # SAP Testing Automation Framework
 
+![SAP Testing Automation Framework](./docs/images/sap-automation-qa.svg)
+
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 [![Azure](https://img.shields.io/badge/Microsoft-SAP%20on%20Azure-0078D4?logo=microsoft)](https://docs.microsoft.com/azure/sap)
 [![Python Coverage](https://img.shields.io/badge/Code%20Coverage-85%25-success?logo=python&logoColor=white)](https://github.com/Azure/sap-automation-qa/actions/workflows/github-actions-code-coverage.yml)
 [![Ansible Lint](https://github.com/Azure/sap-automation-qa/actions/workflows/github-actions-ansible-lint.yml/badge.svg)](https://github.com/Azure/sap-automation-qa/actions/workflows/github-actions-ansible-lint.yml)
 [![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/Azure/sap-automation-qa)](https://scorecard.dev/viewer/?uri=github.com/Azure/sap-automation-qa)
+[![GitHub Issues](https://img.shields.io/github/issues/Azure/sap-automation-qa)](https://github.com/Azure/sap-automation-qa/issues)
 
 ## 🔍 Overview
 
 The SAP Testing Automation Framework is an open-source orchestration tool designed to validate SAP deployments on Microsoft Azure. It enables you to assess system configurations against SAP on Azure best practices and guidelines. Additionally, the framework facilitates automation for various testing scenarios, including High Availability (HA) functional testing.
 
 > **NOTE**: This repository is currently in private preview and is intended for testing and feedback purposes. As this is an early release, it is not yet production-ready, and breaking changes can be introduced at any time.
 
+![SAP Testing Automation Framework](./docs/images/sap-testing-automation-framework.png)
+
 ## Supported Configuration Matrix
 
 The following SAP components are supported in a two-node Pacemaker cluster running on SUSE Linux Enterprise Server (SLES) or Red Hat Enterprise Linux (RHEL):

docs/HIGH_AVAILABILITY.md

@@ -20,6 +20,7 @@ Currently SAP Testing Automation Framework is supported for below Linux distros
 | Component | Type | Cluster Type | Storage |
 |-----------|------|--------------|---------|
 | SAP Central Services | ENSA1 or ENSA2 | Azure Fencing Agent | Azure Files or ANF |
+| SAP Central Services | ENSA1 or ENSA2 | ISCSI (SBD device) | Azure Files or ANF |
 | SAP HANA | Scale-up | Azure Fencing Agent | Azure Managed Disk or ANF |
 | SAP HANA | Scale-up | ISCSI (SBD device) | Azure Managed Disk or ANF |
 
@@ -36,6 +37,15 @@ To run the SAP Testing Automation Framework, you must meet certain prerequisites
   - [SAP HANA high availability on Azure Virtual Machine](https://learn.microsoft.com/azure/sap/workloads/sap-high-availability-guide-start).
   - [SAP Netweaver high availability on Azure Virtual Machine](https://learn.microsoft.com/azure/sap/workloads/sap-high-availability-guide-start)
 
+### Enabling Cluster Services on Boot
+    
+Before executing the tests, ensure that the cluster services are configured to start automatically during system boot. Run the following command on one of the cluster nodes to enable this setting. The `--all` option ensures that the cluster services are enabled on all nodes within the cluster.
+
+```bash
+crm cluster enable --all  # for SUSE virtual machines
+pcs cluster enable --all  # for RedHat virtual machine
+```
+
 ### Management server
 
 The SAP Testing Automation Framework requires a jumpbox or management server with the following setup:
@@ -85,14 +95,17 @@ To set up your enviroment in management server, follow these steps:
 
 Ensure you are logged into the Ubuntu management server that is connected to the SAP system's virtual network.
 
-1.2. **Clone the repository**:
+1.2. **Fork and clone the repository**:
 
 ```bash
 # sudo to root
 sudo su -
 
-# Clone the repository
-git clone https://github.com/Azure/sap-automation-qa.git
+# First, visit https://github.com/Azure/sap-automation-qa in your browser
+# Click the "Fork" button in the top-right corner to create a fork in your GitHub account
+
+# Clone your fork of the repository (replace GITHUB-USERNAME with your GitHub username)
+git clone https://github.com/GITHUB-USERNAME/sap-automation-qa.git
 cd sap-automation-qa
 ```
 
@@ -271,6 +284,51 @@ Test results and logs can be found in:
 cd WORKSPACES/SYSTEM/<SYSTEM_CONFIG_NAME>/quality_assurance/
 ```
 
+## Update the framework
+
+To ensure you have the latest features and fixes, it's important to keep your fork of the SAP Testing Automation Framework up to date. You can do this by pulling the latest changes from the original repository into your fork.
+
+### Steps to update your fork
+
+1. **Ensure you have the upstream repository configured**:
+
+    ```bash
+    # Check if you already have the upstream remote
+    git remote -v
+
+    # If you don't see an 'upstream' entry, add it
+    git remote add upstream https://github.com/Azure/sap-automation-qa.git
+    ```
+
+2. **Fetch the latest changes from the upstream repository**:
+
+    ```bash
+    git fetch upstream
+    ```
+
+3. **Ensure you're on your main branch**:
+
+    ```bash
+    git checkout main
+    ```
+
+4. **Merge the changes from upstream into your local fork**:
+
+    ```bash
+    git merge upstream/main
+    ```
+
+5. **Push the updated code to your GitHub fork**:
+
+    ```bash
+    git push origin main
+    ```
+
+This process will update your fork with all the latest features, bug fixes, and improvements from the original SAP Testing Automation Framework repository.
+
+> [!NOTE]
+> If you've made local changes to your fork, you might encounter merge conflicts during step 4. In that case, you'll need to resolve these conflicts before proceeding with the push in step 5.
+
 ## Additional Resources
 
 - [Azure SAP Documentation](https://docs.microsoft.com/azure/sap)

docs/images/sap-automation-qa.svg

@@ -0,0 +1,35 @@
+# Ansible packages
+ansible-core
+ansible-lint
+ansible-runner
+
+# Azure packages
+azure-identity
+azure-kusto-data
+azure-kusto-ingest
+azure-mgmt-network
+azure-storage-blob
+azure-storage-queue
+
+# Development tools
+black
+pylint
+coverage
+
+# Testing packages
+pytest
+pytest-cov
+pytest-mock
+
+# Data processing
+numpy
+pandas
+
+# Core utilities
+Jinja2
+PyYAML
+requests
+
+# CLI tools
+click
+rich