nautobot 2.3.16__py3-none-any.whl → 2.4.0__py3-none-any.whl

nautobot/core/settings.yaml

@@ -6,6 +6,8 @@ definitions:
     type: "string"
   callable:
     type: "string"
+  date:
+    type: "string"
   regex:
     type: "string"
   relative_path:
@@ -766,6 +768,57 @@ properties:
     is_constance_config: true
     type: "boolean"
     version_added: "2.0.0"
+  EVENT_BROKERS:
+    default: {}
+    description: >-
+      A dictionary defining event brokers that handle event publishing in Nautobot.
+      Each broker specifies its import path, along with topics to include or exclude
+      when publishing events.
+    details: |-
+      Each broker consists of a name, the class it uses for publishing events, and the topics
+      it filters. Topics are the categories of events that a broker will publish or exclude
+      based on the provided filters.
+
+      Example:
+
+      ```python
+      EVENT_BROKERS = {
+          "SyslogEventBroker": {
+              "CLASS": "nautobot.core.events.SyslogEventBroker",
+              "TOPICS": {
+                  "INCLUDE": ["nautobot.test.*"],
+                  "EXCLUDE": ["*.no-publish*"],
+              },
+          },
+      }
+      ```
+
+      In this example:
+      - **SyslogEventBroker** is the broker name.
+      - **CLASS** specifies the path to the event broker's Python class.
+      - **INCLUDE** filters the events the broker will publish, such as all topics starting with "nautobot.test."
+      - **EXCLUDE** filters out specific topics like those with "no-publish" in the name.
+
+      !!! note
+          If **INCLUDE** is set to ["*"], all topics will be published unless excluded by **EXCLUDE**.
+    properties:
+      CLASS:
+        type: "string"
+      TOPICS:
+        type: "object"
+        properties:
+          INCLUDE:
+            type: "array"
+            description: >-
+              List of topics that the broker should publish events for.
+              If empty or set to ["*"], all topics will be included.
+          EXCLUDE:
+            type: "array"
+            description: >-
+              List of topics that the broker should exclude from publishing.
+              If empty, no topics are excluded.
+    type: "object"
+    version_added: "2.4.0"
   EXEMPT_VIEW_PERMISSIONS:
     default: []
     description: "A list of Nautobot models to exempt from the enforcement of view permissions."
@@ -1007,6 +1060,41 @@ properties:
       +/- 2.0.0
           This directory no longer requires an `__init__.py` file.
     environment_variable: "NAUTOBOT_JOBS_ROOT"
+  KUBERNETES_DEFAULT_SERVICE_ADDRESS:
+    default: ""
+    description: "HTTP address of the Kubernetes cluster. e.g. https://kubernetes.default.svc"
+    environment_variable: "NAUTOBOT_KUBERNETES_DEFAULT_SERVICE_ADDRESS"
+    type: "string"
+    version_added: "2.4.0"
+  KUBERNETES_JOB_MANIFEST:
+    default: {}
+    description: "A dictionary that contains the pod manifest used to create a job pod in the kubernetes cluster."
+    type: "object"
+    version_added: "2.4.0"
+  KUBERNETES_JOB_POD_NAME:
+    default: ""
+    description: "Name of the Kubernetes pod."
+    environment_variable: "NAUTOBOT_KUBERNETES_JOB_POD_NAME"
+    type: "string"
+    version_added: "2.4.0"
+  KUBERNETES_JOB_POD_NAMESPACE:
+    default: ""
+    description: "Name of the namespace that the Kubernetes pod is created in."
+    environment_variable: "NAUTOBOT_KUBERNETES_JOB_POD_NAMESPACE"
+    type: "string"
+    version_added: "2.4.0"
+  KUBERNETES_SSL_CA_CERT_PATH:
+    default: "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
+    description: "File path to the SSL CA CERT used for authentication to create the job and job pod."
+    environment_variable: "NAUTOBOT_KUBERNETES_SSL_CA_CERT_PATH"
+    type: "string"
+    version_added: "2.4.0"
+  KUBERNETES_TOKEN_PATH:
+    default: "/var/run/secrets/kubernetes.io/serviceaccount/token"
+    description: "File path to the Bearer token used for authentication to create the job and job pod."
+    environment_variable: "NAUTOBOT_KUBERNETES_TOKEN_PATH"
+    type: "string"
+    version_added: "2.4.0"
   LOCATION_NAME_AS_NATURAL_KEY:
     default: false
     description: >-
