nautobot 2.1.7__py3-none-any.whl → 2.1.9__py3-none-any.whl

nautobot/project-static/docs/development/core/docker-compose-advanced-use-cases.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4758,6 +4772,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/development/core/extending-models.html

@@ -11,7 +11,7 @@
         <link rel="canonical" href="https://docs.nautobot.com/projects/core/en/stable/development/core/extending-models.html">
       
       
-        <link rel="prev" href="best-practices.html">
+        <link rel="prev" href="caching.html">
       
       
         <link rel="next" href="generic-views.html">
@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4587,6 +4601,20 @@
               
   
   
+  
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
     
   
   
@@ -5520,7 +5548,7 @@
       <nav class="md-footer__inner md-grid" aria-label="Footer" >
         
           
-          <a href="best-practices.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Best Practices" rel="prev">
+          <a href="caching.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Caching" rel="prev">
             <div class="md-footer__button md-icon">
               <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
             </div>
@@ -5529,7 +5557,7 @@
                 Previous
               </span>
               <div class="md-ellipsis">
-                Best Practices
+                Caching
               </div>
             </div>
           </a>

nautobot/project-static/docs/development/core/generic-views.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4588,6 +4602,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/development/core/getting-started.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -5036,6 +5050,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models
@@ -6584,7 +6612,9 @@
 <li><code>--keepdb</code> - Save and reuse the initialized test database between test runs. Can significantly improve the initial startup time of the test suite after your first test run. <strong>Do not use if you're actively making changes to model definitions or migrations.</strong></li>
 <li><code>--label &lt;module.path&gt;</code> - Only run the specific subset of tests. Can be broad (<code>--label nautobot.core.tests</code>) or specific (<code>--label nautobot.core.tests.test_graphql.GraphQLQueryTestCase</code>).</li>
 <li><code>--no-buffer</code> - Allow stdout/stderr output from the test to be seen in your terminal, instead of being hidden. <strong>If you're debugging code with <code>breakpoint()</code>, you should use this option, as otherwise you'll never see the breakpoint happen.</strong></li>
-<li><code>--parallel</code> - Split the tests across multiple parallel subprocesses. Can greatly reduce the runtime of the entire test suite when used.</li>
+<li><code>--parallel</code> - Split the tests across multiple parallel subprocesses. Can greatly reduce the runtime of the entire test suite when used. Auto-detects the number of workers if not specified with <code>--parallel-workers</code>.</li>
+<li><code>--parallel-workers</code> - Specify the number of workers to use when running tests in parallel. Implies <code>--parallel</code>.</li>
+<li><code>--pattern</code> - Only run tests which match the given substring. Can be used multiple times.</li>
 <li><code>--skip-docs-build</code> - Skip building/rebuilding the static Nautobot documentation before running the test. Saves some time on reruns when you haven't changed the documentation source files.</li>
 <li><code>--verbose</code> - Run tests more verbosely, including describing each test case as it is run.</li>
 </ul>
@@ -6592,13 +6622,20 @@
 <p>In general, when you first run the Nautobot tests in your local copy of the repository, we'd recommend:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-43-1" name="__codelineno-43-1" href="#__codelineno-43-1"></a>invoke unittest --cache-test-fixtures --keepdb --parallel
 </code></pre></div>
+<p>When there are too many cores on the testing machine, you can limit the number of parallel workers:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-44-1" name="__codelineno-44-1" href="#__codelineno-44-1"></a>invoke unittest --cache-test-fixtures --keepdb --parallel-workers 4
+</code></pre></div>
 <p>On subsequent reruns, you can add the other performance-related options:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-44-1" name="__codelineno-44-1" href="#__codelineno-44-1"></a>invoke unittest --cache-test-fixtures --keepdb --parallel --skip-docs-build
-<a id="__codelineno-44-2" name="__codelineno-44-2" href="#__codelineno-44-2"></a>invoke unittest --cache-test-fixtures --keepdb --parallel --skip-docs-build --label nautobot.core.tests
+<div class="highlight"><pre><span></span><code><a id="__codelineno-45-1" name="__codelineno-45-1" href="#__codelineno-45-1"></a>invoke unittest --cache-test-fixtures --keepdb --parallel --skip-docs-build
+<a id="__codelineno-45-2" name="__codelineno-45-2" href="#__codelineno-45-2"></a>invoke unittest --cache-test-fixtures --keepdb --parallel --skip-docs-build --label nautobot.core.tests
 </code></pre></div>
 <p>When switching between significantly different branches of the code base (e.g. <code>main</code> vs <code>develop</code> vs <code>next</code>), you'll need to remove the cached test factory data, and for once omit the <code>--keepdb</code> option so that the test database can be destroyed and recreated appropriately:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-45-1" name="__codelineno-45-1" href="#__codelineno-45-1"></a>rm development/factory_dump.json
