nautobot 2.4.2__py3-none-any.whl → 2.4.3__py3-none-any.whl

nautobot/project-static/docs/user-guide/feature-guides/custom-fields.html

@@ -2364,7 +2364,7 @@
           <li class="md-nav__item">
   <a href="#retrieve-custom-field-data-in-the-rest-api" class="md-nav__link">
     <span class="md-ellipsis">
-      Retrieve Custom Field Data in the Rest API
+      Retrieve Custom Field Data in the REST API
     </span>
   </a>
   
@@ -2439,7 +2439,7 @@
           <li class="md-nav__item">
   <a href="#modify-custom-field-data-in-the-rest-api" class="md-nav__link">
     <span class="md-ellipsis">
-      Modify Custom Field Data in the Rest API
+      Modify Custom Field Data in the REST API
     </span>
   </a>
   
@@ -9713,7 +9713,7 @@
           <li class="md-nav__item">
   <a href="#retrieve-custom-field-data-in-the-rest-api" class="md-nav__link">
     <span class="md-ellipsis">
-      Retrieve Custom Field Data in the Rest API
+      Retrieve Custom Field Data in the REST API
     </span>
   </a>
   
@@ -9788,7 +9788,7 @@
           <li class="md-nav__item">
   <a href="#modify-custom-field-data-in-the-rest-api" class="md-nav__link">
     <span class="md-ellipsis">
-      Modify Custom Field Data in the Rest API
+      Modify Custom Field Data in the REST API
     </span>
   </a>
   
@@ -9879,7 +9879,7 @@
 <h4 id="maximum-value">Maximum value<a class="headerlink" href="#maximum-value" title="Permanent link">&para;</a></h4>
 <p>Maximum allowed value for <code>Integer</code> fields. Maximum allowed length for <code>Text</code>, <code>URL</code>, <code>JSON</code>, and <code>Markdown</code> fields. Maximum allowed length of each defined choice for a <code>Select</code> or <code>Multiple Selection</code> field.</p>
 <h4 id="validation-regex">Validation Regex<a class="headerlink" href="#validation-regex" title="Permanent link">&para;</a></h4>
-<p>Regular expression to enforce on <code>Text</code>, <code>URL</code>, <code>JSON</code>, <code>Markdown</code>, <code>Selection</code> and <code>Multiple selection</code> field values. Regex validation is handled by the <a href="https://docs.python.org/3/library/re.html">python re engine</a> which uses a PCRE or perl-like regular expression syntax. Examples of common regex validations:</p>
+<p>Regular expression to enforce on <code>Text</code>, <code>URL</code>, <code>JSON</code>, <code>Markdown</code>, <code>Selection</code> and <code>Multiple selection</code> field values. Regex validation is handled by the <a href="https://docs.python.org/3/library/re.html">Python <code>re</code> engine</a> which uses a PCRE or perl-like regular expression syntax. Examples of common regex validations:</p>
 <p>Must start with companyname</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>^companyname
 </code></pre></div>
@@ -9923,7 +9923,7 @@
 <a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a><span class="s1">&#39;1970-01-01&#39;</span>
 </code></pre></div>
 <p>The <code>key</code> of the custom field is used as the key for the associated object's data dictionary.</p>
-<h3 id="retrieve-custom-field-data-in-the-rest-api">Retrieve Custom Field Data in the Rest API<a class="headerlink" href="#retrieve-custom-field-data-in-the-rest-api" title="Permanent link">&para;</a></h3>
+<h3 id="retrieve-custom-field-data-in-the-rest-api">Retrieve Custom Field Data in the REST API<a class="headerlink" href="#retrieve-custom-field-data-in-the-rest-api" title="Permanent link">&para;</a></h3>
 <p>Custom fields are returned in the API for all supported models in the <code>custom_fields</code> key:</p>
 <details class="info">
 <summary><code>GET http://localhost:8080/api/dcim/devices/ffd8df99-6d1a-41c3-b19f-b8357eefc481/</code></summary>
