nautobot 2.2.9__py3-none-any.whl → 2.3.0b1__py3-none-any.whl

nautobot/cloud/models.py

@@ -0,0 +1,247 @@
+from django.db import models  # noqa: I001
+from django.contrib.contenttypes.models import ContentType
+from django.core.exceptions import ValidationError
+from jsonschema.exceptions import ValidationError as JSONSchemaValidationError
+from jsonschema.validators import Draft7Validator
+
+from nautobot.core.constants import CHARFIELD_MAX_LENGTH
+from nautobot.core.models import BaseManager, BaseModel, ContentTypeRelatedQuerySet
+from nautobot.core.models.fields import ForeignKeyLimitedByContentTypes
+from nautobot.core.models.generics import PrimaryModel
+from nautobot.extras.utils import FeatureQuery, extras_features
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "dynamic_groups",
+    "export_templates",
+    "graphql",
+    "webhooks",
+)
+class CloudAccount(PrimaryModel):
+    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, help_text="The name of this Cloud Account.", unique=True)
+    description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
+    account_number = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH, help_text="The account identifier of this Cloud Account."
+    )
+    provider = models.ForeignKey(
+        to="dcim.Manufacturer",
+        on_delete=models.PROTECT,
+        related_name="cloud_accounts",
+        help_text="The Manufacturer instance which represents the Cloud Provider",
+    )
+    secrets_group = models.ForeignKey(
+        to="extras.SecretsGroup",
+        on_delete=models.SET_NULL,
+        default=None,
+        blank=True,
+        null=True,
+    )
+    clone_fields = [
+        "provider",
+        "secrets_group",
+    ]
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return f"{self.name}"
+
+    @property
+    def display(self):
+        return f"{self.provider}: {self.name} - {self.account_number}"
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+    "webhooks",
+)
+class CloudResourceType(PrimaryModel):
+    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, help_text="Type of cloud objects", unique=True)
+    description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
+    provider = models.ForeignKey(
+        to="dcim.Manufacturer",
+        on_delete=models.PROTECT,
+        related_name="cloud_resource_types",
+        help_text="The Manufacturer instance which represents the Cloud Provider",
+    )
+    config_schema = models.JSONField(null=True, blank=True)
+    content_types = models.ManyToManyField(
+        to=ContentType,
+        help_text="The content type(s) to which this model applies.",
+        related_name="cloud_resource_types",
+        limit_choices_to=FeatureQuery("cloud_resource_types"),
+    )
+    clone_fields = [
+        "provider",
+        "content_types",
+    ]
+
+    objects = BaseManager.from_queryset(ContentTypeRelatedQuerySet)()
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+    @property
+    def display(self):
+        return f"{self.provider}: {self.name}"
+
+
+class CloudResourceTypeMixin(models.Model):
+    """Mixin that designates a model as compatible with CloudResourceType content_types selections."""
+
+    cloud_resource_type = ForeignKeyLimitedByContentTypes(to=CloudResourceType, on_delete=models.PROTECT)
+    extra_config = models.JSONField(null=True, blank=True)
+
+    is_cloud_resource_type_model = True
+
+    class Meta:
+        abstract = True
+
+    def clean(self):
+        super().clean()
+
+        # Copied from nautobot.extras.models.models.ConfigContextSchemaValidationMixin
+        schema = self.cloud_resource_type.config_schema
+        if schema:
+            try:
+                Draft7Validator(schema, format_checker=Draft7Validator.FORMAT_CHECKER).validate(self.extra_config)
+            except JSONSchemaValidationError as e:
+                raise ValidationError(
+                    {
+                        "extra_config": [
+                            f"Validation according to CloudResourceType {self.cloud_resource_type} config_schema failed.",
+                            e.message,
+                        ]
+                    }
+                )
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+    "webhooks",
+)
+class CloudNetwork(CloudResourceTypeMixin, PrimaryModel):
+    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, unique=True)
+    description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
+    cloud_account = models.ForeignKey(to=CloudAccount, on_delete=models.PROTECT, related_name="cloud_networks")
+    parent = models.ForeignKey(
+        to="cloud.CloudNetwork", on_delete=models.SET_NULL, blank=True, null=True, related_name="children"
+    )
+    prefixes = models.ManyToManyField(
+        blank=True,
+        related_name="cloud_networks",
+        to="ipam.Prefix",
+        through="cloud.CloudNetworkPrefixAssignment",
+    )
+    clone_fields = [
+        "cloud_resource_type",
+        "cloud_account",
+        "parent",
+    ]
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+    def clean(self):
+        super().clean()
+
+        if self.parent is not None:
+            if self.parent.parent is not None:
+                raise ValidationError(
+                    {"parent": "A CloudNetwork may not be the child of a CloudNetwork that itself has a parent."}
+                )
+            if self.parent == self:
+                raise ValidationError({"parent": "A CloudNetwork may not be its own parent."})
+
+        # TODO: should we enforce that self.cloud_resource_type.provider == self.cloud_account.provider?
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+)
+class CloudNetworkPrefixAssignment(BaseModel):
+    cloud_network = models.ForeignKey(CloudNetwork, on_delete=models.CASCADE, related_name="prefix_assignments")
+    prefix = models.ForeignKey("ipam.Prefix", on_delete=models.CASCADE, related_name="cloud_network_assignments")
+    is_metadata_associable_model = False
+
+    class Meta:
+        unique_together = ["cloud_network", "prefix"]
+        ordering = ["cloud_network", "prefix"]
+
+    def __str__(self):
+        return f"{self.cloud_network}: {self.prefix}"
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+    "webhooks",
+)
+class CloudService(CloudResourceTypeMixin, PrimaryModel):
+    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, unique=True)
+    description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
+    cloud_account = models.ForeignKey(
+        to=CloudAccount,
+        related_name="cloud_services",
+        on_delete=models.SET_NULL,
+        default=None,
+        blank=True,
+        null=True,
+    )
+    cloud_networks = models.ManyToManyField(
+        to=CloudNetwork,
+        through="cloud.CloudServiceNetworkAssignment",
+        related_name="cloud_services",
+        through_fields=("cloud_service", "cloud_network"),
+        blank=True,
+    )
+    clone_fields = [
+        "cloud_account",
+        "cloud_networks",
+        "cloud_resource_type",
+    ]
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+)
+class CloudServiceNetworkAssignment(BaseModel):
+    cloud_network = models.ForeignKey(CloudNetwork, on_delete=models.CASCADE, related_name="cloud_service_assignments")
+    cloud_service = models.ForeignKey(CloudService, on_delete=models.CASCADE, related_name="cloud_network_assignments")
+    is_metadata_associable_model = False
+
+    class Meta:
+        unique_together = ["cloud_network", "cloud_service"]
+        ordering = ["cloud_network", "cloud_service"]
+
+    def __str__(self):
+        return f"{self.cloud_network}: {self.cloud_service}"

