netbox-docker-plugin 5.1.1__tar.gz → 5.3.0__tar.gz

{netbox_docker_plugin-5.1.1/netbox_docker_plugin.egg-info → netbox_docker_plugin-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-docker-plugin
-Version: 5.1.1
+Version: 5.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

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

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/api/serializers.py

@@ -5,6 +5,8 @@
 from rest_framework import serializers
 from utilities.query import dict_to_filter_params
 from users.models import Token
+from virtualization.api.serializers import VirtualMachineSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer, TenantGroupSerializer
 from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer
 from ..models.host import Host
 from ..models.image import Image
@@ -239,6 +241,8 @@ class ImageSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_docker_plugin-api:image-detail"
     )
+    tenant_group = TenantGroupSerializer(nested=True, required=False, allow_null=True)
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
     host = NestedHostSerializer()
     containers = NestedContainerSerializer(many=True, read_only=True)
     registry = NestedRegistrySerializer()
@@ -251,6 +255,8 @@ class ImageSerializer(NetBoxModelSerializer):
             "id",
             "url",
             "display",
+            "tenant_group",
+            "tenant",
             "host",
             "name",
             "version",
@@ -693,6 +699,7 @@ class HostSerializer(NetBoxModelSerializer):
     containers = NestedContainerSerializer(many=True, read_only=True)
     registries = NestedRegistrySerializer(many=True, read_only=True)
     token = NestedTokenSerializer(read_only=True)
+    virtual_machine = VirtualMachineSerializer(required=False)
 
     class Meta:
         """Host Serializer Meta class"""
@@ -706,6 +713,7 @@ class HostSerializer(NetBoxModelSerializer):
             "name",
             "state",
             "token",
+            "virtual_machine",
             "netbox_base_url",
             "agent_version",
             "docker_api_version",

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/api/views.py

@@ -39,7 +39,13 @@ class HostViewSet(NetBoxModelViewSet):
     """Host view set class"""
 
     queryset = Host.objects.prefetch_related(
-        "images", "volumes", "networks", "containers", "registries", "tags"
+        "images",
+        "volumes",
+        "networks",
+        "containers",
+        "registries",
+        "virtual_machine",
+        "tags",
     )
     filterset_class = filtersets.HostFilterSet
     serializer_class = HostSerializer
@@ -108,7 +114,7 @@ class ImageViewSet(NetBoxModelViewSet):
                 url,
                 timeout=10,
                 data=json.dumps({"data": data}, cls=DjangoJSONEncoder),
-                headers={"Content-Type": "application/json"}
+                headers={"Content-Type": "application/json"},
             )
             resp.raise_for_status()
 

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/filtersets.py

@@ -2,6 +2,7 @@
 
 from django_filters import filters, ModelMultipleChoiceFilter
 from django.db.models import Q
+from tenancy.models import Tenant, TenantGroup
 from netbox.filtersets import NetBoxModelFilterSet, BaseFilterSet
 from .models.host import Host
 from .models.image import Image
@@ -38,6 +39,7 @@ class HostFilterSet(NetBoxModelFilterSet):
             "state",
             "agent_version",
             "docker_api_version",
+            "virtual_machine",
         )
 
     # pylint: disable=W0613
@@ -76,6 +78,16 @@ class ImageFilterSet(NetBoxModelFilterSet):
     """Image filterset definition class"""
 
     name = filters.CharFilter(lookup_expr="icontains")
