netbox-docker-plugin 1.3.1__tar.gz → 1.5.0__tar.gz

{netbox-docker-plugin-1.3.1/netbox_docker_plugin.egg-info → netbox-docker-plugin-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 1.3.1
+Version: 1.5.0
 Summary: Manage Docker with Netbox & style.
 Author-email: Vincent Simonin <vincent@saashup.com>
 Project-URL: Homepage, https://github.com/SaaShup/netbox-docker-plugin

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/__init__.py

@@ -10,7 +10,7 @@ class NetBoxDockerConfig(PluginConfig):
     name = "netbox_docker_plugin"
     verbose_name = " NetBox Docker Plugin"
     description = "Manage Docker"
-    version = "1.3.1"
+    version = "1.5.0"
     base_url = "docker"
     author= "Vincent Simonin"
     author_email= "vincent@saashup.com"

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/api/serializers.py

@@ -9,7 +9,15 @@ from ..models.host import Host
 from ..models.image import Image
 from ..models.volume import Volume
 from ..models.network import Network
-from ..models.container import Container, Port, Env, Label, Mount, NetworkSetting
+from ..models.container import (
+    Container,
+    Port,
+    Env,
+    Label,
+    Mount,
+    Bind,
+    NetworkSetting,
+)
 from ..models.registry import Registry
 
 
@@ -316,6 +324,19 @@ class MountSerializer(serializers.ModelSerializer):
         )
 
 
+class BindSerializer(serializers.ModelSerializer):
+    """Container Bind Serializer class"""
+
+    class Meta:
+        """Container Bind Serializer Meta class"""
+
+        model = Bind
+        fields = (
+            "host_path",
+            "container_path",
+        )
+
+
 class NetworkSettingSerializer(serializers.ModelSerializer):
     """Container NetworkSetting Serializer class"""
 
@@ -340,6 +361,7 @@ class ContainerSerializer(NetBoxModelSerializer):
     env = EnvSerializer(many=True, required=False)
     labels = LabelSerializer(many=True, required=False)
     mounts = MountSerializer(many=True, required=False)
+    binds = BindSerializer(many=True, required=False)
     network_settings = NetworkSettingSerializer(many=True, required=False)
 
     class Meta:
@@ -361,6 +383,7 @@ class ContainerSerializer(NetBoxModelSerializer):
             "env",
             "labels",
             "mounts",
+            "binds",
             "network_settings",
             "custom_fields",
             "created",
@@ -374,6 +397,7 @@ class ContainerSerializer(NetBoxModelSerializer):
         attrs.pop("env", None)
         attrs.pop("labels", None)
         attrs.pop("mounts", None)
+        attrs.pop("binds", None)
         attrs.pop("network_settings", None)
 
         super().validate(attrs)
@@ -385,6 +409,7 @@ class ContainerSerializer(NetBoxModelSerializer):
         env_data = validated_data.pop("env", None)
         labels_data = validated_data.pop("labels", None)
         mounts_data = validated_data.pop("mounts", None)
+        binds_data = validated_data.pop("binds", None)
         network_settings_data = validated_data.pop("network_settings", None)
 
         container = super().create(validated_data)
@@ -407,6 +432,12 @@ class ContainerSerializer(NetBoxModelSerializer):
                 obj.full_clean()
                 obj.save()
 
+        if binds_data is not None:
+            for bind in binds_data:
+                obj = Bind(container=container, **bind)
+                obj.full_clean()
+                obj.save()
+
         if network_settings_data is not None:
             for network_setting in network_settings_data:
                 obj = NetworkSetting(container=container, **network_setting)
@@ -420,6 +451,7 @@ class ContainerSerializer(NetBoxModelSerializer):
         env_data = validated_data.pop("env", None)
         labels_data = validated_data.pop("labels", None)
         mounts_data = validated_data.pop("mounts", None)
