netbox-docker-plugin 1.3.0__tar.gz → 1.4.0__tar.gz

{netbox-docker-plugin-1.3.0/netbox_docker_plugin.egg-info → netbox-docker-plugin-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 1.3.0
+Version: 1.4.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.0 → netbox-docker-plugin-1.4.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.0"
+    version = "1.4.0"
     base_url = "docker"
     author= "Vincent Simonin"
     author_email= "vincent@saashup.com"

{netbox-docker-plugin-1.3.0 → netbox-docker-plugin-1.4.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
 
 
@@ -179,7 +187,7 @@ class ImageSerializer(NetBoxModelSerializer):
     )
     host = NestedHostSerializer()
     containers = NestedContainerSerializer(many=True, read_only=True)
-    registry = NestedRegistrySerializer(read_only=True)
+    registry = NestedRegistrySerializer()
 
     class Meta:
         """Image Serializer Meta class"""
@@ -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:

{netbox-docker-plugin-1.3.0 → netbox-docker-plugin-1.4.0}/netbox_docker_plugin/api/views.py

@@ -79,7 +79,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

{netbox-docker-plugin-1.3.0 → netbox-docker-plugin-1.4.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
 
 
@@ -240,6 +248,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.4.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.4.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.3.0 → netbox-docker-plugin-1.4.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.0 → netbox-docker-plugin-1.4.0}/netbox_docker_plugin/tables.py

@@ -6,7 +6,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
 from .templatetags.host import remove_password
 
@@ -211,6 +219,11 @@ class ContainerTable(NetBoxTable):
         url_params={"container_id": "pk"},
         verbose_name="Mounts count",
     )
