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

nautobot/project-static/docs/user-guide/feature-guides/git-data-source.html

@@ -11,7 +11,7 @@
         <link rel="canonical" href="https://docs.nautobot.com/projects/core/en/stable/user-guide/feature-guides/git-data-source.html">
       
       
-        <link rel="prev" href="ip-address-merge-tool.html">
+        <link rel="prev" href="custom-fields.html">
       
       
         <link rel="next" href="graphql.html">
@@ -979,20 +979,6 @@
 
             
           
-            
-              
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../administration/configuration/node-configuration.html" class="md-nav__link">
-        Node.js Configuration
-      </a>
-    </li>
-  
-
-            
-          
         </ul>
       </nav>
     </li>
@@ -1400,8 +1386,10 @@
               
   
   
+    
   
-    <li class="md-nav__item">
+  
+    <li class="md-nav__item md-nav__item--active">
       
       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
       
@@ -1590,184 +1578,6 @@
               
   
   
-    
-  
-  
-    <li class="md-nav__item md-nav__item--active">
-      
-      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
-      
-      
-        
-      
-      
-        <label class="md-nav__link md-nav__link--active" for="__toc">
-          Git as a Data Source
-          <span class="md-nav__icon md-icon"></span>
-        </label>
-      
-      <a href="git-data-source.html" class="md-nav__link md-nav__link--active">
-        Git as a Data Source
-      </a>
-      
-        
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#supported-providers" class="md-nav__link">
-    Supported Providers
-  </a>
-  
-    <nav class="md-nav" aria-label="Supported Providers">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#core-functionality" class="md-nav__link">
-    Core Functionality
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#examples-of-plugins-defining-additional-providers" class="md-nav__link">
-    Examples of Plugins Defining Additional Providers
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#repository-details" class="md-nav__link">
-    Repository Details
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#using-git-data-sources" class="md-nav__link">
-    Using Git Data Sources
-  </a>
-  
-    <nav class="md-nav" aria-label="Using Git Data Sources">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#export-templates" class="md-nav__link">
-    Export Templates
-  </a>
-  
-    <nav class="md-nav" aria-label="Export Templates">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#add-a-repository" class="md-nav__link">
-    Add a Repository
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#fill-out-repository-details" class="md-nav__link">
-    Fill out Repository Details
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#modifying-a-file-and-sync-changes" class="md-nav__link">
-    Modifying a File and Sync Changes
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#jobs" class="md-nav__link">
-    Jobs
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#config-contexts" class="md-nav__link">
-    Config Contexts
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#config-context-schemas" class="md-nav__link">
-    Config Context Schemas
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#additional-git-data-sources" class="md-nav__link">
-    Additional Git Data Sources
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#common-issues-and-troubleshooting" class="md-nav__link">
-    Common Issues and Troubleshooting
-  </a>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-      
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="graphql.html" class="md-nav__link">
-        GraphQL
-      </a>
-    </li>
-  
-
-            
-          
-            
-              
-  
-  
   
     <li class="md-nav__item">
       <a href="relationships.html" class="md-nav__link">
@@ -3854,23 +3664,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>
   
@@ -3959,7 +3755,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>
   
@@ -4167,21 +3963,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>
   
@@ -4852,6 +4634,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
@@ -4964,20 +4760,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
@@ -5741,12 +5523,11 @@
 <p class="admonition-title">Note</p>
 <p>If you are using a self-signed Git repository, the Server Administrator will need to ensure the <a href="../administration/configuration/optional-settings.html#git_ssl_no_verify"><code>GIT_SSL_NO_VERIFY</code></a> environment variable is set to permit this.</p>
 </div>
-<p><img alt="View of Synchronization Status" src="images/git-as-data-source/04-git-data-source.png" />
-<img alt="Status of Export-Templates" src="images/git-as-data-source/06-git-data-source.png" /></p>
+<p><img alt="View of Synchronization Status" src="images/git-as-data-source/04-git-data-source.png" /></p>
 <p>The repository will now be displayed on the main Git Repository page.</p>
 <p><img alt="Default Repository Menu" src="images/git-as-data-source/05-git-data-source.png" /></p>
 <p>Once the repository is synced each template will now be available in the Export Templates section.  <strong>Extensibility -&gt; Export Templates</strong>.</p>
