netbox-docker-plugin 4.8.0__tar.gz → 4.10.0__tar.gz

{netbox_docker_plugin-4.8.0/netbox_docker_plugin.egg-info → netbox_docker_plugin-4.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-docker-plugin
-Version: 4.8.0
+Version: 4.10.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-4.8.0 → netbox_docker_plugin-4.10.0}/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.10.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-4.8.0 → netbox_docker_plugin-4.10.0}/netbox_docker_plugin/api/serializers.py

@@ -20,6 +20,7 @@ from ..models.container import (
     NetworkSetting,
     Device,
     LogDriverOption,
+    Sysctl,
 )
 from ..models.registry import Registry
 
@@ -422,6 +423,19 @@ class DeviceSerializer(serializers.ModelSerializer):
         )
 
 
+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 ContainerSerializer(NetBoxModelSerializer):
             "devices",
             "log_driver",
             "log_driver_options",
+            "sysctls",
             "custom_fields",
             "created",
             "last_updated",
@@ -484,6 +500,7 @@ class ContainerSerializer(NetBoxModelSerializer):
         attrs.pop("binds", None)
         attrs.pop("network_settings", None)
         attrs.pop("devices", None)
+        attrs.pop("sysctls", None)
 
         super().validate(attrs)
 
@@ -499,6 +516,7 @@ class ContainerSerializer(NetBoxModelSerializer):
         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 @@ class ContainerSerializer(NetBoxModelSerializer):
                 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 @@ class ContainerSerializer(NetBoxModelSerializer):
         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 @@ class ContainerSerializer(NetBoxModelSerializer):
                 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-4.8.0 → netbox_docker_plugin-4.10.0}/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-4.8.0 → netbox_docker_plugin-4.10.0}/netbox_docker_plugin/filtersets.py

@@ -17,6 +17,7 @@ from .models.container import (
     NetworkSetting,
     Device,
     LogDriverOption,
+    Sysctl,
 )
 from .models.registry import Registry
 
@@ -340,3 +341,22 @@ class DeviceFilterSet(BaseFilterSet):
 
         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-4.8.0 → netbox_docker_plugin-4.10.0}/netbox_docker_plugin/forms/bind.py

