nautobot 2.1.0b1__py3-none-any.whl → 2.1.1__py3-none-any.whl

nautobot/project-static/docs/development/jobs/migration/from-v1.html

@@ -977,20 +977,6 @@
 
             
           
-            
-              
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../user-guide/administration/configuration/node-configuration.html" class="md-nav__link">
-        Node.js Configuration
-      </a>
-    </li>
-  
-
-            
-          
         </ul>
       </nav>
     </li>
@@ -1439,34 +1425,6 @@
   
   
   
-    <li class="md-nav__item">
-      <a href="../../../user-guide/feature-guides/git-data-source.html" class="md-nav__link">
-        Git as a Data Source
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../user-guide/feature-guides/graphql.html" class="md-nav__link">
-        GraphQL
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
     <li class="md-nav__item">
       <a href="../../../user-guide/feature-guides/relationships.html" class="md-nav__link">
         Relationships
@@ -3335,6 +3293,26 @@
     Job Registration
   </a>
   
+    <nav class="md-nav" aria-label="Job Registration">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#registering-jobs-in-jobs_root-or-git-repositories" class="md-nav__link">
+    Registering Jobs in JOBS_ROOT or Git Repositories
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#registering-jobs-in-a-plugin" class="md-nav__link">
+    Registering Jobs in a Plugin
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
         
           <li class="md-nav__item">
@@ -3713,23 +3691,9 @@
   
   
   
-    <li class="md-nav__item">
-      <a href="../../apps/api/views/view-overrides.html" class="md-nav__link">
-        View Overrides
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
     <li class="md-nav__item">
       <a href="../../apps/api/views/core-view-overrides.html" class="md-nav__link">
-        Legacy View Overrides
+        View Overrides
       </a>
     </li>
   
@@ -3818,7 +3782,7 @@
   
     <li class="md-nav__item">
       <a href="../../apps/api/platform-features/filter-extensions.html" class="md-nav__link">
-        Filter Extentions
+        Filter Extensions
       </a>
     </li>
   
@@ -4026,21 +3990,7 @@
   
     <li class="md-nav__item">
       <a href="../../apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../apps/api/ui-extensions/tabs.html" class="md-nav__link">
-        Tabs
+        Object Detail Views and Tabs
       </a>
     </li>
   
@@ -4711,6 +4661,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../core/bootstrap-ui.html" class="md-nav__link">
+        Bootstrap UI
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../core/best-practices.html" class="md-nav__link">
         Best Practices
@@ -4823,20 +4787,6 @@
   
   
   
-    <li class="md-nav__item">
-      <a href="../../core/react-ui.html" class="md-nav__link">
-        React UI
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
     <li class="md-nav__item">
       <a href="../../core/role-internals.html" class="md-nav__link">
         Role Internals
@@ -5433,6 +5383,26 @@
     Job Registration
   </a>
   
+    <nav class="md-nav" aria-label="Job Registration">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#registering-jobs-in-jobs_root-or-git-repositories" class="md-nav__link">
+    Registering Jobs in JOBS_ROOT or Git Repositories
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#registering-jobs-in-a-plugin" class="md-nav__link">
+    Registering Jobs in a Plugin
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
         
           <li class="md-nav__item">
@@ -5566,18 +5536,25 @@
 <h4 id="read-only-meta-attribute">Read-Only Meta Attribute<a class="headerlink" href="#read-only-meta-attribute" title="Permanent link">&para;</a></h4>
 <p>The <code>read_only</code> Job field no longer forces an automatic database rollback at the end of the Job; it is informational only in v2.0.</p>
 <h3 id="job-registration">Job Registration<a class="headerlink" href="#job-registration" title="Permanent link">&para;</a></h3>