-<a id="__codelineno-45-2" name="__codelineno-45-2" href="#__codelineno-45-2"></a>invoke unittest --cache-test-fixtures --parallel
+<div class="highlight"><pre><span></span><code><a id="__codelineno-46-1" name="__codelineno-46-1" href="#__codelineno-46-1"></a>rm development/factory_dump.json
+<a id="__codelineno-46-2" name="__codelineno-46-2" href="#__codelineno-46-2"></a>invoke unittest --cache-test-fixtures --parallel
+</code></pre></div>
+<p>To limit the test to a specific pattern or label, you can use the <code>--label</code> and <code>--pattern</code> options:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-47-1" name="__codelineno-47-1" href="#__codelineno-47-1"></a>invoke unittest --cache-test-fixtures --keepdb --verbose --skip-docs-build --label nautobot.core.tests.dcim.test_views.DeviceTestCase
+<a id="__codelineno-47-2" name="__codelineno-47-2" href="#__codelineno-47-2"></a>invoke unittest --cache-test-fixtures --keepdb --verbose --skip-docs-build --pattern Controller
 </code></pre></div>
 <h4 id="integration-tests">Integration Tests<a class="headerlink" href="#integration-tests" title="Permanent link">&para;</a></h4>
 <p>Integration tests are automated tests written and run to ensure that the Nautobot application behaves as expected when being used as it would be in practice. By contrast to unit tests, where individual units of code are being tested, integration tests rely upon the server code actually running, and web UI clients or API clients to make real connections to the service to exercise actual workflows, such as navigating to the login page, filling out the username/passwords fields, and clicking the "Log In" button.</p>
@@ -6803,8 +6840,8 @@
 </table>
 <h2 id="submitting-pull-requests">Submitting Pull Requests<a class="headerlink" href="#submitting-pull-requests" title="Permanent link">&para;</a></h2>
 <p>Once you're happy with your work and have verified that all tests pass, commit your changes and push it upstream to your fork. Always provide descriptive (but not excessively verbose) commit messages. When working on a specific issue, be sure to reference it.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-46-1" name="__codelineno-46-1" href="#__codelineno-46-1"></a>git commit -m &quot;Closes #1234: Add IPv5 support&quot;
-<a id="__codelineno-46-2" name="__codelineno-46-2" href="#__codelineno-46-2"></a>git push origin
+<div class="highlight"><pre><span></span><code><a id="__codelineno-48-1" name="__codelineno-48-1" href="#__codelineno-48-1"></a>git commit -m &quot;Closes #1234: Add IPv5 support&quot;
+<a id="__codelineno-48-2" name="__codelineno-48-2" href="#__codelineno-48-2"></a>git push origin
 </code></pre></div>
 <p>Once your fork has the new commit, submit a <a href="https://github.com/nautobot/nautobot/compare">pull request</a> to the Nautobot repo to propose the changes. Be sure to provide a detailed accounting of the changes being made and the reasons for doing so.</p>
 <p>Once submitted, a maintainer will review your pull request and either merge it or request changes. If changes are needed, you can make them via new commits to your fork: The pull request will update automatically.</p>
@@ -6816,11 +6853,11 @@
 <p>Below are common issues you might encounter in your development environment and how to address them.</p>
 <h3 id="fatal-sorry-too-many-clients-already">FATAL: sorry, too many clients already<a class="headerlink" href="#fatal-sorry-too-many-clients-already" title="Permanent link">&para;</a></h3>
 <p>When using <code>nautobot-server runserver</code> to do development you might run into a traceback that looks something like this:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-47-1" name="__codelineno-47-1" href="#__codelineno-47-1"></a>Exception Type: OperationalError at /extras/tags/
-<a id="__codelineno-47-2" name="__codelineno-47-2" href="#__codelineno-47-2"></a>Exception Value: FATAL:  sorry, too many clients already
+<div class="highlight"><pre><span></span><code><a id="__codelineno-49-1" name="__codelineno-49-1" href="#__codelineno-49-1"></a>Exception Type: OperationalError at /extras/tags/
+<a id="__codelineno-49-2" name="__codelineno-49-2" href="#__codelineno-49-2"></a>Exception Value: FATAL:  sorry, too many clients already
 </code></pre></div>
 <p>The <code>runserver</code> development server is multi-threaded by default, which means that every request is creating its own connection. If you are doing some local testing or development that is resulting in a lot of connections to the database, pass <code>--nothreading</code> to the runserver command to disable threading:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-48-1" name="__codelineno-48-1" href="#__codelineno-48-1"></a>nautobot-server runserver --nothreading
+<div class="highlight"><pre><span></span><code><a id="__codelineno-50-1" name="__codelineno-50-1" href="#__codelineno-50-1"></a>nautobot-server runserver --nothreading
 </code></pre></div>
 
 

nautobot/project-static/docs/development/core/homepage.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4588,6 +4602,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/development/core/index.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4588,6 +4602,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/development/core/model-features.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4588,6 +4602,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/development/core/natural-keys.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4588,6 +4602,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/development/core/navigation-menu.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4588,6 +4602,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/development/core/release-checklist.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4588,6 +4602,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/development/core/role-internals.html

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4588,6 +4602,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="extending-models.html" class="md-nav__link">
         Extending Models