-<p><img alt="List of Loaded Export-Templates" src="images/git-as-data-source/07-git-data-source.png" /></p>
+<p><img alt="List of Loaded Export-Templates" src="images/git-as-data-source/06-git-data-source.png" /></p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>If the templates don't populate, make sure the Git directory is named <code>export_templates</code> and the sub-directory and sub-sub-directory names correctly match the Nautobot <code>content type</code>.</p>
@@ -5788,9 +5569,9 @@
 </code></pre></div>
 <p>Once the contributor updates the Git repository via normal Git processes and it is reviewed and merged into the branch that was used, a sync process from Nautobot needs to be completed.  This can be done from the default Git view, or within a specific detailed view of a Git repository.</p>
 <p>From the default Git repositories view:
-<img alt="Sync Repository from Default Menu" src="images/git-as-data-source/08-git-data-source.png" /></p>
+<img alt="Sync Repository from Default Menu" src="images/git-as-data-source/07-git-data-source.png" /></p>
 <p>From the detailed view:
-<img alt="Sync Repository from Detailed Menu" src="images/git-as-data-source/09-git-data-source.png" /></p>
+<img alt="Sync Repository from Detailed Menu" src="images/git-as-data-source/08-git-data-source.png" /></p>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
 <p>Once the repository has been synced it's easy to check the history for the templates.
@@ -5802,7 +5583,7 @@ Navigate to <strong>Git Repositories</strong> and select the repository in quest
 <p>For technical details on jobs, please see the <a href="../platform-functionality/jobs/index.html#jobs">documentation on jobs</a>.</p>
 <p>Jobs allow a user to write scripts in Python.  By integrating the scripts with Git, a user can utilize Git workflows to manage source control, versioning, and pipelines.</p>
 <p>Setting up the repository can be done following the same steps from <a href="#export-templates">Export Templates</a>.  The only differences is the <code>provides</code> selection changes to <code>jobs</code>.</p>
-<p>Jobs need to be defined in <code>/jobs/</code> directory at the root of a Git repository.</p>
+<p>Jobs need to be defined in a <code>/jobs/</code> directory or <code>jobs.py</code> at the root of a Git repository. Any job classes defined in these files that have been registered during import will be discovered by Nautobot and made available to be run as a job. See the section on <a href="../../development/jobs/index.html#job-registration">Job registration</a> for more information.</p>
 <p>An example tree for <code>/jobs/</code>.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>▶ tree jobs
 <a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>jobs
@@ -5813,18 +5594,18 @@ Navigate to <strong>Git Repositories</strong> and select the repository in quest
 </code></pre></div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>As shown in the above example, the <code>/jobs/</code> directory must contain a file called <code>__init__.py</code>. This may be an empty file, but it must exist.</p>
+<p>As shown in the above example, the <code>/jobs/</code> directory must contain a file called <code>__init__.py</code>.</p>
 </div>
-<p>Once the repository is created in Nautobot.
-<img alt="Example Details Jobs" src="images/git-as-data-source/10-git-data-source.png" /></p>
+<p>Once the repository is created in Nautobot.</p>
+<p><img alt="Example Details Jobs" src="images/git-as-data-source/09-git-data-source.png" /></p>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
 <p>The same repository and branch can be used for the different <code>provides</code> methods.  Nautobot Git as a data source will look for specific root directory names.</p>
 </div>
 <p>Once the scripts have been pushed into the repository, a sync needs to be executed, after which navigating to Jobs via <strong>Jobs -&gt; Jobs</strong> will show the new jobs loaded from the Git repository.</p>
-<p><img alt="Default Repository Menu" src="images/git-as-data-source/11-git-data-source.png" /></p>
+<p><img alt="Default Repository Menu" src="images/git-as-data-source/10-git-data-source.png" /></p>
 <p>Jobs now shows the job from the Git repository.</p>
-<p><img alt="List of Loaded Jobs" src="images/git-as-data-source/12-git-data-source.png" /></p>
+<p><img alt="List of Loaded Jobs" src="images/git-as-data-source/11-git-data-source.png" /></p>
 <p>At this point all changes, and history can be kept using Git.  A simple <code>sync</code> operation can be done from Nautobot to pulldown any changes.</p>
 <h3 id="config-contexts">Config Contexts<a class="headerlink" href="#config-contexts" title="Permanent link">&para;</a></h3>
 <p>Detailed information on <a href="../platform-functionality/gitrepository.html#configuration-contexts">config contexts</a> in Git Repositories.</p>