-<p>All Jobs must be registered in the Celery task registry to be available in Nautobot. This must be accomplished by calling <code>nautobot.apps.jobs.register_jobs(*job_classes)</code> at the top level of a Job module so that it is registered when the module is imported. The <code>register_jobs</code> method accepts one or more job classes as arguments.</p>
-<div class="admonition example">
-<p class="admonition-title">Example</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="kn">from</span> <span class="nn">nautobot.apps.jobs</span> <span class="kn">import</span> <span class="n">Job</span><span class="p">,</span> <span class="n">register_jobs</span>
-<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>
-<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="k">class</span> <span class="nc">MyJob</span><span class="p">(</span><span class="n">Job</span><span class="p">):</span>
-<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>    <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>        <span class="k">pass</span>
-<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>
-<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="n">register_jobs</span><span class="p">(</span><span class="n">MyJob</span><span class="p">)</span>
-</code></pre></div>
+<div class="admonition version-changed">
+<p class="admonition-title">Changed in version 2.0.0</p>
 </div>
+<p>All Job classes, including <code>JobHookReceiver</code> and <code>JobButtonReceiver</code> classes must be registered at <strong>import time</strong> using the <code>nautobot.apps.jobs.register_jobs</code> method. This method accepts one or more job classes as arguments. You must account for how your jobs are imported when deciding where to call this method.</p>
+<h4 id="registering-jobs-in-jobs_root-or-git-repositories">Registering Jobs in JOBS_ROOT or Git Repositories<a class="headerlink" href="#registering-jobs-in-jobs_root-or-git-repositories" title="Permanent link">&para;</a></h4>
+<p>Only top level module names within JOBS_ROOT are imported by Nautobot at runtime. This means that if you're using submodules, you need to ensure that your jobs are either registered in your top level <code>__init__.py</code> or that this file imports your submodules where the jobs are registered:</p>
+<div class="highlight"><span class="filename">$JOBS_ROOT/my_jobs/__init__.py</span><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">my_job_module</span>
+</code></pre></div>
+<div class="highlight"><span class="filename">$JOBS_ROOT/my_jobs/my_job_module.py</span><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="kn">from</span> <span class="nn">nautobot.apps.jobs</span> <span class="kn">import</span> <span class="n">Job</span><span class="p">,</span> <span class="n">register_jobs</span>
+<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>
+<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="k">class</span> <span class="nc">MyJob</span><span class="p">(</span><span class="n">Job</span><span class="p">):</span>
+<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a>    <span class="o">...</span>
+<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>
+<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="n">register_jobs</span><span class="p">(</span><span class="n">MyJob</span><span class="p">)</span>
+</code></pre></div>
+<p>Similarly, only the <code>jobs</code> module is loaded from Git repositories. If you're using submodules, you need to ensure that your jobs are either registered in the repository's <code>jobs/__init__.py</code> or that this file imports your submodules where the jobs are registered.</p>
+<p>If not using submodules, you should register your job in the file where your job is defined.</p>
+<h4 id="registering-jobs-in-a-plugin">Registering Jobs in a Plugin<a class="headerlink" href="#registering-jobs-in-a-plugin" title="Permanent link">&para;</a></h4>
+<p>Plugins should register jobs in the module defined in their <a href="../../apps/api/nautobot-app-config.html#nautobotappconfig-code-location-attributes"><code>NautobotAppConfig.jobs</code></a> property. This defaults to the <code>jobs</code> module of the plugin.</p>
 <h3 id="job-logging">Job Logging<a class="headerlink" href="#job-logging" title="Permanent link">&para;</a></h3>
 <p>All of the custom <code>log</code> methods have been removed from the Job class. Instead, use either the Python logger from <code>nautobot.extras.jobs.get_task_logger</code> or use <code>self.logger</code> in the Job class.</p>
 <p>The following table describes the mapping of the old log methods to the new methods:</p>

nautobot/project-static/docs/development/react-ui.html

@@ -4,10 +4,10 @@
 <head>
     <meta charset="utf-8">
     <title>Redirecting...</title>
-    <link rel="canonical" href="core/react-ui.html">
+    <link rel="canonical" href="core/index.html">
     <meta name="robots" content="noindex">
