nautobot 2.2.8__py3-none-any.whl → 2.3.0__py3-none-any.whl

nautobot/cloud/forms.py

@@ -0,0 +1,339 @@
+import inspect
+
+from django import forms
+
+from nautobot.cloud.models import CloudAccount, CloudNetwork, CloudResourceType, CloudService
+from nautobot.core.constants import CHARFIELD_MAX_LENGTH
+from nautobot.core.forms import (
+    DynamicModelChoiceField,
+    DynamicModelMultipleChoiceField,
+    MultiValueCharField,
+    TagFilterField,
+)
+from nautobot.core.forms.fields import MultipleContentTypeField
+from nautobot.dcim.models import Manufacturer
+from nautobot.extras.forms import NautobotBulkEditForm, NautobotFilterForm, NautobotModelForm, TagsBulkEditFormMixin
+from nautobot.extras.models import SecretsGroup
+from nautobot.ipam.models import Namespace, Prefix
+
+#
+# Cloud Account
+#
+
+
+class CloudAccountForm(NautobotModelForm):
+    provider = DynamicModelChoiceField(
+        queryset=Manufacturer.objects.all(),
+        help_text="The Manufacturer instance which represents the Cloud Provider",
+    )
+    secrets_group = DynamicModelChoiceField(queryset=SecretsGroup.objects.all())
+
+    class Meta:
+        model = CloudAccount
+        fields = [
+            "account_number",
+            "name",
+            "description",
+            "provider",
+            "secrets_group",
+            "tags",
+        ]
+
+
+class CloudAccountBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(queryset=CloudAccount.objects.all(), widget=forms.MultipleHiddenInput)
+    secrets_group = DynamicModelChoiceField(queryset=SecretsGroup.objects.all(), required=False)
+    provider = DynamicModelChoiceField(queryset=Manufacturer.objects.all(), required=False)
+    description = forms.CharField(max_length=CHARFIELD_MAX_LENGTH, required=False)
+
+    class Meta:
+        nullable_fields = [
+            "secrets_group",
+            "description",
+        ]
+
+
+class CloudAccountFilterForm(NautobotFilterForm):
+    model = CloudAccount
+    field_order = [
+        "q",
+        "account_number",
+        "name",
+        "provider",
+        "secrets_group",
+        "tags",
+    ]
+    q = forms.CharField(required=False, label="Search")
+    name = MultiValueCharField(required=False)
+    account_number = MultiValueCharField(required=False)
+    secrets_group = DynamicModelMultipleChoiceField(
+        queryset=SecretsGroup.objects.all(), to_field_name="name", required=False
+    )
+    provider = DynamicModelMultipleChoiceField(
+        queryset=Manufacturer.objects.all(), to_field_name="name", required=False
+    )
+    tags = TagFilterField(model)
+
+
+#
+# Cloud Network
+#
+
+
+class CloudNetworkForm(NautobotModelForm):
+    cloud_resource_type = DynamicModelChoiceField(
+        queryset=CloudResourceType.objects.all(),
+        query_params={"content_types": [CloudNetwork._meta.label_lower]},
+    )
+    cloud_account = DynamicModelChoiceField(
+        queryset=CloudAccount.objects.all(),
+    )
+    cloud_services = DynamicModelMultipleChoiceField(
+        queryset=CloudService.objects.all(),
+        required=False,
+    )
+    parent = DynamicModelChoiceField(
+        queryset=CloudNetwork.objects.all(),
+        query_params={"parent__isnull": True},
+        required=False,
+    )
+    namespace = DynamicModelChoiceField(queryset=Namespace.objects.all(), required=False)
+    prefixes = DynamicModelMultipleChoiceField(
+        queryset=Prefix.objects.all(),
+        required=False,
+        query_params={"namespace": "$namespace"},
+    )
+
+    class Meta:
+        model = CloudNetwork
+        fields = [
+            "name",
+            "description",
+            "cloud_resource_type",
+            "cloud_account",
+            "parent",
+            "prefixes",
+            "extra_config",
+            "tags",
+        ]
+        EXTRA_CONFIG_HELP_TEXT = """
+            Optional user-defined <a href="https://json.org/">JSON</a> data for this integration. Example:
+            <pre><code class="language-json">{
+                "key": "value",
+                "key2": [
+                    "value1",
+                    "value2"
+                ]
+            }</code></pre>
+        """
+        help_texts = {
+            "extra_config": inspect.cleandoc(EXTRA_CONFIG_HELP_TEXT),
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if self.instance.present_in_database:
+            self.initial["cloud_services"] = self.instance.cloud_services.values_list("id", flat=True)
+
+    def save(self, *args, **kwargs):
+        instance = super().save(*args, **kwargs)
+        instance.cloud_services.set(self.cleaned_data["cloud_services"])
+        return instance
+
+
+class CloudNetworkBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(queryset=CloudNetwork.objects.all(), widget=forms.MultipleHiddenInput)
+    cloud_resource_type = DynamicModelChoiceField(
+        queryset=CloudResourceType.objects.all(),
+        query_params={"content_types": [CloudNetwork._meta.label_lower]},
+        required=False,
+    )
+    cloud_account = DynamicModelChoiceField(queryset=CloudAccount.objects.all(), required=False)
+    description = forms.CharField(max_length=CHARFIELD_MAX_LENGTH, required=False)
+    namespace = DynamicModelChoiceField(queryset=Namespace.objects.all(), required=False)
+    add_prefixes = DynamicModelMultipleChoiceField(
+        queryset=Prefix.objects.all(), required=False, query_params={"namespace": "$namespace"}
+    )
+    remove_prefixes = DynamicModelMultipleChoiceField(
+        queryset=Prefix.objects.all(), required=False, query_params={"namespace": "$namespace"}
+    )
+    add_cloud_services = DynamicModelMultipleChoiceField(queryset=CloudService.objects.all(), required=False)
+    remove_cloud_services = DynamicModelMultipleChoiceField(queryset=CloudService.objects.all(), required=False)
+
+    class Meta:
+        nullable_fields = [
+            "description",
+        ]
+
+
+class CloudNetworkFilterForm(NautobotFilterForm):
+    model = CloudNetwork
+    field_order = [
+        "q",
+        "name",
+        "cloud_resource_type",
+        "cloud_account",
+        "parent",
+        "tags",
+    ]
+    q = forms.CharField(required=False, label="Search")
+    name = MultiValueCharField(required=False)
+    cloud_resource_type = DynamicModelMultipleChoiceField(
+        queryset=CloudResourceType.objects.all(),
+        query_params={"content_types": [CloudNetwork._meta.label_lower]},
+        to_field_name="name",
+        required=False,
+    )
+    cloud_account = DynamicModelMultipleChoiceField(
+        queryset=CloudAccount.objects.all(), to_field_name="name", required=False
+    )
+    parent = DynamicModelMultipleChoiceField(
+        queryset=CloudNetwork.objects.all(),
+        query_params={"parent__isnull": True},
+        to_field_name="name",
+        required=False,
+    )
+    tags = TagFilterField(model)
+
+
+#
+# Cloud Resource Type
+#
+
+
+class CloudResourceTypeForm(NautobotModelForm):
+    provider = DynamicModelChoiceField(
+        queryset=Manufacturer.objects.all(),
+        help_text="The Manufacturer instance which represents the Cloud Provider",
+    )
+    content_types = MultipleContentTypeField(
+        feature="cloud_resource_types",
+        label="Content Type(s)",
+    )
+
+    class Meta:
+        model = CloudResourceType
+        fields = [
+            "name",
+            "description",
+            "provider",
+            "config_schema",
+            "content_types",
+            "tags",
+        ]
+
+
+class CloudResourceTypeBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(queryset=CloudResourceType.objects.all(), widget=forms.MultipleHiddenInput)
+    provider = DynamicModelChoiceField(queryset=Manufacturer.objects.all(), required=False)
+    content_types = MultipleContentTypeField(
+        feature="cloud_resource_types",
+        required=False,
+        label="Content Type(s)",
+    )
+    description = forms.CharField(max_length=CHARFIELD_MAX_LENGTH, required=False)
+
+    class Meta:
+        nullable_fields = [
+            "description",
+        ]
+
+
+class CloudResourceTypeFilterForm(NautobotFilterForm):
+    model = CloudResourceType
+    field_order = [
+        "q",
+        "name",
+        "provider",
+        "content_types",
+        "tags",
+    ]
+    q = forms.CharField(required=False, label="Search")
+    name = MultiValueCharField(required=False)
+    provider = DynamicModelMultipleChoiceField(
+        queryset=Manufacturer.objects.all(), to_field_name="name", required=False
+    )
+    content_types = MultipleContentTypeField(
+        feature="cloud_resource_types",
+        required=False,
+        choices_as_strings=True,
+        label="Content Type(s)",
+    )
+    tags = TagFilterField(model)
+
+
+#
+# Cloud Service
+#
+
+
+class CloudServiceForm(NautobotModelForm):
+    cloud_account = DynamicModelChoiceField(
+        queryset=CloudAccount.objects.all(),
+        required=False,
+    )
+    cloud_networks = DynamicModelMultipleChoiceField(
+        queryset=CloudNetwork.objects.all(),
+        required=False,
+    )
+    cloud_resource_type = DynamicModelChoiceField(
+        queryset=CloudResourceType.objects.all(),
+        query_params={"content_types": [CloudService._meta.label_lower]},
+    )
+
+    class Meta:
+        model = CloudService
+        fields = [
+            "name",
+            "description",
+            "cloud_resource_type",
+            "cloud_account",
+            "cloud_networks",
+            "extra_config",
+            "tags",
+        ]
+
+
+class CloudServiceBulkEditForm(TagsBulkEditFormMixin, NautobotBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(queryset=CloudService.objects.all(), widget=forms.MultipleHiddenInput)
+    description = forms.CharField(max_length=CHARFIELD_MAX_LENGTH, required=False)
+    cloud_resource_type = DynamicModelChoiceField(
+        queryset=CloudResourceType.objects.all(),
+        query_params={"content_types": [CloudService._meta.label_lower]},
+        required=False,
+    )
+    cloud_account = DynamicModelChoiceField(queryset=CloudAccount.objects.all(), required=False)
+    add_cloud_networks = DynamicModelMultipleChoiceField(queryset=CloudNetwork.objects.all(), required=False)
+    remove_cloud_networks = DynamicModelMultipleChoiceField(queryset=CloudNetwork.objects.all(), required=False)
+    extra_config = forms.JSONField(required=False)
+
+    class Meta:
+        nullable_fields = ["cloud_account", "description", "extra_config"]
+
+
+class CloudServiceFilterForm(NautobotFilterForm):
+    model = CloudService
+    field_order = [
+        "q",
+        "name",
+        "cloud_account",
+        "cloud_networks",
+        "cloud_resource_type",
+        "tags",
+    ]
+    q = forms.CharField(required=False, label="Search")
+    name = MultiValueCharField(required=False)
+    cloud_account = DynamicModelMultipleChoiceField(
+        queryset=CloudAccount.objects.all(), to_field_name="name", required=False
+    )
+    cloud_networks = DynamicModelMultipleChoiceField(
+        queryset=CloudNetwork.objects.all(), to_field_name="name", required=False
+    )
+    cloud_resource_type = DynamicModelMultipleChoiceField(
+        queryset=CloudResourceType.objects.all(),
+        query_params={"content_types": [CloudService._meta.label_lower]},
+        to_field_name="name",
+        required=False,
+    )
+    tags = TagFilterField(model)

nautobot/cloud/homepage.py

@@ -0,0 +1,43 @@
+from nautobot.cloud.models import CloudAccount, CloudNetwork, CloudResourceType, CloudService
+from nautobot.core.apps import HomePageItem, HomePagePanel
+
+layout = (
+    HomePagePanel(
+        name="Cloud",
+        weight=500,
+        items=(
+            HomePageItem(
+                name="Cloud Accounts",
+                link="cloud:cloudaccount_list",
+                model=CloudAccount,
+                description="Account tracking for public and private cloud providers",
+                permissions=["cloud.view_cloudaccount"],
+                weight=100,
+            ),
+            HomePageItem(
+                name="Cloud Resource Types",
+                link="cloud:cloudresourcetype_list",
+                model=CloudResourceType,
+                description="Resource types for public and private cloud providers",
+                permissions=["cloud.view_cloudresourcetype"],
+                weight=200,
+            ),
+            HomePageItem(
+                name="Cloud Networks",
+                link="cloud:cloudnetwork_list",
+                model=CloudNetwork,
+                description="Networks for public and private cloud providers",
+                permissions=["cloud.view_cloudnetwork"],
+                weight=300,
+            ),
+            HomePageItem(
+                name="Cloud Services",
+                link="cloud:cloudservice_list",
+                model=CloudService,
+                description="Services for public and private cloud providers",
+                permissions=["cloud.view_cloudservice"],
+                weight=400,
+            ),
+        ),
+    ),
+)

nautobot/cloud/migrations/0001_initial.py

@@ -0,0 +1,304 @@
+# Generated by Django 4.2.14 on 2024-07-18 16:08
+
+import uuid
+
+import django.core.serializers.json
+from django.db import migrations, models
+import django.db.models.deletion
+
+import nautobot.core.models.fields
+import nautobot.extras.models.mixins
+import nautobot.extras.utils
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("ipam", "0047_alter_ipaddress_role_alter_ipaddress_status_and_more"),
+        ("dcim", "0062_module_data_migration"),
+        ("extras", "0113_saved_views"),
+        ("contenttypes", "0002_remove_content_type_name"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="CloudAccount",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "_custom_field_data",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("name", models.CharField(max_length=255, unique=True)),
+                ("description", models.CharField(blank=True, max_length=255)),
+                ("account_number", models.CharField(max_length=255)),
+                (
+                    "provider",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="cloud_accounts",
+                        to="dcim.manufacturer",
+                    ),
+                ),
+                (
+                    "secrets_group",
+                    models.ForeignKey(
+                        blank=True,
+                        default=None,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to="extras.secretsgroup",
+                    ),
+                ),
+                ("tags", nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag")),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+            bases=(
+                nautobot.extras.models.mixins.DynamicGroupMixin,
+                nautobot.extras.models.mixins.NotesMixin,
+                models.Model,
+            ),
+        ),
+        migrations.CreateModel(
+            name="CloudNetwork",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "_custom_field_data",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("extra_config", models.JSONField(blank=True, null=True)),
+                ("name", models.CharField(max_length=255, unique=True)),
+                ("description", models.CharField(blank=True, max_length=255)),
+                (
+                    "cloud_account",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="cloud_networks",
+                        to="cloud.cloudaccount",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+            bases=(
+                nautobot.extras.models.mixins.DynamicGroupMixin,
+                nautobot.extras.models.mixins.NotesMixin,
+                models.Model,
+            ),
+        ),
+        migrations.CreateModel(
+            name="CloudResourceType",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "_custom_field_data",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("name", models.CharField(max_length=255, unique=True)),
+                ("description", models.CharField(blank=True, max_length=255)),
+                ("config_schema", models.JSONField(blank=True, null=True)),
+                (
+                    "content_types",
+                    models.ManyToManyField(
+                        limit_choices_to=nautobot.extras.utils.FeatureQuery("cloud_resource_types"),
+                        related_name="cloud_resource_types",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+                (
+                    "provider",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="cloud_resource_types",
+                        to="dcim.manufacturer",
+                    ),
+                ),
+                ("tags", nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag")),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+            bases=(
+                nautobot.extras.models.mixins.DynamicGroupMixin,
+                nautobot.extras.models.mixins.NotesMixin,
+                models.Model,
+            ),
+        ),
+        migrations.CreateModel(
+            name="CloudService",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "_custom_field_data",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("extra_config", models.JSONField(blank=True, null=True)),
+                ("name", models.CharField(max_length=255, unique=True)),
+                ("description", models.CharField(blank=True, max_length=255)),
+                (
+                    "cloud_account",
+                    models.ForeignKey(
+                        blank=True,
+                        default=None,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="cloud_services",
+                        to="cloud.cloudaccount",
+                    ),
+                ),
+                (
+                    "cloud_resource_type",
+                    nautobot.core.models.fields.ForeignKeyLimitedByContentTypes(
+                        on_delete=django.db.models.deletion.PROTECT, to="cloud.cloudresourcetype"
+                    ),
+                ),
+                ("tags", nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag")),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+            bases=(
+                nautobot.extras.models.mixins.DynamicGroupMixin,
+                nautobot.extras.models.mixins.NotesMixin,
+                models.Model,
+            ),
+        ),
+        migrations.CreateModel(
+            name="CloudNetworkPrefixAssignment",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                (
+                    "cloud_network",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="prefix_assignments",
+                        to="cloud.cloudnetwork",
+                    ),
+                ),
+                (
+                    "prefix",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="cloud_network_assignments",
+                        to="ipam.prefix",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["cloud_network", "prefix"],
+                "unique_together": {("cloud_network", "prefix")},
+            },
+        ),
+        migrations.CreateModel(
+            name="CloudServiceNetworkAssignment",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                (
+                    "cloud_network",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="cloud_service_assignments",
+                        to="cloud.cloudnetwork",
+                    ),
+                ),
+                (
+                    "cloud_service",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="cloud_network_assignments",
+                        to="cloud.cloudservice",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["cloud_network", "cloud_service"],
+                "unique_together": {("cloud_network", "cloud_service")},
+            },
+        ),
+        migrations.AddField(
+            model_name="cloudnetwork",
+            name="cloud_resource_type",
+            field=nautobot.core.models.fields.ForeignKeyLimitedByContentTypes(
+                on_delete=django.db.models.deletion.PROTECT, to="cloud.cloudresourcetype"
+            ),
+        ),
+        migrations.AddField(
+            model_name="cloudnetwork",
+            name="parent",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="children",
+                to="cloud.cloudnetwork",
+            ),
+        ),
+        migrations.AddField(
+            model_name="cloudnetwork",
+            name="prefixes",
+            field=models.ManyToManyField(
+                blank=True,
+                related_name="cloud_networks",
+                through="cloud.CloudNetworkPrefixAssignment",
+                to="ipam.prefix",
+            ),
+        ),
+        migrations.AddField(
+            model_name="cloudnetwork",
+            name="tags",
+            field=nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag"),
+        ),
+        migrations.AddField(
+            model_name="cloudservice",
+            name="cloud_networks",
+            field=models.ManyToManyField(
+                blank=True,
+                related_name="cloud_services",
+                through="cloud.CloudServiceNetworkAssignment",
+                to="cloud.cloudnetwork",
+            ),
+        ),
+    ]