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

nautobot/project-static/docs/user-guide/administration/configuration/authentication/ldap.html

@@ -9471,7 +9471,7 @@
 <p>On CentOS:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>sudo dnf install -y openldap-devel
 </code></pre></div>
-<h3 id="install-django-auth-ldap">Install django-auth-ldap<a class="headerlink" href="#install-django-auth-ldap" title="Permanent link">&para;</a></h3>
+<h3 id="install-django-auth-ldap">Install <code>django-auth-ldap</code><a class="headerlink" href="#install-django-auth-ldap" title="Permanent link">&para;</a></h3>
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
 <p>This and all remaining steps in this document should all be performed as the <code>nautobot</code> user!</p>
@@ -9540,7 +9540,7 @@
 <a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a>    <span class="n">ldap</span><span class="o">.</span><span class="n">OPT_X_TLS_REQUIRE_CERT</span><span class="p">:</span> <span class="n">ldap</span><span class="o">.</span><span class="n">OPT_X_TLS_NEVER</span><span class="p">,</span>
 <a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="p">}</span>
 </code></pre></div>
-<p>Additional ldap connection options can be found in the <a href="https://www.python-ldap.org/en/python-ldap-3.3.0/reference/ldap.html?highlight=cacert#options">python-ldap documentation</a>.</p>
+<p>Additional LDAP connection options can be found in the <a href="https://www.python-ldap.org/en/python-ldap-3.3.0/reference/ldap.html?highlight=cacert#options"><code>python-ldap</code> documentation</a>.</p>
 <h3 id="user-authentication">User Authentication<a class="headerlink" href="#user-authentication" title="Permanent link">&para;</a></h3>
 <div class="admonition info">
 <p class="admonition-title">Info</p>
@@ -9676,7 +9676,7 @@
 <a id="__codelineno-17-18" name="__codelineno-17-18" href="#__codelineno-17-18"></a>    <span class="p">},</span>
 <a id="__codelineno-17-19" name="__codelineno-17-19" href="#__codelineno-17-19"></a><span class="p">}</span>
 </code></pre></div>
-<p>Ensure the file and path specified in logfile exist and are writable and executable by the application service account. Restart the nautobot service and attempt to log into the site to trigger log entries to this file.</p>
+<p>Ensure the file and path specified in logfile exist and are writable and executable by the application service account. Restart the <code>nautobot</code> service and attempt to log into the site to trigger log entries to this file.</p>
 <hr />
 <p>Be sure to configure <a href="../settings.html#external_auth_default_groups"><code>EXTERNAL_AUTH_DEFAULT_GROUPS</code></a> and <a href="../settings.html#external_auth_default_permissions"><code>EXTERNAL_AUTH_DEFAULT_PERMISSIONS</code></a> next.</p>
 

nautobot/project-static/docs/user-guide/administration/configuration/authentication/sso.html

@@ -9703,7 +9703,7 @@
 
 <h1 id="single-sign-on">Single Sign On<a class="headerlink" href="#single-sign-on" title="Permanent link">&para;</a></h1>
 <p>Nautobot supports several different authentication mechanisms including OAuth (1 and 2), OpenID, SAML, and others.
-To accomplish this, Nautobot comes preinstalled with the <a href="https://python-social-auth.readthedocs.io/en/latest/configuration/django.html">social-auth-app-django</a> Python module.</p>
+To accomplish this, Nautobot comes preinstalled with the <a href="https://python-social-auth.readthedocs.io/en/latest/configuration/django.html"><code>social-auth-app-django</code></a> Python module.</p>
 <p>This module supports several <a href="https://python-social-auth.readthedocs.io/en/latest/backends/index.html">authentication backends</a> by default including:</p>
 <ul>
 <li>Google</li>
@@ -9754,7 +9754,7 @@ To accomplish this, Nautobot comes preinstalled with the <a href="https://python
 <p>You should only enable one social authentication authentication backend. It is technically possible to use multiple backends but we cannot officially support more than one at this time.</p>
 </div>
 <h3 id="custom-authentication-backends">Custom Authentication Backends<a class="headerlink" href="#custom-authentication-backends" title="Permanent link">&para;</a></h3>