+        binds_data = validated_data.pop("binds", None)
         network_settings_data = validated_data.pop("network_settings", None)
 
         container = super().update(instance, validated_data)
@@ -446,6 +478,13 @@ class ContainerSerializer(NetBoxModelSerializer):
                 obj.full_clean()
                 obj.save()
 
+        Bind.objects.filter(container=container).delete()
+        if binds_data is not None:
+            for bind in binds_data:
+                obj = Bind(container=container, **bind)
+                obj.full_clean()
+                obj.save()
+
         NetworkSetting.objects.filter(container=container).delete()
         if network_settings_data is not None:
             for network_setting in network_settings_data:
@@ -462,6 +501,7 @@ class RegistrySerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_docker_plugin-api:registry-detail"
     )
+    host = NestedHostSerializer()
     images = NestedImageSerializer(many=True, read_only=True)
 
     class Meta:
@@ -472,6 +512,7 @@ class RegistrySerializer(NetBoxModelSerializer):
             "id",
             "name",
             "url",
+            "host",
             "display",
             "serveraddress",
             "username",
@@ -491,6 +532,7 @@ class HostSerializer(NetBoxModelSerializer):
     volumes = NestedVolumeSerializer(many=True, read_only=True)
     networks = NestedNetworkSerializer(many=True, read_only=True)
     containers = NestedContainerSerializer(many=True, read_only=True)
+    registries = NestedRegistrySerializer(many=True, read_only=True)
     token = NestedTokenSerializer(read_only=True)
 
     class Meta:
@@ -516,4 +558,5 @@ class HostSerializer(NetBoxModelSerializer):
             "volumes",
             "networks",
             "containers",
+            "registries",
         )

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/api/views.py

@@ -23,7 +23,9 @@ from ..models.registry import Registry
 class HostViewSet(NetBoxModelViewSet):
     """Host view set class"""
 
-    queryset = Host.objects.prefetch_related("images", "volumes", "tags")
+    queryset = Host.objects.prefetch_related(
+        "images", "volumes", "networks", "containers", "registries", "tags"
+    )
     filterset_class = filtersets.HostFilterSet
     serializer_class = HostSerializer
     http_method_names = ["get", "post", "patch", "delete", "options"]
@@ -79,7 +81,15 @@ class ContainerViewSet(NetBoxModelViewSet):
     """Container view set class"""
 
     queryset = Container.objects.prefetch_related(
-        "network_settings", "mounts", "env", "image", "host", "ports", "labels", "tags"
+        "network_settings",
+        "mounts",
+        "binds",
+        "env",
+        "image",
+        "host",
+        "ports",
+        "labels",
+        "tags",
     )
     filterset_class = filtersets.ContainerFilterSet
     serializer_class = ContainerSerializer
@@ -89,7 +99,7 @@ class ContainerViewSet(NetBoxModelViewSet):
 class RegistryViewSet(NetBoxModelViewSet):
     """Registry view set class"""
 
-    queryset = Registry.objects.prefetch_related("images", "tags")
+    queryset = Registry.objects.prefetch_related("host", "images", "tags")
     filterset_class = filtersets.RegistryFilterSet
     serializer_class = RegistrySerializer
     http_method_names = ["get", "post", "patch", "delete", "options"]

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/filtersets.py

@@ -7,7 +7,15 @@ from .models.host import Host
 from .models.image import Image
 from .models.volume import Volume
 from .models.network import Network
-from .models.container import Container, Env, Label, Port, Mount, NetworkSetting
+from .models.container import (
+    Container,
+    Env,
+    Label,
+    Port,
+    Mount,
+    Bind,
+    NetworkSetting,
+)
 from .models.registry import Registry
 
 
@@ -41,6 +49,11 @@ class RegistryFilterSet(NetBoxModelFilterSet):
     """Registry filterset definition class"""
 
     name = filters.CharFilter(lookup_expr="icontains")
