nautobot 2.4.16__py3-none-any.whl → 2.4.17__py3-none-any.whl

nautobot/project-static/docs/development/core/application-registry.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
     
     
       
@@ -35,6 +35,8 @@
   
   
     
+      
+      
     
   
   
@@ -7394,12 +7396,12 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/platform-features/populating-extensibility-features.html" class="md-nav__link">
+      <a href="../apps/api/platform-features/prepopulating-data.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
-    Populating Extensibility Features
+    Prepopulating Data
     
   </span>
   
@@ -10405,9 +10407,9 @@
 <summary>Added in version 2.4.14</summary>
 </details>
 <p>A dictionary of particular features (e.g. "graphql") mapped to the set of Nautobot model classes which support each such feature. For example:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">nautobot.extras.registry</span> <span class="kn">import</span> <span class="n">registry</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">nautobot.extras.registry</span><span class="w"> </span><span class="kn">import</span> <span class="n">registry</span>
 <a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="o">&gt;&gt;&gt;</span> <span class="n">registry</span><span class="p">[</span><span class="s2">&quot;feature_models&quot;</span><span class="p">][</span><span class="s2">&quot;graphql&quot;</span><span class="p">]</span>
-<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="p">[</span><span class="o">&lt;</span><span class="k">class</span> <span class="err">&#39;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">change_logging</span><span class="o">.</span><span class="n">ObjectChange</span><span class="s1">&#39;&gt;, &lt;class &#39;</span><span class="n">nautobot</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">customfields</span><span class="o">.</span><span class="n">ComputedField</span><span class="s1">&#39;&gt;, &lt;class &#39;</span><span class="n">nautobot</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">customfields</span><span class="o">.</span><span class="n">CustomFieldChoice</span><span class="s1">&#39;&gt;, &lt;class &#39;</span><span class="n">nautobot</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">roles</span><span class="o">.</span><span class="n">Role</span><span class="s1">&#39;&gt;, ...</span>
+<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="p">[</span><span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&#39;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">change_logging</span><span class="o">.</span><span class="n">ObjectChange</span><span class="s1">&#39;&gt;, &lt;class &#39;</span><span class="n">nautobot</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">customfields</span><span class="o">.</span><span class="n">ComputedField</span><span class="s1">&#39;&gt;, &lt;class &#39;</span><span class="n">nautobot</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">customfields</span><span class="o">.</span><span class="n">CustomFieldChoice</span><span class="s1">&#39;&gt;, &lt;class &#39;</span><span class="n">nautobot</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">roles</span><span class="o">.</span><span class="n">Role</span><span class="s1">&#39;&gt;, ...</span>
 </code></pre></div>
 <p>Useful as an alternative to <code>model_features</code> (<a href="#model_features">below</a>) for cases where direct access to the Django model classes is desired, such as in generating the GraphQL schema.</p>
 <h3 id="jobs"><code>jobs</code><a class="headerlink" href="#jobs" title="Permanent link">&para;</a></h3>
@@ -10416,18 +10418,18 @@
 </details>
 <p>A dictionary of registered <a href="../jobs/index.html">Job classes</a>, indexed by their <a href="../../user-guide/platform-functionality/jobs/models.html#understanding-job-class-paths">class path</a>. For 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="p">{</span>
-<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>    <span class="s2">&quot;nautobot.core.jobs.ExportObjectList&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExportObjectList</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>    <span class="s2">&quot;nautobot.core.jobs.GitRepositorySync&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">GitRepositorySync</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>    <span class="s2">&quot;nautobot.core.jobs.GitRepositoryDryRun&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">GitRepositoryDryRun</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>    <span class="s2">&quot;nautobot.core.jobs.ImportObjects&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ImportObjects</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>    <span class="s2">&quot;example_app.jobs.ExampleDryRunJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleDryRunJob</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a>    <span class="s2">&quot;example_app.jobs.ExampleJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleJob</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>    <span class="s2">&quot;example_app.jobs.ExampleHiddenJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleHiddenJob</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a>    <span class="s2">&quot;example_app.jobs.ExampleLoggingJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleLoggingJob</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a>    <span class="s2">&quot;example_app.jobs.ExampleFileInputOutputJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleFileInputOutputJob</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a>    <span class="s2">&quot;example_app.jobs.ExampleJobHookReceiver&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleJobHookReceiver</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-12" name="__codelineno-4-12" href="#__codelineno-4-12"></a>    <span class="s2">&quot;example_app.jobs.ExampleSimpleJobButtonReceiver&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleSimpleJobButtonReceiver</span><span class="s2">&quot;&gt;,</span>
-<a id="__codelineno-4-13" name="__codelineno-4-13" href="#__codelineno-4-13"></a>    <span class="s2">&quot;example_app.jobs.ExampleComplexJobButtonReceiver&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleComplexJobButtonReceiver</span><span class="s2">&quot;&gt;</span>
+<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>    <span class="s2">&quot;nautobot.core.jobs.ExportObjectList&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExportObjectList</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>    <span class="s2">&quot;nautobot.core.jobs.GitRepositorySync&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">GitRepositorySync</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>    <span class="s2">&quot;nautobot.core.jobs.GitRepositoryDryRun&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">GitRepositoryDryRun</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>    <span class="s2">&quot;nautobot.core.jobs.ImportObjects&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">nautobot</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ImportObjects</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>    <span class="s2">&quot;example_app.jobs.ExampleDryRunJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleDryRunJob</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a>    <span class="s2">&quot;example_app.jobs.ExampleJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleJob</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>    <span class="s2">&quot;example_app.jobs.ExampleHiddenJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleHiddenJob</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a>    <span class="s2">&quot;example_app.jobs.ExampleLoggingJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleLoggingJob</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a>    <span class="s2">&quot;example_app.jobs.ExampleFileInputOutputJob&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleFileInputOutputJob</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a>    <span class="s2">&quot;example_app.jobs.ExampleJobHookReceiver&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleJobHookReceiver</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-12" name="__codelineno-4-12" href="#__codelineno-4-12"></a>    <span class="s2">&quot;example_app.jobs.ExampleSimpleJobButtonReceiver&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleSimpleJobButtonReceiver</span><span class="s2">&quot;&gt;,</span>
+<a id="__codelineno-4-13" name="__codelineno-4-13" href="#__codelineno-4-13"></a>    <span class="s2">&quot;example_app.jobs.ExampleComplexJobButtonReceiver&quot;</span><span class="p">:</span> <span class="o">&lt;</span><span class="k">class</span><span class="w"> </span><span class="err">&quot;</span><span class="nc">example_app</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">ExampleComplexJobButtonReceiver</span><span class="s2">&quot;&gt;</span>
 <a id="__codelineno-4-14" name="__codelineno-4-14" href="#__codelineno-4-14"></a><span class="p">}</span>
 </code></pre></div>
 <div class="admonition caution">
@@ -10629,7 +10631,8 @@
 <!-- RTD version flyout injected on live site -->
 <div id="readthedocs-embed-flyout"></div>
       
-        <div class="md-social">
+        
+<div class="md-social">
   
     
     
@@ -10685,10 +10688,10 @@
     
     
       
-      <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.d50fe291.min.js", "tags": null, "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"}, "version": null}</script>
+      <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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.50899def.min.js"></script>
+      <script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
       
     
   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});