nautobot/cloud/navigation.py

@@ -0,0 +1,85 @@
+from nautobot.core.apps import (
+    NavMenuAddButton,
+    NavMenuGroup,
+    NavMenuItem,
+    NavMenuTab,
+)
+
+menu_items = (
+    NavMenuTab(
+        name="Cloud",
+        weight=200,
+        groups=(
+            NavMenuGroup(
+                name="Cloud",
+                weight=100,
+                items=(
+                    NavMenuItem(
+                        link="cloud:cloudservice_list",
+                        name="Cloud Services",
+                        weight=100,
+                        permissions=[
+                            "cloud.view_cloudservice",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="cloud:cloudservice_add",
+                                permissions=[
+                                    "cloud.add_cloudservice",
+                                ],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="cloud:cloudnetwork_list",
+                        name="Cloud Networks",
+                        weight=200,
+                        permissions=[
+                            "cloud.view_cloudnetwork",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="cloud:cloudnetwork_add",
+                                permissions=[
+                                    "cloud.add_cloudnetwork",
+                                ],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="cloud:cloudresourcetype_list",
+                        name="Cloud Resource Types",
+                        weight=300,
+                        permissions=[
+                            "cloud.view_cloudresourcetype",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="cloud:cloudresourcetype_add",
+                                permissions=[
+                                    "cloud.add_cloudresourcetype",
+                                ],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="cloud:cloudaccount_list",
+                        name="Cloud Accounts",
+                        weight=400,
+                        permissions=[
+                            "cloud.view_cloudaccount",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="cloud:cloudaccount_add",
+                                permissions=[
+                                    "cloud.add_cloudaccount",
+                                ],
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+        ),
+    ),
+)

nautobot/cloud/tables.py

@@ -0,0 +1,173 @@
+import django_tables2 as tables
+
+from nautobot.core.tables import (
+    BaseTable,
+    ButtonsColumn,
+    LinkedCountColumn,
+    TagColumn,
+    ToggleColumn,
+)
+from nautobot.tenancy.tables import TenantColumn
+
+from .models import CloudAccount, CloudNetwork, CloudNetworkPrefixAssignment, CloudResourceType, CloudService
+
+
+class CloudAccountTable(BaseTable):
+    pk = ToggleColumn()
+    name = tables.Column(linkify=True)
+    provider = tables.Column(linkify=True)
+    secrets_group = tables.Column(linkify=True)
+    tags = TagColumn(url_name="cloud:cloudaccount_list")
+    actions = ButtonsColumn(CloudAccount)
+
+    class Meta(BaseTable.Meta):
+        model = CloudAccount
+        fields = (
+            "pk",
+            "name",
+            "account_number",
+            "description",
+            "provider",
+            "secrets_group",
+            "tags",
+            "actions",
+        )
+        default_columns = (
+            "pk",
+            "name",
+            "account_number",
+            "provider",
+            "actions",
+        )
+
+
+class CloudNetworkTable(BaseTable):
+    pk = ToggleColumn()
+    name = tables.Column(linkify=True)
+    cloud_resource_type = tables.Column(linkify=True)
+    cloud_account = tables.Column(linkify=True)
+    parent = tables.Column(linkify=True)
+    actions = ButtonsColumn(CloudNetwork)
+    assigned_prefix_count = LinkedCountColumn(
+        viewname="ipam:prefix_list",
+        url_params={"cloud_networks": "name"},
+        verbose_name="Assigned Prefixes",
+    )
+    circuit_count = LinkedCountColumn(
+        viewname="circuits:circuit_list",
+        url_params={"cloud_network": "name"},
+        verbose_name="Circuits",
+        reverse_lookup="circuit_terminations__cloud_network",
+    )
+    cloud_service_count = LinkedCountColumn(
+        viewname="cloud:cloudservice_list",
+        url_params={"cloud_networks": "name"},
+        verbose_name="Cloud Services",
+    )
+    tags = TagColumn(url_name="cloud:cloudnetwork_list")
+
+    class Meta(BaseTable.Meta):
+        model = CloudNetwork
+        fields = (
+            "pk",
+            "name",
+            "description",
+            "cloud_resource_type",
+            "cloud_account",
+            "parent",
+            "cloud_service_count",
+            "assigned_prefix_count",
+            "circuit_count",
+            "tags",
+            "actions",
+        )
+        default_columns = (
+            "pk",
+            "name",
+            "description",
+            "cloud_resource_type",
+            "cloud_account",
+            "cloud_service_count",
+            "assigned_prefix_count",
+            "circuit_count",
+            "parent",
+            "actions",
+        )
+
+
+class CloudNetworkPrefixAssignmentTable(BaseTable):
+    cloud_network = tables.Column(
+        verbose_name="Cloud Network",
+        linkify=lambda record: record.cloud_network.get_absolute_url(),
+        accessor="cloud_network.name",
+    )
+    prefix = tables.Column(linkify=True)
+    rd = tables.Column(accessor="vrf.rd", verbose_name="RD")
+    tenant = TenantColumn(accessor="vrf.tenant")
+
+    class Meta(BaseTable.Meta):
+        model = CloudNetworkPrefixAssignment
+        fields = ("cloud_network", "prefix", "rd", "tenant")
+
+
+class CloudResourceTypeTable(BaseTable):
+    pk = ToggleColumn()
+    name = tables.Column(linkify=True)
+    provider = tables.Column(linkify=True)
+    tags = TagColumn(url_name="cloud:cloudresourcetype_list")
+    actions = ButtonsColumn(CloudResourceType)
+
+    class Meta(BaseTable.Meta):
+        model = CloudResourceType
+        fields = (
+            "pk",
+            "name",
+            "description",
+            "provider",
+            "config_schema",
+            "content_types",
+            "tags",
+            "actions",
+        )
+        default_columns = (
+            "pk",
+            "name",
+            "provider",
+            "config_schema",
+            "content_types",
+            "actions",
+        )
+
+
+class CloudServiceTable(BaseTable):
+    pk = ToggleColumn()
+    name = tables.Column(linkify=True)
+    cloud_account = tables.Column(linkify=True)
+    cloud_resource_type = tables.Column(linkify=True)
+    cloud_network_count = LinkedCountColumn(
+        viewname="cloud:cloudnetwork_list",
+        url_params={"cloud_services": "name"},
+        verbose_name="Cloud Networks",
+    )
+    tags = TagColumn(url_name="cloud:cloudservice_list")
+    actions = ButtonsColumn(CloudService)
+
+    class Meta(BaseTable.Meta):
+        model = CloudService
+        fields = (
+            "pk",
+            "name",
+            "cloud_resource_type",
+            "cloud_account",
+            "cloud_network_count",
+            "tags",
+            "actions",
+        )
+        default_columns = (
+            "pk",
+            "name",
+            "cloud_resource_type",
+            "cloud_account",
+            "cloud_network_count",
+            "actions",
+        )

nautobot/cloud/templates/cloud/cloudaccount_retrieve.html

@@ -0,0 +1,43 @@
+{% extends 'generic/object_retrieve.html' %}
+{% load helpers %}
+
+{% block extra_breadcrumbs %}
+                <li><a href="{% url 'cloud:cloudaccount_list' %}?provider={{ object.provider.pk }}">{{ object.provider }}</a></li>
+{% endblock extra_breadcrumbs %}
+
+{% block content_left_page %}
+        <div class="panel panel-default">
+            <div class="panel-heading">
+                <strong>Cloud Account</strong>
+            </div>
+            <table class="table table-hover panel-body attr-table">
+                <tr>
+                    <td>Name</td>
+                    <td>
+                        {{ object.name }}
+                    </td>
+                </tr>
+                <tr>
+                    <td>Provider</td>
+                    <td>{{ object.provider|hyperlinked_object }}</td>
+                </tr>
+                <tr>
+                    <td>Account Number</td>
+                    <td>
+                        <span class="hover_copy"><span id="copy_accountnumber">{{ object.account_number }}</span><button type="button" class="btn btn-inline btn-default hover_copy_button" data-clipboard-target="#copy_accountnumber">
+                            <span class="mdi mdi-content-copy"></span>
+                        </button>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td>Secrets Group</td>
+                    <td>{{ object.secrets_group|hyperlinked_object }}</td>
+                </tr>
+                <tr>
+                    <td>Description</td>
+                    <td>{{ object.description|placeholder }}</td>
+                </tr>
+            </table>
+        </div>
+{% endblock content_left_page %}

nautobot/cloud/templates/cloud/cloudnetwork_retrieve.html

@@ -0,0 +1,128 @@
+{% extends 'generic/object_retrieve.html' %}
+{% load helpers %}
+
+{% block extra_breadcrumbs %}
+    {% if object.parent %}
+        <li>{{ object.parent|hyperlinked_object:"name" }}</li>
+    {% endif %}
+{% endblock extra_breadcrumbs %}
+
+
+{% block extra_nav_tabs %}
+    {% if children_count %}
+            <li role="presentation"{% if request.GET.tab == 'children' %} class="active"{% endif %}>
+                <a href="{{ object.get_absolute_url }}#children" onclick="switch_tab(this.href, reload=false)" aria-controls="children" role="tab" data-toggle="tab">
+                    Children {% badge children_count %}
+                </a>
+            </li>
+    {% endif %}
+    {% if prefix_count %}
+        <li role="presentation"{% if request.GET.tab == 'prefixes' %} class="active"{% endif %}>
+            <a href="{{ object.get_absolute_url }}#prefixes" onclick="switch_tab(this.href, reload=false)" aria-controls="prefixes" role="tab" data-toggle="tab">
+                Prefixes {% badge prefix_count %}
+            </a>
+        </li>
+    {% endif %}
+    {% if circuit_count %}
+        <li role="presentation"{% if request.GET.tab == 'circuits' %} class="active"{% endif %}>
+            <a href="{{ object.get_absolute_url }}#circuits" onclick="switch_tab(this.href, reload=false)" aria-controls="circuits" role="tab" data-toggle="tab">
+                Circuits {% badge circuit_count %}
+            </a>
+        </li>
+    {% endif %}
+    {% if cloud_service_count %}
+        <li role="presentation"{% if request.GET.tab == 'cloud_services' %} class="active"{% endif %}>
+            <a href="{{ object.get_absolute_url }}#cloud_services" onclick="switch_tab(this.href, reload=false)" aria-controls="cloud_services" role="tab" data-toggle="tab">
+                Cloud Services {% badge cloud_service_count %}
+            </a>
+        </li>
+    {% endif %}
+{% endblock extra_nav_tabs %}
+
+{% block extra_tab_content %}
+    {% if children_count %}
+        <div id="children" role="tabpanel" class="tab-pane {% if not active_tab and not request.GET.tab or request.GET.tab == "children" %}active{% else %}fade{% endif %}">
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>Children</strong>
+                </div>
+                {% include 'inc/table.html' with table=children_table %}
+                {% if perms.cloud.add_cloudnetwork %}
+                    <div class="panel-footer text-right noprint">
+                        <a href="{% url 'cloud:cloudnetwork_add' %}?parent={{ object.pk }}" class="btn btn-xs btn-primary">
+                            <span class="mdi mdi-plus-thick" aria-hidden="true"></span> Add child
+                        </a>
+                    </div>
+                {% endif %}
+            </div>
+            {% include 'inc/paginator.html' with paginator=children_table.paginator page=children_table.page %}
+        </div>
+    {% endif %}
+    {% if prefix_count %}
+        <div id="prefixes" role="tabpanel" class="tab-pane {% if not active_tab and not request.GET.tab or request.GET.tab == "prefixes" %}active{% else %}fade{% endif %}">
+            {% include 'panel_table.html' with table=prefixes_table heading="Assigned Prefixes" %}
+            {% include 'inc/paginator.html' with paginator=prefixes_table.paginator page=prefixes_table.page %}
+        </div>
+    {% endif %}
+    {% if circuit_count %}
+        <div id="circuits" role="tabpanel" class="tab-pane {% if not active_tab and not request.GET.tab or request.GET.tab == "circuits" %}active{% else %}fade{% endif %}">
+            {% include 'panel_table.html' with table=circuits_table heading="Circuits" %}
+            {% include 'inc/paginator.html' with paginator=circuits_table.paginator page=circuits_table.page %}
+        </div>
+    {% endif %}
+    {% if cloud_service_count %}
+        <div id="cloud_services" role="tabpanel" class="tab-pane {% if not active_tab and not request.GET.tab or request.GET.tab == "cloud_services" %}active{% else %}fade{% endif %}">
+            {% include 'panel_table.html' with table=cloud_services_table heading="Cloud Services" %}
+            {% include 'inc/paginator.html' with paginator=cloud_services_table.paginator page=cloud_services_table.page %}
+        </div>
+    {% endif %}
+{% endblock extra_tab_content %}
+
+{% block content_left_page %}
+        <div class="panel panel-default">
+            <div class="panel-heading">
+                <strong>Cloud Network</strong>
+            </div>
+            <table class="table table-hover panel-body attr-table">
+                <tr>
+                    <td>Name</td>
+                    <td>
+                        {{ object.name }}
+                    </td>
+                </tr>
+                <tr>
+                    <td>Cloud Resource Type</td>
+                    <td>{{ object.cloud_resource_type|hyperlinked_object }}</td>
+                </tr>
+                <tr>
+                    <td>Cloud Account</td>
+                    <td>{{ object.cloud_account|hyperlinked_object }}</td>
+                </tr>
+                <tr>
+                    <td>Parent</td>
+                    <td>
+                        {% if object.parent %}
+                            {{ object.parent|hyperlinked_object }}
+                        {% else %}
+                            <span class="text-muted">&mdash;</span>
+                        {% endif %}
+                    </td>
+                </tr>
+                <tr>
+                    <td>Description</td>
+                    <td>{{ object.description|placeholder }}</td>
+                </tr>
+            </table>
+        </div>
+{% endblock content_left_page %}
+
+{% block content_right_page %}
+    <div class="panel panel-default">
+        <div class="panel-heading">
+            <strong>Extra Config</strong>
+        </div>
+        <div class="panel-body">
+            <pre>{{ object.extra_config|render_json }}</pre>
+        </div>
+    </div>
+{% endblock content_right_page %}