@@ -10006,7 +10006,7 @@
 </code></pre></div>
 </details>
 <h4 id="filter-queries-on-custom-field-data-in-graphql">Filter Queries on Custom Field Data in GraphQL<a class="headerlink" href="#filter-queries-on-custom-field-data-in-graphql" title="Permanent link">&para;</a></h4>
-<p>Queries can also be filtered by custom field values using any of the filters available in the UI and Rest API:</p>
+<p>Queries can also be filtered by custom field values using any of the filters available in the UI and REST API:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a># Retrieve devices where custom field support_group
 <a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a># does not contain &quot;Network Operations&quot; (case insensitive)
 <a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a>{
@@ -10034,7 +10034,7 @@
 </details>
 <h2 id="modifying-custom-field-data">Modifying Custom Field Data<a class="headerlink" href="#modifying-custom-field-data" title="Permanent link">&para;</a></h2>
 <h3 id="modify-custom-field-data-in-nautobot-shell">Modify Custom Field Data in Nautobot Shell<a class="headerlink" href="#modify-custom-field-data-in-nautobot-shell" title="Permanent link">&para;</a></h3>
-<p>Custom field data behaves like a python dictionary in the Nautobot Shell. When modifying custom fields through the Nautobot Shell, make sure to use the <code>.validated_save()</code> method to save the object to ensure that custom field validation is performed.  Example:</p>
+<p>Custom field data behaves like a Python dictionary in the Nautobot Shell. When modifying custom fields through the Nautobot Shell, make sure to use the <code>.validated_save()</code> method to save the object to ensure that custom field validation is performed.  Example:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="o">&gt;&gt;&gt;</span> <span class="n">device</span><span class="o">.</span><span class="n">cf</span><span class="p">[</span><span class="s2">&quot;support_group&quot;</span><span class="p">]</span>
 <a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a><span class="s1">&#39;Network Operations (555-4357)&#39;</span>
 <a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a><span class="o">&gt;&gt;&gt;</span> <span class="n">device</span><span class="o">.</span><span class="n">cf</span><span class="p">[</span><span class="s2">&quot;support_group&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;Network Testing (555-8080)&quot;</span>
@@ -10043,12 +10043,12 @@
 <a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a><span class="s1">&#39;Network Testing (555-8080)&#39;</span>
 </code></pre></div>
 <p>If you do not use <code>.validated_save()</code> when creating or updating objects, the custom field dictionary will not be populated with default values or even empty values and this can lead to unintuitive behaviour.</p>
-<h3 id="modify-custom-field-data-in-the-rest-api">Modify Custom Field Data in the Rest API<a class="headerlink" href="#modify-custom-field-data-in-the-rest-api" title="Permanent link">&para;</a></h3>
-<p>Individual custom field data can be modified by sending a PATCH to the Rest API and setting the new value in the <code>custom_fields</code> key:</p>
+<h3 id="modify-custom-field-data-in-the-rest-api">Modify Custom Field Data in the REST API<a class="headerlink" href="#modify-custom-field-data-in-the-rest-api" title="Permanent link">&para;</a></h3>
+<p>Individual custom field data can be modified by sending a PATCH to the REST API and setting the new value in the <code>custom_fields</code> key:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>PATCH http://localhost:8080/api/dcim/devices/ffd8df99-6d1a-41c3-b19f-b8357eefc481/
 <a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>{
 <a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a>    &quot;custom_fields&quot;: {
-<a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a>        &quot;support_group&quot;: &quot;Rest API test&quot;
+<a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a>        &quot;support_group&quot;: &quot;REST API test&quot;
 <a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a>    }
 <a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a>}
 </code></pre></div>
@@ -10061,7 +10061,7 @@
 <a id="__codelineno-16-5" name="__codelineno-16-5" href="#__codelineno-16-5"></a><span class="w">    </span><span class="nt">&quot;dmz_device&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
 <a id="__codelineno-16-6" name="__codelineno-16-6" href="#__codelineno-16-6"></a><span class="w">    </span><span class="nt">&quot;eol_date&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;1970-01-01&quot;</span><span class="p">,</span>
 <a id="__codelineno-16-7" name="__codelineno-16-7" href="#__codelineno-16-7"></a><span class="w">    </span><span class="nt">&quot;cmdb_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">12345</span><span class="p">,</span>
-<a id="__codelineno-16-8" name="__codelineno-16-8" href="#__codelineno-16-8"></a><span class="w">    </span><span class="nt">&quot;support_group&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Rest API test&quot;</span>
+<a id="__codelineno-16-8" name="__codelineno-16-8" href="#__codelineno-16-8"></a><span class="w">    </span><span class="nt">&quot;support_group&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;REST API test&quot;</span>
 <a id="__codelineno-16-9" name="__codelineno-16-9" href="#__codelineno-16-9"></a><span class="w">  </span><span class="p">}</span>
 <a id="__codelineno-16-10" name="__codelineno-16-10" href="#__codelineno-16-10"></a><span class="p">}</span>
 </code></pre></div>

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