-    <script>var anchor=window.location.hash.substr(1);location.href="core/react-ui.html"+(anchor?"#"+anchor:"")</script>
-    <meta http-equiv="refresh" content="0; url=core/react-ui.html">
+    <script>var anchor=window.location.hash.substr(1);location.href="core/index.html"+(anchor?"#"+anchor:"")</script>
+    <meta http-equiv="refresh" content="0; url=core/index.html">
 </head>
 <body>
 Redirecting...

nautobot/project-static/docs/index.html

@@ -382,6 +382,26 @@
     Key Use Cases
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#screenshots" class="md-nav__link">
+    Screenshots
+  </a>
+  
+    <nav class="md-nav" aria-label="Screenshots">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#app-screenshots" class="md-nav__link">
+    App Screenshots
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -451,6 +471,13 @@
     Getting Started
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#notices" class="md-nav__link">
+    Notices
+  </a>
+  
 </li>
       
     </ul>
@@ -1094,20 +1121,6 @@
 
             
           
-            
-              
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="user-guide/administration/configuration/node-configuration.html" class="md-nav__link">
-        Node.js Configuration
-      </a>
-    </li>
-  
-
-            
-          
         </ul>
       </nav>
     </li>
@@ -1556,34 +1569,6 @@
   
   
   
-    <li class="md-nav__item">
-      <a href="user-guide/feature-guides/git-data-source.html" class="md-nav__link">
-        Git as a Data Source
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="user-guide/feature-guides/graphql.html" class="md-nav__link">
-        GraphQL
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
     <li class="md-nav__item">
       <a href="user-guide/feature-guides/relationships.html" class="md-nav__link">
         Relationships
@@ -3669,23 +3654,9 @@
   
   
   
-    <li class="md-nav__item">
-      <a href="development/apps/api/views/view-overrides.html" class="md-nav__link">
-        View Overrides
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
     <li class="md-nav__item">
       <a href="development/apps/api/views/core-view-overrides.html" class="md-nav__link">
-        Legacy View Overrides
+        View Overrides
       </a>
     </li>
   
@@ -3774,7 +3745,7 @@
   
     <li class="md-nav__item">
       <a href="development/apps/api/platform-features/filter-extensions.html" class="md-nav__link">
-        Filter Extentions
+        Filter Extensions
       </a>
     </li>
   
@@ -3982,21 +3953,7 @@
   
     <li class="md-nav__item">
       <a href="development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="development/apps/api/ui-extensions/tabs.html" class="md-nav__link">
-        Tabs
+        Object Detail Views and Tabs
       </a>
     </li>
   
@@ -4667,6 +4624,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="development/core/bootstrap-ui.html" class="md-nav__link">
+        Bootstrap UI
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="development/core/best-practices.html" class="md-nav__link">
         Best Practices
@@ -4779,20 +4750,6 @@
   
   
   
-    <li class="md-nav__item">
-      <a href="development/core/react-ui.html" class="md-nav__link">
-        React UI
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
     <li class="md-nav__item">
       <a href="development/core/role-internals.html" class="md-nav__link">
         Role Internals
@@ -5308,6 +5265,26 @@
     Key Use Cases
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#screenshots" class="md-nav__link">
+    Screenshots
+  </a>
+  
+    <nav class="md-nav" aria-label="Screenshots">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#app-screenshots" class="md-nav__link">
+    App Screenshots
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -5377,6 +5354,13 @@
     Getting Started
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#notices" class="md-nav__link">
+    Notices
+  </a>
+  
 </li>
       
     </ul>
@@ -5405,11 +5389,8 @@
 <li>Nautobot has a thriving ecosystem of <strong>Apps</strong> (also known as Plugins), developed as separate projects, for which you can find links to documentation under the <a href="apps/index.html">Nautobot Apps</a> section.</li>
 </ul>
 <h2 id="what-is-nautobot">What is Nautobot?<a class="headerlink" href="#what-is-nautobot" title="Permanent link">&para;</a></h2>
