netbox-docker-plugin 3.0.1__tar.gz → 3.3.0__tar.gz

{netbox_docker_plugin-3.0.1/netbox_docker_plugin.egg-info → netbox_docker_plugin-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: netbox-docker-plugin
-Version: 3.0.1
+Version: 3.3.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.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: license-file
 
 # Netbox Docker Plugin
 
@@ -19,6 +20,10 @@ Manage Docker with Netbox & style. Made to work with [netbox-docker-agent](https
 
 ![UI Container view with dependencies](/docs/assets/screenshot.png)
 
+Thanks [dzove855](https://github.com/dzove855) for the presentation of the plugin the 15th April 2025 during the Netbox Community Call.
+
+[![Netbox Docker Plugin presentation at Netbox Community call the 15th April 2025](https://img.youtube.com/vi/gRamXtFAspQ/sddefault.jpg)](https://youtu.be/gRamXtFAspQ?t=1870)
+
 ## How does it work?
 
 ```mermaid
@@ -32,12 +37,17 @@ sequenceDiagram
 Once the plugin and webhooks are installed, you can:
 
 1. Create hosts that point to
-   [agents](https://github.com/SaaShup/netbox-docker-agent) you had installed
+   [agents](https://github.com/SaaShup/netbox-docker-agent) you had installed *
 2. Retrieve informations from Docker API with the help of the agent
 3. Create containers on host with an image, expose ports, add env variables and
    labels, mount volumes, set networks.
 4. Manage the container status, start, stop, restart.
 
+* adding a host with curl needs a specific **Origin** header to make it working. Example :
+```
+curl -X POST -H "Authorization: Token xxxxx" -H "Content-Type: application/json" -H "Origin: https://myhost" https://myhost/api/plugins/docker/hosts/ -d '{"name": "test-add", "endpoint": "[https://xxxx:xxxx@test.com:1990"}](https://xxxx:xxxx@test.com:1990%22%7D)'
+```
+
 ## Installation
 
 Below the compatibility list of the Netbox Docker PLugin and Netbox. Please chose the right version of the plugin depending of the Netbox version you use:

{netbox_docker_plugin-3.0.1 → netbox_docker_plugin-3.3.0}/README.md

@@ -6,6 +6,10 @@ Manage Docker with Netbox & style. Made to work with [netbox-docker-agent](https
 
 ![UI Container view with dependencies](/docs/assets/screenshot.png)
 
+Thanks [dzove855](https://github.com/dzove855) for the presentation of the plugin the 15th April 2025 during the Netbox Community Call.
+
+[![Netbox Docker Plugin presentation at Netbox Community call the 15th April 2025](https://img.youtube.com/vi/gRamXtFAspQ/sddefault.jpg)](https://youtu.be/gRamXtFAspQ?t=1870)
+
 ## How does it work?
 
 ```mermaid
@@ -19,12 +23,17 @@ sequenceDiagram
 Once the plugin and webhooks are installed, you can:
 
 1. Create hosts that point to
-   [agents](https://github.com/SaaShup/netbox-docker-agent) you had installed
+   [agents](https://github.com/SaaShup/netbox-docker-agent) you had installed *
 2. Retrieve informations from Docker API with the help of the agent
 3. Create containers on host with an image, expose ports, add env variables and
    labels, mount volumes, set networks.
 4. Manage the container status, start, stop, restart.
 
+* adding a host with curl needs a specific **Origin** header to make it working. Example :
+```
+curl -X POST -H "Authorization: Token xxxxx" -H "Content-Type: application/json" -H "Origin: https://myhost" https://myhost/api/plugins/docker/hosts/ -d '{"name": "test-add", "endpoint": "[https://xxxx:xxxx@test.com:1990"}](https://xxxx:xxxx@test.com:1990%22%7D)'
+```
+
 ## Installation
 
 Below the compatibility list of the Netbox Docker PLugin and Netbox. Please chose the right version of the plugin depending of the Netbox version you use:

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

{netbox_docker_plugin-3.0.1 → netbox_docker_plugin-3.3.0}/netbox_docker_plugin/api/serializers.py

@@ -19,6 +19,7 @@ from ..models.container import (
     Bind,
     NetworkSetting,
     Device,
+    LogDriverOption,
 )
 from ..models.registry import Registry
 
@@ -28,6 +29,7 @@ class NestedTokenSerializer(WritableNestedSerializer):
 
     class Meta:
         """Nested Token Serializer Meta class"""
+
         model = Token
         fields = ["id", "url", "display_url", "display", "key", "write_enabled"]
 
@@ -95,6 +97,7 @@ class NestedVolumeSerializer(WritableNestedSerializer):
             "url",
             "display",
             "name",
+            "max_size",
             "driver",
         )
 
@@ -106,7 +109,11 @@ class NestedVolumeSerializer(WritableNestedSerializer):
             params = dict_to_filter_params(data)
             if Volume.objects.filter(**params).count() == 0:
                 host = Host.objects.get(pk=params["host"])
-                volume = Volume(host=host, name=params["name"])
+                volume = Volume(
+                    host=host,
+                    name=params["name"],
+                    max_size=params.get("max_size"),
+                )
                 volume.save()
                 return volume
 
@@ -158,6 +165,7 @@ class NestedContainerSerializer(WritableNestedSerializer):
             "operation",
             "hostname",
             "cap_add",
+            "log_driver",
         )
 
 
@@ -263,6 +271,7 @@ class VolumeSerializer(NetBoxModelSerializer):
             "display",
             "host",
             "name",
+            "max_size",
             "driver",
             "custom_fields",
             "created",
@@ -331,6 +340,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"""
 
@@ -414,6 +436,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"""
@@ -440,6 +463,8 @@ class ContainerSerializer(NetBoxModelSerializer):
             "binds",
             "network_settings",
             "devices",
+            "log_driver",
+            "log_driver_options",
             "custom_fields",
             "created",
             "last_updated",
@@ -451,6 +476,7 @@ class ContainerSerializer(NetBoxModelSerializer):
         attrs = data.copy()
         attrs.pop("ports", None)
         attrs.pop("env", None)
+        attrs.pop("log_driver_options", None)
         attrs.pop("labels", None)
         attrs.pop("mounts", None)
         attrs.pop("binds", None)
@@ -465,6 +491,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)
@@ -481,6 +508,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)
@@ -515,6 +546,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)
@@ -533,6 +565,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:

{netbox_docker_plugin-3.0.1 → netbox_docker_plugin-3.3.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,15 @@ 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):
@@ -113,7 +122,7 @@ class VolumeFilterSet(NetBoxModelFilterSet):
         """Volume filterset definition meta class"""
 
         model = Volume
-        fields = ("id", "name", "driver", "mounts")
+        fields = ("id", "name", "max_size", "driver", "mounts")
 
     # pylint: disable=W0613
     def search(self, queryset, name, value):
@@ -166,7 +175,14 @@ 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 +211,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-3.0.1 → netbox_docker_plugin-3.3.0}/netbox_docker_plugin/forms/container.py

@@ -15,7 +15,12 @@ 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,
+    ContainerLogDriverChoices,
+)
 from ..models.image import Image
 
 
@@ -44,6 +49,7 @@ class ContainerForm(NetBoxModelForm):
             "hostname",
             "restart_policy",
             "cap_add",
+            "log_driver",
             "tags",
         )
         labels = {
@@ -53,6 +59,7 @@ class ContainerForm(NetBoxModelForm):
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
             "cap_add": "Add Host capabilities",
+            "log_driver": "Logging driver",
         }
 
 
@@ -77,6 +84,7 @@ class ContainerEditForm(NetBoxModelForm):
             "hostname",
             "restart_policy",
             "cap_add",
+            "log_driver",
             "tags",
         )
         labels = {
@@ -85,6 +93,7 @@ class ContainerEditForm(NetBoxModelForm):
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
             "cap_add": "Add Host capabilities",
+            "log_driver": "Logging driver",
         }
 
 
@@ -112,6 +121,9 @@ class ContainerFilterForm(NetBoxModelFilterSetForm):
     restart_policy = forms.ChoiceField(
         label="Restart Policy", choices=ContainerRestartPolicyChoices, required=False
     )
+    log_driver = forms.ChoiceField(
+        label="Logging driver", choices=ContainerLogDriverChoices, required=False
+    )
     tag = TagFilterField(model)
 
 
@@ -126,6 +138,13 @@ class ContainerImportForm(NetBoxModelImportForm):
         + "`always`, `unless-stopped`.",
     )
 
+    log_driver = forms.ChoiceField(
+        label="Logging driver",
+        choices=ContainerLogDriverChoices,
+        required=False,
+        help_text="Logging driver. Can be `json-log`, `syslog`.",
+    )
+
     class Meta:
         """Container importation form definition Meta class"""
 
@@ -151,12 +170,17 @@ class ContainerBulkEditForm(NetBoxModelBulkEditForm):
         choices=ContainerRestartPolicyChoices,
         required=True,
     )
+    log_driver = forms.ChoiceField(
+        label="Logging driver",
+        choices=ContainerLogDriverChoices,
+        required=True,
+    )
     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-3.3.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-3.0.1 → netbox_docker_plugin-3.3.0}/netbox_docker_plugin/forms/volume.py

@@ -21,11 +21,13 @@ class VolumeForm(NetBoxModelForm):
         fields = (
             "host",
             "name",
+            "max_size",
             "driver",
             "tags",
         )
         labels = {
             "name": "Name",
+            "max_size": "Optional Maximum Size of Volume (in MB)",
             "host": "Host",
             "driver": "Driver",
         }
@@ -36,6 +38,7 @@ class VolumeFilterForm(NetBoxModelFilterSetForm):
 
     model = Volume
     name = forms.CharField(label="Name", max_length=256, min_length=1, required=False)
+    max_size = forms.IntegerField(label="Max Size (MB)", required=False)
     driver = forms.ChoiceField(
         label="Driver",
         choices=VolumeDriverChoices,
@@ -58,9 +61,10 @@ class VolumeImportForm(NetBoxModelImportForm):
         """Volume importation form definition Meta class"""
 
         model = Volume
-        fields = ("name", "driver", "host")
+        fields = ("name", "max_size", "driver", "host")
         labels = {
             "name": "Unique Image name",
+            "max_size": "Optional Maximum Size of Volume (in MB)",
             "driver": 'Volume provider. Can be "local"',
             "host": "Host identifier",
         }

netbox_docker_plugin-3.3.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-3.3.0/netbox_docker_plugin/migrations/0032_device_and_more.py

@@ -0,0 +1,99 @@
+# 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-3.3.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-3.3.0/netbox_docker_plugin/migrations/0034_volume_max_size.py

@@ -0,0 +1,24 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        ("netbox_docker_plugin", "0033_host_operation"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="volume",
+            name="max_size",
+            field=models.PositiveIntegerField(
+                null=True,
+                blank=True,
+                default=None,
+            ),
+        ),
+    ]