@@ -5838,9 +5619,9 @@ Navigate to <strong>Git Repositories</strong> and select the repository in quest
 <li>Routing Information such as BGP ASNs etc.</li>
 </ul>
 <p>Similar to the other data sources, the repository can be added by navigating to <strong>Extensibility -&gt; Git repositories</strong>. Click on <strong>Add</strong>, and fill out the repository details.</p>
-<p><img alt="Example Details Config Contexts" src="images/git-as-data-source/13-git-data-source.png" /></p>
+<p><img alt="Example Details Config Contexts" src="images/git-as-data-source/12-git-data-source.png" /></p>
 <p>Once the repository syncs the details can be found in the <strong>Synchronization Status</strong> tab.  For example, the platform specifics were synced:</p>
-<p><img alt="Synchronization Menu With Loaded Contexts" src="images/git-as-data-source/14-git-data-source.png" /></p>
+<p><img alt="Synchronization Menu With Loaded Contexts" src="images/git-as-data-source/13-git-data-source.png" /></p>
 <p>The repository structure is:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>▶ tree config_contexts
 <a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>config_contexts
@@ -5870,7 +5651,7 @@ Navigate to <strong>Git Repositories</strong> and select the repository in quest
 <li>Nautobot UI provides a simple view to see merged config contexts.  It can be visualized by navigating to a device and clicking on the <strong>config contexts</strong> tab.</li>
 </ul>
 <p>Here's an example, with some of the details omitted for brevity.</p>
-<p><img alt="Config Contexts Display Pane" src="images/git-as-data-source/15-git-data-source.png" /></p>
+<p><img alt="Config Contexts Display Pane" src="images/git-as-data-source/14-git-data-source.png" /></p>
 <p>There is a huge benefit to having <code>config contexts</code> managed by a Git workflow.  This type of data can be modified often, especially platform specifics, or new device roles.  Utilizing a standard Git workflow allows for all the proper reviews and approvals to be accomplished before accepting the changes into Nautobot for use.</p>
 <h3 id="config-context-schemas">Config Context Schemas<a class="headerlink" href="#config-context-schemas" title="Permanent link">&para;</a></h3>
 <p>Detailed information on <a href="../platform-functionality/gitrepository.html#configuration-context-schemas">config context schemas</a> in Git Repositories.</p>
@@ -5900,9 +5681,9 @@ Navigate to <strong>Git Repositories</strong> and select the repository in quest
 </li>
 <li>Synchronization Status Failures.<ul>
 <li>Validate branch is correct and exists in the remote repository.
-<img alt="Error Branch Doesn't Exist" src="images/git-as-data-source/16-git-data-source.png" /></li>
+<img alt="Error Branch Doesn't Exist" src="images/git-as-data-source/15-git-data-source.png" /></li>
 <li>Validate the remote url is correct and is the <code>http(s)</code> url.  <code>ssh</code> urls are not currently supported.
-<img alt="Error Remote URL Incorrect" src="images/git-as-data-source/17-git-data-source.png" /></li>
+<img alt="Error Remote URL Incorrect" src="images/git-as-data-source/16-git-data-source.png" /></li>
 </ul>
 </li>
 <li>
@@ -5913,7 +5694,7 @@ Navigate to <strong>Git Repositories</strong> and select the repository in quest
 <li>Ensure the PAT permissions are setup properly.</li>
 <li>At a minimum the <code>repo</code> option should be checked or access.</li>
 </ul>
-<p><img alt="Error Authentication Issue" src="images/git-as-data-source/18-git-data-source.png" /></p>
+<p><img alt="Error Authentication Issue" src="images/git-as-data-source/17-git-data-source.png" /></p>
 </li>
 </ol>
 
@@ -5937,7 +5718,7 @@ Navigate to <strong>Git Repositories</strong> and select the repository in quest
       <nav class="md-footer__inner md-grid" aria-label="Footer" >
         
           
-          <a href="ip-address-merge-tool.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: IP Address Merge Tool" rel="prev">
+          <a href="custom-fields.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Custom Fields" 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>
@@ -5946,7 +5727,7 @@ Navigate to <strong>Git Repositories</strong> and select the repository in quest
                 Previous
               </span>
               <div class="md-ellipsis">
-                IP Address Merge Tool
+                Custom Fields
               </div>
             </div>
           </a>