+    host_id = ModelMultipleChoiceFilter(
+        field_name="host_id",
+        queryset=Host.objects.all(),
+        label="Host (ID)",
+    )
 
     class Meta:
         """Registry filterset definition meta class"""
@@ -240,6 +253,22 @@ class MountFilterSet(BaseFilterSet):
         fields = ("id",)
 
 
+class BindFilterSet(BaseFilterSet):
+    """Bind filterset definition class"""
+
+    container_id = ModelMultipleChoiceFilter(
+        field_name="container_id",
+        queryset=Container.objects.all(),
+        label="Container (ID)",
+    )
+
+    class Meta:
+        """Bind filterset definition meta class"""
+
+        model = Bind
+        fields = ("id",)
+
+
 class NetworkSettingFilterSet(BaseFilterSet):
     """NetworkSetting filterset definition class"""
 

netbox-docker-plugin-1.5.0/netbox_docker_plugin/forms/bind.py

@@ -0,0 +1,46 @@
+"""Mount Form definition"""
+
+from django import forms
+from utilities.forms.mixins import BootstrapMixin
+from utilities.forms.fields import (
+    DynamicModelMultipleChoiceField,
+    DynamicModelChoiceField,
+)
+from netbox.forms import (
+    NetBoxModelFilterSetForm,
+)
+from ..models.container import Bind, Container
+
+
+class BindForm(BootstrapMixin, forms.ModelForm):
+    """Bind form definition class"""
+
+    container = DynamicModelChoiceField(
+        label="Container", queryset=Container.objects.all(), required=True
+    )
+
+    class Meta:
+        """Mount form definition Meta class"""
+
+        model = Bind
+        fields = (
+            "container",
+            "host_path",
+            "container_path",
+        )
+        labels = {
+            "container": "Container",
+            "host_path": "Path to mount on host",
+            "container_path": "Mountpoint in container",
+        }
+
+
+class BindFilterForm(NetBoxModelFilterSetForm):
+    """Bind filter form definition class"""
+
+    model = Bind
+    container_id = DynamicModelMultipleChoiceField(
+        queryset=Container.objects.all(),
+        required=False,
+        label="Container",
+    )

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/forms/image.py

@@ -1,7 +1,11 @@
 """Image Forms definitions"""
 
 from django import forms