@@ -1405,6 +1493,17 @@ properties:
     is_constance_config: true
     type: "object"
     version_added: "1.6.0"
+  NTC_SUPPORT_CONTRACT_EXPIRATION_DATE:
+    "$ref": "#/definitions/date"
+    default: ""
+    description: >-
+      Expiration date for an active Nautobot support contract with Network to Code.
+      This value is displayed in the "About" page to provide additional support information.
+    details: >-
+      If specified as an environment variable, use ISO 8601 (`YYYY-MM-DD`) format.
+    environment_variable: "NAUTOBOT_NTC_SUPPORT_CONTRACT_EXPIRATION_DATE"
+    is_constance_config: true
+    version_added: "2.4.0"
   PAGINATE_COUNT:
     default: 50
     description: >-

nautobot/core/tables.py

@@ -4,7 +4,6 @@ import logging
 from django.contrib.auth.models import AnonymousUser
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.core.exceptions import FieldDoesNotExist, FieldError
-from django.db import NotSupportedError
 from django.db.models import Prefetch
 from django.db.models.fields.related import ForeignKey, RelatedField
 from django.db.models.fields.reverse_related import ManyToOneRel
@@ -22,6 +21,7 @@ from tree_queries.models import TreeNode
 from nautobot.core.models.querysets import count_related
 from nautobot.core.templatetags import helpers
 from nautobot.core.utils.lookup import get_model_for_view_name, get_related_field_for_models, get_route_for_model
+from nautobot.core.utils.querysets import maybe_prefetch_related, maybe_select_related
 from nautobot.extras import choices, models
 
 logger = logging.getLogger(__name__)
@@ -64,6 +64,9 @@ class BaseTable(django_tables2.Table):
                 returns new data. Runs after all of the queryset auto-optimization performed by this class.
                 Used for example in IPAM views to inject "fake" records for "available" Prefixes, IPAddresses, or VLANs.
             **kwargs (dict, optional): Passed through to django_tables2.Table
