v1.0.0 Changes (#80)

* initial b4 refactor * final updates for b4 * update CI to only run 1.4 or later of nautobot * fixing bulk edit * change to major * UI & homepage * ken feedback * updating screenshots
nautobot · Aug 31, 2022 · ccdf8b6 · ccdf8b6
1 parent 75dddca
commit ccdf8b6
Show file tree

Hide file tree

Showing 49 changed files with 1,929 additions and 688 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,2 +1,2 @@
 # Default owner(s) of all files in this repository
-* @whitej6 @itdependsnetworks @jathanism @jdrew82
+* @whitej6 @itdependsnetworks @jdrew82
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -75,7 +75,7 @@ jobs:
       fail-fast: true
       matrix:
         python-version: ["3.7"]
-        nautobot-version: ["1.3.4"]
+        nautobot-version: ["1.4.1"]
     env:
       INVOKE_NAUTOBOT_FIREWALL_MODELS_PYTHON_VER: "${{ matrix.python-version }}"
       INVOKE_NAUTOBOT_FIREWALL_MODELS_NAUTOBOT_VER: "${{ matrix.nautobot-version }}"
@@ -120,14 +120,14 @@ jobs:
         include:
           - python-version: "3.10"
             db-backend: "postgresql"
-            nautobot-version: "1.3.3"
+            nautobot-version: "1.4.1"
             # TODO: Include the following, once mysql is working on CI
             #   - python-version: "3.7"
             #     db-backend: "mysql"
-            #     nautobot-version: "1.3.3"
+            #     nautobot-version: "1.4.1"
             #   - python-version: "3.10"
             #     db-backend: "mysql"
-            #     nautobot-version: "stable"
+            #     nautobot-version: "latest"
     runs-on: "ubuntu-20.04"
     env:
       INVOKE_NAUTOBOT_FIREWALL_MODELS_PYTHON_VER: "${{ matrix.python-version }}"

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,27 +1,52 @@
 # Changelog
 
+## v1.0.0 - 2022-08-27
+
+### Removed
+
+- #80 Support for Nautobot < v1.4.0
+
+### Changed
+
+- #80 All plural attrs on PolicyRule are now represented in plural form (`source_user` is now `source_users` etc).
+- #80 Nav menu name from `Firewall` to `Security`.
+- #80 Styling on PolicyRule detail tables
+
+### Added
+
+- #80 Support for Notes
+- #80 Source Service suport
+- #80 Security panel on homepage
+- #80 PolicyRule detail tables convert empty value to `ANY`
+
 ## v0.1.0-beta.3 - 2022-07-19
 
 ### Changed
+
 - #68 Update Policy Rules Expanded to be more intuitive
 - #69 Change to use arrow in UI elements
 
 ### Added
+
 - #63 Capirca Integration
+
 ## v0.1.0-beta.2 - 2022-07-10
 
 ### Changed
+
 - Update Serializers to current standards
 - Update development environment to current standards
 - Update CI matrix for better runtime & coverage of versions
 
 ### Fixed
+
 - Pydocstyle.ini being properly used
 - Dockerfile to work with `NAUTOBOT_VER` from build args, previously poetry superceeded the build arg.
 - Updates for `status` attributes to account for defaulting.
 - Static URLs for images in `README.md` to fix broken link in PyPI page rendering.
 
 ### Added
+
 - Ability to expand Policy detail API view with query param `deep=True`.
 - Added `to_json` method on `Policy` and `PolicyRule` models.
 - Added `rule_details` as a helper for working with a `PolicyRule`
@@ -31,9 +56,11 @@
 ## v0.1.0-beta.1 - 2022-07-08
 
 ### Fixed
+
 - Issues with docs rendering in PyPI & ReadTheDocs
 
 ## v0.1.0-beta.2 - 2022-07-08
 
 ### Announcements
-- Initial Release
+
+- Initial Release
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ The plugin is available as a Python package in PyPI and can be installed with `p
 pip install nautobot-firewall-models
 ```
 
-> The plugin is compatible with Nautobot 1.3.0 and higher
+> The plugin is compatible with Nautobot 1.4.0 and higher
 
 To ensure Nautobot Firewall Models Plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the Nautobot root directory (alongside `requirements.txt`) and list the `nautobot-firewall-models` package:
 

diff --git a/development/Dockerfile b/development/Dockerfile
@@ -1,4 +1,4 @@
-ARG NAUTOBOT_VER="1.3.1"
+ARG NAUTOBOT_VER="1.4.1"
 ARG PYTHON_VER=3.8
 
 FROM ghcr.io/nautobot/nautobot-dev:${NAUTOBOT_VER}-py${PYTHON_VER}
@@ -27,7 +27,7 @@ COPY poetry.lock pyproject.toml /tmp/install/
 # Otherwise Poetry will override the version in this container
 # with the one in the poetry.lock
 # Redifine NAUTOBOT_VER as a build arg as initial is defined outside FROM.
-ARG NAUTOBOT_VER="1.3.1"
+ARG NAUTOBOT_VER="1.4.1"
 RUN poetry add nautobot@$NAUTOBOT_VER
 
 # --no-root declares not to install the project package since we're wanting to take advantage of caching dependency installation

diff --git a/docs/images/datamodel.png b/docs/images/datamodel.png
diff --git a/docs/images/navmenu.png b/docs/images/navmenu.png
diff --git a/docs/images/policy.png b/docs/images/policy.png
diff --git a/docs/index.md b/docs/index.md
@@ -12,7 +12,7 @@ The plugin is available as a Python package in PyPI and can be installed with `p
 pip install nautobot-firewall-models
 ```
 
-> The plugin is compatible with Nautobot 1.3.0 and higher
+> The plugin is compatible with Nautobot 1.4.0 and higher
 
 To ensure Nautobot Firewall Models Plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the Nautobot root directory (alongside `requirements.txt`) and list the `nautobot-firewall-models` package:
 

diff --git a/docs/models.md b/docs/models.md
@@ -51,11 +51,6 @@ This plugin uses [custom models to model many-to-many](https://docs.djangoprojec
     heading-offset=2
 %}
 
-{%
-    include-markdown "./models/policyrulem2m.md"
-    heading-offset=2
-%}
-
 {%
     include-markdown "./models/policydevicem2m.md"
     heading-offset=2

diff --git a/docs/models/policyrule.md b/docs/models/policyrule.md
@@ -23,6 +23,10 @@ It is recommended to use a descriptive name to best identify a PolicyRule, other
 * Log (boolean)
 * Request ID (optional, string)
     * Meant to represent an upstream request (e.g. an service request from an ITSM solution).
+* Index (optional, int)
+    * Sets the index of the PolicyRule in the Policy.
+    * Example `20 permit icmp host 1.1.1.1 any` would have an index of `20`.
+    * Set as optional for now, will be set to required at a later date with default as the highest value + 10.
 
 ## Examples
 

diff --git a/docs/models/policyrulem2m.md b/docs/models/policyrulem2m.md
diff --git a/nautobot_firewall_models/__init__.py b/nautobot_firewall_models/__init__.py
@@ -21,7 +21,7 @@ class NautobotFirewallModelsConfig(PluginConfig):
     description = "Nautobot plugin to model firewall objects.."
     base_url = "firewall"
     required_settings = []
-    min_version = "1.3.0"
+    min_version = "1.4.0"
     max_version = "1.9999"
     default_settings = {"capirca_remark_pass": True, "capirca_os_map": {}, "allowed_status": ["active"]}
     caching_config = {"*": {"timeout": 0}}