nautobot 3.0.0a3__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

nautobot/load_balancers/models.py

@@ -0,0 +1,423 @@
+"""Models for Load Balancer Models."""
+
+from django.db import models
+
+from nautobot.core.constants import CHARFIELD_MAX_LENGTH
+from nautobot.core.models import BaseModel
+from nautobot.core.models.generics import PrimaryModel
+from nautobot.extras.models import StatusField
+from nautobot.extras.utils import extras_features
+from nautobot.load_balancers import choices
+
+
+@extras_features("custom_links", "custom_validators", "export_templates", "graphql", "webhooks")
+class VirtualServer(PrimaryModel):  # pylint: disable=too-many-ancestors
+    """Virtual Server model for Load Balancer Models app."""
+
+    vip = models.ForeignKey(
+        to="ipam.IPAddress", on_delete=models.PROTECT, related_name="virtual_servers", verbose_name="VIP"
+    )
+    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
+    port = models.PositiveIntegerField(blank=True, null=True)
+    protocol = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True, choices=choices.ProtocolChoices)
+    source_nat_pool = models.ForeignKey(
+        to="ipam.Prefix",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+        related_name="virtual_servers",
+        verbose_name="Source NAT Pool",
+    )
+    source_nat_type = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        choices=choices.SourceNATTypeChoices,
+        blank=True,
+        verbose_name="Source NAT Type",
+    )
+    load_balancer_type = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH, choices=choices.LoadBalancerTypeChoices, blank=True
+    )
+    enabled = models.BooleanField(default=True)
+    ssl_offload = models.BooleanField(default=False, verbose_name="SSL Offload")
+    # Assignment to a device, device redundancy group, cloud service or virtual chassis
+    device = models.ForeignKey(
+        to="dcim.Device",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+        related_name="virtual_servers",
+    )
+    device_redundancy_group = models.ForeignKey(
+        to="dcim.DeviceRedundancyGroup",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+        related_name="virtual_servers",
+    )
+    cloud_service = models.ForeignKey(
+        to="cloud.CloudService",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+        related_name="virtual_servers",
+    )
+    virtual_chassis = models.ForeignKey(
+        to="dcim.VirtualChassis",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+        related_name="virtual_servers",
+    )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+        related_name="virtual_servers",
+    )
+    load_balancer_pool = models.ForeignKey(
+        to="load_balancers.LoadBalancerPool",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+        related_name="virtual_servers",
+    )
+    health_check_monitor = models.ForeignKey(
+        to="load_balancers.HealthCheckMonitor",
+        related_name="virtual_servers",
+        verbose_name="Health Check Monitor",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+    )
+    certificate_profiles = models.ManyToManyField(
+        to="load_balancers.CertificateProfile",
+        related_name="virtual_servers",
+        verbose_name="Certificate Profile",
+        blank=True,
+        through="load_balancers.VirtualServerCertificateProfileAssignment",
+    )
+
+    clone_fields = [
+        "port",
+        "protocol",
+        "source_nat_pool",
+        "source_nat_type",
+        "load_balancer_type",
+        "enabled",
+        "ssl_offload",
+        "device",
+        "device_redundancy_group",
+        "cloud_service",
+        "virtual_chassis",
+        "tenant",
+        "load_balancer_pool",
+        "health_check_monitor",
+    ]
+
+    class Meta:
+        """Meta class."""
+
+        ordering = ["name"]
+        unique_together = ["vip", "port", "protocol"]
+        verbose_name = "Virtual Server"
+
+    def __str__(self):
+        """Stringify instance."""
+        return self.name
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+    "webhooks",
+)
+class LoadBalancerPool(PrimaryModel):  # pylint: disable=too-many-ancestors
+    """LoadBalancerPool model for Load Balancer Models app."""
+
+    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
+    # We will attempt to use Constance for the load balancer algorithm options, or statically define in choices.
+    load_balancing_algorithm = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        choices=choices.LoadBalancingAlgorithmChoices,
+    )
+    health_check_monitor = models.ForeignKey(
+        to="load_balancers.HealthCheckMonitor",
+        related_name="load_balancer_pools",
+        verbose_name="Health Check Monitor",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+    )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        related_name="load_balancer_pools",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+    )
+
+    natural_key_field_names = ["pk"]
+    clone_fields = ["load_balancing_algorithm", "health_check_monitor", "tenant"]
+
+    class Meta:
+        """Meta class for LoadBalancerPool."""
+
+        ordering = ["name"]
+        verbose_name = "Load Balancer Pool"
+
+    def __str__(self):
+        """Stringify instance."""
+        return self.name
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+    "statuses",
+    "webhooks",
+)
+class LoadBalancerPoolMember(PrimaryModel):  # pylint: disable=too-many-ancestors
+    """LoadBalancerPoolMember model for load_balancers."""
+
+    label = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        blank=True,
+        help_text="Optional label for the load balancer pool member.",
+    )
+    ip_address = models.ForeignKey(
+        to="ipam.IPAddress",
+        related_name="load_balancer_pool_members",
+        on_delete=models.CASCADE,
+        verbose_name="IP Address",
+    )
+    load_balancer_pool = models.ForeignKey(
+        to="load_balancers.LoadBalancerPool",
+        related_name="load_balancer_pool_members",
+        on_delete=models.PROTECT,
+    )
+    port = models.PositiveIntegerField()
+    ssl_offload = models.BooleanField(
+        default=False,
+        verbose_name="SSL Offload",
+    )
+    health_check_monitor = models.ForeignKey(
+        to="load_balancers.HealthCheckMonitor",
+        related_name="load_balancer_pool_members",
+        verbose_name="Health Check Monitor",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+    )
+    certificate_profiles = models.ManyToManyField(
+        to="load_balancers.CertificateProfile",
+        related_name="load_balancer_pool_members",
+        verbose_name="Certificate Profile",
+        blank=True,
+        through="load_balancers.LoadBalancerPoolMemberCertificateProfileAssignment",
+    )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        related_name="load_balancer_pool_members",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+    )
+    status = StatusField(blank=False, null=False)
+
+    clone_fields = [
+        "load_balancer_pool",
+        "port",
+        "ssl_offload",
+        "health_check_monitor",
+        "tenant",
+        "status",
+    ]
+
+    class Meta:
+        """Meta class for LoadBalancerPoolMember."""
+
+        unique_together = ["ip_address", "port", "load_balancer_pool"]
+        verbose_name = "Load Balancer Pool Member"
+
+    def __str__(self):
+        """Stringify instance."""
+        return f"{self.ip_address.host}:{self.port}"
+
+    @property
+    def display(self):
+        """Return a string display of the object."""
+        return f"{self.ip_address.host}:{self.port}"
+
+
+@extras_features("custom_links", "custom_validators", "export_templates", "graphql", "webhooks")
+class HealthCheckMonitor(PrimaryModel):  # pylint: disable=too-many-ancestors
+    """HealthCheckMonitor model for load_balancers."""
+
+    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, unique=True)
+    interval = models.PositiveIntegerField(blank=True, null=True)
+    retry = models.PositiveIntegerField(blank=True, null=True, help_text="Number of retries before marking as down")
+    timeout = models.PositiveIntegerField(blank=True, null=True)
+    port = models.PositiveIntegerField(blank=True, null=True)
+    health_check_type = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        choices=choices.HealthCheckTypeChoices,
+        blank=True,
+    )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        related_name="health_check_monitors",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+    )
+    clone_fields = ["interval", "retry", "timeout", "port", "health_check_type", "tenant"]
+
+    class Meta:
+        """Meta class for HealthCheckMonitor."""
+
+        ordering = ["name"]
+        verbose_name = "Health Check Monitor"
+
+    def __str__(self):
+        """Stringify instance."""
+        return self.name
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+    "webhooks",
+)
+class CertificateProfile(PrimaryModel):  # pylint: disable=too-many-ancestors
+    """CertificateProfile model for load_balancers."""
+
+    name = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        unique=True,
+    )
+    certificate_type = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        choices=choices.CertificateTypeChoices,
+        blank=True,
+    )
+    certificate_file_path = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        blank=True,
+        verbose_name="Certificate file path",
+    )
+    chain_file_path = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        blank=True,
+        verbose_name="Chain file path",
+    )
+    key_file_path = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        blank=True,
+        verbose_name="Key file path",
+    )
+    expiration_date = models.DateTimeField(
+        blank=True,
+        null=True,
+    )
+    cipher = models.CharField(
+        max_length=CHARFIELD_MAX_LENGTH,
+        blank=True,
+    )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        related_name="certificate_profiles",
+        verbose_name="Tenant",
+        on_delete=models.PROTECT,
+        blank=True,
+        null=True,
+    )
+    clone_fields = [
+        "certificate_type",
+        "certificate_file_path",
+        "chain_file_path",
+        "key_file_path",
+        "expiration_date",
+        "cipher",
+        "tenant",
+    ]
+
+    class Meta:
+        """Meta class for CertificateProfile."""
+
+        ordering = ["name"]
+        verbose_name = "Certificate Profile"
+
+    def __str__(self):
+        """Stringify instance."""
+        return self.name
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+)
+class VirtualServerCertificateProfileAssignment(BaseModel):  # pylint: disable=too-many-ancestors
+    """VirtualServerCertificateProfileAssignment model for load_balancers."""
+
+    virtual_server = models.ForeignKey(
+        to="load_balancers.VirtualServer",
+        on_delete=models.CASCADE,
+        related_name="certificate_profile_assignments",
+    )
+    certificate_profile = models.ForeignKey(
+        to="load_balancers.CertificateProfile",
+        on_delete=models.CASCADE,
+        related_name="virtual_server_assignments",
+    )
+    is_metadata_associable_model = False
+
+    class Meta:
+        """Meta class for VirtualServerCertificateProfileAssignment."""
+
+        unique_together = ["virtual_server", "certificate_profile"]
+        ordering = ["virtual_server", "certificate_profile"]
+
+    def __str__(self):
+        """Stringify instance."""
+        return f"{self.virtual_server}: {self.certificate_profile}"
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+)
+class LoadBalancerPoolMemberCertificateProfileAssignment(BaseModel):  # pylint: disable=too-many-ancestors
+    """LoadBalancerPoolMemberCertificateProfileAssignment model for load_balancers."""
+
+    load_balancer_pool_member = models.ForeignKey(
+        to="load_balancers.LoadBalancerPoolMember",
+        on_delete=models.CASCADE,
+        related_name="certificate_profile_assignments",
+    )
+    certificate_profile = models.ForeignKey(
+        to="load_balancers.CertificateProfile",
+        on_delete=models.CASCADE,
+        related_name="load_balancer_pool_member_assignments",
+    )
+    is_metadata_associable_model = False
+
+    class Meta:
+        """Meta class for LoadBalancerPoolMemberCertificateProfileAssignment."""
+
+        unique_together = ["load_balancer_pool_member", "certificate_profile"]
+        ordering = ["load_balancer_pool_member", "certificate_profile"]
+
+    def __str__(self):
+        """Stringify instance."""
+        return f"{self.load_balancer_pool_member}: {self.certificate_profile}"