-<p>The default external authentication supported is <a href="https://python-social-auth.readthedocs.io/en/latest/configuration/django.html">social-auth-app-django</a> as stated above. If you have developed your own external authentication backend, you will need to configure <code>SOCIAL_AUTH_BACKEND_PREFIX</code> to use your backend instead and correctly enable the SSO redirect when the login button is clicked. For example, if your custom authentication backend is available at <code>custom_auth.backends.custom.Oauth2</code>, you would set things as follows:</p>
+<p>The default external authentication supported is <a href="https://python-social-auth.readthedocs.io/en/latest/configuration/django.html"><code>social-auth-app-django</code></a> as stated above. If you have developed your own external authentication backend, you will need to configure <code>SOCIAL_AUTH_BACKEND_PREFIX</code> to use your backend instead and correctly enable the SSO redirect when the login button is clicked. For example, if your custom authentication backend is available at <code>custom_auth.backends.custom.Oauth2</code>, you would set things as follows:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="n">SOCIAL_AUTH_BACKEND_PREFIX</span> <span class="o">=</span> <span class="s2">&quot;custom_auth.backends&quot;</span>
 <a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>
 <a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="n">AUTHENTICATION_BACKENDS</span> <span class="o">=</span> <span class="p">[</span>
@@ -9984,7 +9984,7 @@ a default set of permissions there are some additional variables to configure th
 <p>The following instructions guide you through the process of configuring Google for OAuth2 authentication.</p>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
-<p>Please note there is further guidance provided by <a href="https://python-social-auth.readthedocs.io/en/latest/backends/google.html#google-oauth2">python-social-auth</a> as well as <a href="https://developers.google.com/identity/protocols/oauth2?csw=1">Google</a>. For more</p>
+<p>Please note there is further guidance provided by <a href="https://python-social-auth.readthedocs.io/en/latest/backends/google.html#google-oauth2"><code>python-social-auth</code></a> as well as <a href="https://developers.google.com/identity/protocols/oauth2?csw=1">Google</a>. For more</p>
 </div>
 <p>information please utilize these additional resources.</p>
 <ol>
@@ -10031,7 +10031,7 @@ a default set of permissions there are some additional variables to configure th
 <p>This guide will walk you through configuring Nautobot to authenticate using SAML with Google as the identity provider.</p>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
-<p>Please note that there is further guidance provided by <a href="https://python-social-auth.readthedocs.io/en/latest/backends/saml.html">python-social-auth</a> and <a href="https://support.google.com/a/answer/6087519?hl=en">Google</a>. For more information please utilize these additional resources.</p>
+<p>Please note that there is further guidance provided by <a href="https://python-social-auth.readthedocs.io/en/latest/backends/saml.html"><code>python-social-auth</code></a> and <a href="https://support.google.com/a/answer/6087519?hl=en">Google</a>. For more information please utilize these additional resources.</p>
 </div>
 <h4 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h4>
 <div class="admonition warning">

nautobot/project-static/docs/user-guide/administration/configuration/redis.html

@@ -9323,7 +9323,7 @@ of the Redis server and port for each sentinel instance to connect to</li>
 <a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>    <span class="p">},</span>
 <a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="p">}</span>
 </code></pre></div>
-<p>For more details on configuring django-redis with Redis Sentinel, please see the documentation for <a href="https://github.com/jazzband/django-redis#use-the-sentinel-connection-factory">Django Redis</a>.</p>
+<p>For more details on configuring <code>django-redis</code> with Redis Sentinel, please see the documentation for <a href="https://github.com/jazzband/django-redis#use-the-sentinel-connection-factory">Django Redis</a>.</p>
 <h3 id="celery-sentinel-configuration"><code>celery</code> Sentinel Configuration<a class="headerlink" href="#celery-sentinel-configuration" title="Permanent link">&para;</a></h3>
 <details class="version-changed">
 <summary>Changed in version 2.0.0 — Do not change <code>CELERY_RESULT_BACKEND</code> or <code>CELERY_RESULT_BACKEND_TRANSPORT_OPTIONS</code></summary>

nautobot/project-static/docs/user-guide/administration/configuration/settings.html

@@ -13472,7 +13472,7 @@ The function must return only one argument: a string of the truncated device dis
 <p>The following settings are <strong>only</strong> configurable as environment variables, and not via <code>nautobot_config.py</code> or similar.</p>
 </div>
 <hr />
-<h3 id="git_ssl_no_verify">GIT_SSL_NO_VERIFY<a class="headerlink" href="#git_ssl_no_verify" title="Permanent link">&para;</a></h3>
+<h3 id="git_ssl_no_verify"><code>GIT_SSL_NO_VERIFY</code><a class="headerlink" href="#git_ssl_no_verify" title="Permanent link">&para;</a></h3>
 <p>Default: Unset</p>
 <p>If you are using a self-signed git repository, you will need to set the environment variable <code>GIT_SSL_NO_VERIFY="1"</code>
 in order for the repository to sync.</p>
@@ -13481,7 +13481,7 @@ in order for the repository to sync.</p>
 <p>This <em>must</em> be specified as an environment variable. Setting it in <code>nautobot_config.py</code> will not have the desired effect.</p>
 </div>
 <hr />
-<h3 id="nautobot_log_deprecation_warnings">NAUTOBOT_LOG_DEPRECATION_WARNINGS<a class="headerlink" href="#nautobot_log_deprecation_warnings" title="Permanent link">&para;</a></h3>
+<h3 id="nautobot_log_deprecation_warnings"><code>NAUTOBOT_LOG_DEPRECATION_WARNINGS</code><a class="headerlink" href="#nautobot_log_deprecation_warnings" title="Permanent link">&para;</a></h3>
 <details class="version-added">
 <summary>Added in version 1.5.2</summary>
 </details>
