netbox-docker-plugin 2.6.0__tar.gz → 2.8.0__tar.gz

{netbox_docker_plugin-2.6.0/netbox_docker_plugin.egg-info → netbox_docker_plugin-2.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 2.6.0
+Version: 2.8.0
 Summary: Manage Docker with Netbox & style.
 Author-email: Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>
 Project-URL: Homepage, https://github.com/SaaShup/netbox-docker-plugin

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.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 = "2.6.0"
+    version = "2.8.0"
     base_url = "docker"
     min_version = "4.0.0"
     author= "Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>"

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/api/serializers.py

@@ -18,6 +18,7 @@ from ..models.container import (
     Mount,
     Bind,
     NetworkSetting,
+    Device,
 )
 from ..models.registry import Registry
 
@@ -375,6 +376,19 @@ class NetworkSettingSerializer(serializers.ModelSerializer):
         fields = ("network",)
 
 
+class DeviceSerializer(serializers.ModelSerializer):
+    """Container Device Serializer class"""
+
+    class Meta:
+        """Container Device Serializer Meta class"""
+
+        model = Device
+        fields = (
+            "host_path",
+            "container_path",
+        )
+
+
 class ContainerSerializer(NetBoxModelSerializer):
     """Container Serializer class"""
 
@@ -389,6 +403,7 @@ class ContainerSerializer(NetBoxModelSerializer):
     mounts = MountSerializer(many=True, required=False)
     binds = BindSerializer(many=True, required=False)
     network_settings = NetworkSettingSerializer(many=True, required=False)
+    devices = DeviceSerializer(many=True, required=False)
 
     class Meta:
         """Container Serializer Meta class"""
@@ -414,6 +429,7 @@ class ContainerSerializer(NetBoxModelSerializer):
             "mounts",
             "binds",
             "network_settings",
+            "devices",
             "custom_fields",
             "created",
             "last_updated",
@@ -429,11 +445,13 @@ class ContainerSerializer(NetBoxModelSerializer):
         attrs.pop("mounts", None)
         attrs.pop("binds", None)
         attrs.pop("network_settings", None)
+        attrs.pop("devices", None)
 
         super().validate(attrs)
 
         return data
 
+    # pylint: disable=R0912
     def create(self, validated_data):
         ports_data = validated_data.pop("ports", None)
         env_data = validated_data.pop("env", None)
@@ -441,6 +459,7 @@ class ContainerSerializer(NetBoxModelSerializer):
         mounts_data = validated_data.pop("mounts", None)
         binds_data = validated_data.pop("binds", None)
         network_settings_data = validated_data.pop("network_settings", None)
+        devices_data = validated_data.pop("devices", None)
 
         container = super().create(validated_data)
 
@@ -474,8 +493,15 @@ class ContainerSerializer(NetBoxModelSerializer):
                 obj.full_clean()
                 obj.save()
 
+        if devices_data is not None:
+            for device in devices_data:
+                obj = Device(container=container, **device)
+                obj.full_clean()
+                obj.save()
+
         return container
 
+    # pylint: disable=R0912
     def update(self, instance, validated_data):
         ports_data = validated_data.pop("ports", None)
         env_data = validated_data.pop("env", None)
@@ -483,6 +509,7 @@ class ContainerSerializer(NetBoxModelSerializer):
         mounts_data = validated_data.pop("mounts", None)
         binds_data = validated_data.pop("binds", None)
         network_settings_data = validated_data.pop("network_settings", None)
+        devices_data = validated_data.pop("devices", None)
 
         container = super().update(instance, validated_data)
 
@@ -522,6 +549,13 @@ class ContainerSerializer(NetBoxModelSerializer):
                 obj.full_clean()
                 obj.save()
 
+        if devices_data is not None:
+            Device.objects.filter(container=container).delete()
+            for device in devices_data:
+                obj = Device(container=container, **device)
+                obj.full_clean()
+                obj.save()
+
         return container
 
 

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/api/views.py

@@ -136,6 +136,7 @@ class ContainerViewSet(NetBoxModelViewSet):
     """Container view set class"""
 
     queryset = Container.objects.prefetch_related(
+        "devices",
         "network_settings",
         "mounts",
         "binds",

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/filtersets.py

@@ -15,6 +15,7 @@ from .models.container import (
     Mount,
     Bind,
     NetworkSetting,
+    Device,
 )
 from .models.registry import Registry
 
@@ -288,3 +289,19 @@ class NetworkSettingFilterSet(BaseFilterSet):
 
         model = NetworkSetting
         fields = ("id",)
+
+
+class DeviceFilterSet(BaseFilterSet):
+    """Device filterset definition class"""
+
+    container_id = ModelMultipleChoiceFilter(
+        field_name="container_id",
+        queryset=Container.objects.all(),
+        label="Container (ID)",
+    )
+
+    class Meta:
+        """Device filterset definition meta class"""
+
+        model = Device
+        fields = ("id",)

netbox_docker_plugin-2.8.0/netbox_docker_plugin/forms/device.py

@@ -0,0 +1,45 @@
+"""Device Form definition"""
+
+from django import forms
+from utilities.forms.fields import (
+    DynamicModelMultipleChoiceField,
+    DynamicModelChoiceField,
+)
+from netbox.forms import (
+    NetBoxModelFilterSetForm,
+)
+from ..models.container import Device, Container
+
+
+class DeviceForm(forms.ModelForm):
+    """Device form definition class"""
+
+    container = DynamicModelChoiceField(
+        label="Container", queryset=Container.objects.all(), required=True
+    )
+
+    class Meta:
+        """Device form definition Meta class"""
+
+        model = Device
+        fields = (
+            "container",
+            "host_path",
+            "container_path",
+        )
+        labels = {
+            "container": "Container",
+            "host_path": "Path to the device on host",
+            "container_path": "Path to the device in container",
+        }
+
+
+class DeviceFilterForm(NetBoxModelFilterSetForm):
+    """Device filter form definition class"""
+
+    model = Device
+    container_id = DynamicModelMultipleChoiceField(
+        queryset=Container.objects.all(),
+        required=False,
+        label="Container",
+    )

netbox_docker_plugin-2.8.0/netbox_docker_plugin/migrations/0032_device_and_more.py

@@ -0,0 +1,66 @@
+# 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", "0031_container_cap_add"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Device",
+            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="devices",
+                        to="netbox_docker_plugin.container",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("container", "container_path", "host_path"),
+            },
+        ),
+        migrations.AddConstraint(
+            model_name="device",
+            constraint=models.UniqueConstraint(
+                fields=("container", "container_path", "host_path"),
+                name="netbox_docker_plugin_device_unique_device",
+            ),
+        ),
+    ]

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/models/container.py