@@ -9766,7 +9766,7 @@ Navigate to <strong>Git Repositories</strong> and select the repository in quest
 <a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a>├── query2.gql
 </code></pre></div>
 <h2 id="additional-git-data-sources">Additional Git Data Sources<a class="headerlink" href="#additional-git-data-sources" title="Permanent link">&para;</a></h2>
-<p>As seen in <a href="#fill-out-repository-details">Fill out Repository Details</a>, the standard installation of Nautobot will come natively with export templates, jobs, and config contexts.  Additional data sources can be incorporated using the Nautobot App system.  For example, the <a href="https://github.com/nautobot/nautobot-app-golden-config">nautobot-golden-config</a> App implements four additional data sources.</p>
+<p>As seen in <a href="#fill-out-repository-details">Fill out Repository Details</a>, the standard installation of Nautobot will come natively with export templates, jobs, and config contexts.  Additional data sources can be incorporated using the Nautobot App system.  For example, the <a href="https://github.com/nautobot/nautobot-app-golden-config">Golden Configuration</a> App implements four additional data sources.</p>
 <ul>
 <li>Config Contexts</li>
 <li>Backup Configs</li>

nautobot/project-static/docs/user-guide/platform-functionality/dynamicgroup.html

@@ -9515,7 +9515,7 @@
 </div>
 <h2 id="dynamic-group-types">Dynamic Group Types<a class="headerlink" href="#dynamic-group-types" title="Permanent link">&para;</a></h2>
 <h3 id="filter-based-dynamic-groups">Filter-Based Dynamic Groups<a class="headerlink" href="#filter-based-dynamic-groups" title="Permanent link">&para;</a></h3>
-<p>Assignment of objects to a filter-based Dynamic Group is powered by Nautobot <strong>FilterSet</strong> classes underneath the hood. The <a href="https://django-filter.readthedocs.io/en/stable/">django-filter</a> documentation may be a useful reference for users wanting to develop an in-depth understanding of FilterSets, but is by no means required to understand Dynamic Groups.</p>
+<p>Assignment of objects to a filter-based Dynamic Group is powered by Nautobot <strong>FilterSet</strong> classes underneath the hood. The <a href="https://django-filter.readthedocs.io/en/stable/"><code>django-filter</code></a> documentation may be a useful reference for users wanting to develop an in-depth understanding of FilterSets, but is by no means required to understand Dynamic Groups.</p>
 <p>A filter-based Dynamic Group defines a <code>filter</code> field, which is stored in the database as a JSON dict. An object is considered to be a member of such a Dynamic Group if it has the correct Content Type and it is not excluded by the filter criteria defined by the group. By default, a freshly created Dynamic Group has an empty filter (<code>{}</code>), which means that all objects of the matching Content Type are members of this group, just as a default list view of these objects would display all such objects prior to any filter fields being selected in the web UI.</p>
 <p>For example, for a Dynamic Group with Content Type of <code>dcim.device</code> and an empty filter, the list of members would be equivalent to the default Device list view, which in turn is equivalent to the queryset for <code>Device.objects.all()</code> from the database ORM.</p>
 <details class="version-changed">