@@ -13492,7 +13492,7 @@ in order for the repository to sync.</p>
 <p>Default: <code>False</code></p>
 <p>This can be set to <code>True</code> to allow deprecation warnings raised by Nautobot to (additionally) be logged as <code>WARNING</code> level log messages. (Deprecation warnings are normally silent in Python, but can be enabled globally by <a href="https://docs.python.org/3/library/warnings.html">various means</a> such as setting the <code>PYTHONWARNINGS</code> environment variable. However, doing so can be rather noisy, as it will also include warnings from within Django about various code in various package dependencies of Nautobot's, etc. This configuration setting allows a more targeted enablement of only warnings from within Nautobot itself, which can be useful when vetting various Nautobot Apps for future-proofness against upcoming changes to Nautobot.)</p>
 <hr />
-<h3 id="nautobot_root_1">NAUTOBOT_ROOT<a class="headerlink" href="#nautobot_root_1" title="Permanent link">&para;</a></h3>
+<h3 id="nautobot_root_1"><code>NAUTOBOT_ROOT</code><a class="headerlink" href="#nautobot_root_1" title="Permanent link">&para;</a></h3>
 <p>Default: <code>~/.nautobot/</code></p>
 <p>The filesystem path to use to store Nautobot files (Jobs, uploaded images, Git repositories, etc.).</p>
 <p>This setting is used internally in the core settings to provide default locations for <a href="index.html#file-storage">features that require file storage</a>, and the <a href="index.html#specifying-your-configuration">default location of the <code>nautobot_config.py</code></a>.</p>

nautobot/project-static/docs/user-guide/administration/guides/celery-queues.html

@@ -9214,9 +9214,9 @@
 
 
 <h1 id="celery-task-queues">Celery Task Queues<a class="headerlink" href="#celery-task-queues" title="Permanent link">&para;</a></h1>
-<p>If you're planning to run multiple jobs, leverage job hooks or are finding that your jobs are taking too long to complete you may want to consider deploying multiple celery workers with different queues for different types of tasks.</p>
+<p>If you're planning to run multiple jobs, leverage job hooks or are finding that your jobs are taking too long to complete you may want to consider deploying multiple Celery workers with different queues for different types of tasks.</p>
 <h2 id="how-celery-task-queues-work">How Celery Task Queues Work<a class="headerlink" href="#how-celery-task-queues-work" title="Permanent link">&para;</a></h2>
-<p>The default celery behavior is:</p>
+<p>The default Celery behavior is:</p>
 <ul>
 <li><a href="https://docs.celeryq.dev/en/stable/reference/cli.html#cmdoption-celery-worker-Q"><code>--queue celery</code></a></li>
 <li><a href="https://docs.celeryq.dev/en/stable/reference/cli.html#cmdoption-celery-worker-c"><code>--concurrency</code></a> set to the number of CPUs detected on the system</li>
@@ -9227,10 +9227,10 @@
 <p>Each environment is unique but it's generally a good idea to add at least one extra worker on a separate queue for running jobs. Nautobot uses the default <code>celery</code> queue to perform some background tasks and if the queue is full of long running jobs these system tasks could take a long time to execute. This could cause performance problems or unexpected behavior in Nautobot. A new worker can be deployed on a separate queue by using the <a href="../installation/services.html#celery-worker"><code>nautobot-worker.service</code> systemd service</a> and modifying the <code>ExecStart</code> line to include a <a href="https://docs.celeryq.dev/en/stable/reference/cli.html#cmdoption-celery-worker-Q"><code>--queues</code> option</a>. Example:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="na">ExecStart</span><span class="o">=</span><span class="s">/opt/nautobot/bin/nautobot-server celery worker --loglevel INFO --pidfile /var/tmp/nautobot-worker-jobqueue.pid --queues job_queue</span>
 </code></pre></div>
-<p>This will create a worker that will only process tasks sent to the <code>job_queue</code> celery queue. You can use this worker to run jobs while the rest of Nautobot's background tasks will be processed by the default celery worker listening to the <code>celery</code> queue.</p>
+<p>This will create a worker that will only process tasks sent to the <code>job_queue</code> Celery queue. You can use this worker to run jobs while the rest of Nautobot's background tasks will be processed by the default Celery worker listening to the <code>celery</code> queue.</p>
 <div class="admonition info">
 <p class="admonition-title">Info</p>
-<p>Workers can be configured to listen to multiple queues by supplying a comma separated list of queues to the <code>--queues</code> argument. See the <a href="https://docs.celeryq.dev/en/stable/userguide/workers.html#queues">celery workers guide</a> for more information.</p>
+<p>Workers can be configured to listen to multiple queues by supplying a comma separated list of queues to the <code>--queues</code> argument. See the <a href="https://docs.celeryq.dev/en/stable/userguide/workers.html#queues">Celery workers guide</a> for more information.</p>
 </div>
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
@@ -9247,7 +9247,7 @@
 <p>You may have to change this setting multiple times to find what works best in your environment.</p>
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
-<p>Modifying your concurrency setting may increase the CPU and will increase the memory load on your celery worker by at least 175MB per concurrent thread. Only change this setting if you have monitoring systems in place to monitor the system resources on your worker.</p>
+<p>Modifying your concurrency setting may increase the CPU and will increase the memory load on your Celery worker by at least 175MB per concurrent thread. Only change this setting if you have monitoring systems in place to monitor the system resources on your worker.</p>
 </div>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>

nautobot/project-static/docs/user-guide/administration/guides/docker.html

@@ -9604,14 +9604,14 @@
 
 
 <h1 id="nautobot-docker-images">Nautobot Docker Images<a class="headerlink" href="#nautobot-docker-images" title="Permanent link">&para;</a></h1>
-<p>Nautobot is packaged as a Docker image for use in a production environment; developer images are also provided for those working on App development and testing. The Docker image and deployment strategies are being actively developed, check back here or join the <strong>#nautobot</strong> channel on <a href="https://slack.networktocode.com/">Network to Code's Slack community</a> for the most up to date information.</p>
+<p>Nautobot is packaged as a Docker image for use in a production environment; developer images are also provided for those working on App development and testing. The Docker image and deployment strategies are being actively developed, check back here or join the <code>#nautobot</code> channel on <a href="https://slack.networktocode.com/">Network to Code's Slack community</a> for the most up to date information.</p>
 <h2 id="python-versions">Python Versions<a class="headerlink" href="#python-versions" title="Permanent link">&para;</a></h2>
 <p>Docker images are published for multiple supported Python versions. The default image, recommended for most users, is based on the <code>python:3.12-slim</code> image.</p>
 <details class="version-changed">
 <summary>Changed in version 1.6.1</summary>
 <p>The Python version for the image tags that do not explicitly state a Python version changed to 3.11 for Nautobot 1.6.1. From now on, these tagged images will always contain the <strong>latest</strong> supported Python version (e.g., when Python 3.12 support is added, these tags will change to contain Python 3.12). This is a change from Nautobot 1.6.0 and earlier, where tags that did not state a Python version would contain the <strong>earliest</strong> supported Python version.</p>
 </details>
-<p>Currently images are pushed for the following python versions:</p>
+<p>Currently images are pushed for the following Python versions:</p>
 <ul>
 <li>3.9</li>
 <li>3.10</li>
@@ -9876,7 +9876,7 @@
 </code></pre></div>
 <p>Similarly, you can use <code>docker-compose.final-dev.yml</code> if you wish to build and test the <code>final-dev</code> image.</p>
 <h2 id="docker-compose">Docker Compose<a class="headerlink" href="#docker-compose" title="Permanent link">&para;</a></h2>
-<p>An <a href="https://github.com/nautobot/nautobot-docker-compose/">example library for using Docker Compose</a> to build out all of the components for Nautobot can be found within the Nautobot community. Please see <a href="https://github.com/nautobot/nautobot-docker-compose/">https://github.com/nautobot/nautobot-docker-compose/</a> for examples on the base application, LDAP integration, and using Apps.</p>
+<p>An <a href="https://github.com/nautobot/nautobot-docker-compose/">example library for using Docker Compose</a> to build out all of the components for Nautobot can be found within the Nautobot community. Please refer to that library for examples on the base application, LDAP integration, and using Apps.</p>
 
 
 

nautobot/project-static/docs/user-guide/administration/guides/health-checks.html

@@ -9646,7 +9646,7 @@
 <p>Note the differences between these two. In some situations you'll want to use both for different types of checks. More on this later in this document.</p>
 <details class="info">
 <summary>Background information</summary>
-<p>Nautobot uses the <a href="https://github.com/KristianOellegaard/django-health-check">django-health-check</a> project and some custom health checks (database connection and cache availability). Additional health checks are available as part of that  project and can be added to the <a href="../configuration/settings.html#extra-applications"><code>EXTRA_INSTALLED_APPS</code></a> configuration variable as desired.</p>
+<p>Nautobot uses the <a href="https://github.com/KristianOellegaard/django-health-check"><code>django-health-check</code></a> project and some custom health checks (database connection and cache availability). Additional health checks are available as part of that project and can be added to the <a href="../configuration/settings.html#extra-applications"><code>EXTRA_INSTALLED_APPS</code></a> configuration variable as desired.</p>
 </details>
 <h3 id="nautobot-celery-worker">Nautobot Celery Worker<a class="headerlink" href="#nautobot-celery-worker" title="Permanent link">&para;</a></h3>
 <p>In addition to monitoring the existence of a given Celery worker process ID, you can use the fact that Celery provides a <a href="https://docs.celeryq.dev/en/stable/reference/cli.html#celery-inspect"><code>celery inspect ping</code> CLI command</a> that sends a short message to a given Celery worker(s) and reports back on whether it receives a response(s). Nautobot wraps this with the <code>nautobot-server</code> CLI command, so in general you can run <code>nautobot-server celery inspect ping --destination &lt;worker name&gt;</code> to confirm whether a given worker is able to receive and respond to Celery control messages.</p>

nautobot/project-static/docs/user-guide/administration/guides/prometheus-metrics.html

@@ -9285,12 +9285,12 @@
 <summary>Added in version 2.2.1</summary>
 <p>In case the <code>/metrics</code> endpoint is not performant or not required, you can disable specific apps with the <a href="../configuration/settings.html#metrics_disabled_apps"><code>METRICS_DISABLED_APPS</code></a> configuration setting.</p>
 </details>
-<p>For more information see the <a href="https://github.com/korfuri/django-prometheus">django-prometheus</a> docs.</p>
+<p>For more information see the <a href="https://github.com/korfuri/django-prometheus"><code>django-prometheus</code></a> docs.</p>
 <h2 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permanent link">&para;</a></h2>
 <details class="version-added">
 <summary>Added in version 2.1.5</summary>
 </details>
-<p>Metrics by default do not require authentication to view. Authentication can be toggled with the <code>METRICS_AUTHENTICATION</code> configuration setting. If set to <code>True</code>, this will require the user to be logged in or to use an API token. See <a href="../../platform-functionality/rest-api/authentication.html">Rest API Authentication</a> for more details on API authentication.</p>
+<p>Metrics by default do not require authentication to view. Authentication can be toggled with the <code>METRICS_AUTHENTICATION</code> configuration setting. If set to <code>True</code>, this will require the user to be logged in or to use an API token. See <a href="../../platform-functionality/rest-api/authentication.html">REST API Authentication</a> for more details on API authentication.</p>
 <h3 id="sample-telegraf-configuration">Sample Telegraf configuration<a class="headerlink" href="#sample-telegraf-configuration" title="Permanent link">&para;</a></h3>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="k">[[inputs.prometheus]]</span>
 <a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="n">urls</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;http://localhost/metrics&quot;</span><span class="p">]</span>
@@ -9298,7 +9298,7 @@
 <a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="n">http_headers</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="s2">&quot;Authorization&quot;</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s2">&quot;Token 0123456789abcdef0123456789abcdef01234567&quot;</span><span class="p">}</span>
 </code></pre></div>
 <h2 id="metric-types">Metric Types<a class="headerlink" href="#metric-types" title="Permanent link">&para;</a></h2>
-<p>Nautobot makes use of the <a href="https://github.com/korfuri/django-prometheus">django-prometheus</a> library to export a number of different types of metrics, including:</p>
+<p>Nautobot makes use of the <a href="https://github.com/korfuri/django-prometheus"><code>django-prometheus</code></a> library to export a number of different types of metrics, including:</p>
 <ul>
 <li>Per model insert, update, and delete counters</li>
 <li>Per view request counters</li>
@@ -9320,7 +9320,7 @@
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>Metrics from the celery worker are not available from Nautobot at this time.  However, additional tools such as <a href="https://flower.readthedocs.io/en/latest/">flower</a> can be used to monitor the celery workers until these metrics are exposed through Nautobot.</p>
+<p>Metrics from the Celery worker are not available from Nautobot at this time.  However, additional tools such as <a href="https://flower.readthedocs.io/en/latest/">flower</a> can be used to monitor the Celery workers until these metrics are exposed through Nautobot.</p>
 </div>
 
 

nautobot/project-static/docs/user-guide/administration/guides/request-profiling.html

@@ -9400,11 +9400,11 @@
 
 
 <h1 id="request-profiling">Request Profiling<a class="headerlink" href="#request-profiling" title="Permanent link">&para;</a></h1>
-<p>Nautobot offers advanced request profiling through <a href="https://github.com/jazzband/django-silk">django-silk</a>. This allows administrators to collect debug information about user activities, which can be used to troubleshoot issues with the system.</p>
+<p>Nautobot offers advanced request profiling through <a href="https://github.com/jazzband/django-silk"><code>django-silk</code></a>. This allows administrators to collect debug information about user activities, which can be used to troubleshoot issues with the system.</p>
 <h2 id="user-setting">User Setting<a class="headerlink" href="#user-setting" title="Permanent link">&para;</a></h2>
 <p>Request profiling may be enabled by individual users in their profile within the web interface. This can be found under the "Advanced Settings" section.</p>
 <p><img alt="user advanced settings" src="../../../media/user-guide/administration/guides/request-profiling/advanced-settings.png" /></p>
-<p>Once a user enables request profiling, all subsequent HTTP requests made by that specific user to the system will be logged by django-silk. This setting will persist until the user either logs out or disables the setting in their profile.</p>
+<p>Once a user enables request profiling, all subsequent HTTP requests made by that specific user to the system will be logged by <code>django-silk</code>. This setting will persist until the user either logs out or disables the setting in their profile.</p>
 <h3 id="user-setting-notes">User Setting Notes<a class="headerlink" href="#user-setting-notes" title="Permanent link">&para;</a></h3>
 <ul>
 <li>
@@ -9415,42 +9415,42 @@
 </li>
 </ul>
 <h2 id="silk-ui">Silk UI<a class="headerlink" href="#silk-ui" title="Permanent link">&para;</a></h2>
-<p>Nautobot administrators with super-user permissions can access the django-silk UI at the <code>/silk/</code> URL.</p>
+<p>Nautobot administrators with super-user permissions can access the <code>django-silk</code> UI at the <code>/silk/</code> URL.</p>
 <p><img alt="silk ui" src="../../../media/user-guide/administration/guides/request-profiling/silk-ui.png" /></p>
 <p>From there, administrators can view details of individual requests, including timing, SQL queries, and cProfile artifacts.</p>
 <h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
-<p>The Nautobot configuration comes out of the box with django-silk set up to support the above functionality. Those settings are described below, but it is not the intention of the Nautobot docs to describe all django-silk settings. Django-silk provides several other parameters that knowledgeable users may also be able to use, depending on the use case.</p>
-<h3 id="allow_request_profiling">ALLOW_REQUEST_PROFILING<a class="headerlink" href="#allow_request_profiling" title="Permanent link">&para;</a></h3>
+<p>The Nautobot configuration comes out of the box with <code>django-silk</code> set up to support the above functionality. Those settings are described below, but it is not the intention of the Nautobot docs to describe all <code>django-silk</code> settings. Django-silk provides several other parameters that knowledgeable users may also be able to use, depending on the use case.</p>
+<h3 id="allow_request_profiling"><code>ALLOW_REQUEST_PROFILING</code><a class="headerlink" href="#allow_request_profiling" title="Permanent link">&para;</a></h3>
 <p>Default: <code>False</code></p>
 <p>Global setting to allow or deny users from enabling request profiling on their login session.</p>
 <hr />
-<h3 id="silky_python_profiler">SILKY_PYTHON_PROFILER<a class="headerlink" href="#silky_python_profiler" title="Permanent link">&para;</a></h3>
+<h3 id="silky_python_profiler"><code>SILKY_PYTHON_PROFILER</code><a class="headerlink" href="#silky_python_profiler" title="Permanent link">&para;</a></h3>
 <p>Default: <code>True</code></p>
 <p>Enables use of the built-in Python cProfile profiler.</p>
 <hr />
-<h3 id="silky_python_profiler_binary">SILKY_PYTHON_PROFILER_BINARY<a class="headerlink" href="#silky_python_profiler_binary" title="Permanent link">&para;</a></h3>
+<h3 id="silky_python_profiler_binary"><code>SILKY_PYTHON_PROFILER_BINARY</code><a class="headerlink" href="#silky_python_profiler_binary" title="Permanent link">&para;</a></h3>
 <p>Default: <code>True</code></p>
 <p>Generates a binary <code>.prof</code> file for each profiled request, which can be downloaded.</p>
 <hr />
-<h3 id="silky_python_profiler_extended_file_name">SILKY_PYTHON_PROFILER_EXTENDED_FILE_NAME<a class="headerlink" href="#silky_python_profiler_extended_file_name" title="Permanent link">&para;</a></h3>
+<h3 id="silky_python_profiler_extended_file_name"><code>SILKY_PYTHON_PROFILER_EXTENDED_FILE_NAME</code><a class="headerlink" href="#silky_python_profiler_extended_file_name" title="Permanent link">&para;</a></h3>
 <p>Default: <code>True</code></p>
 <p>Adds part of the request URL path to the profile file name to make it easier to identify specific requests.</p>
 <hr />
-<h3 id="silky_intercept_func">SILKY_INTERCEPT_FUNC<a class="headerlink" href="#silky_intercept_func" title="Permanent link">&para;</a></h3>
+<h3 id="silky_intercept_func"><code>SILKY_INTERCEPT_FUNC</code><a class="headerlink" href="#silky_intercept_func" title="Permanent link">&para;</a></h3>
 <p>Default: <code>nautobot.core.settings.silk_request_logging_intercept_logic</code></p>
 <p>This defines a custom function that filters requests to be profiled. Notably, the default looks for the user session flag described above.</p>
 <hr />
-<h3 id="silky_authentication">SILKY_AUTHENTICATION<a class="headerlink" href="#silky_authentication" title="Permanent link">&para;</a></h3>
+<h3 id="silky_authentication"><code>SILKY_AUTHENTICATION</code><a class="headerlink" href="#silky_authentication" title="Permanent link">&para;</a></h3>
 <p>Default: <code>True</code></p>
-<p>Users must be authenticated to access the django-silk UI.</p>
+<p>Users must be authenticated to access the <code>django-silk</code> UI.</p>
 <hr />
-<h3 id="silky_authorisation">SILKY_AUTHORISATION<a class="headerlink" href="#silky_authorisation" title="Permanent link">&para;</a></h3>
+<h3 id="silky_authorisation"><code>SILKY_AUTHORISATION</code><a class="headerlink" href="#silky_authorisation" title="Permanent link">&para;</a></h3>
 <p>Default: <code>True</code></p>
-<p>Users must have permissions to access the django-silk UI. Used in combination with <code>SILKY_AUTHENTICATION</code>.</p>
+<p>Users must have permissions to access the <code>django-silk</code> UI. Used in combination with <code>SILKY_AUTHENTICATION</code>.</p>
 <hr />
-<h3 id="silky_permissions">SILKY_PERMISSIONS<a class="headerlink" href="#silky_permissions" title="Permanent link">&para;</a></h3>
+<h3 id="silky_permissions"><code>SILKY_PERMISSIONS</code><a class="headerlink" href="#silky_permissions" title="Permanent link">&para;</a></h3>
 <p>Default: <code>nautobot.core.settings.silk_user_permissions</code></p>
-<p>This ensures the users must be a superuser of the system to access the django-silk UI. Used in combination with <code>SILKY_AUTHENTICATION</code> and <code>SILKY_AUTHORISATION</code>.</p>
+<p>This ensures the users must be a superuser of the system to access the <code>django-silk</code> UI. Used in combination with <code>SILKY_AUTHENTICATION</code> and <code>SILKY_AUTHORISATION</code>.</p>
 
 
 

nautobot/project-static/docs/user-guide/administration/guides/s3-django-storage.html

@@ -9289,7 +9289,7 @@
 </ul>
 <div class="admonition info">
 <p class="admonition-title">Info</p>
-<p>The remaining options are not required, but django-storages documentation should be reviewed to understand the security requirements.</p>
+<p>The remaining options are not required, but the <code>django-storages</code> documentation should be reviewed to understand the security requirements.</p>
 </div>
 <p>By using the the settings listed above, the static files will be stored in the S3 bucket instead of on the Nautobot server's filesystem. Once the <code>nautobot-server collectstatic</code> is executed you will see the files.</p>
 <p>Here's a snippet from the S3 bucket in use.
@@ -9315,7 +9315,7 @@
 </code></pre></div>
 <p>The <code>models.FileField</code> alongside the <code>upload_to</code> argument can be used to store user uploaded files into the already established S3 bucket. With the configuration settings provided earlier in this article and the <code>upload_to=uploads/</code> attribute the software attachments will be stored at <code>f"{AWS_STORAGE_BUCKET_NAME}.s3.amazonaws.com/{AWS_LOCATION}/uploads/"</code>.</p>
 <p>The nice thing about using <code>django-storages</code> is the ease of use and the ability to easily extend storage backends. One use case for extending storage backends that has been used is to store certain App data attachments in its own S3 bucket with different permissions. If we take this concept to the example of <code>SoftwareFileAttachment</code> we can put the software images in their own S3 bucket by creating a custom storage backend that we can pass to our <code>models.FileField</code> model field.</p>
-<p>For this example I created a simple python file called <code>customer_storage.py</code> in the root of my App.</p>
+<p>For this example I created a simple Python file called <code>customer_storage.py</code> in the root of my App.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="sd">&quot;&quot;&quot;Example of a custom extension to support flexible s3 storage.&quot;&quot;&quot;</span>
 <a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="kn">from</span> <span class="nn">storages.backends.s3</span> <span class="kn">import</span> <span class="n">S3Storage</span>
 <a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>

nautobot/project-static/docs/user-guide/administration/installation/app-install.html

@@ -9272,7 +9272,7 @@
 <p>You must be <strong>absolutely</strong> sure to install the app within Nautobot's virtual environment.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>If you installed Nautobot in a production environment, you'll want to sudo to the nautobot user first using <code>sudo -iu nautobot</code>.</p>
+<p>If you installed Nautobot in a production environment, you'll want to sudo to the <code>nautobot</code> user first using <code>sudo -iu nautobot</code>.</p>
 </div>
 <h2 id="install-the-package">Install the Package<a class="headerlink" href="#install-the-package" title="Permanent link">&para;</a></h2>
 <p>Download and install the app package per its installation instructions. Apps published via PyPI are typically installed using <code>pip3</code>.</p>

nautobot/project-static/docs/user-guide/administration/installation/install_system.html

@@ -9686,7 +9686,7 @@ is done with the following commands.</p>
 </div>
 </div>
 <h3 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">&para;</a></h3>
-<!-- pyml disable-next-line no-inline-html -->
+<!-- pyml disable-next-line no-inline-html,proper-names -->
 <h4>django.db.utils.NotSupportedError: conversion between UTF8 and SQL_ASCII is not supported</h4>
 
 <p>Django requires the database encoding for PostgreSQL databases to be set to UTF-8. If you receive the error <code>django.db.utils.NotSupportedError: conversion between UTF8 and SQL_ASCII is not supported</code>, you will need to drop and re-create the <code>nautobot</code> database with the correct encoding.</p>

nautobot/project-static/docs/user-guide/administration/installation/nautobot.html

@@ -750,9 +750,9 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#sudo-to-nautobot" class="md-nav__link">
+  <a href="#sudo-to-nautobot-user" class="md-nav__link">
     <span class="md-ellipsis">
-      Sudo to nautobot
+      Sudo to nautobot user
     </span>
   </a>
   
@@ -9358,9 +9358,9 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#sudo-to-nautobot" class="md-nav__link">
+  <a href="#sudo-to-nautobot-user" class="md-nav__link">
     <span class="md-ellipsis">
-      Sudo to nautobot
+      Sudo to nautobot user
     </span>
   </a>
   
@@ -9563,7 +9563,7 @@
 <div class="highlight"><span class="filename">Example output of updating bashrc</span><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>export NAUTOBOT_ROOT=/opt/nautobot
 </code></pre></div>
 </details>
-<h2 id="sudo-to-nautobot">Sudo to nautobot<a class="headerlink" href="#sudo-to-nautobot" title="Permanent link">&para;</a></h2>
+<h2 id="sudo-to-nautobot-user">Sudo to <code>nautobot</code> user<a class="headerlink" href="#sudo-to-nautobot-user" title="Permanent link">&para;</a></h2>
 <p>It is critical to install Nautobot as the <code>nautobot</code> user so that we don't have to worry about fixing permissions later.</p>
 <div class="highlight"><span class="filename">Log into the nautobot user</span><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>sudo -iu nautobot
 </code></pre></div>
@@ -9790,7 +9790,7 @@
 <div class="highlight"><span class="filename">Run a nautobot-server check</span><pre><span></span><code><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a>nautobot-server check
 </code></pre></div>
 <details class="example">
-<summary>nautobot-server check output</summary>
+<summary><code>nautobot-server check</code> output</summary>
 <div class="highlight"><span class="filename">Example nautobot-server check output</span><pre><span></span><code><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a>System check identified no issues (0 silenced).
 </code></pre></div>
 </details>

nautobot/project-static/docs/user-guide/administration/installation/services.html

@@ -9840,7 +9840,7 @@ Fields</a>, and <a href="../../platform-functionality/gitrepository.html">Git Re
 <p>Please see the <a href="../configuration/settings.html#databases">configuration guide on MySQL Unicode settings</a> for instructions on how to address this.</p>
 <p>Please see <a href="https://github.com/nautobot/nautobot/issues/645">Computed fields with fallback value that is unicode results in OperationalError (#645)</a> for more details.</p>
 <h3 id="svg-images-not-rendered">SVG images not rendered<a class="headerlink" href="#svg-images-not-rendered" title="Permanent link">&para;</a></h3>
-<p>When serving Nautobot directly from uWSGI on RedHat or CentOS there may be a problem rendering .svg images to include the Nautobot logo. On the RedHat based operating systems there is no file <code>/etc/mime.types</code> by default, unfortunately, uWSGI looks for this file to serve static files (see <a href="https://uwsgi-docs.readthedocs.io/en/latest/StaticFiles.html#mime-types">Serving static files with uWSGI</a>). To work around this copy the file <code>/etc/mime.types</code> from a known good system for example an Ubuntu/Debian system or even the Nautobot container to /opt/nautobot/mime.types. Then add the following line to your <code>uwsgi.ini</code> file and restart the Nautobot services:</p>
+<p>When serving Nautobot directly from uWSGI on RedHat or CentOS there may be a problem rendering .svg images to include the Nautobot logo. On the RedHat based operating systems there is no file <code>/etc/mime.types</code> by default, unfortunately, uWSGI looks for this file to serve static files (see <a href="https://uwsgi-docs.readthedocs.io/en/latest/StaticFiles.html#mime-types">Serving static files with uWSGI</a>). To work around this copy the file <code>/etc/mime.types</code> from a known good system for example an Ubuntu/Debian system or even the Nautobot container to <code>/opt/nautobot/mime.types</code>. Then add the following line to your <code>uwsgi.ini</code> file and restart the Nautobot services:</p>
 <div class="highlight"><span class="filename">Add MIME file settings to uwsgi.ini</span><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>mime-file = /opt/nautobot/mime.types
 </code></pre></div>
 <p>Alternatively, host Nautobot behind Nginx as instructed in <a href="http-server.html">HTTP server setup</a>.</p>

nautobot/project-static/docs/user-guide/administration/security/index.html

@@ -9230,7 +9230,7 @@
 <h2 id="security-vulnerability-reporting">Security Vulnerability Reporting<a class="headerlink" href="#security-vulnerability-reporting" title="Permanent link">&para;</a></h2>
 <p>We appreciate the time security researchers and users contribute to reporting vulnerabilities to the Nautobot Community.</p>
 <p>If you feel your report is safe for public disclosure (a CVE related to a dependency, or a low-risk bug) please feel free to open a bug <a href="https://github.com/nautobot/nautobot/issues/new/choose">issue on GitHub</a>.</p>
-<p>If you are unsure of the severity of your report or you feel it should not be publicly disclosed until a fix has been released, you can also email <a href="mailto:security@nautobot.com">security@nautobot.com</a> with the security details.</p>
+<p>If you are unsure of the severity of your report or you feel it should not be publicly disclosed until a fix has been released, you can also email <a href="mailto:security@nautobot.com"><code>security@nautobot.com</code></a> with the security details.</p>
 <p>You may encrypt your email with the GPG keys of the security response members below. While accepted, encryption using GPG is NOT mandatory to make a disclosure.</p>
 <div class="admonition tip">
 <p class="admonition-title">When Should I Report a Vulnerability?</p>

nautobot/project-static/docs/user-guide/administration/security/notices.html

@@ -9342,6 +9342,7 @@
 <h1 id="nautobot-security-notices">Nautobot Security Notices<a class="headerlink" href="#nautobot-security-notices" title="Permanent link">&para;</a></h1>
 <p>As a part of the Nautobot development team's commitment to security, we maintain the below historical list of security issues which have been fixed and disclosed. Note that this list <strong>only</strong> includes issues in Nautobot itself; while we frequently update our library dependencies to keep them up-to-date and free of known security issues therein, any reported issues in such libraries, and the corresponding updates to Nautobot's specified dependencies, are out of scope for this document.</p>
 <h2 id="cve-2024-36112">CVE-2024-36112<a class="headerlink" href="#cve-2024-36112" title="Permanent link">&para;</a></h2>
+<!-- pyml disable-num-lines 500 proper-names -->
 <!-- pyml disable-next-line no-inline-html -->
 <table>
   <tr>

nautobot/project-static/docs/user-guide/administration/tools/nautobot-shell.html

@@ -9265,7 +9265,7 @@
 <p>Nautobot includes a Python management shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following command:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>nautobot-server nbshell
 </code></pre></div>
-<p>This will launch a lightly customized version of <a href="https://django-extensions.readthedocs.io/en/latest/shell_plus.html">the django-extensions <code>shell_plus</code> shell</a>, which is an extension of <a href="https://docs.djangoproject.com/en/stable/ref/django-admin/#shell">the built-in Django shell</a> with all relevant Nautobot models pre-loaded.</p>
+<p>This will launch a lightly customized version of <a href="https://django-extensions.readthedocs.io/en/latest/shell_plus.html">the <code>django-extensions</code> <code>shell_plus</code> shell</a>, which is an extension of <a href="https://docs.djangoproject.com/en/stable/ref/django-admin/#shell">the built-in Django shell</a> with all relevant Nautobot models pre-loaded.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>nautobot-server nbshell
 </code></pre></div>
 <p>Example output:</p>

nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1.html

@@ -14418,15 +14418,18 @@ Most removed database fields in Nautobot 2.0 fall into the following general cat
 <p>With the removal of the atomic transaction, the <code>commit</code> flag has been removed. The ability to bypass job approval on dryrun can be achieved by using an optional <code>dryrun</code> argument. Job authors who wish to allow users to bypass approval when the <code>dryrun</code> flag is set should set a <code>dryrun</code> attribute with a value of <code>DryRunVar()</code> on their job class. <code>DryRunVar</code> can be imported from <code>nautobot.extras.jobs</code>.</p>
 <div class="admonition example">
 <p class="admonition-title">Example</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="kn">from</span> <span class="nn">nautobot.extras.jobs</span> <span class="kn">import</span> <span class="n">DryRunVar</span><span class="p">,</span> <span class="n">Job</span>
-<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a>
-<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="k">class</span> <span class="nc">ExampleJob</span><span class="p">(</span><span class="n">Job</span><span class="p">):</span>
-<a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a>    <span class="n">dryrun</span> <span class="o">=</span> <span class="n">DryRunVar</span><span class="p">()</span>
-<a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a>
-<a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a>    <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dryrun</span><span class="p">):</span>
-<a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a>        <span class="o">...</span>
-</code></pre></div>
 </div>
+<!-- pyml disable-num-lines 2 proper-names -->
+<div class="highlight"><pre><span></span><code>```py
+from nautobot.extras.jobs import DryRunVar, Job
+
+class ExampleJob(Job):
+    dryrun = DryRunVar()
+
+    def run(self, dryrun):
+        ...
+```
+</code></pre></div>
 <p>A new <code>supports_dryrun</code> field has been added to the <code>Job</code> model and <code>Job</code> class that returns true if the <code>Job</code> class implements the <code>dryrun = DryRunVar()</code> attribute. This is used to determine if jobs that require approval can be dry run without prior approval.</p>
 <p>The <code>commit_default</code> job field has been renamed to <code>dryrun_default</code> and the default value has been changed from <code>True</code> to <code>False</code>.</p>
 <div class="admonition important">