+    tenant_group_id = ModelMultipleChoiceFilter(
+        field_name="tenant_group_id",
+        queryset=TenantGroup.objects.all(),
+        label="Tenant Group (ID)",
+    )
+    tenant_id = ModelMultipleChoiceFilter(
+        field_name="tenant_id",
+        queryset=Tenant.objects.all(),
+        label="Tenant (ID)",
+    )
     host_id = ModelMultipleChoiceFilter(
         field_name="host_id",
         queryset=Host.objects.all(),

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/forms/host.py

@@ -2,7 +2,8 @@
 
 from django import forms
 from utilities.forms.rendering import FieldSet
-from utilities.forms.fields import TagFilterField
+from utilities.forms.fields import TagFilterField, DynamicModelChoiceField
+from virtualization.models import VirtualMachine
 from netbox.forms import (
     NetBoxModelForm,
     NetBoxModelImportForm,
@@ -12,9 +13,43 @@ from netbox.forms import (
 from ..models.host import Host, HostStateChoices
 
 
+class HostAddForm(NetBoxModelForm):
+    """Host form definition class"""
+
+    virtual_machine = DynamicModelChoiceField(
+        queryset=VirtualMachine.objects.all(),
+        selector=True,
+        required=False,
+        label="Virtual Machine",
+    )
+
+    class Meta:
+        """Host form definition Meta class"""
+
+        model = Host
+        fields = (
+            "name",
+            "endpoint",
+            "virtual_machine",
+        )
+        help_texts = {"name": "Unique Name", "endpoint": "Docker instance endpoint"}
+        labels = {"name": "Name", "endpoint": "Endpoint"}
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.fields.pop("tags", None)
+
+
 class HostForm(NetBoxModelForm):
     """Host form definition class"""
 
+    virtual_machine = DynamicModelChoiceField(
+        queryset=VirtualMachine.objects.all(),
+        selector=True,
+        required=False,
+        label="Virtual Machine",
+    )
+
     class Meta:
         """Host form definition Meta class"""
 
@@ -22,6 +57,7 @@ class HostForm(NetBoxModelForm):
         fields = (
             "name",
             "endpoint",
+            "virtual_machine",
             "tags",
         )
         help_texts = {"name": "Unique Name", "endpoint": "Docker instance endpoint"}

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/forms/image.py

@@ -7,6 +7,7 @@ from utilities.forms.fields import (
     DynamicModelMultipleChoiceField,
     DynamicModelChoiceField,
 )
+from tenancy.models import Tenant, TenantGroup
 from netbox.forms import (
     NetBoxModelForm,
     NetBoxModelImportForm,
@@ -21,6 +22,13 @@ from ..models.registry import Registry
 class ImageForm(NetBoxModelForm):
     """Image form definition class"""
 
+    tenant_group = DynamicModelChoiceField(
+        label="Tenant Group", queryset=TenantGroup.objects.all(), required=False
+    )
+    tenant = DynamicModelChoiceField(
+        label="Tenant", queryset=Tenant.objects.all(), required=False,
+        query_params={"group_id": "$tenant_group"},
+    )
     host = DynamicModelChoiceField(
         label="Host", queryset=Host.objects.all(), required=True
     )
@@ -31,11 +39,18 @@ class ImageForm(NetBoxModelForm):
         query_params={"host_id": "$host"},
     )
 
+    fieldsets = (
+        FieldSet("host", "registry", "name", "version", "tags", name="General"),
+        FieldSet("tenant_group", "tenant", name="Tenancy"),
+    )
+
     class Meta:
         """Image form definition Meta class"""
 
         model = Image
         fields = (
+            "tenant_group",
+            "tenant",
             "host",
             "registry",
             "name",
@@ -44,6 +59,8 @@ class ImageForm(NetBoxModelForm):
         )
         labels = {
             "name": "Name",
+            "tenant_group": "Tenant Group",
+            "tenant": "Tenant",
             "host": "Host",
             "registry": "Registry",
             "version": "Version",
@@ -54,6 +71,16 @@ class ImageFilterForm(NetBoxModelFilterSetForm):
     """Image filter form definition class"""
 
     model = Image
+    tenant_group_id = DynamicModelMultipleChoiceField(
+        queryset=TenantGroup.objects.all(),
+        required=False,
+        label="Tenant Group",
+    )
+    tenant_id = DynamicModelMultipleChoiceField(
+        queryset=Tenant.objects.all(),
+        required=False,
+        label="Tenant",
+    )
     name = forms.CharField(label="Name", max_length=256, min_length=1, required=False)
     version = forms.CharField(
         label="Version", max_length=256, min_length=1, required=False
@@ -97,9 +124,20 @@ class ImageImportForm(NetBoxModelImportForm):
 class ImageBulkEditForm(NetBoxModelBulkEditForm):
     """Image bulk edit form definition class"""
 
+    tenant_group = DynamicModelChoiceField(
+        queryset=TenantGroup.objects.all(),
+        required=False,
+    )
+    tenant = DynamicModelChoiceField(
+        queryset=Tenant.objects.all(),
+        required=False,
+    )
     version = forms.CharField(
         required=False,
     )
 
     model = Image
-    fieldsets = (FieldSet("version", name="General"),)
+    fieldsets = (
+        FieldSet("version", name="General"),
+        FieldSet("tenant_group", "tenant", name="Tenancy"),
+    )

netbox_docker_plugin-5.3.0/netbox_docker_plugin/migrations/1044_host_virtual_machine.py

@@ -0,0 +1,29 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        (
+            "netbox_docker_plugin",
+            "1043_container_cap_drop_container_extra_hosts_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="host",
+            name="virtual_machine",
+            field=models.OneToOneField(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                to="virtualization.virtualmachine",
+            ),
+        ),
+    ]

netbox_docker_plugin-5.3.0/netbox_docker_plugin/migrations/1045_image_tenant_image_tenant_group.py

@@ -0,0 +1,38 @@
+# pylint: disable=C0103
+"""Migration file"""
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migration file"""
+
+    dependencies = [
+        ("netbox_docker_plugin", "1044_host_virtual_machine"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="image",
+            name="tenant",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="images",
+                to="tenancy.tenant",
+            ),
+        ),
+        migrations.AddField(
+            model_name="image",
+            name="tenant_group",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="images",
+                to="tenancy.tenantgroup",
+            ),
+        ),
+    ]

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/models/container.py

@@ -328,6 +328,7 @@ class Container(NetBoxModel):
         return reverse("plugins:netbox_docker_plugin:container", args=[self.pk])
 
     def clean(self):
+        """Validate that the image belongs to the same host and has been pulled."""
         super().clean()
 
         if self.host != self.image.host:
@@ -335,6 +336,11 @@ class Container(NetBoxModel):
                 {"image": f"Image {self.image} does not belong to host {self.host}."}
             )
 
+        if not self.image.ImageID:
+            raise ValidationError(
+                {"image": f"Image {self.image} has no ID yet. Pull or refresh it first."}
+            )
+
 
 class Port(models.Model):
     """Container definition class"""

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/models/host.py

@@ -9,6 +9,7 @@ from django.core.validators import (
 )
 from utilities.choices import ChoiceSet
 from users.models import Token
+from virtualization.models import VirtualMachine
 from netbox.models import NetBoxModel
 
 
@@ -64,6 +65,12 @@ class Host(NetBoxModel):
         default=HostStateChoices.STATE_CREATED,
     )
     token = models.ForeignKey(Token, on_delete=models.SET_NULL, null=True, blank=True)
+    virtual_machine = models.OneToOneField(
+        VirtualMachine,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+    )
     netbox_base_url = models.CharField(
         max_length=1024,
         validators=[URLValidator()],

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/models/image.py

@@ -8,6 +8,7 @@ from django.core.validators import (
     MinValueValidator,
     MaxValueValidator,
 )
+from tenancy.models import Tenant, TenantGroup
 from netbox.models import NetBoxModel
 from .host import Host
 from .registry import Registry
@@ -16,6 +17,20 @@ from .registry import Registry
 class Image(NetBoxModel):
     """Image definition class"""
 
+    tenant_group = models.ForeignKey(
+        TenantGroup,
+        on_delete=models.SET_NULL,
+        related_name="images",
+        blank=True,
+        null=True,
+    )
+    tenant = models.ForeignKey(
+        Tenant,
+        on_delete=models.SET_NULL,
+        related_name="images",
+        blank=True,
+        null=True,
+    )
     host = models.ForeignKey(Host, on_delete=models.CASCADE, related_name="images")
     registry = models.ForeignKey(
         Registry,

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/tables.py

@@ -26,6 +26,7 @@ class HostTable(NetBoxTable):
     """Host Table definition class"""
 
     name = tables.Column(linkify=True)
+    virtual_machine = tables.Column(linkify=True, verbose_name="Virtual Machine")
     image_count = columns.LinkedCountColumn(
         viewname="plugins:netbox_docker_plugin:image_list",
         url_params={"host_id": "pk"},
@@ -62,6 +63,7 @@ class HostTable(NetBoxTable):
             "name",
             "endpoint",
             "state",
+            "virtual_machine",
             "agent_version",
             "docker_api_version",
             "image_count",
@@ -139,6 +141,8 @@ class MinRegistryTable(NetBoxTable):
 class ImageTable(NetBoxTable):
     """Image Table definition class"""
 
+    tenant_group = tables.Column(linkify=True)
+    tenant = tables.Column(linkify=True)
     host = tables.Column(linkify=True)
     registry = tables.Column(linkify=True)
     name = tables.Column(linkify=True)
@@ -160,6 +164,8 @@ class ImageTable(NetBoxTable):
         fields = (
             "pk",
             "id",
+            "tenant_group",
+            "tenant",
             "host",
             "name",
             "version",
@@ -170,6 +176,8 @@ class ImageTable(NetBoxTable):
             "tags",
         )
         default_columns = (
+            "tenant_group",
+            "tenant",
             "host",
             "name",
             "version",

netbox_docker_plugin-5.3.0/netbox_docker_plugin/template_content.py

@@ -0,0 +1,23 @@
+"""Template modifications definitions"""
+
+# pylint: disable=W0223
+
+from netbox.plugins import PluginTemplateExtension
+from .models import Host
+
+
+class VirtualMachineHostTable(PluginTemplateExtension):
+    """Virtual machine object template"""
+
+    models = ["virtualization.virtualmachine"]
+
+    def right_page(self):
+        return self.render(
+            "netbox_docker_plugin/virtual_machine_host_table.html",
+            extra_context={
+                "Host": Host.objects.filter(virtual_machine=self.context["object"])
+            },
+        )
+
+
+template_extensions = [VirtualMachineHostTable]

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/templates/netbox_docker_plugin/host.html

@@ -27,6 +27,17 @@
           <th scope="row">Endpoint</th>
           <td>{{ object.endpoint|remove_password }}</td>
         </tr>
+        <tr>
+          <th scope="row">Virtual Machine</th>
+          <td>
+            {% if object.virtual_machine %}
+            <a href="{% url 'virtualization:virtualmachine' pk=object.virtual_machine.pk %}">
+              {{ object.virtual_machine|placeholder }}</a>
+            {% else %}
+            {{ object.virtual_machine|placeholder }}</a>
+            {% endif %}
+          </td>
+        </tr>
         <tr>
           <th scope="row">State</th>
           <td>{{ object.get_state_display }}</td>

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/templates/netbox_docker_plugin/image.html

@@ -103,6 +103,31 @@
         </tr>
       </table>
     </div>
+    <div class="card">
+      <h2 class="card-header">Tenancy</h2>
+      <table class="table table-hover attr-table">
+        <tr>
+          <th scope="row">Tenant Group</th>
+          <td>
+            {% if object.tenant_group %}
+              <a href="{{ object.tenant_group.get_absolute_url }}">{{ object.tenant_group }}</a>
+            {% else %}
+              {{ None|placeholder }}
+            {% endif %}
+          </td>
+        </tr>
+        <tr>
+          <th scope="row">Tenant</th>
+          <td>
+            {% if object.tenant %}
+              <a href="{{ object.tenant.get_absolute_url }}">{{ object.tenant }}</a>
+            {% else %}
+              {{ None|placeholder }}
+            {% endif %}
+          </td>
+        </tr>
+      </table>
+    </div>
     {% include 'inc/panels/custom_fields.html' %}
     {% include 'inc/panels/tags.html' %}
     {% plugin_left_page object %}

netbox_docker_plugin-5.3.0/netbox_docker_plugin/templates/netbox_docker_plugin/virtual_machine_host_table.html

@@ -0,0 +1,4 @@
+<div class="card">
+    <h2 class="card-header">Docker Host</h2>
+    {% htmx_table 'plugins:netbox_docker_plugin:host_list' virtual_machine=object.pk %}
+</div>

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/tests/container/test_container_api.py

@@ -70,8 +70,18 @@ class ContainerApiTestCase(
             host=host2, name="registry2", serveraddress="http://localhost:8082"
         )
 
-        image1 = Image.objects.create(host=host1, name="image1", registry=registry1)
-        image2 = Image.objects.create(host=host2, name="image2", registry=registry2)
+        image1 = Image.objects.create(
+            host=host1,
+            name="image1",
+            registry=registry1,
+            ImageID="sha256:abc123",
+        )
+        image2 = Image.objects.create(
+            host=host2,
+            name="image2",
+            registry=registry2,
+            ImageID="sha256:abc456",
+        )
 
         network1 = Network.objects.create(host=host1, name="network1")
         network2 = Network.objects.create(host=host2, name="network2")
@@ -244,6 +254,7 @@ class ContainerApiTestCase(
             host=host3,
             name="image3",
             registry=registry3,
+            ImageID="sha256:abc789",
         )
         container11 = Container.objects.create(
             host=host3,
@@ -330,8 +341,18 @@ class ContainerApiTestCase(
             host=host2, name="registry5", serveraddress="http://localhost:8082"
         )
 
-        image1 = Image.objects.create(host=host1, name="image", registry=registry1)
-        image2 = Image.objects.create(host=host2, name="image", registry=registry2)
+        image1 = Image.objects.create(
+            host=host1,
+            name="image",
+            registry=registry1,
+            ImageID="sha256:abc101112",
+        )
+        image2 = Image.objects.create(
+            host=host2,
+            name="image",
+            registry=registry2,
+            ImageID="sha256:abc131415",
+        )
 
         container = Container.objects.create(host=host1, image=image1, name="container")
 

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/tests/container/test_container_api_exec.py

@@ -28,7 +28,12 @@ class ContainerApiExecTestCase(BaseAPITestCase):
             host=host1, name="registry1", serveraddress="http://localhost:8080"
         )
 
-        image1 = Image.objects.create(host=host1, name="image1", registry=registry1)
+        image1 = Image.objects.create(
+            host=host1,
+            name="image1",
+            registry=registry1,
+            ImageID="sha256:abc123",
+        )
 
         container = Container.objects.create(
             host=host1,
@@ -86,11 +91,11 @@ class ContainerApiExecTestCase(BaseAPITestCase):
             m.put(
                 "http://localhost:8080/api/engine/containers/1234/exec",
                 text="Error",
-                status_code= 500
+                status_code=500,
             )
 
             response = self.client.post(
                 self.endpoint, **self.header, data={"cmd": ["ls"]}, format="json"
             )
             self.assertHttpStatus(response, status.HTTP_502_BAD_GATEWAY)
-            self.assertEqual(response.data, 'Error')
+            self.assertEqual(response.data, "Error")

{netbox_docker_plugin-5.1.1 → netbox_docker_plugin-5.3.0}/netbox_docker_plugin/tests/container/test_container_operation_view.py

@@ -257,8 +257,12 @@ class ContainerViewsTestCase(BaseModelViewTestCase, ModelViewTestCase):
             host=host2, name="registry2", serveraddress="http://localhost:8082"
         )
 
-        image1 = Image.objects.create(host=host1, name="image1", registry=registry1)
-        image2 = Image.objects.create(host=host2, name="image2", registry=registry2)
+        image1 = Image.objects.create(
+            host=host1, name="image1", registry=registry1, ImageID="sha256:abc123"
+        )
+        image2 = Image.objects.create(
+            host=host2, name="image2", registry=registry2, ImageID="sha256:abc456"
+        )
 
         Container.objects.create(
             host=host1,