nautobot/project-static/docs/user-guide/platform-functionality/graphql.html

@@ -9113,7 +9113,7 @@
         <li class="md-nav__item">
   <a href="#querying-the-graphql-interface-over-the-rest-api" class="md-nav__link">
     <span class="md-ellipsis">
-      Querying the GraphQL interface over the rest API
+      Querying the GraphQL interface over the REST API
     </span>
   </a>
   
@@ -9216,8 +9216,8 @@
 <a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a><span class="p">}</span>
 </code></pre></div>
 <p>It is possible to explore the Graph and create some queries in a human friendly UI at the endpoint <code>graphql/</code>. This interface (called <code>graphqli</code>) provides a great playground to build new queries as it provides full autocompletion and type validation.</p>
-<h2 id="querying-the-graphql-interface-over-the-rest-api">Querying the GraphQL interface over the rest API<a class="headerlink" href="#querying-the-graphql-interface-over-the-rest-api" title="Permanent link">&para;</a></h2>
-<p>It is possible to query the GraphQL interface via the rest API as well, the endpoint is available at <code>api/graphql/</code> and supports the same Token based authentication as all other Nautobot APIs.</p>
+<h2 id="querying-the-graphql-interface-over-the-rest-api">Querying the GraphQL interface over the REST API<a class="headerlink" href="#querying-the-graphql-interface-over-the-rest-api" title="Permanent link">&para;</a></h2>
+<p>It is possible to query the GraphQL interface via the REST API as well, the endpoint is available at <code>api/graphql/</code> and supports the same Token based authentication as all other Nautobot APIs.</p>
 <p>A GraphQL Query must be encapsulated in a JSON payload with the <code>query</code> key and sent with a POST request. Optionally it is possible to provide a list of <code>variables</code> in the same payload as presented below.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p">{</span>
 <a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w">  </span><span class="nt">&quot;query&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;query ($id: Int!) { device(id: $id) { name }}&quot;</span><span class="p">,</span>

nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobqueue.html

@@ -9125,8 +9125,8 @@
 <details class="version-added">
 <summary>Added in version 2.4.0</summary>
 </details>
-<p>JobQueue instances represent the queues that nautobot <a href="index.html">jobs</a> can be run on. It is introduced as an alternative to <code>task_queues</code> attribute on the Job model to define the eligible queues for this job.</p>
-<p>The JobQueue model has <code>name</code> and <code>queue_type</code> as required attributes. The <code>name</code> attribute has to be unique on each Job Queue and there are currently two supported queue types: "celery" and "kubernetes". The user can optionally assign a <a href="../../core-data-model/tenancy/tenant.html">tenant</a> instance to a Job Queue.</p>
+<p>JobQueue instances represent the queues that Nautobot <a href="index.html">jobs</a> can be run on. It is introduced as an alternative to <code>task_queues</code> attribute on the Job model to define the eligible queues for this job.</p>
+<p>The JobQueue model has <code>name</code> and <code>queue_type</code> as required attributes. The <code>name</code> attribute has to be unique on each Job Queue and there are currently two supported queue types: <code>"celery"</code> and <code>"kubernetes"</code>. The user can optionally assign a <a href="../../core-data-model/tenancy/tenant.html">tenant</a> instance to a Job Queue.</p>
 <p>You can access the Job instances that the Job Queue is assigned to through the <code>jobs</code> attribute from the Job Queue side.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="o">&gt;&gt;&gt;</span> <span class="n">JobQueue</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">first</span><span class="p">()</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="o">&lt;</span><span class="n">JobQueue</span><span class="p">:</span> <span class="n">celery</span><span class="p">:</span> <span class="n">celery</span> <span class="n">Job</span> <span class="n">Queue</span> <span class="o">-</span> <span class="mi">2</span><span class="o">&gt;</span>

