cdot65 / pan-os-upgrade

An efficient tool to execute configuration backups, network state snapshots, system readiness checks, and operating system upgrades of Palo Alto Networks firewalls and Panorama appliances.
https://cdot65.github.io/pan-os-upgrade/
Apache License 2.0
39 stars 9 forks source link

Update Readme Screenshot, Remove 'jobs' Readiness Check, and Add Retry Mechanism for Upgrade #18

Closed cdot65 closed 9 months ago

cdot65 commented 9 months ago

Summary of Changes

This pull request introduces several key updates to the panos-upgrade-assurance script, which enhance its functionality and user documentation. The changes are as follows:

Update Readme Screenshot

Resolves the enhancement request #19 for updating the README file's screenshot to showcase the full upgrade workflow of the script.

Includes a new, comprehensive screenshot that visually represents the entire upgrade process, from start to finish.

Remove 'jobs' Readiness Check:

Addresses the bug #8 reported where the 'jobs' readiness check was causing script failures due to error handling issues. The 'jobs' check has been removed to ensure smooth script execution and prevent errors during readiness evaluation.

Incorporate Retry Mechanism for Upgrade Process

Adds a new feature to the script: a retry mechanism for the upgrade process.

This mechanism is designed to automatically retry the upgrade in case of certain types of failures, enhancing the robustness and reliability of the upgrade process.

Testing

Comprehensive testing has been conducted to ensure that each update functions as intended. The README's new screenshot has been reviewed for clarity and accuracy. The removal of the 'jobs' readiness check has been tested to confirm that it resolves the reported bug without introducing new issues. The new retry mechanism has been rigorously tested under various scenarios to ensure its effectiveness in handling upgrade failures.

Documentation

Updated the README file to reflect the changes in the script's functionality and to include the new screenshot. Added notes in the script documentation regarding the removal of the 'jobs' readiness check and the introduction of the retry mechanism.

Request for Review

I request a review of these changes from the maintainers and welcome any feedback or suggestions. Once reviewed and approved, these updates will enhance the script's usability and reliability.