nautobot/project-static/docs/development/core/best-practices.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
     
     
       
@@ -35,6 +35,8 @@
   
   
     
+      
+      
     
   
   
@@ -7394,12 +7396,12 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/platform-features/populating-extensibility-features.html" class="md-nav__link">
+      <a href="../apps/api/platform-features/prepopulating-data.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
-    Populating Extensibility Features
+    Prepopulating Data
     
   </span>
   
@@ -10703,12 +10705,12 @@ For most purposes, this is not the case you are intending to check!</p>
 <p>Models should generally <strong>not</strong> have a <code>slug</code> field, and should use the model's primary key (UUID) in URL patterns for both the UI and the REST API. All models should have a human-friendly natural key, either a single unique field (typically <code>name</code>) or a minimally complex unique-together set of fields (such as <code>DeviceType</code>'s <code>(manufacturer, model)</code>).</p>
 </details>
 <p>For models that have a strong use case for a <code>slug</code> or similar field (such as <code>GitRepository.slug</code>, which defines a module name for Python imports from the repository, or <code>CustomField.key</code>, which defines the key used to access this field in the REST API and GraphQL), Nautobot provides the <code>AutoSlugField</code> to handle automatically populating the <code>slug</code> field from another field(s). Generally speaking model slugs should be populated from the <code>name</code> field. Below is an example on defining the <code>slug</code> field.</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">django.db</span> <span class="kn">import</span> <span class="n">models</span>