nautobot/project-static/docs/user-guide/platform-functionality/jobs/kubernetes-job-support.html

@@ -9412,8 +9412,8 @@
 </ol>
 <p>So if you have any concerns with running Celery workers in your Kubernetes deployment, executing jobs with Kubernetes might be for you.</p>
 <h2 id="how-to-configure-environment-variables">How to Configure Environment Variables<a class="headerlink" href="#how-to-configure-environment-variables" title="Permanent link">&para;</a></h2>
-<h3 id="nautobot_kubernetes_job_manifest">NAUTOBOT_KUBERNETES_JOB_MANIFEST<a class="headerlink" href="#nautobot_kubernetes_job_manifest" title="Permanent link">&para;</a></h3>
-<p>This environment variable should store a <a href="https://kubernetes.io/docs/concepts/workloads/controllers/job/">Kubernetes Job</a> template as a python dictionary. Below is a sample kubernetes job manifest.</p>
+<h3 id="nautobot_kubernetes_job_manifest"><code>NAUTOBOT_KUBERNETES_JOB_MANIFEST</code><a class="headerlink" href="#nautobot_kubernetes_job_manifest" title="Permanent link">&para;</a></h3>
+<p>This environment variable should store a <a href="https://kubernetes.io/docs/concepts/workloads/controllers/job/">Kubernetes Job</a> template as a Python dictionary. Below is a sample kubernetes job manifest.</p>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
 <p>Ensure this job template uses the same Docker image as your Nautobot Kubernetes deployment. You can specify the image name in spec.template.spec.containers.image. Additionally, configure and map the required environment variables to corresponding <a href="https://kubernetes.io/docs/concepts/configuration/configmap/">Kubernetes ConfigMap</a> instances. These variables can be defined in the spec.template.spec.containers.env list. For consistency, it is recommended to use the same environment configuration for this Job manifest as that of your Nautobot Kubernetes deployment.</p>
@@ -9482,9 +9482,9 @@
 <a id="__codelineno-0-62" name="__codelineno-0-62" href="#__codelineno-0-62"></a>    <span class="p">},</span>
 <a id="__codelineno-0-63" name="__codelineno-0-63" href="#__codelineno-0-63"></a><span class="p">}</span>
 </code></pre></div>
-<h3 id="nautobot_kubernetes_job_pod_name">NAUTOBOT_KUBERNETES_JOB_POD_NAME<a class="headerlink" href="#nautobot_kubernetes_job_pod_name" title="Permanent link">&para;</a></h3>
-<p>The default value for this environment variable is "nautobot-job". You can modify this value as needed; however, ensure that <code>metadata.name</code> field in NAUTOBOT_KUBERNETES_JOB_MANIFEST is updated accordingly to maintain consistencty</p>
-<h3 id="nautobot_kubernetes_job_pod_namespace">NAUTOBOT_KUBERNETES_JOB_POD_NAMESPACE<a class="headerlink" href="#nautobot_kubernetes_job_pod_namespace" title="Permanent link">&para;</a></h3>
+<h3 id="nautobot_kubernetes_job_pod_name"><code>NAUTOBOT_KUBERNETES_JOB_POD_NAME</code><a class="headerlink" href="#nautobot_kubernetes_job_pod_name" title="Permanent link">&para;</a></h3>
+<p>The default value for this environment variable is <code>"nautobot-job"</code>. You can modify this value as needed; however, ensure that <code>metadata.name</code> field in <code>NAUTOBOT_KUBERNETES_JOB_MANIFEST</code> is updated accordingly to maintain consistencty</p>
+<h3 id="nautobot_kubernetes_job_pod_namespace"><code>NAUTOBOT_KUBERNETES_JOB_POD_NAMESPACE</code><a class="headerlink" href="#nautobot_kubernetes_job_pod_namespace" title="Permanent link">&para;</a></h3>
 <p>The default value for this environment variable is "default". However, this value could be inaccurate depending on the setup of your Nautobot deployment. To ensure you have the right value for this variable. You can run the command <code>kubectl describe pod &lt;nautobot-pod-name&gt;</code> and you should see an output similar to what is below:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>Name:<span class="w">             </span>nautobot-679bdc765-hl72m
 <a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>Namespace:<span class="w">        </span>default
