Add release notes for version 1.1.0 and troubleshooting steps for ARP…

… table comparison failures
cdot65 · Feb 4, 2024 · 2402cc6 · 2402cc6
1 parent 32465e5
commit 2402cc6
Show file tree

Hide file tree

Showing 7 changed files with 960 additions and 483 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md
@@ -2,10 +2,25 @@
 
 Welcome to the release notes for the `pan-os-upgrade` tool. This document provides a detailed record of changes, enhancements, and fixes in each version of the tool.
 
+## Version 1.1.0
+
+**Release Date:** *<20240204>*
+
+### What's New
+
+- Pre/Post upgrade diff report created in PDF format
+- Changed structure of AssuranceOptions
+- `enabled_by_default` key added to allow for declaring which tests will execute by default
+- Introduced "skipped" emoji to bring awareness to which tests and checks are skipped
+- Using custom fork for `panos-upgrade-assurance` to account for integer values for `ttl` in ARP snapshots
+- Added a new troubleshooting item to address how to handle when ARP snapshots fail due to a bug in the dependency
+- Formatting and docstrings revisited
+
 ## Version 1.0.0
 
 **Release Date:** *<20240131>*
 
+<!-- trunk-ignore(markdownlint/MD024) -->
 ### What's New
 
 - Shipping first release! 🚀

diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/user-guide/docker/execution.md b/docs/user-guide/docker/execution.md
diff --git a/docs/user-guide/docker/troubleshooting.md b/docs/user-guide/docker/troubleshooting.md
@@ -54,6 +54,21 @@ Encountering issues during the Docker execution of `pan-os-upgrade` can happen,
 
 **Solution:** Ensure the filter syntax is correctly formatted and the specified criteria accurately reflect your firewall configuration in Panorama. Double-check network connectivity to Panorama and ensure the filters match the attributes of the firewalls you intend to upgrade.
 
+### 9. ARP Table Comparison Failures
+
+**Problem:** When capturing ARP tables for comparison, the script fails with `WrongDataTypeException: Unknown value format for key ttl`.
+
+**Solution:** This issue can arise when ARP table entries contain integer values for `ttl`, which the current implementation may not handle properly. To address this, consider installing a custom fork of `panos-upgrade-assurance` that includes a fix for this issue, available at [https://github.com/cdot65/pan-os-upgrade-assurance/tree/main](https://github.com/cdot65/pan-os-upgrade-assurance/tree/main). Alternatively, you can configure the script to omit ARP snapshots from the tests if modifying the script is not feasible.
+
+**Steps to Install Custom Fork:**
+
+1. Run this command: `pip install git+https://github.com/cdot65/pan-os-upgrade-assurance.git@main`
+
+**Steps to Omit ARP Snapshots:**
+
+1. If using a `settings.yaml` file, ensure ARP snapshots are disabled.
+2. If running the script interactively, choose not to capture ARP snapshots when prompted.
+
 ## General Tips
 
 - Always verify your Docker setup and configurations before running `pan-os-upgrade`.

diff --git a/docs/user-guide/python/execution.md b/docs/user-guide/python/execution.md
diff --git a/docs/user-guide/python/troubleshooting.md b/docs/user-guide/python/troubleshooting.md
@@ -69,6 +69,21 @@ After generating the locale, you can verify it's available by running `locale -a
 
 If you cannot request `sudo` permissions within WSL2, either use the `pan-os-upgrade` script from the Windows CMD terminal, or use the Docker container.
 
+### 10. ARP Table Comparison Failures
+
+**Problem:** When capturing ARP tables for comparison, the script fails with `WrongDataTypeException: Unknown value format for key ttl`.
+
+**Solution:** This issue can arise when ARP table entries contain integer values for `ttl`, which the current implementation may not handle properly. To address this, consider installing a custom fork of `panos-upgrade-assurance` that includes a fix for this issue, available at [https://github.com/cdot65/pan-os-upgrade-assurance/tree/main](https://github.com/cdot65/pan-os-upgrade-assurance/tree/main). Alternatively, you can configure the script to omit ARP snapshots from the tests if modifying the script is not feasible.
+
+**Steps to Install Custom Fork:**
+
+1. Run this command: `pip install git+https://github.com/cdot65/pan-os-upgrade-assurance.git@main`
+
+**Steps to Omit ARP Snapshots:**
+
+1. If using a `settings.yaml` file, ensure ARP snapshots are disabled.
+2. If running the script interactively, choose not to capture ARP snapshots when prompted.
+
 ## General Tips
 
 - Always perform a dry run (`--dry-run`) before executing the actual upgrade.