Merge pull request #61 from cdot65/59-enhancement-request-support-for…

…-configuration-files-to-override-default-settings Override script execution default settings
cdot65 · Jan 28, 2024 · 964b33d · 964b33d
2 parents 77226a9 + c23a1f5
commit 964b33d
Show file tree

Hide file tree

Showing 11 changed files with 2,294 additions and 1,945 deletions.
diff --git a/.gitignore b/.gitignore
@@ -165,3 +165,4 @@ cython_debug/
 # ignore local dev
 assurance
 logs
+pan_os_upgrade/settings.yaml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,13 +1,25 @@
 {
   "cSpell.words": [
+    "adminpassword",
     "apikey",
     "defusedxml",
+    "dynaconf",
+    "Dynaconf",
+    "hhotfix",
     "highavailability",
+    "hostnames",
     "levelname",
+    "malformatted",
     "nics",
+    "NXDOMAIN",
+    "proxied",
     "pydantic",
     "Pydantic",
     "refreshall",
+    "typer",
+    "Typer",
+    "Typer's",
+    "unsynchronized",
     "Xapi",
     "xmltodict"
   ]

diff --git a/README.md b/README.md
diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -10,9 +10,12 @@ RUN apk add --no-cache gcc musl-dev libffi-dev make
 # Set the working directory in the container to /app
 WORKDIR /app
 
+# Add settings.yaml to the container at /app
+ADD settings.yaml /app
+
 # Install any needed packages specified in requirements.txt
-# Note: The requirements.txt should contain pan-os-upgrade==0.4.1
-RUN pip install --no-cache-dir pan-os-upgrade==0.4.1
+# Note: The requirements.txt should contain pan-os-upgrade==0.4.2
+RUN pip install --no-cache-dir pan-os-upgrade==0.4.2
 
 # Set the locale to avoid issues with emoji rendering
 ENV LANG C.UTF-8

diff --git a/docker/settings.yaml b/docker/settings.yaml
@@ -0,0 +1 @@
+---
diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md
@@ -2,10 +2,21 @@
 
 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 0.4.2
+
+**Release Date:** *<20240127>*
+
+### What's New
+
+- Created mechanism to override the default settings of `pan-os-upgrade`
+- Added support for new CLI argument, `pan-os-upgrade settings`
+- Created a banner message to help with usability
+
 ## Version 0.4.1
 
 **Release Date:** *<20240127>*
 
+<!-- trunk-ignore(markdownlint/MD024) -->
 ### What's New
 
 - Resolved an issue where missing fields in session snapshots for older PAN-OS versions caused errors in Pydantic models
@@ -133,4 +144,4 @@ Welcome to the release notes for the `pan-os-upgrade` tool. This document provid
 
 ---
 
-For more detailed information on each release, visit the [GitHub repository](https://github.com/cdot65/pan-os-upgrade/releases) or check the [commit history](https://github.com/cdot65/pan-os-upgrade/commits/main).
+For more detailed information on each release, visit the [GitHub repository](https://github.com/cdot65/pan-os-upgrade/releases) or check the [commit history](https://github.com/cdot65/pan-os-upgrade/commits/main).
diff --git a/docs/user-guide/docker/execution.md b/docs/user-guide/docker/execution.md
diff --git a/docs/user-guide/python/execution.md b/docs/user-guide/python/execution.md
diff --git a/pan_os_upgrade/upgrade.py b/pan_os_upgrade/upgrade.py
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pan-os-upgrade"
-version = "0.4.1"
+version = "0.4.2"
 description = "Python script to automate the upgrade process of PAN-OS firewalls."
 authors = ["Calvin Remsburg <[email protected]>"]
 license = "Apache 2.0"
@@ -15,6 +15,8 @@ pydantic = "^2.5.3"
 typer = { extras = ["all"], version = "^0.9.0" }
 setuptools = "^69.0.3"
 dnspython = "^2.5.0"
+dynaconf = "^3.2.4"
+pyyaml = "^6.0.1"
 
 [tool.poetry.group.dev.dependencies]
 black = "^23.12.1"