@@ -9501,7 +9501,7 @@
 <a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>...
 </code></pre></div>
 <p>Note that the field with label <code>Namespace</code> tells you exactly what namespace your Nautobot deployment is in and what value you should assign to the environment variable <code>NAUTOBOT_KUBERNETES_JOB_POD_NAMESPACE</code>. To ensure you have the right value for this variable. You can run the command <code>kubectl describe pod &lt;nautobot-pod-name&gt;</code> and you should see an output similar to what is below:</p>
-<h3 id="nautobot_kubernetes_default_service_address">NAUTOBOT_KUBERNETES_DEFAULT_SERVICE_ADDRESS<a class="headerlink" href="#nautobot_kubernetes_default_service_address" title="Permanent link">&para;</a></h3>
+<h3 id="nautobot_kubernetes_default_service_address"><code>NAUTOBOT_KUBERNETES_DEFAULT_SERVICE_ADDRESS</code><a class="headerlink" href="#nautobot_kubernetes_default_service_address" title="Permanent link">&para;</a></h3>
 <p>The default value for this environment variable is <a href="https://kubernetes.default.svc">https://kubernetes.default.svc</a>. However, this value may vary depending on your Nautobot deployment setup. The format for the base URL is <code>https://&lt;kubernetes-service-name&gt;.&lt;kubernetes-service-namespace&gt;.svc.</code></p>
 <p>If you know the namespace where your Kubernetes service is running, you can run the command <code>kubectl get services -n &lt;kubernetes-service-namespace&gt;</code> to retrieve the service details. The output will resemble the example shown below.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>NAME<span class="w">         </span>TYPE<span class="w">        </span>CLUSTER-IP<span class="w">      </span>EXTERNAL-IP<span class="w">   </span>PORT<span class="o">(</span>S<span class="o">)</span><span class="w">    </span>AGE

nautobot/project-static/js/dropdown.js

@@ -0,0 +1,28 @@
+$(document).on('show.bs.dropdown', '.table-responsive .dropdown', function() {
+    const $dropdown = $(this);
+    const $toggle = $dropdown.find('.dropdown-toggle');
+    const $menu = $dropdown.find('.dropdown-menu');
+
+    const toggleOffset = $toggle.offset();
+    const topOffset = toggleOffset.top + $toggle.outerHeight()
+    // calculate left offset to match right side edges of dropdown and toggle button
+    const leftOffset = toggleOffset.left + $toggle.outerWidth() - $menu.outerWidth()
+
+    $menu.appendTo('body').css({
+        position: 'absolute',
+        top: topOffset,
+        left: leftOffset,
+        display: 'table', // required, because we're outside any container
+    });
+
+    // move dropdown back and hide
+    $dropdown.one('hidden.bs.dropdown', function () {
+        $menu.appendTo($dropdown);
+        $menu.removeAttr('style');
+    });
+
+    // hide dropdown when scrolling vertically to avoid recalculating position
+    $('.table-responsive').one('scroll', function() {
+        $toggle.trigger("click");
+    });
+});

nautobot/tenancy/forms.py

@@ -1,5 +1,6 @@
 from django import forms
 
