Merge pull request #578 from nautobot/release-v3.2.0

Release v3.2.0

.cookiecutter.json

@@ -21,15 +21,16 @@
         "_drift_manager": {
             "template": "https://github.com/nautobot/cookiecutter-nautobot-app.git",
             "template_dir": "nautobot-app",
-            "template_ref": "refs/tags/nautobot-app-v2.3.2",
+            "template_ref": "refs/tags/nautobot-app-v2.4.0",
             "cookie_dir": "",
             "branch_prefix": "drift-manager",
             "pull_request_strategy": "create",
             "post_actions": [
-                "black"
+                "ruff",
+                "poetry"
             ],
-            "draft": true,
-            "baked_commit_ref": "022954d51f46c54813d3c8c81584a16f0faea1f5"
+            "draft": false,
+            "baked_commit_ref": "671ef8a64a7bc40e991ade1dd64560d734f122bc"
         }
     }
 }

.github/CODEOWNERS

@@ -2,6 +2,7 @@
 * @nautobot/plugin-ssot
 /nautobot_ssot/integrations/aci/ @chadell @nautobot/plugin-ssot
 /nautobot_ssot/integrations/aristacv/ @qduk @jdrew82 @nautobot/plugin-ssot
+/nautobot_ssot/integrations/bootstrap/ @bile0026 @nautobot/plugin-ssot
 /nautobot_ssot/integrations/device42/ @jdrew82 @nautobot/plugin-ssot
 /nautobot_ssot/integrations/infoblox/ @qduk @jdrew82 @nautobot/plugin-ssot
 /nautobot_ssot/integrations/ipfabric/ @alhogan @nautobot/plugin-ssot

.github/workflows/ci.yml

@@ -37,7 +37,7 @@ jobs:
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Linting: ruff"
-        run: "poetry run invoke ruff"
+        run: "poetry run invoke ruff --action lint"
   check-docs-build:
     runs-on: "ubuntu-22.04"
     env:
@@ -146,6 +146,10 @@ jobs:
         uses: "actions/checkout@v4"
       - name: "Setup environment"
         uses: "networktocode/gh-action-setup-poetry-environment@v6"
+      - name: "Constrain Nautobot version and regenerate lock file"
+        env:
+          INVOKE_NAUTOBOT_SSOT_LOCAL: "true"
+        run: "poetry run invoke lock --constrain-nautobot-ver --constrain-python-ver"
       - name: "Set up Docker Buildx"
         id: "buildx"
         uses: "docker/setup-buildx-action@v3"
@@ -172,9 +176,9 @@ jobs:
       - name: "Run Tests"
         run: "poetry run invoke unittest"
   changelog:
-    if: |
+    if: >
       contains(fromJson('["develop","ltm-1.6"]'), github.base_ref) &&
-      (github.head_ref != 'main')
+      (github.head_ref != 'main') && (!startsWith(github.head_ref, 'release'))
     runs-on: "ubuntu-22.04"
     steps:
       - name: "Check out repository code"

.github/workflows/upstream_testing.yml

@@ -4,10 +4,11 @@ name: "Nautobot Upstream Monitor"
 on:  # yamllint disable-line rule:truthy rule:comments
   schedule:
     - cron: "0 4 */2 * *"  # every other day at midnight
+  workflow_dispatch:
 
 jobs:
   upstream-test:
     uses: "nautobot/nautobot/.github/workflows/plugin_upstream_testing_base.yml@develop"
     with:  # Below could potentially be collapsed into a single argument if a concrete relationship between both is enforced
       invoke_context_name: "NAUTOBOT_SSOT"
-      plugin_name: "nautobot-app-ssot"
+      plugin_name: "nautobot-ssot"

README.md

@@ -33,6 +33,7 @@ This Nautobot application framework includes the following integrations:
 - Infoblox
 - IPFabric
 - Itential
