Cookie updated by NetworkToCode Cookie Drift Manager Tool (#184)

* Cookie updated by NetworkToCode Cookie Drift Manager Tool Template: ``` { "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git", "dir": "nautobot-app", "ref": "refs/tags/nautobot-app-v2.4.1", "path": null } ``` Cookie: ``` { "remote": "https://github.com/nautobot/nautobot-app-nornir.git", "path": "/tmp/tmpyz49mb0b/nautobot-app-nornir", "repository_path": "/tmp/tmpyz49mb0b/nautobot-app-nornir", "dir": "", "branch_prefix": "drift-manager", "context": { "codeowner_github_usernames": "-* @itdependsnetworks\n-* @jeffkala", "full_name": "Network to Code, LLC", "email": "info@networktocode.com", "github_org": "nautobot", "app_name": "nautobot_plugin_nornir", "verbose_name": "Nautobot Nornir Plugin", "app_slug": "nautobot-plugin-nornir", "project_slug": "nautobot-app-nornir", "repo_url": "https://github.com/nautobot/nautobot-app-nornir", "base_url": "plugin-nornir", "min_nautobot_version": "2.0.0", "max_nautobot_version": "2.9999", "camel_name": "NautobotPluginNornir", "project_short_description": "Nautobot App that provides a shim layer to simplify using Nornir within other Nautobot Apps and Nautobot Jobs", "model_class_name": "None", "open_source_license": "Apache-2.0", "docs_base_url": "https://docs.nautobot.com", "docs_app_url": "https://docs.nautobot.com/projects/plugin-nornir/en/latest", "_template": "https://github.com/nautobot/cookiecutter-nautobot-app.git", "_output_dir": "/tmp/tmpyz49mb0b", "_repo_dir": "/github/home/.cookiecutters/cookiecutter-nautobot-app/nautobot-app", "_checkout": "refs/tags/nautobot-app-v2.4.1" }, "base_branch": "develop", "remote_name": "origin", "pull_request_strategy": "PullRequestStrategy.CREATE", "post_actions": [ "PostAction.RUFF", "PostAction.POETRY" ], "baked_commit_ref": "10810b960b3fd351f64068169653793051d9e53e", "draft": false } ``` CLI Arguments: ``` { "cookie_dir": "", "input": false, "json_filename": "", "output_dir": "", "push": true, "template": "", "template_dir": "", "template_ref": "refs/tags/nautobot-app-v2.4.1", "pull_request": null, "post_action": [ "ruff", "poetry" ], "disable_post_actions": true, "draft": false } ``` * Resolve Documentation issues. * Correct issues after Drift Manager. --------- Co-authored-by: bakebot <info@networktocode.com> Co-authored-by: Stephen Kiely <stephenkiely87@gmail.com>
nautobot · Jan 11, 2025 · 59baf2e · 59baf2e
1 parent e00be7d
commit 59baf2e
Show file tree

Hide file tree

Showing 14 changed files with 944 additions and 834 deletions.
diff --git a/.cookiecutter.json b/.cookiecutter.json
@@ -21,7 +21,7 @@
         "_drift_manager": {
             "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
             "template_dir": "nautobot-app",
-            "template_ref": "refs/tags/nautobot-app-v2.4.0",
+            "template_ref": "refs/tags/nautobot-app-v2.4.1",
             "cookie_dir": "",
             "branch_prefix": "drift-manager",
             "pull_request_strategy": "create",
@@ -30,7 +30,7 @@
                 "poetry"
             ],
             "draft": false,
-            "baked_commit_ref": "10810b960b3fd351f64068169653793051d9e53e"
+            "baked_commit_ref": "bad9dcf39c5a3addcc21997e4218fc6504d6e1fc"
         }
     }
 }
diff --git a/...REQUEST_TEMPLATE/pull_request_template.md → .github/pull_request_template.md b/...REQUEST_TEMPLATE/pull_request_template.md → .github/pull_request_template.md
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -25,6 +25,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Linting: ruff format"
         run: "poetry run invoke ruff --action format"
   ruff-lint:
@@ -36,6 +38,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Linting: ruff"
         run: "poetry run invoke ruff --action lint"
   check-docs-build:
@@ -47,6 +51,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Check Docs Build"
         run: "poetry run invoke build-and-check-docs"
   poetry:
@@ -58,6 +64,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Checking: poetry lock file"
         run: "poetry run invoke lock --check"
   yamllint:
@@ -69,6 +77,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Linting: yamllint"
         run: "poetry run invoke yamllint"
   check-in-docker:
@@ -91,6 +101,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Constrain Nautobot version and regenerate lock file"
         env:
           INVOKE_NAUTOBOT_PLUGIN_NORNIR_LOCAL: "true"
@@ -146,6 +158,8 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Constrain Nautobot version and regenerate lock file"
         env:
           INVOKE_NAUTOBOT_PLUGIN_NORNIR_LOCAL: "true"
@@ -187,6 +201,8 @@ jobs:
           fetch-depth: "0"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+        with:
+          poetry-version: "1.8.5"
       - name: "Check for changelog entry"
         run: |
           git fetch --no-tags origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 Apache Software License 2.0
 
