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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: netbox-docker-plugin
-Version: 2.8.0
+Version: 2.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
@@ -10,6 +10,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: license-file
 
 # Netbox Docker Plugin
 

{netbox_docker_plugin-2.8.0 → netbox_docker_plugin-2.10.0}/netbox_docker_plugin/__init__.py

@@ -4,20 +4,21 @@ from django.db.models.signals import post_migrate
 from netbox.plugins import PluginConfig
 from .utilities import create_webhook
 
+
 class NetBoxDockerConfig(PluginConfig):
     """Plugin Config Class"""
 
     name = "netbox_docker_plugin"
     verbose_name = " NetBox Docker Plugin"
     description = "Manage Docker"
-    version = "2.8.0"
+    version = "2.10.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"
+    min_version = "4.0.11"
+    author = "Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>"
+    author_email = "vincent@saashup.com, david.jose.delassus@gmail.com"
 
     def ready(self):
-        from . import signals # pylint: disable=unused-import, import-outside-toplevel
+        from . import signals  # pylint: disable=unused-import, import-outside-toplevel
 
         post_migrate.connect(create_webhook)
 

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

@@ -19,6 +19,7 @@ from ..models.container import (
     Bind,
     NetworkSetting,
     Device,
+    LogDriverOption,
 )
 from ..models.registry import Registry
 
@@ -43,6 +44,7 @@ class NestedHostSerializer(WritableNestedSerializer):
             "state",
             "agent_version",
             "docker_api_version",
+            "operation",
         )
 
 
@@ -148,6 +150,7 @@ class NestedContainerSerializer(WritableNestedSerializer):
             "operation",
             "hostname",
             "cap_add",
+            "log_driver",
         )
 
 
@@ -321,6 +324,19 @@ class EnvSerializer(serializers.ModelSerializer):
         )
 
 
+class LogDriverOptionSerializer(serializers.ModelSerializer):
+    """Container Log Driver Option Serializer class"""
+
+    class Meta:
+        """Container Log Driver Option Serializer Meta class"""
+
+        model = LogDriverOption
+        fields = (
+            "option_name",
+            "value",
+        )
+
+
 class LabelSerializer(serializers.ModelSerializer):
     """Container Label Serializer class"""
 
@@ -404,6 +420,7 @@ class ContainerSerializer(NetBoxModelSerializer):
     binds = BindSerializer(many=True, required=False)
     network_settings = NetworkSettingSerializer(many=True, required=False)
     devices = DeviceSerializer(many=True, required=False)
+    log_driver_options = LogDriverOptionSerializer(many=True, required=False)
 
     class Meta:
         """Container Serializer Meta class"""
@@ -430,6 +447,8 @@ class ContainerSerializer(NetBoxModelSerializer):
             "binds",
             "network_settings",
             "devices",
+            "log_driver",
+            "log_driver_options",
             "custom_fields",
             "created",
             "last_updated",
@@ -455,6 +474,7 @@ class ContainerSerializer(NetBoxModelSerializer):
     def create(self, validated_data):
         ports_data = validated_data.pop("ports", None)
         env_data = validated_data.pop("env", None)
+        log_driver_options_data = validated_data.pop("log_driver_options", None)
         labels_data = validated_data.pop("labels", None)
         mounts_data = validated_data.pop("mounts", None)
         binds_data = validated_data.pop("binds", None)
@@ -471,6 +491,10 @@ class ContainerSerializer(NetBoxModelSerializer):
             for env in env_data:
                 Env.objects.create(container=container, **env)
 
+        if log_driver_options_data is not None:
+            for option in log_driver_options_data:
+                LogDriverOption.objects.create(container=container, **option)
+
         if labels_data is not None:
             for label in labels_data:
                 Label.objects.create(container=container, **label)
@@ -505,6 +529,7 @@ class ContainerSerializer(NetBoxModelSerializer):
     def update(self, instance, validated_data):
         ports_data = validated_data.pop("ports", None)
         env_data = validated_data.pop("env", None)
+        log_driver_options_data = validated_data.pop("log_driver_options", None)
         labels_data = validated_data.pop("labels", None)
         mounts_data = validated_data.pop("mounts", None)
         binds_data = validated_data.pop("binds", None)
@@ -523,6 +548,11 @@ class ContainerSerializer(NetBoxModelSerializer):
             for env in env_data:
                 Env.objects.create(container=container, **env)
 
+        if log_driver_options_data is not None:
+            LogDriverOption.objects.filter(container=container).delete()
+            for option in log_driver_options_data:
+                LogDriverOption.objects.create(container=container, **option)
+
         if labels_data is not None:
             Label.objects.filter(container=container).delete()
             for label in labels_data:
@@ -615,6 +645,7 @@ class HostSerializer(NetBoxModelSerializer):
             "netbox_base_url",
             "agent_version",
             "docker_api_version",
+            "operation",
             "custom_fields",
             "created",
             "last_updated",

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

@@ -85,7 +85,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
@@ -145,6 +145,7 @@ class ContainerViewSet(NetBoxModelViewSet):
         "host",
         "ports",
         "labels",
+        "log_driver_options",
         "tags",
     )
     filterset_class = filtersets.ContainerFilterSet

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

@@ -16,6 +16,7 @@ from .models.container import (
     Bind,
     NetworkSetting,
     Device,
+    LogDriverOption,
 )
 from .models.registry import Registry
 
@@ -89,7 +90,7 @@ class ImageFilterSet(NetBoxModelFilterSet):
         """Image filterset definition meta class"""
 
         model = Image
-        fields = ("id", "name", "version", "size", "ImageID", "containers")
+        fields = ("id", "name", "version", "size", "ImageID", "Digest", "containers")
 
     # pylint: disable=W0613
     def search(self, queryset, name, value):
@@ -166,7 +167,7 @@ class ContainerFilterSet(NetBoxModelFilterSet):
         """Container filterset definition meta class"""
 
         model = Container
-        fields = ("id", "name", "state", "hostname", "restart_policy")
+        fields = ("id", "name", "state", "hostname", "restart_policy", "ContainerID")
 
     # pylint: disable=W0613
     def search(self, queryset, name, value):
@@ -195,6 +196,25 @@ class EnvFilterSet(BaseFilterSet):
         )
 
 
+class LogDriverOptionFilterSet(BaseFilterSet):
+    """Log driver option filterset definition class"""
+
+    container_id = ModelMultipleChoiceFilter(
+        field_name="container_id",
+        queryset=Container.objects.all(),
+        label="Container (ID)",
+    )
+
+    class Meta:
+        """Log driver option filterset definition meta class"""
+
+        model = LogDriverOption
+        fields = (
+            "id",
+            "option_name",
+        )
+
+
 class LabelFilterSet(BaseFilterSet):
     """Label filterset definition class"""
 

{netbox_docker_plugin-2.8.0 → netbox_docker_plugin-2.10.0}/netbox_docker_plugin/forms/container.py

@@ -15,7 +15,11 @@ 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,
+    ContainerCapAddChoices,
+)
 from ..models.image import Image
 
 
@@ -44,6 +48,7 @@ class ContainerForm(NetBoxModelForm):
             "hostname",
             "restart_policy",
             "cap_add",
+            "log_driver",
             "tags",
         )
         labels = {
@@ -53,6 +58,7 @@ class ContainerForm(NetBoxModelForm):
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
             "cap_add": "Add Host capabilities",
+            "log_driver": "Logging Driver",
         }
 
 
@@ -77,6 +83,7 @@ class ContainerEditForm(NetBoxModelForm):
             "hostname",
             "restart_policy",
             "cap_add",
+            "log_driver",
             "tags",
         )
         labels = {
@@ -85,6 +92,7 @@ class ContainerEditForm(NetBoxModelForm):
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
             "cap_add": "Add Host capabilities",
+            "log_driver": "Logging Driver",
         }
 
 
@@ -112,6 +120,7 @@ class ContainerFilterForm(NetBoxModelFilterSetForm):
     restart_policy = forms.ChoiceField(
         label="Restart Policy", choices=ContainerRestartPolicyChoices, required=False
     )
+    log_driver = forms.ChoiceField(label="Logging driver", required=False)
     tag = TagFilterField(model)
 
 
@@ -126,6 +135,12 @@ class ContainerImportForm(NetBoxModelImportForm):
         + "`always`, `unless-stopped`.",
     )
 
+    log_driver = forms.CharField(
+        label="Logging driver",
+        required=False,
+        help_text="Logging driver. Can be `json-file`, `syslog`.",
+    )
+
     class Meta:
         """Container importation form definition Meta class"""
 
@@ -151,12 +166,16 @@ class ContainerBulkEditForm(NetBoxModelBulkEditForm):
         choices=ContainerRestartPolicyChoices,
         required=True,
     )
+    log_driver = forms.CharField(
+        label="Logging driver",
+        required=False,
+    )
     hostname = forms.CharField(
         label="Hostname", max_length=256, min_length=1, required=False
     )
 
     model = Container
-    fieldsets = (FieldSet("restart_policy", "hostname", name="General"),)
+    fieldsets = (FieldSet("restart_policy", "log_driver", "hostname", name="General"),)
 
 
 class ContainerOperationForm(NetBoxModelForm):

{netbox_docker_plugin-2.8.0 → netbox_docker_plugin-2.10.0}/netbox_docker_plugin/forms/host.py

@@ -72,3 +72,13 @@ class HostBulkEditForm(NetBoxModelBulkEditForm):
 
     model = Host
     fieldsets = (FieldSet("endpoint", name="General"),)
+
+
+class HostOperationForm(NetBoxModelForm):
+    """Host Operation form definition class"""
+
+    class Meta:
+        """Host form definition Meta class"""
+
+        model = Host
+        fields = ("operation",)

netbox_docker_plugin-2.10.0/netbox_docker_plugin/forms/log_driver_option.py

@@ -0,0 +1,28 @@
+"""Log Driver option Form definition"""
+
+from django import forms
+from utilities.forms.fields import DynamicModelChoiceField
+from ..models.container import LogDriverOption, Container
+
+
+class LogDriverOptionForm(forms.ModelForm):
+    """Log Driver option form definition class"""
+
+    container = DynamicModelChoiceField(
+        label="Container", queryset=Container.objects.all(), required=True
+    )
+
+    class Meta:
+        """Log Driver option form definition Meta class"""
+
+        model = LogDriverOption
+        fields = (
+            "container",
+            "option_name",
+            "value",
+        )
+        labels = {
+            "container": "Container",
+            "option_name": "Option Name",
+            "value": "Value",
+        }

netbox_docker_plugin-2.10.0/netbox_docker_plugin/migrations/0031_container_cap_add.py

@@ -0,0 +1,37 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+import django.contrib.postgres.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        (
+            "netbox_docker_plugin",
+            "0030_alter_container_containerid_alter_container_hostname_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.RunSQL(
+            "ALTER TABLE netbox_docker_plugin_container "
+            + "ADD COLUMN IF NOT EXISTS cap_add character varying(32)[];",
+            state_operations=[
+                migrations.AddField(
+                    model_name="container",
+                    name="cap_add",
+                    field=django.contrib.postgres.fields.ArrayField(
+                        base_field=models.CharField(
+                            blank=True, max_length=32, null=True
+                        ),
+                        blank=True,
+                        null=True,
+                        size=None,
+                    ),
+                ),
+            ],
+        )
+    ]

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

@@ -0,0 +1,98 @@
+# 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.RunSQL(
+            """
+CREATE TABLE IF NOT EXISTS public.netbox_docker_plugin_device
+(
+    id bigint NOT NULL GENERATED BY DEFAULT AS IDENTITY,
+    host_path character varying(1024) NOT NULL,
+    container_path character varying(1024) NOT NULL,
+    container_id bigint NOT NULL,
+    CONSTRAINT netbox_docker_plugin_device_pkey PRIMARY KEY (id),
+    CONSTRAINT netbox_docker_plugin_device_unique_device UNIQUE
+        (container_id, container_path, host_path),
+    CONSTRAINT netbox_docker_plugin_container_id_a53ca874_fk_netbox_do FOREIGN KEY (container_id)
+        REFERENCES public.netbox_docker_plugin_container (id) MATCH SIMPLE
+        ON UPDATE NO ACTION
+        ON DELETE NO ACTION
+        DEFERRABLE INITIALLY DEFERRED
+);
+CREATE INDEX IF NOT EXISTS netbox_docker_plugin_device_container_id_a53ca874
+    ON public.netbox_docker_plugin_device USING btree
+    (container_id ASC NULLS LAST);
+            """,
+            state_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.10.0/netbox_docker_plugin/migrations/0033_host_operation.py

@@ -0,0 +1,26 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        ("netbox_docker_plugin", "0032_device_and_more"),
+    ]
+
+    operations = [
+        migrations.RunSQL(
+            "ALTER TABLE netbox_docker_plugin_host "
+            + "ADD COLUMN IF NOT EXISTS operation character varying(32);",
+            state_operations=[
+                migrations.AddField(
+                    model_name="host",
+                    name="operation",
+                    field=models.CharField(default="none", max_length=32),
+                ),
+            ],
+        )
+    ]

netbox_docker_plugin-2.10.0/netbox_docker_plugin/migrations/0034_container_log_driver_alter_container_containerid_and_more.py

@@ -0,0 +1,147 @@
+# 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", "0033_host_operation"),
+    ]
+
+    operations = [
+        migrations.RunSQL(
+            "ALTER TABLE netbox_docker_plugin_container "
+            + "ADD COLUMN IF NOT EXISTS log_driver character varying(32);",
+            state_operations=[
+                migrations.AddField(
+                    model_name="container",
+                    name="log_driver",
+                    field=models.CharField(blank=True, max_length=32, null=True),
+                ),
+            ],
+        ),
+        migrations.AlterField(
+            model_name="container",
+            name="ContainerID",
+            field=models.CharField(
+                blank=True,
+                max_length=128,
+                null=True,
+                validators=[
+                    django.core.validators.MinLengthValidator(limit_value=1),
+                    django.core.validators.MaxLengthValidator(limit_value=128),
+                ],
+            ),
+        ),
+        migrations.AlterField(
+            model_name="container",
+            name="hostname",
+            field=models.CharField(
+                blank=True,
+                max_length=256,
+                null=True,
+                validators=[
+                    django.core.validators.MinLengthValidator(limit_value=1),
+                    django.core.validators.MaxLengthValidator(limit_value=256),
+                ],
+            ),
+        ),
+        migrations.AlterField(
+            model_name="port",
+            name="public_port",
+            field=models.IntegerField(
+                validators=[
+                    django.core.validators.MinValueValidator(limit_value=-1),
+                    django.core.validators.MaxValueValidator(limit_value=65535),
+                ]
+            ),
+        ),
+        migrations.RunSQL(
+            """
+CREATE TABLE IF NOT EXISTS public.netbox_docker_plugin_logdriveroption
+(
+    id bigint NOT NULL GENERATED BY DEFAULT AS IDENTITY,
+    option_name character varying(255) NOT NULL,
+    value character varying(4096) NOT NULL,
+    container_id bigint NOT NULL,
+    CONSTRAINT netbox_docker_plugin_logdriveroption_pkey PRIMARY KEY (id),
+    CONSTRAINT netbox_docker_plugin_container_id_929d4dfe_fk_netbox_do FOREIGN KEY (container_id)
+        REFERENCES public.netbox_docker_plugin_container (id) MATCH SIMPLE
+        ON UPDATE NO ACTION
+        ON DELETE NO ACTION
+        DEFERRABLE INITIALLY DEFERRED
+);
+
+CREATE INDEX IF NOT EXISTS netbox_docker_plugin_logdriveroption_container_id_929d4dfe
+    ON public.netbox_docker_plugin_logdriveroption USING btree
+    (container_id ASC NULLS LAST);
+
+CREATE UNIQUE INDEX IF NOT EXISTS netbox_docker_plugin_logdriveroption_unique_option_name_contain
+    ON public.netbox_docker_plugin_logdriveroption USING btree
+    (option_name ASC NULLS LAST, container_id ASC NULLS LAST);
+            """,
+            state_operations=[
+                migrations.CreateModel(
+                    name="LogDriverOption",
+                    fields=[
+                        (
+                            "id",
+                            models.BigAutoField(
+                                auto_created=True, primary_key=True, serialize=False
+                            ),
+                        ),
+                        (
+                            "option_name",
+                            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=4096,
+                                validators=[
+                                    django.core.validators.MaxLengthValidator(
+                                        limit_value=4096
+                                    )
+                                ],
+                            ),
+                        ),
+                        (
+                            "container",
+                            models.ForeignKey(
+                                on_delete=django.db.models.deletion.CASCADE,
+                                related_name="log_driver_options",
+                                to="netbox_docker_plugin.container",
+                            ),
+                        ),
+                    ],
+                    options={
+                        "ordering": ("container", "option_name"),
+                    },
+                ),
+                migrations.AddConstraint(
+                    model_name="logdriveroption",
+                    constraint=models.UniqueConstraint(
+                        models.F("option_name"),
+                        models.F("container"),
+                        name="netbox_docker_plugin_logdriveroption_unique_option_name_container'",
+                    ),
+                ),
+            ],
+        ),
+    ]