netbox-docker-plugin 1.18.0__tar.gz → 2.0.0__tar.gz

{netbox_docker_plugin-1.18.0/netbox_docker_plugin.egg-info → netbox_docker_plugin-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 1.18.0
+Version: 2.0.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-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/__init__.py

@@ -1,7 +1,7 @@
 """Netbox Plugin Configuration"""
 
-from extras.plugins import PluginConfig
 from django.db.models.signals import post_migrate
+from netbox.plugins import PluginConfig
 from .utilities import create_webhook
 
 class NetBoxDockerConfig(PluginConfig):
@@ -10,9 +10,9 @@ class NetBoxDockerConfig(PluginConfig):
     name = "netbox_docker_plugin"
     verbose_name = " NetBox Docker Plugin"
     description = "Manage Docker"
-    version = "1.18.0"
-    max_version = "3.7.8"
+    version = "2.0.0"
     base_url = "docker"
+    min_version = "4.0.0"
     author= "Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>"
     author_email= "vincent@saashup.com, david.jose.delassus@gmail.com"
 

netbox_docker_plugin-2.0.0/netbox_docker_plugin/api/renderers.py

@@ -0,0 +1,14 @@
+""" Response renderers for Django Rest Framework """
+
+from django.utils.encoding import smart_str
+from rest_framework import renderers
+
+
+class PlainTextRenderer(renderers.BaseRenderer):
+    """ text/plain renderer """
+
+    media_type = "text/plain"
+    format = "txt"
+
+    def render(self, data, accepted_media_type=None, renderer_context=None):
+        return smart_str(data, encoding=self.charset)

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/api/serializers.py

@@ -3,7 +3,7 @@
 # pylint: disable=E1101
 
 from rest_framework import serializers
-from utilities.utils import dict_to_filter_params
+from utilities.query import dict_to_filter_params
 from users.api.nested_serializers import NestedTokenSerializer
 from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer
 from ..models.host import Host
@@ -18,7 +18,6 @@ from ..models.container import (
     Mount,
     Bind,
     NetworkSetting,
-    Device,
 )
 from ..models.registry import Registry
 
@@ -147,7 +146,6 @@ class NestedContainerSerializer(WritableNestedSerializer):
             "restart_policy",
             "operation",
             "hostname",
-            "cap_add",
         )
 
 
@@ -231,6 +229,7 @@ class ImageSerializer(NetBoxModelSerializer):
             "containers",
             "tags",
         )
+        brief_fields = NestedImageSerializer.Meta.fields
 
 
 class VolumeSerializer(NetBoxModelSerializer):
@@ -259,6 +258,7 @@ class VolumeSerializer(NetBoxModelSerializer):
             "mounts",
             "tags",
         )
+        brief_fields = NestedVolumeSerializer.Meta.fields
 
 
 class NetworkSerializer(NetBoxModelSerializer):
@@ -289,6 +289,7 @@ class NetworkSerializer(NetBoxModelSerializer):
             "network_settings",
             "tags",
         )
+        brief_fields = NestedNetworkSerializer.Meta.fields
 
 
 class PortSerializer(serializers.ModelSerializer):
@@ -373,19 +374,6 @@ 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"""
 
@@ -400,7 +388,6 @@ 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"""
@@ -419,19 +406,18 @@ class ContainerSerializer(NetBoxModelSerializer):
             "ContainerID",
             "hostname",
             "restart_policy",
-            "cap_add",
             "ports",
             "env",
             "labels",
             "mounts",
             "binds",
             "network_settings",
-            "devices",
             "custom_fields",
             "created",
             "last_updated",
             "tags",
         )
+        brief_fields = NestedContainerSerializer.Meta.fields
 
     def validate(self, data):
         attrs = data.copy()
@@ -441,13 +427,11 @@ 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)
@@ -455,7 +439,6 @@ 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)
 
@@ -489,15 +472,8 @@ 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)
@@ -505,7 +481,6 @@ 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)
 
@@ -545,13 +520,6 @@ 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
 
 
@@ -580,6 +548,7 @@ class RegistrySerializer(NetBoxModelSerializer):
             "email",
             "images",
         )
+        brief_fields = NestedRegistrySerializer.Meta.fields
 
 
 class HostSerializer(NetBoxModelSerializer):