@@ -3,7 +3,6 @@
 from django import forms
 from utilities.forms.fields import (
     DynamicModelMultipleChoiceField,
-    DynamicModelChoiceField,
 )
 from netbox.forms import (
     NetBoxModelFilterSetForm,
@@ -14,8 +13,11 @@ from ..models.container import Bind, Container
 class BindForm(forms.ModelForm):
     """Bind form definition class"""
 
-    container = DynamicModelChoiceField(
-        label="Container", queryset=Container.objects.all(), required=True
+    container = forms.ModelChoiceField(
+        label="Container",
+        queryset=Container.objects.all(),
+        required=True,
+        widget=forms.HiddenInput,
     )
 
     class Meta:
@@ -29,12 +31,23 @@ class BindForm(forms.ModelForm):
             "read_only",
         )
         labels = {
-            "container": "Container",
             "host_path": "Path to mount on host",
             "container_path": "Mountpoint in container",
             "read_only": "Mount as read-only within the container",
         }
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if "data" in kwargs:
+            container = Container.objects.filter(id=kwargs["data"]["container"])
+        elif "initial" in kwargs and "container" in kwargs["initial"]:
+            container = Container.objects.filter(id=kwargs["initial"]["container"])
+        else:
+            container = Container.objects.filter(id=self.instance.container.id)
+
+        self.instance._meta.verbose_name = f"Bind — {container.first()}"
+
 
 class BindFilterForm(NetBoxModelFilterSetForm):
     """Bind filter form definition class"""

{netbox_docker_plugin-4.8.0 → netbox_docker_plugin-4.10.0}/netbox_docker_plugin/forms/container.py

@@ -67,11 +67,10 @@ class ContainerForm(NetBoxModelForm):
 class ContainerEditForm(NetBoxModelForm):
     """Container form definition class"""
 
-    image = DynamicModelChoiceField(
+    image = forms.ModelChoiceField(
         label="Image",
         queryset=Image.objects.all(),
         required=True,
-        query_params={"host_id": "$host"},
     )
     cap_add = forms.MultipleChoiceField(choices=ContainerCapAddChoices, required=False)
 
@@ -99,6 +98,11 @@ class ContainerEditForm(NetBoxModelForm):
             "cmd": "Command",
         }
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.fields["image"].queryset = Image.objects.filter(host=self.instance.host)
+
 
 class ContainerFilterForm(NetBoxModelFilterSetForm):
     """Container filter form definition class"""
@@ -124,9 +128,7 @@ class ContainerFilterForm(NetBoxModelFilterSetForm):
     restart_policy = forms.ChoiceField(
         label="Restart Policy", choices=ContainerRestartPolicyChoices, required=False
     )
-    log_driver = forms.ChoiceField(
-        label="Logging driver", required=False
-    )
+    log_driver = forms.ChoiceField(label="Logging driver", required=False)
     tag = TagFilterField(model)
 
 

{netbox_docker_plugin-4.8.0 → netbox_docker_plugin-4.10.0}/netbox_docker_plugin/forms/device.py

@@ -3,7 +3,6 @@
 from django import forms
 from utilities.forms.fields import (
     DynamicModelMultipleChoiceField,
-    DynamicModelChoiceField,
 )
 from netbox.forms import (
     NetBoxModelFilterSetForm,
@@ -14,8 +13,11 @@ from ..models.container import Device, Container
 class DeviceForm(forms.ModelForm):
     """Device form definition class"""
 
-    container = DynamicModelChoiceField(
-        label="Container", queryset=Container.objects.all(), required=True
+    container = forms.ModelChoiceField(
+        label="Container",
+        queryset=Container.objects.all(),
+        required=True,
+        widget=forms.HiddenInput,
     )
 
     class Meta:
@@ -28,11 +30,22 @@ class DeviceForm(forms.ModelForm):
             "container_path",
         )
         labels = {
-            "container": "Container",
             "host_path": "Path to the device on host",
             "container_path": "Path to the device in container",
         }
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if "data" in kwargs:
+            container = Container.objects.filter(id=kwargs["data"]["container"])
+        elif "initial" in kwargs and "container" in kwargs["initial"]:
+            container = Container.objects.filter(id=kwargs["initial"]["container"])
+        else:
+            container = Container.objects.filter(id=self.instance.container.id)
+
+        self.instance._meta.verbose_name = f"Device — {container.first()}"
+
 
 class DeviceFilterForm(NetBoxModelFilterSetForm):
     """Device filter form definition class"""

netbox_docker_plugin-4.10.0/netbox_docker_plugin/forms/env.py

@@ -0,0 +1,41 @@
+"""Env Form definition"""
+
+from django import forms
+from ..models.container import Env, Container
+
+
+class EnvForm(forms.ModelForm):
+    """Env form definition class"""
+
+    container = forms.ModelChoiceField(
+        label="Container",
+        queryset=Container.objects.all(),
+        required=True,
+        widget=forms.HiddenInput,
+    )
+
+    class Meta:
+        """Env form definition Meta class"""
+
+        model = Env
+        fields = (
+            "container",
+            "var_name",
+            "value",
+        )
+        labels = {
+            "var_name": "Variable Name",
+            "value": "Value",
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if "data" in kwargs:
+            container = Container.objects.filter(id=kwargs["data"]["container"])
+        elif "initial" in kwargs and "container" in kwargs["initial"]:
+            container = Container.objects.filter(id=kwargs["initial"]["container"])
+        else:
+            container = Container.objects.filter(id=self.instance.container.id)
+
+        self.instance._meta.verbose_name = f"Environment variable — {container.first()}"

netbox_docker_plugin-4.10.0/netbox_docker_plugin/forms/label.py

@@ -0,0 +1,41 @@
+"""Label Form definition"""
+
+from django import forms
+from ..models.container import Label, Container
+
+
+class LabelForm(forms.ModelForm):
+    """Label form definition class"""
+
+    container = forms.ModelChoiceField(
+        label="Container",
+        queryset=Container.objects.all(),
+        required=True,
+        widget=forms.HiddenInput,
+    )
+
+    class Meta:
+        """Label form definition Meta class"""
+
+        model = Label
+        fields = (
+            "container",
+            "key",
+            "value",
+        )
+        labels = {
+            "key": "Key",
+            "value": "Value",
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if "data" in kwargs:
+            container = Container.objects.filter(id=kwargs["data"]["container"])
+        elif "initial" in kwargs and "container" in kwargs["initial"]:
+            container = Container.objects.filter(id=kwargs["initial"]["container"])
+        else:
+            container = Container.objects.filter(id=self.instance.container.id)
+
+        self.instance._meta.verbose_name = f"Label — {container.first()}"

netbox_docker_plugin-4.10.0/netbox_docker_plugin/forms/log_driver_option.py

@@ -0,0 +1,41 @@
+"""Log Driver option Form definition"""
+
+from django import forms
+from ..models.container import LogDriverOption, Container
+
+
+class LogDriverOptionForm(forms.ModelForm):
+    """Log Driver option form definition class"""
+
+    container = forms.ModelChoiceField(
+        label="Container",
+        queryset=Container.objects.all(),
+        required=True,
+        widget=forms.HiddenInput,
+    )
+
+    class Meta:
+        """Log Driver option form definition Meta class"""
+
+        model = LogDriverOption
+        fields = (
+            "container",
+            "option_name",
+            "value",
+        )
+        labels = {
+            "option_name": "Option Name",
+            "value": "Value",
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if "data" in kwargs:
+            container = Container.objects.filter(id=kwargs["data"]["container"])
+        elif "initial" in kwargs and "container" in kwargs["initial"]:
+            container = Container.objects.filter(id=kwargs["initial"]["container"])
+        else:
+            container = Container.objects.filter(id=self.instance.container.id)
+
+        self.instance._meta.verbose_name = f"Log driver option — {container.first()}"

{netbox_docker_plugin-4.8.0 → netbox_docker_plugin-4.10.0}/netbox_docker_plugin/forms/mount.py

@@ -3,7 +3,6 @@
 from django import forms
 from utilities.forms.fields import (
     DynamicModelMultipleChoiceField,
-    DynamicModelChoiceField,
 )
 from netbox.forms import (
     NetBoxModelFilterSetForm,
@@ -15,10 +14,13 @@ from ..models.volume import Volume
 class MountForm(forms.ModelForm):
     """Mount form definition class"""
 
-    container = DynamicModelChoiceField(
-        label="Container", queryset=Container.objects.all(), required=True
+    container = forms.ModelChoiceField(
+        label="Container",
+        queryset=Container.objects.all(),
+        required=True,
+        widget=forms.HiddenInput,
     )
-    volume = DynamicModelChoiceField(
+    volume = forms.ModelChoiceField(
         label="Volume", queryset=Volume.objects.all(), required=True
     )
 
@@ -33,12 +35,27 @@ class MountForm(forms.ModelForm):
             "read_only",
         )
         labels = {
-            "container": "Container",
             "source": "Source directory",
             "volume": "Volume",
             "read_only": "Mount as read-only within the container",
         }
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if "data" in kwargs:
+            container = Container.objects.filter(id=kwargs["data"]["container"])
+        elif "initial" in kwargs and "container" in kwargs["initial"]:
+            container = Container.objects.filter(id=kwargs["initial"]["container"])
+        else:
+            container = Container.objects.filter(id=self.instance.container.id)
+
+        self.fields["volume"].queryset = Volume.objects.filter(
+            host=container.first().host
+        )
+
+        self.instance._meta.verbose_name = f"Mount — {container.first()}"
+
 
 class MountFilterForm(NetBoxModelFilterSetForm):
     """Mount filter form definition class"""

{netbox_docker_plugin-4.8.0 → netbox_docker_plugin-4.10.0}/netbox_docker_plugin/forms/network_setting.py

@@ -3,7 +3,6 @@
 from django import forms
 from utilities.forms.fields import (
     DynamicModelMultipleChoiceField,
-    DynamicModelChoiceField,
 )
 from netbox.forms import (
     NetBoxModelFilterSetForm,
@@ -15,10 +14,13 @@ from ..models.network import Network
 class NetworkSettingForm(forms.ModelForm):
     """NetworkSetting form definition class"""
 
-    container = DynamicModelChoiceField(
-        label="Container", queryset=Container.objects.all(), required=True
+    container = forms.ModelChoiceField(
+        label="Container",
+        queryset=Container.objects.all(),
+        required=True,
+        widget=forms.HiddenInput,
     )
-    network = DynamicModelChoiceField(
+    network = forms.ModelChoiceField(
         label="Network", queryset=Network.objects.all(), required=True
     )
 
@@ -26,15 +28,28 @@ class NetworkSettingForm(forms.ModelForm):
         """NetworkSetting form definition Meta class"""
 
         model = NetworkSetting
-        fields = (
-            "container",
-            "network"
-        )
+        fields = ("container", "network")
         labels = {
-            "container": "Container",
             "network": "Network",
         }
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if "data" in kwargs:
+            container = Container.objects.filter(id=kwargs["data"]["container"])
+        elif "initial" in kwargs and "container" in kwargs["initial"]:
+            container = Container.objects.filter(id=kwargs["initial"]["container"])
+        else:
+            container = Container.objects.filter(id=self.instance.container.id)
+
+        self.fields["network"].queryset = Network.objects.filter(
+            host=container.first().host
+        )
+
+        self.instance._meta.verbose_name = f"Network setting — {container.first()}"
+
+
 class NetworkSettingFilterForm(NetBoxModelFilterSetForm):
     """Mount filter form definition class"""
 

netbox_docker_plugin-4.10.0/netbox_docker_plugin/forms/port.py

@@ -0,0 +1,43 @@
+"""Port Form definition"""
+
+from django import forms
+from ..models.container import Port, Container
+
+
+class PortForm(forms.ModelForm):
+    """Port form definition class"""
+
+    container = forms.ModelChoiceField(
+        label="Container",
+        queryset=Container.objects.all(),
+        required=True,
+        widget=forms.HiddenInput,
+    )
+
+    class Meta:
+        """Port form definition Meta class"""
+
+        model = Port
+        fields = (
+            "container",
+            "public_port",
+            "private_port",
+            "type",
+        )
+        labels = {
+            "public_port": "Public Port",
+            "private_port": "Private Port",
+            "type": "Type",
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if "data" in kwargs:
+            container = Container.objects.filter(id=kwargs["data"]["container"])
+        elif "initial" in kwargs and "container" in kwargs["initial"]:
+            container = Container.objects.filter(id=kwargs["initial"]["container"])
+        else:
+            container = Container.objects.filter(id=self.instance.container.id)
+
+        self.instance._meta.verbose_name = f"Port mapping — {container.first()}"

netbox_docker_plugin-4.10.0/netbox_docker_plugin/forms/sysctl.py

@@ -0,0 +1,41 @@
+"""Sysctl Form definition"""
+
+from django import forms
+from ..models.container import Sysctl, Container
+
+
+class SysctlForm(forms.ModelForm):
+    """Sysctl form definition class"""
+
+    container = forms.ModelChoiceField(
+        label="Container",
+        queryset=Container.objects.all(),
+        required=True,
+        widget=forms.HiddenInput,
+    )
+
+    class Meta:
+        """Sysctl form definition Meta class"""
+
+        model = Sysctl
+        fields = (
+            "container",
+            "key",
+            "value",
+        )
+        labels = {
+            "key": " Sysctl Key",
+            "value": "Value",
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if "data" in kwargs:
+            container = Container.objects.filter(id=kwargs["data"]["container"])
+        elif "initial" in kwargs and "container" in kwargs["initial"]:
+            container = Container.objects.filter(id=kwargs["initial"]["container"])
+        else:
+            container = Container.objects.filter(id=self.instance.container.id)
+
+        self.instance._meta.verbose_name = f"Sysctl — {container.first()}"