Skip to content

Conversation

devanshjainms
Copy link
Contributor

This pull request restructures and improves the documentation for setting up and configuring the SAP Testing Automation Framework. The main change is moving the detailed technical requirements and environment setup instructions out of HIGH_AVAILABILITY.md into a new, dedicated SETUP.MD file. This helps to declutter the high availability documentation and provides a clearer, step-by-step setup guide for users. Additionally, the setup instructions have been updated and expanded.

Documentation restructuring and improvements:

  • All technical requirements, Azure RBAC configuration steps, network connectivity details, analytics integration options, and environment setup instructions have been removed from docs/HIGH_AVAILABILITY.md and moved into a new, dedicated setup guide (docs/SETUP.MD). This makes the high availability documentation more focused and the setup process easier to follow. [1] [2] [3]

  • The new docs/SETUP.MD file includes:

    • Expanded OS support for the management server (now includes REDHAT 9.4).
    • Clear, step-by-step instructions for installing prerequisites, cloning the repository, running the setup script, and activating the Python environment.
    • Consolidated and clarified instructions for configuring Azure managed identities and network connectivity.
  • The docs/HIGH_AVAILABILITY.md file now references the new setup guide for configuration steps, streamlining the document and reducing duplication.

…ramework

- Created a comprehensive setup guide (SETUP.MD) detailing technical requirements for running the SAP Testing Automation Framework on Microsoft Azure, including management server setup, Azure RBAC configuration, and network connectivity.
- Introduced high availability test cases for SAP HANA and SCS clusters, including detailed pseudocode for various scenarios such as resource migration, node crashes, and service failures.
- Added specific test cases for validating HA parameters, Azure Load Balancer configurations, and SAPControl configurations.
- Implemented pseudocode for critical tests like blocking network communication, killing processes, and handling manual restarts, ensuring robust validation of high availability mechanisms.
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request restructures the documentation for the SAP Testing Automation Framework by extracting technical setup requirements from the high availability documentation into a dedicated setup guide. This improves documentation organization by separating concerns and creating clearer, focused guides.

  • Moved all technical requirements, Azure RBAC configuration, and environment setup from HIGH_AVAILABILITY.md to a new SETUP.MD file
  • Updated file path references in high availability test documentation to reflect the new file structure
  • Enhanced the setup guide with expanded OS support (including REDHAT 9.4) and clearer step-by-step instructions

Reviewed Changes

Copilot reviewed 4 out of 17 changed files in this pull request and generated 2 comments.

File Description
docs/SETUP.MD New dedicated setup guide with expanded technical requirements and step-by-step installation instructions
docs/HIGH_AVAILABILITY.md Simplified by removing technical setup content and referencing the new setup guide
docs/high_availability/SCS_HIGH_AVAILABILITY.md Updated file path references to correct relative paths after documentation restructure
docs/high_availability/DB_HIGH_AVAILABILITY.md Updated file path references to correct relative paths after documentation restructure

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 4 out of 17 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Member

@hdamecharla hdamecharla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@devanshjainms devanshjainms merged commit ff35e20 into Azure:development-sep-2025 Sep 30, 2025
6 checks passed
@devanshjainms devanshjainms added the documentation Improvements or additions to documentation label Sep 30, 2025
mkdeegan pushed a commit that referenced this pull request Oct 3, 2025
* Bump requests from 2.32.4 to 2.32.5 (#105)

* Bump requests from 2.32.4 to 2.32.5 (#106)

* Updated logic for HA DB/SCS cluster configuration validation  (#114)

* Restructure the documents for high availability testing (#116)

* Bump pandas from 2.3.1 to 2.3.3 (#118)

Bumps [pandas](https://github.com/pandas-dev/pandas) from 2.3.1 to 2.3.3.
- [Release notes](https://github.com/pandas-dev/pandas/releases)
- [Commits](pandas-dev/pandas@v2.3.1...v2.3.3)

---
updated-dependencies:
- dependency-name: pandas
  dependency-version: 2.3.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Devansh Jain <86314060+devanshjainms@users.noreply.github.com>

* Updated commands to get the automated-register and priority fencing delay (#122)

* Add provider value resolution and enhance parameter status determination logic

* Refactor cluster parameter retrieval logic and update related tests

* Refactor command imports and update cluster status retrieval logic to use new parameters

* Refactor HANA resource handling by renaming parameters and updating related logic across multiple files

* Refactor command execution logic to simplify parameter value retrieval

* Fix typo in method name and update related test cases for cluster parameter retrieval

* Fix inconsistent quote style in test case for cluster parameter retrieval

* Update cluster parameter retrieval to include PRIORITY_FENCING_DELAY and fix typo in test case name

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants