nautobot 2.4.0b1__py3-none-any.whl → 2.4.1__py3-none-any.whl

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

@@ -11,14 +11,14 @@
         <link rel="canonical" href="https://docs.nautobot.com/projects/core/en/stable/development/core/model-checklist.html">
       
       
-        <link rel="prev" href="local-k8s.html">
+        <link rel="prev" href="minikube-dev-environment-for-k8s-jobs.html">
       
       
         <link rel="next" href="model-features.html">
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -2112,6 +2112,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Networks and Controllers
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -5131,6 +5152,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Kubernetes Job Support
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
         
@@ -8062,11 +8104,11 @@
   
   
     <li class="md-nav__item">
-      <a href="local-k8s.html" class="md-nav__link">
+      <a href="minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Local Kubernetes Cluster
+    Minikube Dev Environment for K8s Jobs
   </span>
   
 
@@ -9288,7 +9330,7 @@
 
 <h1 id="model-development-checklist">Model Development Checklist<a class="headerlink" href="#model-development-checklist" title="Permanent link">&para;</a></h1>
 <p>A general best-practices checklist to follow when adding a new data model in Nautobot or adding new fields to an existing model.</p>
-<!-- markdownlint-disable no-inline-html -->
+<!-- pyml disable-num-lines 9 no-inline-html -->
 <style>
 article ul li:before {
     content: '□';
@@ -9298,7 +9340,6 @@ article ul li {
     list-style-type: none;
 }
 </style>
-<!-- markdownlint-enable no-inline-html -->
 
 <h2 id="bootstrapping-a-new-model">Bootstrapping a new Model<a class="headerlink" href="#bootstrapping-a-new-model" title="Permanent link">&para;</a></h2>
 <h3 id="data-model">Data Model<a class="headerlink" href="#data-model" title="Permanent link">&para;</a></h3>
@@ -9366,7 +9407,7 @@ article ul li {
 </li>
 <li>Implement API <code>&lt;Model&gt;ViewSet</code> class in <code>nautobot.&lt;app&gt;.api.views</code> module<ul>
 <li>Use appropriate <a href="best-practices.html#base-classes">base class</a> and mixin(s)</li>
-<li>Use appropriate <code>select_related</code>/<code>prefetch_related</code> for performance</li>
+<li>Use appropriate <code>select_related</code>/<code>prefetch_related</code> for performance (bearing in mind that in Nautobot 2.4.0 and later, the viewset can perform many of these optimizations automatically)</li>
 </ul>
 </li>
 <li>Add API viewset to <code>nautobot.&lt;app&gt;.api.urls</code> module</li>
@@ -9390,10 +9431,13 @@ article ul li {
 <li>Use appropriate <a href="best-practices.html#base-classes">base class</a> and mixin(s)</li>
 </ul>
 </li>
-<li>Implement <code>nautobot/&lt;app&gt;/templates/&lt;app&gt;/&lt;model&gt;_retrieve.html</code> detail template</li>
 <li>Implement <code>NautobotUIViewSet</code> subclass in <code>nautobot.&lt;app&gt;.views</code> module<ul>
 <li>Use appropriate <a href="best-practices.html#base-classes">base class</a> and mixin(s)</li>
-<li>Use appropriate <code>select_related</code>/<code>prefetch_related</code> for performance</li>
+<li>Use appropriate <code>select_related</code>/<code>prefetch_related</code> for performance (bearing in mind that in the list view, the table class can perform many of these optimizations automatically)</li>
+<li>Implement <code>object_detail_content</code> using the UI Component Framework<ul>
+<li>(only if strictly necessary) Implement <code>nautobot/&lt;app&gt;/templates/&lt;app&gt;/&lt;model&gt;_retrieve.html</code> detail template</li>
+</ul>
+</li>
 </ul>
 </li>
 <li>Add UI viewset to <code>nautobot.&lt;app&gt;.urls</code> module</li>
@@ -9565,7 +9609,7 @@ article ul li {
       <nav class="md-footer__inner md-grid" aria-label="Footer" >
         
           
-          <a href="local-k8s.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Local Kubernetes Cluster">
+          <a href="minikube-dev-environment-for-k8s-jobs.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Minikube Dev Environment for K8s Jobs">
             <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 11z"/></svg>
@@ -9575,7 +9619,7 @@ article ul li {
                 Previous
               </span>
               <div class="md-ellipsis">
-                Local Kubernetes Cluster
+                Minikube Dev Environment for K8s Jobs
               </div>
             </div>
           </a>
@@ -9680,7 +9724,7 @@ article ul li {
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "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.6ce7567c.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.83f73b43.min.js"></script>
+      <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -2112,6 +2112,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Networks and Controllers
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -5131,6 +5152,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Kubernetes Job Support
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
         
@@ -8062,11 +8104,11 @@
   
   
     <li class="md-nav__item">
-      <a href="local-k8s.html" class="md-nav__link">
+      <a href="minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Local Kubernetes Cluster
+    Minikube Dev Environment for K8s Jobs
   </span>
   
 
@@ -9246,7 +9288,7 @@
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "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.6ce7567c.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.83f73b43.min.js"></script>
+      <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -2112,6 +2112,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Networks and Controllers
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -5131,6 +5152,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Kubernetes Job Support
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
         
@@ -8062,11 +8104,11 @@
   
   
     <li class="md-nav__item">
-      <a href="local-k8s.html" class="md-nav__link">
+      <a href="minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Local Kubernetes Cluster
+    Minikube Dev Environment for K8s Jobs
   </span>
   
 
@@ -9429,7 +9471,7 @@
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "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.6ce7567c.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.83f73b43.min.js"></script>
+      <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -2112,6 +2112,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Networks and Controllers
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -5131,6 +5152,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Kubernetes Job Support
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
         
@@ -8062,11 +8104,11 @@
   
   
     <li class="md-nav__item">
-      <a href="local-k8s.html" class="md-nav__link">
+      <a href="minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Local Kubernetes Cluster
+    Minikube Dev Environment for K8s Jobs
   </span>
   
 
@@ -9377,7 +9419,7 @@
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "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.6ce7567c.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.83f73b43.min.js"></script>
+      <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -2112,6 +2112,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Networks and Controllers
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -5131,6 +5152,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Kubernetes Job Support
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
         
@@ -8062,11 +8104,11 @@
   
   
     <li class="md-nav__item">
-      <a href="local-k8s.html" class="md-nav__link">
+      <a href="minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Local Kubernetes Cluster
+    Minikube Dev Environment for K8s Jobs
   </span>
   
 
@@ -9532,13 +9574,13 @@
 <h3 id="create-a-new-release-tag">Create a New Release Tag<a class="headerlink" href="#create-a-new-release-tag" title="Permanent link">&para;</a></h3>
 <p>You need to create a release tag locally so that you can use it later when you draft the new release for nautobot, for example, <code>v1.4.3</code>.
 To create the tag locally:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>$<span class="w"> </span>git<span class="w"> </span>tag<span class="w"> </span>v1.4.3
+<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>git<span class="w"> </span>tag<span class="w"> </span>v1.4.3
 </code></pre></div>
 <p>To list all the tags to see if it is created successfully:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>$<span class="w"> </span>git<span class="w"> </span>tag
+<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>git<span class="w"> </span>tag
 </code></pre></div>
 <p>To push the tag upstream:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>$<span class="w"> </span>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>v1.4.3
+<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>v1.4.3
 </code></pre></div>
 <h3 id="create-a-new-release">Create a New Release<a class="headerlink" href="#create-a-new-release" title="Permanent link">&para;</a></h3>
 <p>Draft a <a href="https://github.com/nautobot/nautobot/releases/new">new release</a> with the following parameters.</p>
@@ -9775,7 +9817,7 @@ To create the tag locally:</p>
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "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.6ce7567c.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.83f73b43.min.js"></script>
+      <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -2112,6 +2112,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Networks and Controllers
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -5131,6 +5152,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Kubernetes Job Support
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
         
@@ -8062,11 +8104,11 @@
   
   
     <li class="md-nav__item">
-      <a href="local-k8s.html" class="md-nav__link">
+      <a href="minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Local Kubernetes Cluster
+    Minikube Dev Environment for K8s Jobs
   </span>
   
 
@@ -9276,7 +9318,7 @@ own risk!</p>
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "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.6ce7567c.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.83f73b43.min.js"></script>
+      <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>