+- Cisco Meraki
 - ServiceNow
 
 Read more about integrations [here](https://docs.nautobot.com/projects/ssot/en/latest/user/integrations). To enable and configure integrations follow the instructions from [the install guide](https://docs.nautobot.com/projects/ssot/en/latest/admin/install/#integrations-configuration).
@@ -42,16 +43,19 @@ Read more about integrations [here](https://docs.nautobot.com/projects/ssot/en/l
 ---
 
 The dashboard view of the app.
+
 ![Dashboard View](https://raw.githubusercontent.com/nautobot/nautobot-app-ssot/develop/docs/images/dashboard_initial.png)
 
 ---
 
 The detailed view of the example data source that is prepackaged within this app.
+
 ![Data Source Detail View](https://raw.githubusercontent.com/nautobot/nautobot-app-ssot/develop/docs/images/data_source_detail.png)
 
 ---
 
 The detailed view of an executed sync.
+
 ![Sync Detail View](https://raw.githubusercontent.com/nautobot/nautobot-app-ssot/develop/docs/images/sync_detail.png)
 
 ---
@@ -83,6 +87,7 @@ The SSoT framework includes a number of integrations with external Systems of Re
 * Cisco DNA Center
 * Infoblox
 * Itential
+* Cisco Meraki
 * ServiceNow
 
 > Note that the Arista CloudVision integration is currently incompatible with the [Arista Labs](https://labs.arista.com/) environment due to a TLS issue. It has been confirmed to work in on-prem environments previously.

development/Dockerfile

@@ -54,14 +54,16 @@ WORKDIR /source
 COPY . /source
 
 # Build args must be declared in each stage
+ARG NAUTOBOT_VER
 ARG PYTHON_VER
 
-# Constrain the Nautobot version to NAUTOBOT_VER
+# Constrain the Nautobot version to NAUTOBOT_VER, fall back to installing from git branch if not available on PyPi
 # In CI, this should be done outside of the Dockerfile to prevent cross-compile build failures
 ARG CI
 RUN if [ -z "${CI+x}" ]; then \
     INSTALLED_NAUTOBOT_VER=$(pip show nautobot | grep "^Version" | sed "s/Version: //"); \
-    poetry add --lock nautobot@${INSTALLED_NAUTOBOT_VER} --python ${PYTHON_VER}; fi
+    poetry add --lock nautobot@${INSTALLED_NAUTOBOT_VER} --python ${PYTHON_VER} || \
+    poetry add --lock git+https://github.com/nautobot/nautobot.git#${NAUTOBOT_VER} --python ${PYTHON_VER}; fi
 
 # Install the app
 RUN poetry install --extras all --with dev

development/app_config_schema.py

@@ -40,9 +40,7 @@ def _main():
             **SchemaBuilder().to_json_schema(app_config),  # type: ignore
         }
         app_config = import_module(package_name).config
-        _enrich_object_schema(
-            schema, app_config.default_settings, app_config.required_settings
-        )
+        _enrich_object_schema(schema, app_config.default_settings, app_config.required_settings)
         schema_path.write_text(json.dumps(schema, indent=4) + "\n")
         print(f"\n==================\nGenerated schema:\n\n{schema_path}\n")
         print(

development/creds.example.env

@@ -48,3 +48,10 @@ NAUTOBOT_APIC_VERIFY_DEVNET=False
 SERVICENOW_PASSWORD="changeme"
 
 IPFABRIC_API_TOKEN=secrettoken
+
+NAUTOBOT_SSOT_ENABLE_BOOTSTRAP="False"
+NAUTOBOT_BOOTSTRAP_SSOT_ENVIRONMENT_BRANCH=develop
+NAUTOBOT_BOOTSTRAP_SSOT_LOAD_SOURCE=file # or git
+
+MERAKI_ORG_ID='123456'
+MERAKI_TOKEN='vtx01710aa0fn452740055y1hs60ns8c107ho168'

development/development.env

@@ -7,6 +7,7 @@ NAUTOBOT_BANNER_TOP="Local"
 NAUTOBOT_CHANGELOG_RETENTION=0
 
 NAUTOBOT_DEBUG=True
+NAUTOBOT_LOG_DEPRECATION_WARNINGS=True
 NAUTOBOT_LOG_LEVEL=DEBUG
 NAUTOBOT_METRICS_ENABLED=True
 NAUTOBOT_NAPALM_TIMEOUT=5
@@ -93,6 +94,8 @@ NAUTOBOT_SSOT_INFOBLOX_USERNAME="changeme"
 NAUTOBOT_SSOT_INFOBLOX_VERIFY_SSL="True"
 # NAUTOBOT_SSOT_INFOBLOX_WAPI_VERSION=""
 
+NAUTOBOT_SSOT_ENABLE_MERAKI="False"
+
 NAUTOBOT_SSOT_ENABLE_SERVICENOW="False"
 SERVICENOW_INSTANCE=""
 SERVICENOW_USERNAME=""

development/nautobot_config.py

@@ -18,12 +18,8 @@
 
     if "debug_toolbar" not in INSTALLED_APPS:  # noqa: F405
         INSTALLED_APPS.append("debug_toolbar")  # noqa: F405
-    if (
-        "debug_toolbar.middleware.DebugToolbarMiddleware" not in MIDDLEWARE
-    ):  # noqa: F405
-        MIDDLEWARE.insert(
-            0, "debug_toolbar.middleware.DebugToolbarMiddleware"
-        )  # noqa: F405
+    if "debug_toolbar.middleware.DebugToolbarMiddleware" not in MIDDLEWARE:  # noqa: F405
+        MIDDLEWARE.insert(0, "debug_toolbar.middleware.DebugToolbarMiddleware")  # noqa: F405
 
 #
 # Misc. settings
@@ -55,9 +51,7 @@
             "NAUTOBOT_DB_PORT",
             default_db_settings[nautobot_db_engine]["NAUTOBOT_DB_PORT"],
         ),  # Database port, default to postgres
-        "CONN_MAX_AGE": int(
-            os.getenv("NAUTOBOT_DB_TIMEOUT", "300")
-        ),  # Database timeout
+        "CONN_MAX_AGE": int(os.getenv("NAUTOBOT_DB_TIMEOUT", "300")),  # Database timeout
         "ENGINE": nautobot_db_engine,
     }
 }
@@ -192,13 +186,48 @@
             "atl01": "Atlanta",
         },
         "aristacv_verify": is_truthy(os.getenv("NAUTOBOT_ARISTACV_VERIFY", "true")),
+        "bootstrap_nautobot_environment_branch": os.getenv("NAUTOBOT_BOOTSTRAP_SSOT_ENVIRONMENT_BRANCH", "develop"),
+        "bootstrap_models_to_sync": {
+            "secret": True,
+            "secrets_group": True,
+            "git_repository": True,
+            "dynamic_group": True,
+            "computed_field": True,
+            "tag": True,
+            "graph_ql_query": True,
+            "software": False,
+            "software_image": False,
+            "validated_software": False,
+            "tenant_group": True,
+            "tenant": True,
+            "role": True,
+            "manufacturer": True,
+            "platform": True,
+            "location_type": True,
+            "location": True,
+            "team": True,
+            "contact": True,
+            "provider": True,
+            "provider_network": True,
+            "circuit_type": True,
+            "circuit": True,
+            "circuit_termination": True,
+            "namespace": True,
+            "rir": True,
+            "vlan_group": True,
+            "vlan": True,
+            "vrf": True,
+            "prefix": True,
+        },
         "enable_aci": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_ACI")),
         "enable_aristacv": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_ARISTACV")),
+        "enable_bootstrap": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_BOOTSTRAP", "false")),
         "enable_device42": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_DEVICE42")),
         "enable_dna_center": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_DNA_CENTER")),
         "enable_infoblox": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_INFOBLOX")),
         "enable_ipfabric": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_IPFABRIC")),
         "enable_itential": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_ITENTIAL")),
+        "enable_meraki": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_MERAKI")),
         "enable_servicenow": is_truthy(os.getenv("NAUTOBOT_SSOT_ENABLE_SERVICENOW")),
         "hide_example_jobs": is_truthy(os.getenv("NAUTOBOT_SSOT_HIDE_EXAMPLE_JOBS")),
         "device42_defaults": {

development/towncrier_template.j2

@@ -1,4 +1,15 @@
 
+# v{{ versiondata.version.split(".")[:2] | join(".") }} Release Notes
+
+This document describes all new features and changes in the release. The format is based on [Keep a
+Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic
+Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Release Overview
+
+- Major features or milestones
+- Changes to compatibility with Nautobot and/or other apps, libraries etc.
+
 {% if render_title %}
 ## [v{{ versiondata.version }} ({{ versiondata.date }})](https://github.com/nautobot/nautobot-app-ssot/releases/tag/v{{ versiondata.version}})
 
@@ -12,7 +23,11 @@
 {% if definitions[category]['showcontent'] %}
 {% for text, values in sections[section][category].items() %}
 {% for item in text.split('\n') %}
+{% if values %}
 - {{ values|join(', ') }} - {{ item.strip() }}
+{% else %}
+- {{ item.strip() }}
+{% endif %}
 {% endfor %}
 {% endfor %}
 

docs/admin/compatibility_matrix.md

@@ -28,3 +28,4 @@ While that last supported version will not be strictly enforced--via the max_ver
 | 3.0.0                          | 2.1.0                          | 2.99.99                       |
 | 3.0.1                          | 2.1.0                          | 2.99.99                       |
 | 3.1.0                          | 2.1.0                          | 2.99.99                       |
+| 3.2.0                          | 2.1.0                          | 2.99.99                       |

docs/admin/install.md

@@ -91,8 +91,11 @@ Set up each integration using the specific guides:
 
 - [Cisco ACI](./integrations/aci_setup.md)
 - [Arista CloudVision](./integrations/aristacv_setup.md)
+- [Bootstrap](./integrations/bootstrap_setup.md)
 - [Device42](./integrations/device42_setup.md)
 - [Cisco DNA Center](./integrations/dna_center_setup.md)
 - [Infoblox](./integrations/infoblox_setup.md)
 - [IPFabric](./integrations/ipfabric_setup.md)
+- [Itential](./integrations/itential_setup.md)
+- [Cisco Meraki](./integrations/meraki_setup.md)
 - [ServiceNow](./integrations/servicenow_setup.md)

docs/admin/integrations/aci_setup.md

@@ -56,7 +56,7 @@ PLUGINS_CONFIG = {
 
 All APIC specific settings have been updated to use the Controller and related ExternalIntegration objects. The ExternalIntegration object that is assigned to the Controller will define the APIC base URL, user credentials, and SSL verification. It will also have a `tenant_prefix` key in the `extra_config` section of the ExternalIntegration to define the Tenant prefix.
 
-The `aci_apics` setting from the `nautobot_config.py` file is no longer used and any configuration found for it will be automatically migrated into a Controller and an ExternalIntegration object.
+The `aci_apics` setting from the `nautobot_config.py` file is no longer used. Any configuration found for the APICs that were defined in `aci_apics` will need to be manually input into the Nautobot UI to create the required ExternalIntegration and Controller objects.
 
 ## Nautobot Objects Affected by Settings
 
@@ -82,14 +82,19 @@ There are example YAML files for a few common switch models in `nautobot_ssot/in
     When upgrading from `nautobot-plugin-ssot-aci` app, it's necessary to [avoid conflicts](../upgrade.md#potential-apps-conflicts).
 
 - Uninstall the old app:
+
     ```shell
     pip uninstall nautobot-plugin-ssot-aci
     ```
+
 - Upgrade the app with required extras:
+
     ```shell
     pip install --upgrade nautobot-ssot[aci]
     ```
+
 - Fix `nautobot_config.py` by removing `nautobot_ssot_aci` from `PLUGINS` and merging app configuration into `nautobot_ssot`:
+
     ```python
     PLUGINS = [
         "nautobot_ssot",