+from nautobot.core.constants import CHARFIELD_MAX_LENGTH
 from nautobot.core.forms import (
     CommentField,
     DynamicModelChoiceField,
@@ -22,6 +23,14 @@ from .models import Tenant, TenantGroup
 #
 
 
+class TenantGroupBulkEditForm(NautobotBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(queryset=TenantGroup.objects.all(), widget=forms.MultipleHiddenInput())
+    description = forms.CharField(max_length=CHARFIELD_MAX_LENGTH, required=False)
+
+    class Meta:
+        nullable_fields = []
+
+
 class TenantGroupForm(NautobotModelForm):
     parent = DynamicModelChoiceField(queryset=TenantGroup.objects.all(), required=False)
 

nautobot/tenancy/templates/tenancy/tenant_create.html

@@ -0,0 +1,21 @@
+{% extends 'generic/object_create.html' %}
+{% load static %}
+{% load form_helpers %}
+
+{% block form %}
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Tenant</strong></div>
+        <div class="panel-body">
+            {% render_field form.name %}
+            {% render_field form.tenant_group %}
+            {% render_field form.description %}
+        </div>
+    </div>
+    {% include 'inc/extras_features_edit_form_fields.html' %}
+    <div class="panel panel-default">
+        <div class="panel-heading"><strong>Comments</strong></div>
+        <div class="panel-body">
+            {% render_field form.comments %}
+        </div>
+    </div>
+{% endblock %}

nautobot/tenancy/templates/tenancy/tenant_edit.html

@@ -1,21 +1,2 @@
-{% extends 'generic/object_create.html' %}
-{% load static %}
-{% load form_helpers %}
-
-{% block form %}
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Tenant</strong></div>
-        <div class="panel-body">
-            {% render_field form.name %}
-            {% render_field form.tenant_group %}
-            {% render_field form.description %}
-        </div>
-    </div>
-    {% include 'inc/extras_features_edit_form_fields.html' %}
-    <div class="panel panel-default">
-        <div class="panel-heading"><strong>Comments</strong></div>
-        <div class="panel-body">
-            {% render_field form.comments %}
-        </div>
-    </div>
-{% endblock %}
+{% extends 'tenancy/tenant_create.html' %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/tenancy/templates/tenancy/tenantgroup.html

@@ -1,44 +1,2 @@
-{% extends 'generic/object_retrieve.html' %}
-{% load helpers %}
-
-{% block content_left_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Tenant Group</strong>
-            </div>
-            <table class="table table-hover panel-body attr-table">
-                <tr>
-                    <td>Description</td>
-                    <td>{{ object.description|placeholder }}</td>
-                </tr>
-                <tr>
-                    <td>Parent</td>
-                    <td>{{ object.parent|hyperlinked_object }}</td>
-                </tr>
-                <tr>
-                    <td>Tenants</td>
-                    <td>
-                        <a href="{% url 'tenancy:tenant_list' %}?tenant_group={{ object.name }}">{{ tenant_table.rows|length }}</a>
-                    </td>
-                </tr>
-            </table>
-        </div>
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Tenants</strong>
-            </div>
-            {% include 'inc/table.html' with table=tenant_table %}
-            {% if perms.teanancy.add_tenant %}
-                <div class="panel-footer text-right noprint">
-                    <a href="{% url 'tenancy:tenant_add' %}?tenant_group={{ object.pk }}" class="btn btn-xs btn-primary">
-                        <span class="mdi mdi-plus-thick" aria-hidden="true"></span> Add tenant
-                    </a>
-                </div>
-            {% endif %}
-        </div>
-        {% include 'inc/paginator.html' with paginator=tenant_table.paginator page=tenant_table.page %}
-        <div class="row"></div>
-{% endblock content_right_page %}
+{% extends 'tenancy/tenantgroup_retrieve.html' %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/tenancy/templates/tenancy/tenantgroup_retrieve.html

@@ -0,0 +1 @@
+{% extends 'generic/object_retrieve.html' %}

nautobot/tenancy/tests/test_views.py

@@ -3,7 +3,7 @@ from nautobot.extras.models import Tag
 from nautobot.tenancy.models import Tenant, TenantGroup
 
 
-class TenantGroupTestCase(ViewTestCases.OrganizationalObjectViewTestCase):
+class TenantGroupTestCase(ViewTestCases.OrganizationalObjectViewTestCase, ViewTestCases.BulkEditObjectsViewTestCase):
     model = TenantGroup
     sort_on_field = "name"
 
@@ -14,6 +14,10 @@ class TenantGroupTestCase(ViewTestCases.OrganizationalObjectViewTestCase):
             "description": "A new tenant group",
         }
 
+        cls.bulk_edit_data = {
+            "description": "New description",
+        }
+
 
 class TenantTestCase(ViewTestCases.PrimaryObjectViewTestCase):
     model = Tenant

nautobot/tenancy/urls.py

@@ -1,83 +1,11 @@
-from django.urls import path
-
-from nautobot.extras.views import ObjectChangeLogView, ObjectNotesView
+from nautobot.core.views.routers import NautobotUIViewSetRouter
 
 from . import views
-from .models import Tenant, TenantGroup
 
 app_name = "tenancy"
-urlpatterns = [
-    # Tenant groups
-    path("tenant-groups/", views.TenantGroupListView.as_view(), name="tenantgroup_list"),
-    path(
-        "tenant-groups/add/",
-        views.TenantGroupEditView.as_view(),
-        name="tenantgroup_add",
-    ),
-    path(
-        "tenant-groups/import/",
-        views.TenantGroupBulkImportView.as_view(),  # 3.0 TODO: remove, unused
-        name="tenantgroup_import",
-    ),
-    path(
-        "tenant-groups/delete/",
-        views.TenantGroupBulkDeleteView.as_view(),
-        name="tenantgroup_bulk_delete",
-    ),
-    path(
-        "tenant-groups/<uuid:pk>/",
-        views.TenantGroupView.as_view(),
-        name="tenantgroup",
-    ),
-    path(
-        "tenant-groups/<uuid:pk>/edit/",
-        views.TenantGroupEditView.as_view(),
-        name="tenantgroup_edit",
-    ),
-    path(
-        "tenant-groups/<uuid:pk>/delete/",
-        views.TenantGroupDeleteView.as_view(),
-        name="tenantgroup_delete",
-    ),
-    path(
-        "tenant-groups/<uuid:pk>/changelog/",
-        ObjectChangeLogView.as_view(),
-        name="tenantgroup_changelog",
-        kwargs={"model": TenantGroup},
-    ),
-    path(
-        "tenant-groups/<uuid:pk>/notes/",
-        ObjectNotesView.as_view(),
-        name="tenantgroup_notes",
-        kwargs={"model": TenantGroup},
-    ),
-    # Tenants
-    path("tenants/", views.TenantListView.as_view(), name="tenant_list"),
-    path("tenants/add/", views.TenantEditView.as_view(), name="tenant_add"),
-    path("tenants/import/", views.TenantBulkImportView.as_view(), name="tenant_import"),  # 3.0 TODO: remove, unused
-    path("tenants/edit/", views.TenantBulkEditView.as_view(), name="tenant_bulk_edit"),
-    path(
-        "tenants/delete/",
-        views.TenantBulkDeleteView.as_view(),
-        name="tenant_bulk_delete",
-    ),
-    path("tenants/<uuid:pk>/", views.TenantView.as_view(), name="tenant"),
-    path("tenants/<uuid:pk>/edit/", views.TenantEditView.as_view(), name="tenant_edit"),
-    path(
-        "tenants/<uuid:pk>/delete/",
-        views.TenantDeleteView.as_view(),
-        name="tenant_delete",
-    ),
-    path(
-        "tenants/<uuid:pk>/changelog/",
-        ObjectChangeLogView.as_view(),
-        name="tenant_changelog",
-        kwargs={"model": Tenant},
-    ),
-    path(
-        "tenants/<uuid:pk>/notes/",
-        ObjectNotesView.as_view(),
-        name="tenant_notes",
-        kwargs={"model": Tenant},
-    ),
-]
+router = NautobotUIViewSetRouter()
+router.register("tenant-groups", views.TenantGroupUIViewSet)
+router.register("tenants", views.TenantUIViewSet)
+
+urlpatterns = []
+urlpatterns += router.urls