-Copyright (c) 2024, Network to Code, LLC
+Copyright (c) 2025, Network to Code, LLC
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/changes/+nautobot-app-v2.4.1.housekeeping b/changes/+nautobot-app-v2.4.1.housekeeping
@@ -0,0 +1 @@
+Rebaked from the cookie `nautobot-app-v2.4.1`.
diff --git a/development/docker-compose.dev.yml b/development/docker-compose.dev.yml
@@ -45,10 +45,12 @@ services:
     volumes:
       - "./nautobot_config.py:/opt/nautobot/nautobot_config.py"
       - "../:/source"
-# To expose postgres or redis to the host uncomment the following
-# postgres:
+# To expose postgres (5432), myql (3306) on db service or redis (6379) to the host uncomment the
+# following. Ensure to match the 2 idented spaces which to have the service nested under services.
+# db:
 #   ports:
 #     - "5432:5432"
+#     - "3306:3306"
 # redis:
 #   ports:
 #     - "6379:6379"
diff --git a/development/docker-compose.mysql.yml b/development/docker-compose.mysql.yml
@@ -14,6 +14,13 @@ services:
       - "development.env"
       - "creds.env"
       - "development_mysql.env"
+  beat:
+    environment:
+      - "NAUTOBOT_DB_ENGINE=django.db.backends.mysql"
+    env_file:
+      - "development.env"
+      - "creds.env"
+      - "development_mysql.env"
   db:
     image: "mysql:8"
     command:

diff --git a/development/nautobot_config.py b/development/nautobot_config.py
@@ -4,7 +4,7 @@
 import sys
 
 from nautobot.core.settings import *  # noqa: F403  # pylint: disable=wildcard-import,unused-wildcard-import
-from nautobot.core.settings_funcs import is_truthy, parse_redis_connection
+from nautobot.core.settings_funcs import is_truthy
 
 #
 # Debug
@@ -65,16 +65,8 @@
 #
 
 # The django-redis cache is used to establish concurrent locks using Redis.
-CACHES = {
-    "default": {
-        "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": parse_redis_connection(redis_database=0),
-        "TIMEOUT": 300,
-        "OPTIONS": {
-            "CLIENT_CLASS": "django_redis.client.DefaultClient",
-        },
-    }
-}
+# Inherited from nautobot.core.settings
+# CACHES = {....}
 
 #
 # Celery settings are not defined here because they can be overloaded with

diff --git a/docs/admin/install.md b/docs/admin/install.md
@@ -94,4 +94,4 @@ The plugin behavior can be extended further with [config context](https://nautob
 | connection_secret_path | Dotted expression of the dictionary path where a device secret should be stored for a given Nornir Plugin. |
 | secret_access_type     | Type of Secret Access Type to use. Examples. "GENERIC", "CONSOLE", "GNMI", "HTTP", "NETCONF", "REST", "RESTCONF", "SNMP", "SSH"|
 
-For details on the [credentials](../../user/app_feature_credentials), and [inventory](../../user/app_feature_inventory) please see their respective documentation.
+For details on the [credentials](../user/app_feature_credentials.md), and [inventory](../user/app_feature_inventory.md) please see their respective documentation.
diff --git a/docs/user/app_getting_started.md b/docs/user/app_getting_started.md
@@ -8,8 +8,8 @@ To install the App, please follow the instructions detailed in the [Installation
 
 ## Credentials
 
-The plugin allows you to integrate via a variety of methods to define your credentials, for details on what the options, see the [feature overview](./app_feature_credentials).
+The plugin allows you to integrate via a variety of methods to define your credentials, for details on what the options, see the [feature overview](./app_feature_credentials.md).
 
 ## Inventory
 
-The plugin allows you integrate Nornir with inventory, for details on what the options, see the [feature overview](./app_feature_inventory).
+The plugin allows you integrate Nornir with inventory, for details on what the options, see the [feature overview](./app_feature_inventory.md).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -132,6 +132,7 @@ nav:
       - Extending the App: "dev/extending.md"
       - Contributing to the App: "dev/contributing.md"
       - Development Environment: "dev/dev_environment.md"
+      - Release Checklist: "dev/release_checklist.md"
       - Code Reference:
           - "dev/code_reference/index.md"
           - Package: "dev/code_reference/package.md"

diff --git a/nautobot_plugin_nornir/urls.py b/nautobot_plugin_nornir/urls.py
@@ -3,7 +3,20 @@
 from django.templatetags.static import static
 from django.urls import path
 from django.views.generic import RedirectView
+from nautobot.apps.urls import NautobotUIViewSetRouter
+
+# Uncomment the following line if you have views to import
+# from nautobot_plugin_nornir import views
+
+
+router = NautobotUIViewSetRouter()
+
+# Here is an example of how to register a viewset, you will want to replace views.NautobotPluginNornirUIViewSet with your viewset
+# router.register("nautobot_plugin_nornir", views.NautobotPluginNornirUIViewSet)
+
 
 urlpatterns = [
     path("docs/", RedirectView.as_view(url=static("nautobot_plugin_nornir/docs/index.html")), name="docs"),
 ]
+
+urlpatterns += router.urls