-from utilities.forms.fields import TagFilterField, DynamicModelMultipleChoiceField
+from utilities.forms.fields import (
+    TagFilterField,
+    DynamicModelMultipleChoiceField,
+    DynamicModelChoiceField,
+)
 from netbox.forms import (
     NetBoxModelForm,
     NetBoxModelImportForm,
@@ -16,6 +20,16 @@ from ..models.registry import Registry
 class ImageForm(NetBoxModelForm):
     """Image form definition class"""
 
+    host = DynamicModelChoiceField(
+        label="Host", queryset=Host.objects.all(), required=True
+    )
+    registry = DynamicModelChoiceField(
+        label="Registry",
+        queryset=Registry.objects.all(),
+        required=True,
+        query_params={"host_id": "$host"},
+    )
+
     class Meta:
         """Image form definition Meta class"""
 

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/forms/registry.py

@@ -1,12 +1,13 @@
 """Registry Forms definitions"""
 
 from django import forms
-from utilities.forms.fields import TagFilterField
+from utilities.forms.fields import TagFilterField, DynamicModelMultipleChoiceField
 from netbox.forms import (
     NetBoxModelForm,
     NetBoxModelFilterSetForm,
 )
 from ..models.registry import Registry
+from ..models.host import Host
 
 
 class RegistryForm(NetBoxModelForm):
@@ -24,6 +25,7 @@ class RegistryForm(NetBoxModelForm):
 
         model = Registry
         fields = (
+            "host",
             "name",
             "serveraddress",
             "username",
@@ -39,5 +41,10 @@ class RegistryFilterForm(NetBoxModelFilterSetForm):
     """Registry filter form definition class"""
 
     model = Registry
+    host_id = DynamicModelMultipleChoiceField(
+        queryset=Host.objects.all(),
+        required=False,
+        label="Host",
+    )
     name = forms.CharField(label="Name", required=False)
     tag = TagFilterField(model)

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/migrations/0021_registry_and_more.py

@@ -6,7 +6,6 @@ import utilities.json
 import django.core.validators
 from django.db import migrations, models
 import django.db.models.deletion
-import netbox_docker_plugin.models.registry
 
 
 class Migration(migrations.Migration):
@@ -60,7 +59,6 @@ class Migration(migrations.Migration):
             model_name="image",
             name="registry",
             field=models.ForeignKey(
-                default=netbox_docker_plugin.models.registry.Registry.get_default_registry,
                 on_delete=django.db.models.deletion.CASCADE,
                 related_name="images",
                 to="netbox_docker_plugin.registry",

netbox-docker-plugin-1.5.0/netbox_docker_plugin/migrations/0022_bind_bind_netbox_docker_plugin_bind_unique_bind.py

@@ -0,0 +1,74 @@
+# pylint: disable=C0103
+""" Migration file """
+
+import django.core.validators
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """ Migration file """
+
+    dependencies = [
+        ("netbox_docker_plugin", "0021_registry_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Bind",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                (
+                    "host_path",
+                    models.CharField(
+                        max_length=1024,
+                        validators=[
+                            django.core.validators.MinLengthValidator(
+                                limit_value=1,
+                            ),
+                            django.core.validators.MaxLengthValidator(
+                                limit_value=1024,
+                            ),
+                        ],
+                    ),
+                ),
+                (
+                    "container_path",
+                    models.CharField(
+                        max_length=1024,
+                        validators=[
+                            django.core.validators.MinLengthValidator(
+                                limit_value=1,
+                            ),
+                            django.core.validators.MaxLengthValidator(
+                                limit_value=1024,
+                            ),
+                        ],
+                    ),
+                ),
+                (
+                    "container",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="binds",
+                        to="netbox_docker_plugin.container",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("container", "container_path", "host_path"),
+            },
+        ),
+        migrations.AddConstraint(
+            model_name="bind",
+            constraint=models.UniqueConstraint(
+                fields=("container", "container_path", "host_path"),
+                name="netbox_docker_plugin_bind_unique_bind",
+            ),
+        ),
+    ]

netbox-docker-plugin-1.5.0/netbox_docker_plugin/migrations/0023_delete_hosts.py

@@ -0,0 +1,33 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+from django.db import migrations
+
+
+def delete_hosts(apps, schema_editor):
+    """Delete all Hosts and Registries"""
+    Host = apps.get_model("netbox_docker_plugin", "Host")
+    Host.objects.using(schema_editor.connection.alias).all().delete()
+
+    Registry = Host = apps.get_model("netbox_docker_plugin", "Registry")
+    Registry.objects.using(schema_editor.connection.alias).all().delete()
+
+
+def do_nothing(apps, schema_editor): # pylint: disable=W0613
+    """Nothing to do"""
+    return None
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        (
+            "netbox_docker_plugin",
+            "0022_bind_bind_netbox_docker_plugin_bind_unique_bind",
+        ),
+    ]
+
+    operations = [
+        migrations.RunPython(delete_hosts, do_nothing),
+    ]

netbox-docker-plugin-1.5.0/netbox_docker_plugin/migrations/0024_registry_host_alter_registry_name_and_more.py

@@ -0,0 +1,47 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+import django.core.validators
+from django.db import migrations, models
+import django.db.models.deletion
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        (
+            "netbox_docker_plugin",
+            "0023_delete_hosts",
+        ),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="registry",
+            name="host",
+            field=models.ForeignKey(
+                default=None,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="registries",
+                to="netbox_docker_plugin.host",
+            ),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name="registry",
+            name="name",
+            field=models.CharField(
+                max_length=255,
+                validators=[
+                    django.core.validators.MinLengthValidator(limit_value=1),
+                    django.core.validators.MaxLengthValidator(limit_value=255),
+                ],
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="registry",
+            constraint=models.UniqueConstraint(
+                fields=("host", "name"), name="netbox_docker_plugin_registry_name_host"
+            ),
+        ),
+    ]

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/models/container.py

@@ -307,6 +307,44 @@ class Mount(models.Model):
             )
 
 