@@ -620,6 +589,7 @@ class HostSerializer(NetBoxModelSerializer):
             "containers",
             "registries",
         )
+        brief_fields = NestedHostSerializer.Meta.fields
 
 
 class ContainerCommandSerializer(serializers.Serializer):

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/api/views.py

@@ -3,7 +3,6 @@
 from collections.abc import Sequence
 import json
 import requests
-from django.utils.html import escape
 from rest_framework import status
 from rest_framework.renderers import JSONRenderer
 from rest_framework.decorators import action
@@ -16,7 +15,7 @@ from drf_spectacular.utils import (
 from users.models import Token
 from netbox.api.viewsets import NetBoxModelViewSet
 from .. import filtersets
-from .renderers import make_content_type_renderer
+from .renderers import PlainTextRenderer
 from .serializers import (
     HostSerializer,
     ImageSerializer,
@@ -72,47 +71,6 @@ class ImageViewSet(NetBoxModelViewSet):
     serializer_class = ImageSerializer
     http_method_names = ["get", "post", "patch", "delete", "options"]
 
-    @extend_schema(
-        operation_id="plugins_docker_image_force_pull",
-        responses={
-            (200, "application/json"): OpenApiResponse(response=str),
-            (502, "application/json"): OpenApiResponse(response=str),
-        },
-    )
-    @action(
-        detail=True,
-        methods=["post"],
-        renderer_classes=[JSONRenderer],
-    )
-    def force_pull(self, _request, **_kwargs):
-        """ Force pull an existing image """
-
-        image: Image = self.get_object()
-        agent_url = image.host.endpoint
-
-        url = f"{agent_url}/api/engine/images"
-
-        try:
-            serializer = self.get_serializer(image)
-            data = serializer.data
-            data["force"] = True
-
-            resp = requests.post(url, timeout=10, json={"data": data})
-            resp.raise_for_status()
-
-        except requests.HTTPError:
-            return Response(
-                {"success": False, "payload": resp.text},
-                status=status.HTTP_502_BAD_GATEWAY,
-                content_type="application/json",
-            )
-
-        return Response(
-            {"success": True, "payload": resp.json()},
-            status=status.HTTP_200_OK,
-            content_type="application/json",
-        )
-
 
 class VolumeViewSet(NetBoxModelViewSet):
     """Volume view set class"""
@@ -136,7 +94,6 @@ class ContainerViewSet(NetBoxModelViewSet):
     """Container view set class"""
 
     queryset = Container.objects.prefetch_related(
-        "devices",
         "network_settings",
         "mounts",
         "binds",
@@ -154,13 +111,13 @@ class ContainerViewSet(NetBoxModelViewSet):
     @extend_schema(
         operation_id="plugins_docker_container_logs",
         responses={
-            (200, "text/html"): OpenApiResponse(
+            (200, "text/plain"): OpenApiResponse(
                 response=str,
                 examples=[
                     OpenApiExample(
                         "Container's logs",
                         value="Hello World",
-                        media_type="text/html",
+                        media_type="text/plain",
                     ),
                 ],
             ),
@@ -179,7 +136,7 @@ class ContainerViewSet(NetBoxModelViewSet):
     @action(
         detail=True,
         methods=["get"],
-        renderer_classes=[make_content_type_renderer("text/html", "txt")],
+        renderer_classes=[PlainTextRenderer],
     )
     def logs(self, _request, **_kwargs):
         """Fetch container's logs"""
@@ -196,22 +153,22 @@ class ContainerViewSet(NetBoxModelViewSet):
 
         except requests.HTTPError:
             return Response(
-                escape(resp.text),
+                resp.text,
                 status=status.HTTP_502_BAD_GATEWAY,
-                content_type="text/html",
+                content_type="text/plain",
             )
 
         return Response(
-            escape(resp.text),
+            resp.text,
             status=status.HTTP_200_OK,
-            content_type="text/html",
+            content_type="text/plain",
         )
 
     @extend_schema(
         operation_id="plugins_docker_container_exec",
         request=ContainerCommandSerializer,
         responses={
-            (200, "application/json"): OpenApiResponse(
+            (200, "text/plain"): OpenApiResponse(
                 response=str,
                 examples=[
                     OpenApiExample(
@@ -221,13 +178,13 @@ class ContainerViewSet(NetBoxModelViewSet):
                     ),
                 ],
             ),
-            (502, "text/html"): OpenApiResponse(
+            (502, "text/plain"): OpenApiResponse(
                 response=str,
                 examples=[
                     OpenApiExample(
                         "Engine error",
                         value="Error as returned by Agent",
-                        media_type="text/html",
+                        media_type="text/plain",
                     ),
                 ],
             ),
@@ -258,9 +215,9 @@ class ContainerViewSet(NetBoxModelViewSet):
 
         except requests.HTTPError:
             return Response(
-                escape(resp.text),
+                resp.text,
                 status=status.HTTP_502_BAD_GATEWAY,
-                content_type="text/html",
+                content_type="text/plain",
             )
 
         return Response(data=json.loads(resp.text))

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/filtersets.py

@@ -15,7 +15,6 @@ from .models.container import (
     Mount,
     Bind,
     NetworkSetting,
-    Device,
 )
 from .models.registry import Registry
 
@@ -289,19 +288,3 @@ 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-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/bind.py

@@ -1,7 +1,6 @@
 """Mount Form definition"""
 
 from django import forms
-from utilities.forms.mixins import BootstrapMixin
 from utilities.forms.fields import (
     DynamicModelMultipleChoiceField,
     DynamicModelChoiceField,
@@ -12,7 +11,7 @@ from netbox.forms import (
 from ..models.container import Bind, Container
 
 
-class BindForm(BootstrapMixin, forms.ModelForm):
+class BindForm(forms.ModelForm):
     """Bind form definition class"""
 
     container = DynamicModelChoiceField(

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/container.py

@@ -1,6 +1,7 @@
 """Container Forms definitions"""
 
 from django import forms
+from utilities.forms.rendering import FieldSet
 from utilities.forms.fields import (
     TagFilterField,
     DynamicModelMultipleChoiceField,
@@ -14,11 +15,7 @@ from netbox.forms import (
 )
 from ..models.volume import Volume
 from ..models.host import Host
-from ..models.container import (
-    Container,
-    ContainerRestartPolicyChoices,
-    ContainerCapAddChoices,
-)
+from ..models.container import Container, ContainerRestartPolicyChoices
 from ..models.image import Image
 
 
@@ -34,7 +31,6 @@ class ContainerForm(NetBoxModelForm):
         required=True,
         query_params={"host_id": "$host"},
     )
-    cap_add = forms.MultipleChoiceField(choices=ContainerCapAddChoices, required=False)
 
     class Meta:
         """Container form definition Meta class"""
@@ -46,7 +42,6 @@ class ContainerForm(NetBoxModelForm):
             "name",
             "hostname",
             "restart_policy",
-            "cap_add",
             "tags",
         )
         labels = {
@@ -55,7 +50,6 @@ class ContainerForm(NetBoxModelForm):
             "image": "Image",
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
-            "cap_add": "Add Host capabilities",
         }
 
 
@@ -68,7 +62,6 @@ class ContainerEditForm(NetBoxModelForm):
         required=True,
         query_params={"host_id": "$host"},
     )
-    cap_add = forms.MultipleChoiceField(choices=ContainerCapAddChoices, required=False)
 
     class Meta:
         """Container form definition Meta class"""
@@ -79,7 +72,6 @@ class ContainerEditForm(NetBoxModelForm):
             "name",
             "hostname",
             "restart_policy",
-            "cap_add",
             "tags",
         )
         labels = {
@@ -87,7 +79,6 @@ class ContainerEditForm(NetBoxModelForm):
             "image": "Image",
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
-            "cap_add": "Add Host capabilities",
         }
 
 
@@ -159,7 +150,7 @@ class ContainerBulkEditForm(NetBoxModelBulkEditForm):
     )
 
     model = Container
-    fieldsets = (("General", ("restart_policy", "hostname")),)
+    fieldsets = (FieldSet("restart_policy", "hostname", name="General"),)
 
 
 class ContainerOperationForm(NetBoxModelForm):

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/env.py

@@ -2,11 +2,10 @@
 
 from django import forms
 from utilities.forms.fields import DynamicModelChoiceField
-from utilities.forms.mixins import BootstrapMixin
 from ..models.container import Env, Container
 
 
-class EnvForm(BootstrapMixin, forms.ModelForm):
+class EnvForm(forms.ModelForm):
     """Env form definition class"""
 
     container = DynamicModelChoiceField(

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/host.py

@@ -1,6 +1,7 @@
 """Host Forms definitions"""
 
 from django import forms
+from utilities.forms.rendering import FieldSet
 from utilities.forms.fields import TagFilterField
 from netbox.forms import (
     NetBoxModelForm,
@@ -70,4 +71,4 @@ class HostBulkEditForm(NetBoxModelBulkEditForm):
     )
 
     model = Host
-    fieldsets = (("General", ("endpoint",)),)
+    fieldsets = (FieldSet("endpoint", name="General"),)

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/image.py

@@ -1,6 +1,7 @@
 """Image Forms definitions"""
 
 from django import forms
+from utilities.forms.rendering import FieldSet
 from utilities.forms.fields import (
     TagFilterField,
     DynamicModelMultipleChoiceField,
@@ -101,4 +102,4 @@ class ImageBulkEditForm(NetBoxModelBulkEditForm):
     )
 
     model = Image
-    fieldsets = (("General", ("version",)),)
+    fieldsets = (FieldSet("version", name="General"),)

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/label.py

@@ -2,11 +2,10 @@
 
 from django import forms
 from utilities.forms.fields import DynamicModelChoiceField
-from utilities.forms.mixins import BootstrapMixin
 from ..models.container import Label, Container
 
 
-class LabelForm(BootstrapMixin, forms.ModelForm):
+class LabelForm(forms.ModelForm):
     """Label form definition class"""
 
     container = DynamicModelChoiceField(

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/mount.py

@@ -1,7 +1,6 @@
 """Mount Form definition"""
 
 from django import forms
-from utilities.forms.mixins import BootstrapMixin
 from utilities.forms.fields import (
     DynamicModelMultipleChoiceField,
     DynamicModelChoiceField,
@@ -13,7 +12,7 @@ from ..models.container import Mount, Container
 from ..models.volume import Volume
 
 
-class MountForm(BootstrapMixin, forms.ModelForm):
+class MountForm(forms.ModelForm):
     """Mount form definition class"""
 
     container = DynamicModelChoiceField(

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/network.py

@@ -1,6 +1,7 @@
 """Network Forms definitions"""
 
 from django import forms
+from utilities.forms.rendering import FieldSet
 from utilities.forms.fields import TagFilterField, DynamicModelMultipleChoiceField
 from utilities.choices import ChoiceSet
 from netbox.forms import (
@@ -103,9 +104,4 @@ class NetworkBulkEditForm(NetBoxModelBulkEditForm):
     NetworkID = forms.CharField(required=False, label="NetworkID")
 
     model = Network
-    fieldsets = (
-        (
-            "General",
-            ("driver", "NetworkID"),
-        ),
-    )
+    fieldsets =(FieldSet("driver", "NetworkID", name="General"),)

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/network_setting.py

@@ -5,7 +5,6 @@ from utilities.forms.fields import (
     DynamicModelMultipleChoiceField,
     DynamicModelChoiceField,
 )
-from utilities.forms.mixins import BootstrapMixin
 from netbox.forms import (
     NetBoxModelFilterSetForm,
 )
@@ -13,7 +12,7 @@ from ..models.container import NetworkSetting, Container
 from ..models.network import Network
 
 
-class NetworkSettingForm(BootstrapMixin, forms.ModelForm):
+class NetworkSettingForm(forms.ModelForm):
     """NetworkSetting form definition class"""
 
     container = DynamicModelChoiceField(

{netbox_docker_plugin-1.18.0 → netbox_docker_plugin-2.0.0}/netbox_docker_plugin/forms/port.py

@@ -2,11 +2,10 @@
 
 from django import forms
 from utilities.forms.fields import DynamicModelChoiceField
-from utilities.forms.mixins import BootstrapMixin
 from ..models.container import Port, Container
 
 
-class PortForm(BootstrapMixin, forms.ModelForm):
+class PortForm(forms.ModelForm):
     """Port form definition class"""
 
     container = DynamicModelChoiceField(