+    bind_count = columns.LinkedCountColumn(
+        viewname="plugins:netbox_docker_plugin:bind_list",
+        url_params={"container_id": "pk"},
+        verbose_name="Binds count",
+    )
     networksetting_count = columns.LinkedCountColumn(
         viewname="plugins:netbox_docker_plugin:networksetting_list",
         url_params={"container_id": "pk"},
@@ -244,6 +257,7 @@ class ContainerTable(NetBoxTable):
             "hostname",
             "port_count",
             "mount_count",
+            "bind_count",
             "networksetting_count",
             "env_count",
             "label_count",
@@ -256,6 +270,7 @@ class ContainerTable(NetBoxTable):
             "state",
             "port_count",
             "mount_count",
+            "bind_count",
             "networksetting_count",
             "env_count",
             "label_count",
@@ -323,6 +338,21 @@ class MountTable(NetBoxTable):
         default_columns = ("container", "source", "volume")
 
 
+class BindTable(NetBoxTable):
+    """Bind Table definition class"""
+
+    container = tables.Column(linkify=True)
+
+    actions = columns.ActionsColumn(actions=("edit", "delete"))
+
+    class Meta(NetBoxTable.Meta):
+        """Bind Table definition Meta class"""
+
+        model = Bind
+        fields = ("container", "host_path", "container_path")
+        default_columns = ("container", "host_path", "container_path")
+
+
 class NetworkSettingTable(NetBoxTable):
     """NetworkSetting Table definition class"""
 

{netbox-docker-plugin-1.3.0 → netbox-docker-plugin-1.4.0}/netbox_docker_plugin/templates/netbox_docker_plugin/container.html

@@ -111,6 +111,20 @@
         </div>
       {% endif %}
     </div>
+    <div class="card">
+      <h5 class="card-header">BINDS</h5>
+      <div class="card-body htmx-container table-responsive"
+        hx-get="{% url 'plugins:netbox_docker_plugin:bind_list' %}?container_id={{ object.pk }}"
+        hx-trigger="load"
+      ></div>
+      {% if perms.netbox_docker_plugin.add_env %}
+        <div class="card-footer text-end noprint">
+          <a href="{% url 'plugins:netbox_docker_plugin:bind_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary btn-sm">
+            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> New Bind
+          </a>
+        </div>
+      {% endif %}
+    </div>
     <div class="card">
       <h5 class="card-header">NETWORK SETTINGS</h5>
       <div class="card-body htmx-container table-responsive"

{netbox-docker-plugin-1.3.0 → netbox-docker-plugin-1.4.0}/netbox_docker_plugin/tests/container/test_container_api.py

@@ -35,6 +35,7 @@ class ContainerApiTestCase(
         "env",
         "labels",
         "mounts",
+        "binds",
         "network_settings",
     ]
 
@@ -78,6 +79,9 @@ class ContainerApiTestCase(
                     {"source": "/data", "volume": volume1.pk},
                     {"source": "/etc", "volume": volume2.pk},
                 ],
+                "binds": [
+                    {"host_path": "/opt/ct5/data", "container_path": "/data"},
+                ],
                 "network_settings": [
                     {"network": network1.pk},
                 ],

{netbox-docker-plugin-1.3.0 → netbox-docker-plugin-1.4.0}/netbox_docker_plugin/urls.py

@@ -18,6 +18,7 @@ from .views import (
     label as label_views,
     port as port_views,
     mount as mount_views,
+    bind as bind_views,
     network_setting as network_setting_views,
     registry as registry_views,
 )
@@ -306,6 +307,27 @@ urlpatterns = (
         mount_views.MountDeleteView.as_view(),
         name="mount_delete",
     ),
+    # Bind
+    path(
+        "binds/",
+        bind_views.BindListView.as_view(),
+        name="bind_list",
+    ),
+    path(
+        "binds/add/",
+        bind_views.BindEditView.as_view(),
+        name="bind_add",
+    ),
+    path(
+        "binds/<int:pk>/edit/",
+        bind_views.BindEditView.as_view(),
+        name="bind_edit",
+    ),
+    path(
+        "binds/<int:pk>/delete/",
+        bind_views.BindDeleteView.as_view(),
+        name="bind_delete",
+    ),
     # NetworkSetting
     path(
         "network-settings/",

netbox-docker-plugin-1.4.0/netbox_docker_plugin/views/bind.py

@@ -0,0 +1,28 @@
+"""Container views definitions"""
+
+from netbox.views import generic
+from .. import tables, filtersets
+from ..forms.bind import BindForm, BindFilterForm
+from ..models.container import Bind
+
+
+class BindListView(generic.ObjectListView):
+    """Bind list view definition"""
+
+    queryset = Bind.objects.prefetch_related("container")
+    table = tables.BindTable
+    filterset = filtersets.BindFilterSet
+    filterset_form = BindFilterForm
+
+
+class BindEditView(generic.ObjectEditView):
+    """Bind edition view definition"""
+
+    queryset = Bind.objects.all()
+    form = BindForm
+
+
+class BindDeleteView(generic.ObjectDeleteView):
+    """Bind delete view definition"""
+
+    queryset = Bind.objects.all()

{netbox-docker-plugin-1.3.0 → netbox-docker-plugin-1.4.0}/netbox_docker_plugin/views/container.py

@@ -4,14 +4,29 @@ from utilities.utils import count_related
 from netbox.views import generic
 from .. import tables, filtersets
 from ..forms import container
-from ..models.container import Container, Mount, Port, NetworkSetting, Env, Label
+from ..models.container import (
+    Container,
+    Mount,
+    Bind,
+    Port,
+    NetworkSetting,
+    Env,
+    Label,
+)
 
 
 class ContainerView(generic.ObjectView):
     """Container view definition"""
 
     queryset = Container.objects.prefetch_related(
-        "host", "image", "env", "labels", "mounts", "ports", "network_settings"
+        "host",
+        "image",
+        "env",
+        "labels",
+        "mounts",
+        "binds",
+        "ports",
+        "network_settings",
     )
 
 
@@ -28,6 +43,7 @@ class ContainerListView(generic.ObjectListView):
     queryset = Container.objects.annotate(
         port_count=count_related(Port, "container"),
         mount_count=count_related(Mount, "container"),
+        bind_count=count_related(Bind, "container"),
         networksetting_count=count_related(NetworkSetting, "container"),
         env_count=count_related(Env, "container"),
         label_count=count_related(Label, "container"),

{netbox-docker-plugin-1.3.0 → netbox-docker-plugin-1.4.0/netbox_docker_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 1.3.0
+Version: 1.4.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.0 → netbox-docker-plugin-1.4.0}/netbox_docker_plugin.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ netbox_docker_plugin/api/serializers.py
 netbox_docker_plugin/api/urls.py
 netbox_docker_plugin/api/views.py
 netbox_docker_plugin/forms/__init__.py
+netbox_docker_plugin/forms/bind.py
 netbox_docker_plugin/forms/container.py
 netbox_docker_plugin/forms/env.py
 netbox_docker_plugin/forms/host.py
@@ -48,6 +49,7 @@ netbox_docker_plugin/migrations/0018_alter_mount_volume_alter_networksetting_net
 netbox_docker_plugin/migrations/0019_host_agent_version_host_docker_api_version.py
 netbox_docker_plugin/migrations/0020_container_hostname.py
 netbox_docker_plugin/migrations/0021_registry_and_more.py
+netbox_docker_plugin/migrations/0022_bind_bind_netbox_docker_plugin_bind_unique_bind.py
 netbox_docker_plugin/migrations/__init__.py
 netbox_docker_plugin/models/__init__.py
 netbox_docker_plugin/models/container.py
@@ -90,6 +92,7 @@ netbox_docker_plugin/tests/volume/test_volume_api.py
 netbox_docker_plugin/tests/volume/test_volume_views.py
 netbox_docker_plugin/utilities/__init__.py
 netbox_docker_plugin/views/__init__.py
+netbox_docker_plugin/views/bind.py
 netbox_docker_plugin/views/container.py
 netbox_docker_plugin/views/env.py
 netbox_docker_plugin/views/host.py

{netbox-docker-plugin-1.3.0 → netbox-docker-plugin-1.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "netbox-docker-plugin"
-version = "1.3.0"
+version = "1.4.0"
 authors = [
   { name="Vincent Simonin", email="vincent@saashup.com" },
 ]