+        Warning:
+            Do not modify/set the `base_columns` attribute after BaseTable class is instantiated.
+            Do not modify/set the `base_columns` attribute after calling super().__init__() of BaseTable class.
         """
         # Add custom field columns
         model = self._meta.model
@@ -236,51 +239,10 @@ class BaseTable(django_tables2.Table):
                     prefetch_fields.append("__".join(prefetch_path))
 
             if select_fields:
-                # Django doesn't allow .select_related() on a QuerySet that had .values()/.values_list() applied, or
-                # one that has had union()/intersection()/difference() applied.
-                # We can detect and avoid these cases the same way that Django itself does.
-                if queryset._fields is not None:
-                    logger.debug(
-                        "NOT applying select_related(%s) to %s QuerySet as it includes .values()/.values_list()",
-                        select_fields,
-                        model.__name__,
-                    )
-                elif queryset.query.combinator:
-                    logger.debug(
-                        "NOT applying select_related(%s) to %s QuerySet as it is a combinator query",
-                        select_fields,
-                        model.__name__,
-                    )
-                else:
-                    logger.debug("Applying .select_related(%s) to %s QuerySet", select_fields, model.__name__)
-                    # Belt and suspenders - we should have avoided any error cases above, but be safe anyway:
-                    try:
-                        queryset = queryset.select_related(*select_fields)
-                    except (TypeError, ValueError, NotSupportedError) as exc:
-                        logger.warning(
-                            "Unexpected error when trying to .select_related() on %s QuerySet: %s",
-                            model.__name__,
-                            exc,
-                        )
+                queryset = maybe_select_related(queryset, select_fields)
 
             if prefetch_fields:
-                if queryset.query.combinator:
-                    logger.debug(
-                        "NOT applying prefetch_related(%s) to %s QuerySet as it is a combinator query",
-                        prefetch_fields,
-                        model.__name__,
-                    )
-                else:
-                    logger.debug("Applying .prefetch_related(%s) to %s QuerySet", prefetch_fields, model.__name__)
-                    # Belt and suspenders - we should have avoided any error cases above, but be safe anyway:
-                    try:
-                        queryset = queryset.prefetch_related(*prefetch_fields)
-                    except (AttributeError, TypeError, ValueError, NotSupportedError) as exc:
-                        logger.warning(
-                            "Unexpected error when trying to .prefetch_related() on %s QuerySet: %s",
-                            model.__name__,
-                            exc,
-                        )
+                queryset = maybe_prefetch_related(queryset, prefetch_fields)
 
             if count_fields:
                 for column_name, column_model, lookup_name, distinct in count_fields:
@@ -314,7 +276,9 @@ class BaseTable(django_tables2.Table):
     @property
     def configurable_columns(self):
         selected_columns = [
-            (name, self.columns[name].verbose_name) for name in self.sequence if name not in ["pk", "actions"]
+            (name, column.verbose_name)
+            for name, column in self.columns.items()
+            if name in self.sequence and name not in ["pk", "actions"]
         ]
         available_columns = [
             (name, column.verbose_name)
@@ -325,7 +289,7 @@ class BaseTable(django_tables2.Table):
 
     @property
     def visible_columns(self):
-        return [name for name in self.sequence if self.columns[name].visible and name not in self.exclude]
+        return [name for name, column in self.columns.items() if column.visible and name not in self.exclude]
 
     @property
     def order_by(self):

nautobot/core/tasks.py

@@ -49,7 +49,7 @@ def get_releases(pre_releases=False):
     cache.set(
         "nautobot.core.releases.get_latest_release",
         max(releases),
-        config.get_settings_or_config("RELEASE_CHECK_TIMEOUT"),
+        config.get_settings_or_config("RELEASE_CHECK_TIMEOUT", fallback=24 * 3600),
     )
 
     # Since this is a Celery task, we can't return Version objects as they are not JSON serializable.

nautobot/core/templates/about.html

@@ -0,0 +1,67 @@
+{% extends 'base.html' %}
+{% load helpers %}
+{% load registry %}
+
+{% block header %}
+    {{ block.super }}
+    {% if new_release %}
+        {# new_release is set only if the current user is a superuser or staff member #}
+        <div class="alert alert-info text-center" role="alert">
+            <i class="mdi mdi-information-outline"></i>
+            A new release is available: <a href="{{ new_release.url }}">Nautobot v{{ new_release.version }}</a> |
+            <a href="https://docs.nautobot.com/projects/core/en/v{{ new_release.version }}/installation/upgrading/">Upgrade instructions</a>
+        </div>
+    {% endif %}
+{% endblock %}
+
+
+{% block content %}
+    <h1>About Nautobot</h1>
+    <div class="row">
+        <div class="col-md-6">
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>About</strong>
+                </div>
+                <div class="panel-body">
+                    <a href="https://networktocode.com/nautobot/">Nautobot</a> is a product of <a href="https://networktocode.com/">Network to Code</a>. Nautobot is a Network Source of Truth and Network Automation Platform. Nautobot has an extensive ecosystem of solutions that can be installed to provide and power Network Automation feature sets. Please check the <a href="{% url 'apps:apps_marketplace' %}">App Marketplace</a> to learn more.
+                </div>
+            </div>
+        </div>
+        <div class="col-md-6">
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>Support</strong>
+                </div>
+                <table class="table table-hover panel-body attr-table">
+                    <tr>
+                        <td>Support Contract Status</td>
+                        <td>{{ support_contract_active | render_boolean }}</td>
+                    </tr>
+                    <tr>
+                        <td>Contract Expiry Date</td>
+                        <td>
+                            {% if support_contract_active %}
+                                {{ support_expiration_date | date }}
+                            {% elif support_expiration_date %}
+                                <span style="color: red;">{{ support_expiration_date | date }}</span>
+                            {% else %}
+                                &mdash;
+                            {% endif %}
+                        </td>
+                    </tr>
+                    <tr>
+                        <td>&nbsp;</td>
+                        <td>
+                            {% if not support_expiration_date %}
+                                To inquire about Nautobot support with Network to Code, please email <a href="mailto:info@networktocode.com">info@networktocode.com</a>.
+                            {% else %}
+                                If there is any question on the status of your Nautobot support contract with Network to Code, please email <a href="mailto:info@networktocode.com">info@networktocode.com</a>.
+                            {% endif %}
+                        </td>
+                    </tr>
+                </table>
+            </div>
+        </div>
+    </div>
+{% endblock %}

nautobot/core/templates/components/button/default.html

@@ -0,0 +1,7 @@
+{% if link %}<a href="{{ link }}"{% else %}<button type="button"{% endif %}
+    class="btn btn-{{ color }}"
+    {% for key, value in attributes.items %}{{ key }}="{{ value }}" {% endfor %}
+>
+    {% if icon %}<span class="mdi {{ icon }}" aria-hidden="true"></span>{% endif %}
+    {{ label }}
+{% if link %}</a>{% else %}</button>{% endif %}

nautobot/core/templates/components/button/dropdown.html

@@ -0,0 +1,20 @@
+<div class="btn-group">
+    <button type="button" class="btn btn-{{ color }} dropdown-toggle" data-toggle="dropdown"
+        aria-haspopup="true" aria-expanded="false"
+        {% for key, value in attributes.items %}{{ key }}="{{ value }}" {% endfor %}
+    >
+        {% if icon %}<span class="mdi {{ icon }}" aria-hidden="true"></span>{% endif %}
+        {{ label }}
+        <span class="caret"></span>
+    </button>
+    <ul class="dropdown-menu">
+        {% for child in children %}
+            <li><a href="{{ child.link }}" class="text-{{ child.color }}"
+                {% for key, value in child.attributes.items %}{{ key }}="{{ value }}" {% endfor %}
+            >
+                {% if child.icon %}<span class="mdi {{ child.icon }}" aria-hidden="true"></span>{% endif %}
+                {{ child.label }}
+            </a></li>
+        {% endfor %}
+    </ul>
+</div>

nautobot/core/templates/components/layout/one_over_two.html

@@ -0,0 +1,19 @@
+{% load ui_framework %}
+{% load plugins %}
+
+<div class="row">
+    <div class="col-md-12">
+        {% render_components full_width_panels %}
+        {% if include_plugin_content %}{% plugin_full_width_page object %}{% endif %}
+    </div>
+</div>
+<div class="row">
+    <div class="col-md-6">
+        {% render_components left_half_panels %}
+        {% if include_plugin_content %}{% plugin_left_page object %}{% endif %}
+    </div>
+    <div class="col-md-6">
+        {% render_components right_half_panels %}
+        {% if include_plugin_content %}{% plugin_right_page object %}{% endif %}
+    </div>
+</div>

nautobot/core/templates/components/layout/two_over_one.html

@@ -0,0 +1,19 @@
+{% load ui_framework %}
+{% load plugins %}
+
+<div class="row">
+    <div class="col-md-6">
+        {% render_components left_half_panels %}
+        {% if include_plugin_content %}{% plugin_left_page object %}{% endif %}
+    </div>
+    <div class="col-md-6">
+        {% render_components right_half_panels %}
+        {% if include_plugin_content %}{% plugin_right_page object %}{% endif %}
+    </div>
+</div>
+<div class="row">
+    <div class="col-md-12">
+        {% render_components full_width_panels %}
+        {% if include_plugin_content %}{% plugin_full_width_page object %}{% endif %}
+    </div>
+</div>

nautobot/core/templates/components/panel/body_content_data_table.html

@@ -0,0 +1,27 @@
+{% load helpers %}
+<table class="table table-hover table-headings">
+    {% if data %}
+        {% if column_headers %}
+            <thead>
+                <tr>
+                    {% for column_header in column_headers %}
+                        <th>{{ column_header }}</th>
+                    {% endfor %}
+                </tr>
+            </thead>
+        {% endif %}
+        <tbody>
+            {% for entry in data %}
+                <tr>
+                    {% for column in columns %}
+                        <td>{{ entry|get_item:column|placeholder }}</td>
+                    {% endfor %}
+                </tr>
+            {% endfor %}
+        </tbody>
+    {% else %}
+        <tr>
+            <td colspan="{{ columns|length }}" class="text-center text-muted">&mdash; No data &mdash;</td>
+        </td>
+    {% endif %}
+</table>

nautobot/core/templates/components/panel/body_content_objects_table.html

@@ -0,0 +1,4 @@
+{% load render_table from django_tables2 %}
+{% with table=body_content_table %}
+    {% render_table table 'inc/table.html' %}
+{% endwith %}

nautobot/core/templates/components/panel/body_content_tags.html

@@ -0,0 +1,6 @@
+{% load helpers %}
+{% for tag in tags %}
+    {% tag tag list_url_name %}
+{% empty %}
+    <span class="text-muted">No tags assigned</span>
+{% endfor %}

nautobot/core/templates/components/panel/body_content_text.html

@@ -0,0 +1,12 @@
+{% load helpers %}
+{% if render_as == 'json' %}
+    <pre>{{ value | render_json }}</pre>
+{% elif render_as == 'yaml' %}
+    <pre>{{ value | render_yaml }}</pre>
+{% elif render_as == 'markdown' %}
+    {{ value | render_markdown }}
+{% elif render_as == 'code' %}
+    <pre>{{ value }}</pre>
+{% else %}
+    {{ value }}
+{% endif %}

nautobot/core/templates/components/panel/body_wrapper_generic.html

@@ -0,0 +1,3 @@
+<div class="panel-body"{% if body_id %} id="{{ body_id }}"{% endif %}>
+    {{ body_content }}
+</div>

nautobot/core/templates/components/panel/body_wrapper_key_value_table.html

@@ -0,0 +1,3 @@
+<table class="table table-hover panel-body attr-table"{% if body_id %} id="{{ body_id }}"{% endif %}>
+    {{ body_content }}
+</table>

nautobot/core/templates/components/panel/body_wrapper_table.html

@@ -0,0 +1,3 @@
+<div class="table-responsive"{% if body_id %} id="{{ body_id }}"{% endif %}>
+    {{ body_content }}
+</div>

nautobot/core/templates/components/panel/footer_contacts_table.html

@@ -0,0 +1,20 @@
+{% with request.path|add:"?tab=contacts"|urlencode as return_url %}
+    {% if perms.extras.change_contactassociation %}
+        <button type="submit" name="_edit" formaction="{% url 'extras:contactassociation_bulk_edit' %}?return_url={{return_url}}" class="btn btn-warning btn-xs">
+            <span class="mdi mdi-pencil" aria-hidden="true"></span> Edit
+        </button>
+    {% endif %}
+    {% if perms.extras.delete_contactassociation %}
+        <button type="submit" formaction="{% url 'extras:contactassociation_bulk_delete' %}?return_url={{return_url}}" class="btn btn-danger btn-xs">
+            <span class="mdi mdi-trash-can-outline" aria-hidden="true"></span> Delete
+        </button>
+    {% endif %}
+    {% if perms.extras.add_contactassociation %}
+        <div class="pull-right">
+            <a href="{% url 'extras:object_contact_team_assign' %}?return_url={{return_url}}&associated_object_id={{object.id}}&associated_object_type={{content_type.id}}" class="btn btn-primary btn-xs">
+                <span class="mdi mdi-plus-thick" aria-hidden="true"></span> Add Contact
+            </a>
+        </div>
+    {% endif %}
+    <div class="clearfix"></div>
+{% endwith %}

nautobot/core/templates/components/panel/footer_content_table.html

@@ -0,0 +1,14 @@
+{% if body_content_table_list_url and more_queryset_count > 0 %}
+    <a href="{{ body_content_table_list_url }}">
+        <span class="mdi mdi-dots-horizontal" aria-hidden="true"></span> View {{ more_queryset_count }} more {{ body_content_table_verbose_name_plural }}
+    </a>
+{% endif %}
+
+{% if body_content_table_add_url %}
+    <div class="pull-right">
+        <a href="{{ body_content_table_add_url }}" class="btn btn-xs btn-primary">
+            <span class="mdi mdi-plus-thick" aria-hidden="true"></span> Add {{ body_content_table_verbose_name }}
+        </a>
+    </div>
+    <div class="clearfix"></div>
+{% endif %}

nautobot/core/templates/components/panel/grouping_toggle.html

@@ -0,0 +1,14 @@
+<tr>
+    <td colspan="2">
+        <strong>
+            <!-- TODO: this is not very consistent with other button styling -->
+            <button type="button"
+                    class="accordion-toggle mdi mdi-chevron-down"
+                    name="grouping.{{ grouping }}"
+                    data-toggle="collapse"
+                    data-target=".collapseme-{{ body_id }}-{{ counter }}">
+                {{ grouping }}
+            </button>
+        </strong>
+    </td>
+</tr>

nautobot/core/templates/components/panel/header_extra_content_table.html

@@ -0,0 +1,3 @@
+{% load helpers %}
+
+<strong>{{ body_content_table_verbose_name_plural|bettertitle }}</strong>  {% if body_content_table_list_url %}<a href="{{ body_content_table_list_url }}" class="badge badge-primary">{{ body_content_table.rows|length }}</a>{% endif %}

nautobot/core/templates/components/panel/panel.html

@@ -0,0 +1,16 @@
+<div class="panel panel-default">
+    {% if label.strip or header_extra_content.strip %}
+        <div class="panel-heading">
+            {% if label %}
+                <strong>{{ label }}</strong>
+            {% endif %}
+            {{ header_extra_content }}
+        </div>
+    {% endif %}
+    {{ body }}
+    {% if footer_content.strip %}
+        <div class="panel-footer">
+            {{ footer_content }}
+        </div>
+    {% endif %}
+</div>

nautobot/core/templates/components/panel/stats_panel_body.html

@@ -0,0 +1,8 @@
+<div class="panel-body">
+    {% for url, value, title in stats.values %}
+        <div class="col-md-4 text-center">
+            <h2><a href="{% url url %}?{{ filter_name }}={{ object.pk }}" class="btn {% if value > 0 %}btn-primary{% else %}btn-default{% endif %} btn-lg">{{ value }}</a></h2>
+            <p>{{ title }}</p>
+        </div>
+    {% endfor %}
+</div>

nautobot/core/templates/components/tab/content_wrapper.html

@@ -0,0 +1,3 @@
+<div id="{{ tab_id }}" role="tabpanel" class="tab-pane {% if request.GET.tab == tab_id %}active{% else %}fade{% endif %}">
+    {{ tab_content }}
+</div>

nautobot/core/templates/components/tab/label_wrapper.html

@@ -0,0 +1,5 @@
+<li role="presentation"{% if request.GET.tab == tab_id %} class="active"{% endif %}>
+    <a href="{{ object.get_absolute_url }}#{{ tab_id }}" onclick="switch_tab(this.href)" aria-controls="{{ tab_id }}" role="tab" data-toggle="tab">
+        {{ label }}
+    </a>
+</li>

nautobot/core/templates/components/tab/label_wrapper_distinct_view.html

@@ -0,0 +1,3 @@
+<li role="presentation"{% if request.GET.tab == tab_id %} class="active"{% endif %}>
+    <a href="{{ url }}?tab={{ tab_id }}">{{ label }}</a>
+</li>