✨ Add container Sysctl model

.github/workflows/main_ci.yml

@@ -12,7 +12,7 @@ jobs:
       max-parallel: 4
       matrix:
         python-version: ["3.12"]
-        netbox-version: ["v4.3.7"]
+        netbox-version: ["v4.4.6"]
     services:
       redis:
         image: redis

.github/workflows/pr_ci.yml

@@ -15,7 +15,7 @@ jobs:
       max-parallel: 4
       matrix:
         python-version: ["3.12"]
-        netbox-version: ["v4.3.7"]
+        netbox-version: ["v4.4.6"]
     services:
       redis:
         image: redis

netbox_docker_plugin/__init__.py

@@ -11,7 +11,7 @@ class NetBoxDockerConfig(PluginConfig):
     name = "netbox_docker_plugin"
     verbose_name = " NetBox Docker Plugin"
     description = "Manage Docker"
-    version = "4.8.0"
+    version = "4.9.0"
     base_url = "docker"
     min_version = "4.3.7"
     author = "Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>"

netbox_docker_plugin/api/serializers.py

@@ -20,6 +20,7 @@
     NetworkSetting,
     Device,
     LogDriverOption,
+    Sysctl,
 )
 from ..models.registry import Registry
 
@@ -422,6 +423,19 @@ class Meta:
         )
 
 
+class SysctlSerializer(serializers.ModelSerializer):
+    """Container sysctl Serializer class"""
+
+    class Meta:
+        """Container sysctl Serializer Meta class"""
+
+        model = Sysctl
+        fields = (
+            "key",
+            "value",
+        )
+
+
 class ContainerSerializer(NetBoxModelSerializer):
     """Container Serializer class"""
 
@@ -438,6 +452,7 @@ class ContainerSerializer(NetBoxModelSerializer):
     network_settings = NetworkSettingSerializer(many=True, required=False)
     devices = DeviceSerializer(many=True, required=False)
     log_driver_options = LogDriverOptionSerializer(many=True, required=False)
+    sysctls = SysctlSerializer(many=True, required=False)
 
     class Meta:
         """Container Serializer Meta class"""
@@ -467,6 +482,7 @@ class Meta:
             "devices",
             "log_driver",
             "log_driver_options",
+            "sysctls",
             "custom_fields",
             "created",
             "last_updated",
@@ -484,6 +500,7 @@ def validate(self, data):
         attrs.pop("binds", None)
         attrs.pop("network_settings", None)
         attrs.pop("devices", None)
+        attrs.pop("sysctls", None)
 
         super().validate(attrs)
 
@@ -499,6 +516,7 @@ def create(self, validated_data):
         binds_data = validated_data.pop("binds", None)
         network_settings_data = validated_data.pop("network_settings", None)
         devices_data = validated_data.pop("devices", None)
+        sysctls_data = validated_data.pop("sysctls", None)
 
         container = super().create(validated_data)
 
@@ -542,6 +560,10 @@ def create(self, validated_data):
                 obj.full_clean()
                 obj.save()
 
+        if sysctls_data is not None:
+            for sysctl in sysctls_data:
+                Sysctl.objects.create(container=container, **sysctl)
+
         return container
 
     # pylint: disable=R0912
@@ -554,6 +576,7 @@ def update(self, instance, validated_data):
         binds_data = validated_data.pop("binds", None)
         network_settings_data = validated_data.pop("network_settings", None)
         devices_data = validated_data.pop("devices", None)
+        sysctls_data = validated_data.pop("sysctls", None)
 
         container = super().update(instance, validated_data)
 
@@ -605,6 +628,11 @@ def update(self, instance, validated_data):
                 obj.full_clean()
                 obj.save()
 
+        if sysctls_data is not None:
+            Sysctl.objects.filter(container=container).delete()
+            for sysctl in sysctls_data:
+                Sysctl.objects.create(container=container, **sysctl)
+
         return container
 
 

netbox_docker_plugin/api/views.py

@@ -47,13 +47,19 @@ class HostViewSet(NetBoxModelViewSet):
     def perform_create(self, serializer):
         if isinstance(serializer.validated_data, Sequence):
             for obj in serializer.validated_data:
-                token = Token(user=self.request.user, write_enabled=True, description="DockerAgent")
+                token = Token(
+                    user=self.request.user,
+                    write_enabled=True,
+                    description="DockerAgent",
+                )
                 token.save()
 
                 obj["token"] = token
                 obj["netbox_base_url"] = self.request.stream.META["HTTP_ORIGIN"]
         else:
-            token = Token(user=self.request.user, write_enabled=True, description="DockerAgent")
+            token = Token(
+                user=self.request.user, write_enabled=True, description="DockerAgent"
+            )
             token.save()
 
             serializer.validated_data["token"] = token
@@ -85,7 +91,7 @@ class ImageViewSet(NetBoxModelViewSet):
         renderer_classes=[JSONRenderer],
     )
     def force_pull(self, _request, **_kwargs):
-        """ Force pull an existing image """
+        """Force pull an existing image"""
 
         image: Image = self.get_object()
         agent_url = image.host.endpoint