+<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="w"> </span><span class="nn">django.db</span><span class="w"> </span><span class="kn">import</span> <span class="n">models</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="kn">from</span> <span class="nn">nautobot.core.models.fields</span> <span class="kn">import</span> <span class="n">AutoSlugField</span>
-<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="kn">from</span> <span class="nn">nautobot.core.models.generics</span> <span class="kn">import</span> <span class="n">PrimaryModel</span>
+<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="kn">from</span><span class="w"> </span><span class="nn">nautobot.core.models.fields</span><span class="w"> </span><span class="kn">import</span> <span class="n">AutoSlugField</span>
+<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="kn">from</span><span class="w"> </span><span class="nn">nautobot.core.models.generics</span><span class="w"> </span><span class="kn">import</span> <span class="n">PrimaryModel</span>
 <a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>
-<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="k">class</span> <span class="nc">ExampleModel</span><span class="p">(</span><span class="n">PrimaryModel</span><span class="p">):</span>
+<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="k">class</span><span class="w"> </span><span class="nc">ExampleModel</span><span class="p">(</span><span class="n">PrimaryModel</span><span class="p">):</span>
 <a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a>    <span class="n">name</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 <a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>    <span class="n">slug</span> <span class="o">=</span> <span class="n">AutoSlugField</span><span class="p">(</span><span class="n">populate_from</span><span class="o">=</span><span class="s1">&#39;name&#39;</span><span class="p">)</span>
 </code></pre></div>
@@ -10720,7 +10722,7 @@ For most purposes, this is not the case you are intending to check!</p>
 <summary>Changed in version 2.0.0</summary>
 <p><code>get_route_for_model</code> was moved from the <code>nautobot.utilities.utils</code> module to <code>nautobot.core.utils.lookup</code>.</p>
 </details>
-<div class="highlight"><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.core.utils.lookup</span> <span class="kn">import</span> <span class="n">get_route_for_model</span>
+<div class="highlight"><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="w"> </span><span class="nn">nautobot.core.utils.lookup</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_route_for_model</span>
 </code></pre></div>
 <p>This utility function supports both UI and API views for both Nautobot core apps and Nautobot Apps.</p>
 <h3 id="ui-routes">UI Routes<a class="headerlink" href="#ui-routes" title="Permanent link">&para;</a></h3>
@@ -10799,8 +10801,8 @@ For most purposes, this is not the case you are intending to check!</p>
 </li>
 <li>In the event that fields do need to be customized to extend lookup expressions, a <a href="https://django-filter.readthedocs.io/en/stable/ref/filterset.html#declaring-filterable-fields">dictionary of field names mapped to a list of lookups</a> <strong>may</strong> be used, however, this pattern is only compatible with explicitly declaring all fields, which should also be avoided for the common case. For example:</li>
 </ul>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="k">class</span> <span class="nc">UserFilter</span><span class="p">(</span><span class="n">NautobotFilterSet</span><span class="p">):</span>
-<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a>    <span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">UserFilter</span><span class="p">(</span><span class="n">NautobotFilterSet</span><span class="p">):</span>
+<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a>    <span class="k">class</span><span class="w"> </span><span class="nc">Meta</span><span class="p">:</span>
 <a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a>        <span class="n">model</span> <span class="o">=</span> <span class="n">User</span>
 <a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a>        <span class="n">fields</span> <span class="o">=</span> <span class="p">{</span>
 <a id="__codelineno-16-5" name="__codelineno-16-5" href="#__codelineno-16-5"></a>            <span class="s1">&#39;username&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;exact&#39;</span><span class="p">,</span> <span class="s1">&#39;contains&#39;</span><span class="p">],</span>
@@ -10832,7 +10834,7 @@ For most purposes, this is not the case you are intending to check!</p>
 </li>
 </ul>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="c1"># Typical usage</span>
-<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="kn">from</span> <span class="nn">nautobot.core.filters</span> <span class="kn">import</span> <span class="n">NaturalKeyOrPKMultipleChoiceFilter</span>
+<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="kn">from</span><span class="w"> </span><span class="nn">nautobot.core.filters</span><span class="w"> </span><span class="kn">import</span> <span class="n">NaturalKeyOrPKMultipleChoiceFilter</span>
 <a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a>
 <a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a>    <span class="n">provider</span> <span class="o">=</span> <span class="n">NaturalKeyOrPKMultipleChoiceFilter</span><span class="p">(</span>
 <a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a>        <span class="n">queryset</span><span class="o">=</span><span class="n">Provider</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">all</span><span class="p">(),</span>
@@ -10841,7 +10843,7 @@ For most purposes, this is not the case you are intending to check!</p>
 <a id="__codelineno-17-8" name="__codelineno-17-8" href="#__codelineno-17-8"></a>    <span class="p">)</span>
 </code></pre></div>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="c1"># Optionally, using the to_field_name argument to look up by &quot;slug&quot; instead of by &quot;name&quot;</span>
-<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="kn">from</span> <span class="nn">nautobot.core.filters</span> <span class="kn">import</span> <span class="n">NaturalKeyOrPKMultipleChoiceFilter</span>
+<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="kn">from</span><span class="w"> </span><span class="nn">nautobot.core.filters</span><span class="w"> </span><span class="kn">import</span> <span class="n">NaturalKeyOrPKMultipleChoiceFilter</span>
 <a id="__codelineno-18-3" name="__codelineno-18-3" href="#__codelineno-18-3"></a>
 <a id="__codelineno-18-4" name="__codelineno-18-4" href="#__codelineno-18-4"></a>    <span class="n">git_repository</span> <span class="o">=</span> <span class="n">NaturalKeyOrPKMultipleChoiceFilter</span><span class="p">(</span>
 <a id="__codelineno-18-5" name="__codelineno-18-5" href="#__codelineno-18-5"></a>        <span class="n">to_field_name</span><span class="o">=</span><span class="s2">&quot;slug&quot;</span><span class="p">,</span>
@@ -10855,7 +10857,7 @@ For most purposes, this is not the case you are intending to check!</p>
 </ul>
 </li>
 </ul>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="kn">from</span> <span class="nn">nautobot.core.filters</span> <span class="kn">import</span> <span class="n">RelatedMembershipBooleanFilter</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">nautobot.core.filters</span><span class="w"> </span><span class="kn">import</span> <span class="n">RelatedMembershipBooleanFilter</span>
 <a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a>
 <a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a>    <span class="n">has_interfaces</span> <span class="o">=</span> <span class="n">RelatedMembershipBooleanFilter</span><span class="p">(</span>
 <a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a>        <span class="n">field_name</span><span class="o">=</span><span class="s2">&quot;interfaces&quot;</span><span class="p">,</span>
@@ -10907,9 +10909,9 @@ For most purposes, this is not the case you are intending to check!</p>
 <p>For example:</p>
 </li>
 </ul>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="k">class</span> <span class="nc">ProductFilter</span><span class="p">(</span><span class="n">NautobotFilterSet</span><span class="p">):</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">ProductFilter</span><span class="p">(</span><span class="n">NautobotFilterSet</span><span class="p">):</span>
 <a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a>
-<a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a>     <span class="k">class</span> <span class="nc">Meta</span><span class="p">:</span>
+<a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a>     <span class="k">class</span><span class="w"> </span><span class="nc">Meta</span><span class="p">:</span>
 <a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a>         <span class="n">model</span> <span class="o">=</span> <span class="n">Interface</span>
 <a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a>         <span class="n">fields</span> <span class="o">=</span> <span class="s2">&quot;__all__&quot;</span>
 <a id="__codelineno-21-6" name="__codelineno-21-6" href="#__codelineno-21-6"></a>         <span class="n">filter_overrides</span> <span class="o">=</span> <span class="p">{</span>
@@ -10947,7 +10949,7 @@ For most purposes, this is not the case you are intending to check!</p>
 <a id="__codelineno-22-7" name="__codelineno-22-7" href="#__codelineno-22-7"></a>
 <a id="__codelineno-22-8" name="__codelineno-22-8" href="#__codelineno-22-8"></a>    <span class="c1"># Method definition loses context and further the field&#39;s lookup_expr</span>
 <a id="__codelineno-22-9" name="__codelineno-22-9" href="#__codelineno-22-9"></a>    <span class="c1"># falls back to the default of &quot;exact&quot; and the `name` value is irrelevant here.</span>
-<a id="__codelineno-22-10" name="__codelineno-22-10" href="#__codelineno-22-10"></a>    <span class="k">def</span> <span class="nf">_pass_through_ports</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">queryset</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+<a id="__codelineno-22-10" name="__codelineno-22-10" href="#__codelineno-22-10"></a>    <span class="k">def</span><span class="w"> </span><span class="nf">_pass_through_ports</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">queryset</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
 <a id="__codelineno-22-11" name="__codelineno-22-11" href="#__codelineno-22-11"></a>        <span class="nb">breakpoint</span><span class="p">()</span>  <span class="c1"># This was added to illustrate debugging with pdb below</span>
 <a id="__codelineno-22-12" name="__codelineno-22-12" href="#__codelineno-22-12"></a>        <span class="k">return</span> <span class="n">queryset</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">frontports__isnull</span><span class="o">=</span><span class="n">value</span><span class="p">,</span> <span class="n">rearports__isnull</span><span class="o">=</span><span class="n">value</span><span class="p">)</span>
 </code></pre></div>
@@ -10988,7 +10990,7 @@ For most purposes, this is not the case you are intending to check!</p>
 <p>It would be better to just eliminate <code>pass_through_ports=True</code> entirely in exchange for <code>front_ports=True&amp;rear_ports=True</code> (current) or <code>has_frontports=True&amp;has_rearports=True</code> (future).</p>
 <h4 id="generating-reversible-q-objects">Generating Reversible Q Objects<a class="headerlink" href="#generating-reversible-q-objects" title="Permanent link">&para;</a></h4>
 <p>With consistent and proper use of filter field arguments when defining them on a filterset, a query could be constructed using the <code>field_name</code> and <code>lookup_expr</code> values. For example:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a>    <span class="k">def</span> <span class="nf">generate_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a>    <span class="k">def</span><span class="w"> </span><span class="nf">generate_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
 <a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a>        <span class="n">query</span> <span class="o">=</span> <span class="n">Q</span><span class="p">()</span>
 <a id="__codelineno-27-3" name="__codelineno-27-3" href="#__codelineno-27-3"></a>        <span class="n">predicate</span> <span class="o">=</span> <span class="p">{</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">field</span><span class="o">.</span><span class="n">field_name</span><span class="si">}</span><span class="s2">__</span><span class="si">{</span><span class="n">field</span><span class="o">.</span><span class="n">lookup_expr</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">:</span> <span class="n">value</span><span class="p">}</span>
 <a id="__codelineno-27-4" name="__codelineno-27-4" href="#__codelineno-27-4"></a>        <span class="k">if</span> <span class="n">field</span><span class="o">.</span><span class="n">exclude</span><span class="p">:</span>
@@ -11101,7 +11103,8 @@ For most purposes, this is not the case you are intending to check!</p>
 <!-- RTD version flyout injected on live site -->
 <div id="readthedocs-embed-flyout"></div>
       
-        <div class="md-social">
+        
+<div class="md-social">
   
     
     
@@ -11157,10 +11160,10 @@ For most purposes, this is not the case you are intending to check!</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.d50fe291.min.js", "tags": null, "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"}, "version": null}</script>
+      <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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.50899def.min.js"></script>
+      <script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
       
     
   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});

nautobot/project-static/docs/development/core/bootstrap-ui.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
     
     
       
@@ -35,6 +35,8 @@
   
   
     
+      
+      
     
   
   
@@ -7394,12 +7396,12 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/platform-features/populating-extensibility-features.html" class="md-nav__link">
+      <a href="../apps/api/platform-features/prepopulating-data.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
-    Populating Extensibility Features
+    Prepopulating Data
     
   </span>
   
@@ -10291,7 +10293,8 @@
 <!-- RTD version flyout injected on live site -->
 <div id="readthedocs-embed-flyout"></div>
       
-        <div class="md-social">
+        
+<div class="md-social">
   
     
     
@@ -10347,10 +10350,10 @@
     
     
       
-      <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.d50fe291.min.js", "tags": null, "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"}, "version": null}</script>
+      <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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.50899def.min.js"></script>
+      <script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
       
     
   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
     
     
       
@@ -35,6 +35,8 @@
   
   
     
+      
+      
     
   
   
@@ -7394,12 +7396,12 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/platform-features/populating-extensibility-features.html" class="md-nav__link">
+      <a href="../apps/api/platform-features/prepopulating-data.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
-    Populating Extensibility Features
+    Prepopulating Data
     
   </span>
   
@@ -10308,7 +10310,8 @@
 <!-- RTD version flyout injected on live site -->
 <div id="readthedocs-embed-flyout"></div>
       
-        <div class="md-social">
+        
+<div class="md-social">
   
     
     
@@ -10364,10 +10367,10 @@
     
     
       
-      <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.d50fe291.min.js", "tags": null, "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"}, "version": null}</script>
+      <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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.50899def.min.js"></script>
+      <script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
       
     
   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
     
     
       
@@ -35,6 +35,8 @@
   
   
     
+      
+      
     
   
   
@@ -7394,12 +7396,12 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/platform-features/populating-extensibility-features.html" class="md-nav__link">
+      <a href="../apps/api/platform-features/prepopulating-data.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
-    Populating Extensibility Features
+    Prepopulating Data
     
   </span>
   
@@ -10336,7 +10338,8 @@ erDiagram
 <!-- RTD version flyout injected on live site -->
 <div id="readthedocs-embed-flyout"></div>
       
-        <div class="md-social">
+        
+<div class="md-social">
   
     
     
@@ -10392,10 +10395,10 @@ erDiagram
     
     
       
-      <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.d50fe291.min.js", "tags": null, "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"}, "version": null}</script>
+      <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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.50899def.min.js"></script>
+      <script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
       
     
   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.16">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
     
     
       
@@ -35,6 +35,8 @@
   
   
     
+      
+      
     
   
   
@@ -7394,12 +7396,12 @@
   
   
     <li class="md-nav__item">
-      <a href="../apps/api/platform-features/populating-extensibility-features.html" class="md-nav__link">
+      <a href="../apps/api/platform-features/prepopulating-data.html" class="md-nav__link">
         
   
   
   <span class="md-ellipsis">
-    Populating Extensibility Features
+    Prepopulating Data
     
   </span>
   
@@ -10502,7 +10504,7 @@
 <li><code>compose_dir</code>: the full path to the directory containing the Docker Compose YAML files (default: <code>"&lt;nautobot source directory&gt;/development"</code>)</li>
 <li><code>compose_files</code>: the Docker Compose YAML file(s) to use (default: <code>["docker-compose.yml", "docker-compose.postgres.yml", "docker-compose.dev.yml"]</code>)</li>
 <li><code>docker_image_names_main</code> and <code>docker_image_names_develop</code>: Used when <a href="release-checklist.html#publish-docker-images">building Docker images for publication</a>; you shouldn't generally need to change these.</li>
-<li><code>ephemeral_ports</code>: Setting this value to <code>True</code> will make all Nautobot containers with published ports expose themselves with dynamic ports. This is useful when running multiple Nautobot versions at the same time on the same machine so you won't experience system port conflicts.</li>
+<li><code>ephemeral_ports</code>: Setting this value to <code>True</code> and not using any custom compose files will make all Nautobot containers with published ports expose themselves with dynamic ports. This is useful when running multiple Nautobot versions at the same time on the same machine so you won't experience system port conflicts. If setting <code>compose_files</code>, this will have no effect so please ensure to manually add the <code>docker-compose.ephemeral-ports.yml</code> to your list.</li>
 </ul>
 <p>These setting may be overridden several different ways (from highest to lowest precedence):</p>
 <ul>
@@ -10775,7 +10777,8 @@ then copy the <code>launch:</code> values to the <code>.vscode/launch.json</code
 <!-- RTD version flyout injected on live site -->
 <div id="readthedocs-embed-flyout"></div>
       
-        <div class="md-social">
+        
+<div class="md-social">
   
     
     
@@ -10831,10 +10834,10 @@ then copy the <code>launch:</code> values to the <code>.vscode/launch.json</code
     
     
       
-      <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.d50fe291.min.js", "tags": null, "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"}, "version": null}</script>
+      <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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
     
     
-      <script src="../../assets/javascripts/bundle.50899def.min.js"></script>
+      <script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
       
     
   <script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});