+class Bind(models.Model):
+    """Bind definition class"""
+
+    objects = RestrictedQuerySet.as_manager()
+
+    container = models.ForeignKey(
+        Container, on_delete=models.CASCADE, related_name="binds"
+    )
+    host_path = models.CharField(
+        max_length=1024,
+        validators=[
+            MinLengthValidator(limit_value=1),
+            MaxLengthValidator(limit_value=1024),
+        ],
+    )
+    container_path = models.CharField(
+        max_length=1024,
+        validators=[
+            MinLengthValidator(limit_value=1),
+            MaxLengthValidator(limit_value=1024),
+        ],
+    )
+
+    class Meta:
+        """Mount Model Meta Class"""
+
+        ordering = ("container", "container_path", "host_path")
+        constraints = (
+            models.UniqueConstraint(
+                fields=["container", "container_path", "host_path"],
+                name="%(app_label)s_%(class)s_unique_bind",
+            ),
+        )
+
+    def __str__(self):
+        return f"{self.host_path}:{self.container_path}"
+
+
 class NetworkSetting(models.Model):
     """NetworkSetting definition class"""
 

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/models/image.py

@@ -19,7 +19,6 @@ class Image(NetBoxModel):
     host = models.ForeignKey(Host, on_delete=models.CASCADE, related_name="images")
     registry = models.ForeignKey(
         Registry,
-        default=Registry.get_default_registry,  # type: ignore
         on_delete=models.CASCADE,
         related_name="images",
     )

{netbox-docker-plugin-1.3.1 → netbox-docker-plugin-1.5.0}/netbox_docker_plugin/models/registry.py

@@ -1,19 +1,35 @@
 """Registry Model definition"""
 
 from django.db import models
+from django.db.models.signals import post_save
+from django.dispatch import receiver
 from django.core.validators import (
     MinLengthValidator,
     MaxLengthValidator,
 )
 from django.urls import reverse
 from netbox.models import NetBoxModel
+from .host import Host
+
+
+@receiver(post_save, sender=Host)
+def create_default_registry(sender, **kwargs): # pylint: disable=W0613
+    """Create default registry on Host creation"""
+
+    if kwargs.get("created") is True:
+        registry = Registry(
+            host=kwargs.get("instance"),
+            name="dockerhub",
+            serveraddress="https://registry.hub.docker.com/v2/",
+        )
+        registry.save()
 
 
 class Registry(NetBoxModel):
     """Registry definition class"""
 
+    host = models.ForeignKey(Host, on_delete=models.CASCADE, related_name="registries")
     name = models.CharField(
-        unique=True,
         max_length=255,
         validators=[
             MinLengthValidator(limit_value=1),
@@ -25,20 +41,16 @@ class Registry(NetBoxModel):
     password = models.CharField(blank=True, null=True, max_length=512)
     email = models.EmailField(blank=True, null=True, max_length=512)
 
-    @classmethod
-    def get_default_registry(cls):
-        """Return the default Registry"""
-        # pylint: disable=W0612
-        registry, created = cls.objects.get_or_create(
-            name="dockerhub",
-            serveraddress="https://registry.hub.docker.com/v2/",
-        )
-        return registry.pk
-
     class Meta:
         """Registry Model Meta Class"""
 
         ordering = ("name",)
+        constraints = (
+            models.UniqueConstraint(
+                fields=["host", "name"],
+                name="%(app_label)s_%(class)s_name_host",
+            ),
+        )
 
     def __str__(self):
         return f"{self.name}"