@@ -146,6 +152,7 @@ class ContainerViewSet(NetBoxModelViewSet):
         "ports",
         "labels",
         "log_driver_options",
+        "sysctls",
         "tags",
     )
     filterset_class = filtersets.ContainerFilterSet

netbox_docker_plugin/filtersets.py

@@ -17,6 +17,7 @@
     NetworkSetting,
     Device,
     LogDriverOption,
+    Sysctl,
 )
 from .models.registry import Registry
 
@@ -340,3 +341,22 @@ class Meta:
 
         model = Device
         fields = ("id",)
+
+
+class SysctlFilterSet(BaseFilterSet):
+    """Sysctl filterset definition class"""
+
+    container_id = ModelMultipleChoiceFilter(
+        field_name="container_id",
+        queryset=Container.objects.all(),
+        label="Container (ID)",
+    )
+
+    class Meta:
+        """Sysctl filterset definition meta class"""
+
+        model = Sysctl
+        fields = (
+            "id",
+            "key",
+        )

netbox_docker_plugin/forms/sysctl.py

@@ -0,0 +1,28 @@
+"""Sysctl Form definition"""
+
+from django import forms
+from utilities.forms.fields import DynamicModelChoiceField
+from ..models.container import Sysctl, Container
+
+
+class SysctlForm(forms.ModelForm):
+    """Sysctl form definition class"""
+
+    container = DynamicModelChoiceField(
+        label="Container", queryset=Container.objects.all(), required=True
+    )
+
+    class Meta:
+        """Sysctl form definition Meta class"""
+
+        model = Sysctl
+        fields = (
+            "container",
+            "key",
+            "value",
+        )
+        labels = {
+            "container": "Container",
+            "key": "Key",
+            "value": "Value",
+        }

netbox_docker_plugin/migrations/1041_sysctl.py

@@ -0,0 +1,67 @@
+# pylint: disable=C0103
+# pylint: disable=R0801
+"""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", "1040_alter_container_log_driver"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Sysctl",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                (
+                    "key",
+                    models.CharField(
+                        max_length=255,
+                        validators=[
+                            django.core.validators.MinLengthValidator(limit_value=1),
+                            django.core.validators.MaxLengthValidator(limit_value=255),
+                        ],
+                    ),
+                ),
+                (
+                    "value",
+                    models.CharField(
+                        blank=True,
+                        max_length=4095,
+                        validators=[
+                            django.core.validators.MaxLengthValidator(limit_value=4095)
+                        ],
+                    ),
+                ),
+                (
+                    "container",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="sysctls",
+                        to="netbox_docker_plugin.container",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("container", "key"),
+                "constraints": [
+                    models.UniqueConstraint(
+                        models.F("key"),
+                        models.F("container"),
+                        name="netbox_docker_plugin_sysctl_unique_key_container'",
+                    )
+                ],
+            },
+        ),
+    ]

netbox_docker_plugin/models/container.py

@@ -175,9 +175,7 @@ class Container(NetBoxModel):
         blank=True,
     )
     cmd = ArrayField(
-        models.CharField(
-            max_length=1024, blank=True, null=True
-        ),
+        models.CharField(max_length=1024, blank=True, null=True),
         null=True,
         blank=True,
     )
@@ -585,3 +583,42 @@ class Meta:
 
     def __str__(self):
         return f"{self.host_path}:{self.container_path}"
+
+
+class Sysctl(models.Model):
+    """SysCtl definition class"""
+
+    objects = RestrictedQuerySet.as_manager()
+
+    container = models.ForeignKey(
+        Container, on_delete=models.CASCADE, related_name="sysctls"
+    )
+    key = models.CharField(
+        max_length=255,
+        validators=[
+            MinLengthValidator(limit_value=1),
+            MaxLengthValidator(limit_value=255),
+        ],
+    )
+    value = models.CharField(
+        max_length=4095,
+        validators=[
+            MaxLengthValidator(limit_value=4095),
+        ],
+        blank=True,
+    )
+
+    class Meta:
+        """SysCtl Model Meta Class"""
+
+        ordering = ("container", "key")
+        constraints = (
+            models.UniqueConstraint(
+                "key",
+                "container",
+                name="%(app_label)s_%(class)s_unique_key_container'",
+            ),
+        )
+
+    def __str__(self):
+        return f"{self.key}"

netbox_docker_plugin/tables.py

@@ -16,6 +16,7 @@
     NetworkSetting,
     Device,
     LogDriverOption,
+    Sysctl,
 )
 from .models.registry import Registry
 from .templatetags.host import remove_password
@@ -461,3 +462,18 @@ class Meta(NetBoxTable.Meta):
             "host_path",
             "container_path",
         )
+
+
+class SysctlTable(NetBoxTable):
+    """Sysctl Table definition class"""
+
+    container = tables.Column(linkify=True)
+
+    actions = columns.ActionsColumn(actions=("edit", "delete"))
+
+    class Meta(NetBoxTable.Meta):
+        """Sysctl Table definition Meta class"""
+
+        model = Sysctl
+        fields = ("container", "key", "value")
+        default_columns = ("container", "key", "value")