nautobot/load_balancers/navigation.py

@@ -0,0 +1,80 @@
+"""Menu items."""
+
+from nautobot.core.apps import NavMenuAddButton, NavMenuGroup, NavMenuItem, NavMenuTab
+from nautobot.core.ui.choices import NavigationIconChoices, NavigationWeightChoices
+
+menu_items = (
+    NavMenuTab(
+        name="Load Balancers",
+        icon=NavigationIconChoices.LOAD_BALANCERS,
+        weight=NavigationWeightChoices.LOAD_BALANCERS,
+        groups=(
+            NavMenuGroup(
+                name="Load Balancers",
+                weight=100,
+                items=(
+                    NavMenuItem(
+                        link="load_balancers:virtualserver_list",
+                        name="Virtual Servers",
+                        weight=100,
+                        permissions=["load_balancers.view_virtualserver"],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="load_balancers:virtualserver_add",
+                                permissions=["load_balancers.add_virtualserver"],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="load_balancers:loadbalancerpool_list",
+                        name="Load Balancer Pools",
+                        weight=200,
+                        permissions=["load_balancers.view_loadbalancerpool"],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="load_balancers:loadbalancerpool_add",
+                                permissions=["load_balancers.add_loadbalancerpool"],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="load_balancers:loadbalancerpoolmember_list",
+                        name="Load Balancer Pool Members",
+                        weight=300,
+                        permissions=["load_balancers.view_loadbalancerpoolmember"],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="load_balancers:loadbalancerpoolmember_add",
+                                permissions=["load_balancers.add_loadbalancerpoolmember"],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="load_balancers:healthcheckmonitor_list",
+                        name="Health Check Monitors",
+                        weight=400,
+                        permissions=["load_balancers.view_healthcheckmonitor"],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="load_balancers:healthcheckmonitor_add",
+                                permissions=["load_balancers.add_healthcheckmonitor"],
+                            ),
+                        ),
+                    ),
+                    NavMenuItem(
+                        link="load_balancers:certificateprofile_list",
+                        name="Certificate Profiles",
+                        weight=500,
+                        permissions=["load_balancers.view_certificateprofile"],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="load_balancers:certificateprofile_add",
+                                permissions=["load_balancers.add_certificateprofile"],
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+        ),
+    ),
+)