@@ -53,6 +53,7 @@ class ContainerOperationChoices(ChoiceSet):
         ("restart", "Restart", "blue"),
         ("stop", "Stop", "blue"),
         ("recreate", "Recreate", "blue"),
+        ("kill", "Kill", "red"),
         ("none", "None", "white"),
     ]
 
@@ -188,6 +189,11 @@ class Container(NetBoxModel):
             "dead",
         ]
 
+    @property
+    def can_kill(self) -> bool:
+        """Check if the container can be killed"""
+        return self.state in ["created", "restarting", "running", "exited", "dead"]
+
     class Meta:
         """Image Model Meta Class"""
 
@@ -461,3 +467,41 @@ class NetworkSetting(models.Model):
                     + f"{self.container.host}."
                 }
             )
+
+
+class Device(models.Model):
+    """Device definition class"""
+
+    objects = RestrictedQuerySet.as_manager()
+
+    container = models.ForeignKey(
+        Container, on_delete=models.CASCADE, related_name="devices"
+    )
+    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:
+        """Device 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_device",
+            ),
+        )
+
+    def __str__(self):
+        return f"{self.host_path}:{self.container_path}"

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/signals.py

@@ -42,6 +42,7 @@ def restrict_container_actions(instance, **_kwargs):
             instance.operation == "restart" and not instance.can_restart,
             instance.operation == "stop" and not instance.can_stop,
             instance.operation == "recreate" and not instance.can_recreate,
+            instance.operation == "kill" and not instance.can_kill,
         ]
     ):
         raise AbortRequest(

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/tables.py

@@ -14,6 +14,7 @@ from .models.container import (
     Mount,
     Bind,
     NetworkSetting,
+    Device,
 )
 from .models.registry import Registry
 from .templatetags.host import remove_password
@@ -239,6 +240,11 @@ class ContainerTable(NetBoxTable):
         url_params={"container_id": "pk"},
         verbose_name="Labels count",
     )
+    device_count = columns.LinkedCountColumn(
+        viewname="plugins:netbox_docker_plugin:device_list",
+        url_params={"container_id": "pk"},
+        verbose_name="Devices count",
+    )
     tags = columns.TagColumn()
 
     class Meta(NetBoxTable.Meta):
@@ -263,6 +269,7 @@ class ContainerTable(NetBoxTable):
             "networksetting_count",
             "env_count",
             "label_count",
+            "device_count",
             "tags",
         )
         default_columns = (
@@ -395,3 +402,26 @@ class NetworkSettingTable(NetBoxTable):
             "container",
             "network",
         )
+
+
+class DeviceTable(NetBoxTable):
+    """Device Table definition class"""
+
+    container = tables.Column(linkify=True)
+
+    actions = columns.ActionsColumn(actions=("edit", "delete"))
+
+    class Meta(NetBoxTable.Meta):
+        """Device Table definition Meta class"""
+
+        model = Device
+        fields = (
+            "container",
+            "host_path",
+            "container_path",
+        )
+        default_columns = (
+            "container",
+            "host_path",
+            "container_path",
+        )

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/templates/netbox_docker_plugin/container-layout.html

@@ -45,6 +45,20 @@
   </button>
 </form>
 
+<form action="{% url 'plugins:netbox_docker_plugin:container_operation' pk=object.id operation='kill' %}" method="post">
+  {% csrf_token %}
+  <input type="hidden" name="operation" value="kill">
+  <button
+    type="submit"
+    class="btn btn-dark"
+    {% if not object.can_kill %}
+    disabled
+    {% endif %}
+  >
+    <i class="mdi mdi-skull"></i> Kill
+  </button>
+</form>
+
 <form action="{% url 'plugins:netbox_docker_plugin:container_operation' pk=object.id operation='recreate' %}" method="post">
   {% csrf_token %}
   <input type="hidden" name="operation" value="recreate">

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/templates/netbox_docker_plugin/container.html

@@ -165,4 +165,24 @@
     </div>
   </div>
 </div>
+
+<h2>Host capabilities</h2>
+<div class="row mb-3">
+  <div class="col col-md-6">
+    <div class="card">
+      <h5 class="card-header">DEVICES</h5>
+      <div class="card-body htmx-container table-responsive"
+        hx-get="{% url 'plugins:netbox_docker_plugin:device_list' %}?container_id={{ object.pk }}"
+        hx-trigger="load"
+      ></div>
+      {% if perms.netbox_docker_plugin.add_device %}
+        <div class="card-footer text-end noprint">
+          <a href="{% url 'plugins:netbox_docker_plugin:device_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
+            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> New Device
+          </a>
+        </div>
+      {% endif %}
+    </div>
+  </div>
+</div>
 {% endblock content %}

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/tests/container/test_container_actions.py

@@ -10,12 +10,12 @@ from netbox_docker_plugin.models.registry import Registry
 
 
 class ContainerActionTestCase(TestCase):
-    """ Test the various scenarii of container actions """
+    """Test the various scenarii of container actions"""
 
     objects = {}
 
     def test_allowed_operations(self):
-        """ Test that only specific operations are allowed according to a state """
+        """Test that only specific operations are allowed according to a state"""
 
         cases = [
             ("create", ["none"]),
@@ -23,7 +23,19 @@ class ContainerActionTestCase(TestCase):
             ("stop", ["running"]),
             ("restart", ["running"]),
             ("recreate", ["created", "exited", "dead", "running"]),
-            ("noop", ["created", "restarting", "running", "paused", "exited", "dead", "none"]),
+            ("kill", ["created", "restarting", "running", "exited", "dead"]),
+            (
+                "noop",
+                [
+                    "created",
+                    "restarting",
+                    "running",
+                    "paused",
+                    "exited",
+                    "dead",
+                    "none",
+                ],
+            ),
         ]
 
         for operation, states in cases:
@@ -48,14 +60,18 @@ class ContainerActionTestCase(TestCase):
                     )
 
     def test_forbidden_operations(self):
-        """ Test that forbidden operations raise an AbortRequest """
+        """Test that forbidden operations raise an AbortRequest"""
 
         cases = [
-            ("create", ["created", "restarting", "running", "paused", "exited", "dead"]),
+            (
+                "create",
+                ["created", "restarting", "running", "paused", "exited", "dead"],
+            ),
             ("start", ["running", "restarting", "paused", "none"]),
             ("stop", ["created", "restarting", "paused", "exited", "dead", "none"]),
             ("restart", ["created", "restarting", "paused", "exited", "dead", "none"]),
             ("recreate", ["restarting", "paused", "none"]),
+            ("kill", ["paused", "none"]),
         ]
 
         for operation, states in cases:
@@ -79,7 +95,7 @@ class ContainerActionTestCase(TestCase):
                             obj.save()
 
     def test_delete_non_running_container(self):
-        """ Test that a non running container can be deleted """
+        """Test that a non running container can be deleted"""
 
         for state in ["created", "paused", "exited", "dead"]:
             with self.subTest(operation="delete", state=state):
@@ -98,7 +114,7 @@ class ContainerActionTestCase(TestCase):
                 self.assertFalse(Container.objects.filter(name=name).exists())
 
     def test_delete_running_container(self):
-        """ Test that a running container cannot be deleted """
+        """Test that a running container cannot be deleted"""
 
         for state in ["running", "restarting", "none"]:
             with self.subTest(operation="delete", state=state):
@@ -119,9 +135,17 @@ class ContainerActionTestCase(TestCase):
                         obj.delete()
 
     def test_delete_container_on_deleted_host(self):
-        """ Test that a container on a deleted host can be deleted """
-
-        for state in ["created", "running", "restarted", "paused", "exited", "dead", "none"]:
+        """Test that a container on a deleted host can be deleted"""
+
+        for state in [
+            "created",
+            "running",
+            "restarted",
+            "paused",
+            "exited",
+            "dead",
+            "none",
+        ]:
             with self.subTest(operation="delete", state=state):
                 with transaction.atomic():
                     name = f"container-delete-{state}"

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/tests/container/test_container_api.py

@@ -47,6 +47,7 @@ class ContainerApiTestCase(
         "mounts",
         "binds",
         "network_settings",
+        "devices",
     ]
 
     @classmethod
@@ -121,6 +122,9 @@ class ContainerApiTestCase(
                 "network_settings": [
                     {"network": network1.pk},
                 ],
+                "devices": [
+                    {"host_path": "/dev/sda", "container_path": "/dev/xvdc"},
+                ]
             },
             {
                 "host": host2.pk,

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/urls.py

@@ -21,6 +21,7 @@ from .views import (
     bind as bind_views,
     network_setting as network_setting_views,
     registry as registry_views,
+    device as device_views,
 )
 
 urlpatterns = (
@@ -405,4 +406,25 @@ urlpatterns = (
         name="registry_journal",
         kwargs={"model": Registry},
     ),
+    # Device
+    path(
+        "devices/",
+        device_views.DeviceListView.as_view(),
+        name="device_list",
+    ),
+    path(
+        "devices/add/",
+        device_views.DeviceEditView.as_view(),
+        name="device_add",
+    ),
+    path(
+        "devices/<int:pk>/edit/",
+        device_views.DeviceEditView.as_view(),
+        name="device_edit",
+    ),
+    path(
+        "devices/<int:pk>/delete/",
+        device_views.DeviceDeleteView.as_view(),
+        name="device_delete",
+    ),
 )

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin/views/container.py

@@ -13,6 +13,7 @@ from ..models.container import (
     NetworkSetting,
     Env,
     Label,
+    Device,
 )
 
 
@@ -29,6 +30,7 @@ class ContainerView(generic.ObjectView):
         "binds",
         "ports",
         "network_settings",
+        "devices",
     )
 
 
@@ -74,6 +76,7 @@ class ContainerListView(generic.ObjectListView):
         networksetting_count=count_related(NetworkSetting, "container"),
         env_count=count_related(Env, "container"),
         label_count=count_related(Label, "container"),
+        device_count=count_related(Device, "container"),
     )
 
     table = tables.ContainerTable

netbox_docker_plugin-2.8.0/netbox_docker_plugin/views/device.py

@@ -0,0 +1,28 @@
+"""Container views definitions"""
+
+from netbox.views import generic
+from .. import tables, filtersets
+from ..forms.device import DeviceForm, DeviceFilterForm
+from ..models.container import Device
+
+
+class DeviceListView(generic.ObjectListView):
+    """Device list view definition"""
+
+    queryset = Device.objects.prefetch_related("container")
+    table = tables.DeviceTable
+    filterset = filtersets.DeviceFilterSet
+    filterset_form = DeviceFilterForm
+
+
+class DeviceEditView(generic.ObjectEditView):
+    """Device edition view definition"""
+
+    queryset = Device.objects.all()
+    form = DeviceForm
+
+
+class DeviceDeleteView(generic.ObjectDeleteView):
+    """Device delete view definition"""
+
+    queryset = Device.objects.all()

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0/netbox_docker_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 2.6.0
+Version: 2.8.0
 Summary: Manage Docker with Netbox & style.
 Author-email: Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>
 Project-URL: Homepage, https://github.com/SaaShup/netbox-docker-plugin

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/netbox_docker_plugin.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ 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/device.py
 netbox_docker_plugin/forms/env.py
 netbox_docker_plugin/forms/host.py
 netbox_docker_plugin/forms/image.py
@@ -61,6 +62,7 @@ netbox_docker_plugin/migrations/0028_mount_and_bind_read_only.py
 netbox_docker_plugin/migrations/0029_alter_container_state.py
 netbox_docker_plugin/migrations/0030_alter_container_containerid_alter_container_hostname_and_more.py
 netbox_docker_plugin/migrations/0031_container_cap_add.py
+netbox_docker_plugin/migrations/0032_device_and_more.py
 netbox_docker_plugin/migrations/__init__.py
 netbox_docker_plugin/models/__init__.py
 netbox_docker_plugin/models/container.py
@@ -111,6 +113,7 @@ 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/device.py
 netbox_docker_plugin/views/env.py
 netbox_docker_plugin/views/host.py
 netbox_docker_plugin/views/image.py

{netbox_docker_plugin-2.6.0 → netbox_docker_plugin-2.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "netbox-docker-plugin"
-version = "2.6.0"
+version = "2.8.0"
 authors = [
   { name="Vincent Simonin", email="vincent@saashup.com" },
   { name="David Delassus", email="david.jose.delassus@gmail.com" }