-<!-- markdownlint-disable MD033 -->
-<p><img src="assets/nautobot_logo.svg" class="logo"></p>
-<!-- markdownlint-enable MD033 -->
-
-<p>Nautobot is an open source Network Source of Truth and Network Automation Platform. Nautobot was initially developed as a fork of NetBox (v2.10.4), which was originally created by Jeremy Stretch at DigitalOcean and by the NetBox open source community.</p>
+<p><img alt="Nautobot Logo" src="assets/nautobot_logo.svg" /></p>
+<p>Nautobot is an open source Network Source of Truth and Network Automation Platform built as a web application atop the <a href="https://www.djangoproject.com/">Django</a> Python framework with a <a href="https://www.postgresql.org/">PostgreSQL</a> or <a href="https://www.mysql.com">MySQL</a> database.</p>
 <h2 id="key-use-cases">Key Use Cases<a class="headerlink" href="#key-use-cases" title="Permanent link">&para;</a></h2>
 <p>Nautobot enables three (3) key use cases.</p>
 <ol>
@@ -5433,6 +5414,14 @@
 </ul>
 </li>
 </ol>
+<h2 id="screenshots">Screenshots<a class="headerlink" href="#screenshots" title="Permanent link">&para;</a></h2>
+<p><img alt="Main Page" src="media/ss_main_page.png" /></p>
+<p><img alt="Config Contexts" src="media/ss_config_contexts.png" /></p>
+<p><img alt="Prefix Hierarchy" src="media/ss_prefix_hierarchy.png" /></p>
+<p><img alt="GraphQL API" src="media/ss_graphiql.png" /></p>
+<h3 id="app-screenshots">App Screenshots<a class="headerlink" href="#app-screenshots" title="Permanent link">&para;</a></h3>
+<p><img alt="Golden Config App" src="media/ss_plugin_golden_config.png" /></p>
+<p><img alt="ChatOps App" src="media/ss_plugin_chatops.png" /></p>
 <h2 id="design-philosophy">Design Philosophy<a class="headerlink" href="#design-philosophy" title="Permanent link">&para;</a></h2>
 <p>The following tenets drive the direction of Nautobot.</p>
 <h3 id="replicate-the-real-world">Replicate the Real World<a class="headerlink" href="#replicate-the-real-world" title="Permanent link">&para;</a></h3>
@@ -5469,7 +5458,7 @@
 </tr>
 <tr>
 <td>Database</td>
-<td>PostgreSQL 9.6+ or MySQL 8.0+</td>
+<td>PostgreSQL 12.0+ or MySQL 8.0+</td>
 </tr>
 <tr>
 <td>Cache</td>
@@ -5496,6 +5485,10 @@
 <li><code>django-cacheops</code> usage was removed and replaced with Django's native caching features.</li>
 </ul>
 </div>
+<div class="admonition version-removed">
+<p class="admonition-title">Removed in version 2.1.0</p>
+<p>Support for versions of PostgreSQL older than 12.0 was removed.</p>
+</div>
 <p>The following diagram displays how data travels through Nautobot's application stack.</p>
 <p><img alt="Application stack diagram" src="media/nautobot_application_stack_low_level.png" title="Application stack diagram" /></p>
 <h2 id="supported-python-versions">Supported Python Versions<a class="headerlink" href="#supported-python-versions" title="Permanent link">&para;</a></h2>
@@ -5514,6 +5507,10 @@
 </div>
 <h2 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">&para;</a></h2>
 <p>See the <a href="user-guide/administration/installation/index.html">installation guide</a> for help getting Nautobot up and running quickly.</p>
+<h2 id="notices">Notices<a class="headerlink" href="#notices" title="Permanent link">&para;</a></h2>
+<blockquote>
+<p>Nautobot was initially developed as a fork of NetBox (v2.10.4), which was originally created by Jeremy Stretch at DigitalOcean and by the NetBox open source community.</p>
+</blockquote>