nautobot 2.2.4__py3-none-any.whl → 2.2.5__py3-none-any.whl

nautobot/project-static/docs/release-notes/version-1.1.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.18">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.23">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.66ac8b77.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">
       
         
         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -9477,7 +9477,7 @@
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../assets/javascripts/bundle.3220b9d7.min.js"></script>
+      <script src="../assets/javascripts/bundle.ebd0bdb7.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

nautobot/project-static/docs/release-notes/version-1.2.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.18">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.23">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.66ac8b77.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">
       
         
         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -9646,7 +9646,7 @@
 <h4 id="networking-template-filters-1082">Networking Template Filters (<a href="https://github.com/nautobot/nautobot/issues/1082">#1082</a>)<a class="headerlink" href="#networking-template-filters-1082" title="Permanent link">&para;</a></h4>
 <p>Template rendering with Django and/or Jinja2 now supports by default all filters provided by the <a href="https://netutils.readthedocs.io/en/latest/index.html"><code>netutils</code></a> library. These filters can be used in page templates, computed fields, custom links, export templates, etc. For details, please refer to the <a href="../user-guide/platform-functionality/template-filters.html">filters</a> documentation.</p>
 <h4 id="organizational-branding-859">Organizational Branding (<a href="https://github.com/nautobot/nautobot/issues/859">#859</a>)<a class="headerlink" href="#organizational-branding-859" title="Permanent link">&para;</a></h4>
-<p>Organizations may provide custom branding assets to change the logo, icons, and footer URLs to help Nautobot fit within their environments and user communities. Please see the <a href="../user-guide/administration/configuration/optional-settings.html#BRANDING_FILEPATHS">configuration documenation</a> for details on how to specify the location and usage of custom branding assets.</p>
+<p>Organizations may provide custom branding assets to change the logo, icons, and footer URLs to help Nautobot fit within their environments and user communities. Please see the <a href="../user-guide/administration/configuration/optional-settings.html#branding_filepaths">configuration documenation</a> for details on how to specify the location and usage of custom branding assets.</p>
 <h4 id="plugin-banners-534">Plugin Banners (<a href="https://github.com/nautobot/nautobot/issues/534">#534</a>)<a class="headerlink" href="#plugin-banners-534" title="Permanent link">&para;</a></h4>
 <p>Each plugin is now able to optionally inject a custom banner into any of the Nautobot core views.</p>
 <p>Please refer to the <a href="../development/apps/index.html">plugin development documentation</a> for more details about this functionality.</p>
@@ -9669,7 +9669,7 @@
 <p>Job log messages are now stored in a separate database table as a separate <code>JobLogEntry</code> data model, instead of being stored as JSON on the <code>JobResult</code> model/table. This provides faster and more robust rendering of <code>JobResult</code>-related views and lays groundwork for future enhancements of the Jobs feature.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>If you are executing Jobs inside your tests, there are some changes you will need to make for your tests to support this feature correctly. Refer to the <a href="../user-guide/platform-functionality/jobs/index.html#testing-jobs">Jobs documentation</a> for details.</p>
+<p>If you are executing Jobs inside your tests, there are some changes you will need to make for your tests to support this feature correctly. Refer to the <a href="../development/jobs/index.html#testing-jobs">Jobs documentation</a> for details.</p>
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -10184,7 +10184,7 @@
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../assets/javascripts/bundle.3220b9d7.min.js"></script>
+      <script src="../assets/javascripts/bundle.ebd0bdb7.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

nautobot/project-static/docs/release-notes/version-1.3.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.18">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.23">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.66ac8b77.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">
       
         
         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -9749,7 +9749,7 @@
 </div>
 <p>For more details please refer to the <a href="../user-guide/platform-functionality/jobs/index.html">Jobs feature documentation</a> as well as the <a href="../user-guide/platform-functionality/jobs/models.html">Job data model documentation</a>.</p>
 <h4 id="jobs-with-sensitive-parameters-2091">Jobs With Sensitive Parameters (<a href="https://github.com/nautobot/nautobot/issues/2091">#2091</a>)<a class="headerlink" href="#jobs-with-sensitive-parameters-2091" title="Permanent link">&para;</a></h4>
-<p>Jobs model now includes a <a href="../user-guide/platform-functionality/jobs/index.html#has_sensitive_variables"><code>has_sensitive_variables</code></a> field which by default prevents the job's input parameters from being saved to the database. Review whether each job's input parameters include sensitive data such as passwords or other user credentials before setting this to <code>False</code> for any given job.</p>
+<p>Jobs model now includes a <a href="../development/jobs/index.html#has_sensitive_variables"><code>has_sensitive_variables</code></a> field which by default prevents the job's input parameters from being saved to the database. Review whether each job's input parameters include sensitive data such as passwords or other user credentials before setting this to <code>False</code> for any given job.</p>
 <h4 id="json-type-for-custom-fields-897">JSON Type for Custom Fields (<a href="https://github.com/nautobot/nautobot/issues/897">#897</a>)<a class="headerlink" href="#json-type-for-custom-fields-897" title="Permanent link">&para;</a></h4>
 <p>Custom fields can now have a type of "json". Fields of this type can be used to store arbitrary JSON data.</p>
 <h4 id="natural-indexing-for-common-lookups-1638">Natural Indexing for Common Lookups (<a href="https://github.com/nautobot/nautobot/issues/1638">#1638</a>)<a class="headerlink" href="#natural-indexing-for-common-lookups-1638" title="Permanent link">&para;</a></h4>
@@ -10351,7 +10351,7 @@
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../assets/javascripts/bundle.3220b9d7.min.js"></script>
+      <script src="../assets/javascripts/bundle.ebd0bdb7.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

nautobot/project-static/docs/release-notes/version-1.4.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.18">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.23">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.66ac8b77.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">
       
         
         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -10066,7 +10066,7 @@
 <p>You can refer to the <a href="../development/apps/api/ui-extensions/object-views.html">plugin development guide</a> on how to add tabs to existing object detail views.</p>
 <h4 id="custom-template-css-html-javascript-on-job-forms-1865">Custom Template (CSS, HTML, JavaScript) on Job Forms (<a href="https://github.com/nautobot/nautobot/issues/1865">#1865</a>)<a class="headerlink" href="#custom-template-css-html-javascript-on-job-forms-1865" title="Permanent link">&para;</a></h4>
 <p>Jobs can now specify a <code>template_name</code> property and provide a custom template with additional JavaScript and CSS to help with user input on the Job submission form.</p>
-<p>You can refer to the <a href="../user-guide/platform-functionality/jobs/index.html#template_name">Job class metadata attribute documentation</a> on how to build and define this template.</p>
+<p>You can refer to the <a href="../development/jobs/index.html#template_name">Job class metadata attribute documentation</a> on how to build and define this template.</p>
 <h4 id="dynamic-groups-support-additional-models-2200">Dynamic Groups Support Additional Models (<a href="https://github.com/nautobot/nautobot/pull/2200">#2200</a>)<a class="headerlink" href="#dynamic-groups-support-additional-models-2200" title="Permanent link">&para;</a></h4>
 <p>Cluster, IP Address, Prefix, and Rack models can now be filtered on in Dynamic Groups and can also support nested or groups of Dynamic Groups. Some fields have been excluded from filtering until a sensible widget can be provided.</p>
 <h4 id="dark-mode-ui-729">Dark Mode UI (<a href="https://github.com/nautobot/nautobot/issues/729">#729</a>)<a class="headerlink" href="#dark-mode-ui-729" title="Permanent link">&para;</a></h4>
@@ -10081,7 +10081,7 @@
 <p>Please see the documentation on <a href="../development/core/best-practices.html#mapping-model-fields-to-filters">best practices for mapping model fields to filters</a> for more information.</p>
 <h4 id="job-hooks-1878">Job Hooks (<a href="https://github.com/nautobot/nautobot/issues/1878">#1878</a>)<a class="headerlink" href="#job-hooks-1878" title="Permanent link">&para;</a></h4>
 <p>Jobs can now be configured to run automatically when a change event occurs on a Nautobot object. Job hooks associate jobs to content types and actions to run jobs when a create, update or delete action occurs on the selected content type. A new job base class <code>JobHookReceiver</code> was introduced that jobs must subclass to be associated with a job hook.</p>
-<p>Please see the documentation on <a href="../user-guide/platform-functionality/jobs/models.html#jobhook">Job Hooks</a> for more information.</p>
+<p>Please see the documentation on <a href="../user-guide/platform-functionality/jobs/jobhook.html">Job Hooks</a> for more information.</p>
 <h4 id="job-re-runs-1875">Job Re-Runs (<a href="https://github.com/nautobot/nautobot/issues/1875">#1875</a>)<a class="headerlink" href="#job-re-runs-1875" title="Permanent link">&para;</a></h4>
 <p>JobResult records now save the arguments with which the Job was called, allowing for easy re-execution of the Job with the same arguments as before. A "re-run" button has been added to the JobResult list view and detail view.</p>
 <h4 id="location-data-model-1052">Location Data Model (<a href="https://github.com/nautobot/nautobot/issues/1052">#1052</a>)<a class="headerlink" href="#location-data-model-1052" title="Permanent link">&para;</a></h4>
@@ -10827,7 +10827,7 @@
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../assets/javascripts/bundle.3220b9d7.min.js"></script>
+      <script src="../assets/javascripts/bundle.ebd0bdb7.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

nautobot/project-static/docs/release-notes/version-1.5.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.18">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.23">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/main.66ac8b77.min.css">
+      <link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">
       
         
         <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
@@ -10867,7 +10867,7 @@
 <h4 id="custom-field-grouping-899">Custom Field Grouping (<a href="https://github.com/nautobot/nautobot/issues/899">#899</a>)<a class="headerlink" href="#custom-field-grouping-899" title="Permanent link">&para;</a></h4>
 <p>Custom fields can now be assigned to a free-text "grouping" to improve usability when a large number of custom fields are defined on a given model. In the UI, fields in the same grouping will be grouped together, and groupings can be expanded/collapsed for display purposes.</p>
 <h4 id="custom-celery-task-queues-2421">Custom Celery Task Queues (<a href="https://github.com/nautobot/nautobot/pull/2421">#2421</a>)<a class="headerlink" href="#custom-celery-task-queues-2421" title="Permanent link">&para;</a></h4>
-<p>A new optional job property <code>task_queues</code> has been introduced to allow Nautobot to leverage custom celery queues for jobs. This will allow you to send jobs to specific workers based on which queue is selected. This property can be set on the job class and overridden in the job model, similar to other overridable job fields. If <code>task_queues</code> is not defined on the job class or job model, the job will only be able to use the default queue. A new field has been added to the job run form to allow you to select a queue when you run the job and  an optional field <code>task_queue</code> has been added to the REST API <a href="../user-guide/platform-functionality/jobs/index.html#via-the-api">job run endpoint</a> for the same purpose.</p>
+<p>A new optional job property <code>task_queues</code> has been introduced to allow Nautobot to leverage custom celery queues for jobs. This will allow you to send jobs to specific workers based on which queue is selected. This property can be set on the job class and overridden in the job model, similar to other overridable job fields. If <code>task_queues</code> is not defined on the job class or job model, the job will only be able to use the default queue. A new field has been added to the job run form to allow you to select a queue when you run the job and  an optional field <code>task_queue</code> has been added to the REST API <a href="../user-guide/platform-functionality/jobs/index.html#via-the-rest-api">job run endpoint</a> for the same purpose.</p>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
 <p>The default celery queue name has been changed from <code>celery</code> to <code>default</code>. If you have any workers or tasks hard coded to use <code>celery</code> you will need to update those workers/tasks or change the <a href="../user-guide/administration/configuration/optional-settings.html#celery_task_default_queue"><code>CELERY_TASK_DEFAULT_QUEUE</code></a> setting in your <code>nautobot_config.py</code>.</p>
@@ -10938,7 +10938,7 @@ relationship:</p>
 </ul>
 <h3 id="changed">Changed<a class="headerlink" href="#changed" title="Permanent link">&para;</a></h3>
 <h4 id="database-query-caching-is-now-disabled-by-default-1721">Database Query Caching is now Disabled by Default (<a href="https://github.com/nautobot/nautobot/issues/1721">#1721</a>)<a class="headerlink" href="#database-query-caching-is-now-disabled-by-default-1721" title="Permanent link">&para;</a></h4>
-<p>In prior versions of Nautobot, database query caching using the <a href="https://github.com/Suor/django-cacheops"><code>django-cacheops</code></a> application (aka Cacheops) was enabled by default. This is determined by the default value of the <a href="../user-guide/administration/configuration/optional-settings.html#cacheops_enabled"><code>CACHEOPS_ENABLED</code></a> setting being set to <code>True</code>.</p>
+<p>In prior versions of Nautobot, database query caching using the <a href="https://github.com/Suor/django-cacheops"><code>django-cacheops</code></a> application (aka Cacheops) was enabled by default. This is determined by the default value of the <code>CACHEOPS_ENABLED</code> setting being set to <code>True</code>.</p>
 <p>Through much trial and error we ultimately decided that this feature is more trouble than it is worth and we have begun to put more emphasis on improving performance of complex database queries over continuing to rely upon the various benefits and pitfalls of utilizing Cacheops.</p>
 <p>As a result, the value of this setting now defaults to <code>False</code>, disabling database query caching entirely for new deployments. Cacheops will be removed entirely in a future release.</p>
 <div class="admonition important">
@@ -11858,7 +11858,7 @@ relationship:</p>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../assets/javascripts/bundle.3220b9d7.min.js"></script>
+      <script src="../assets/javascripts/bundle.ebd0bdb7.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>