netbox-docker-plugin 2.1.0__tar.gz → 2.6.0__tar.gz

{netbox_docker_plugin-2.1.0/netbox_docker_plugin.egg-info → netbox_docker_plugin-2.6.0}/PKG-INFO

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

@@ -10,7 +10,7 @@ class NetBoxDockerConfig(PluginConfig):
     name = "netbox_docker_plugin"
     verbose_name = " NetBox Docker Plugin"
     description = "Manage Docker"
-    version = "2.1.0"
+    version = "2.6.0"
     base_url = "docker"
     min_version = "4.0.0"
     author= "Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>"

netbox_docker_plugin-2.6.0/netbox_docker_plugin/api/renderers.py

@@ -0,0 +1,19 @@
+""" Response renderers for Django Rest Framework """
+
+from django.utils.encoding import smart_str
+from rest_framework import renderers
+
+
+def make_content_type_renderer(content_type: str, api_format: str):
+    """ Create a response renderer for the specific content type """
+
+    class ContentTypeRenderer(renderers.BaseRenderer):
+        """ content type renderer """
+
+        media_type = content_type
+        format = api_format
+
+        def render(self, data, accepted_media_type=None, renderer_context=None):
+            return smart_str(data, encoding=self.charset)
+
+    return ContentTypeRenderer

{netbox_docker_plugin-2.1.0 → netbox_docker_plugin-2.6.0}/netbox_docker_plugin/api/serializers.py

@@ -146,6 +146,7 @@ class NestedContainerSerializer(WritableNestedSerializer):
             "restart_policy",
             "operation",
             "hostname",
+            "cap_add",
         )
 
 
@@ -406,6 +407,7 @@ class ContainerSerializer(NetBoxModelSerializer):
             "ContainerID",
             "hostname",
             "restart_policy",
+            "cap_add",
             "ports",
             "env",
             "labels",

{netbox_docker_plugin-2.1.0 → netbox_docker_plugin-2.6.0}/netbox_docker_plugin/api/views.py

@@ -3,6 +3,7 @@
 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
@@ -15,7 +16,7 @@ from drf_spectacular.utils import (
 from users.models import Token
 from netbox.api.viewsets import NetBoxModelViewSet
 from .. import filtersets
-from .renderers import PlainTextRenderer
+from .renderers import make_content_type_renderer
 from .serializers import (
     HostSerializer,
     ImageSerializer,
@@ -71,6 +72,47 @@ 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"""
@@ -111,23 +153,23 @@ class ContainerViewSet(NetBoxModelViewSet):
     @extend_schema(
         operation_id="plugins_docker_container_logs",
         responses={
-            (200, "text/plain"): OpenApiResponse(
+            (200, "text/html"): OpenApiResponse(
                 response=str,
                 examples=[
                     OpenApiExample(
                         "Container's logs",
                         value="Hello World",
-                        media_type="text/plain",
+                        media_type="text/html",
                     ),
                 ],
             ),
-            (502, "text/plain"): OpenApiResponse(
+            (502, "text/html"): OpenApiResponse(
                 response=str,
                 examples=[
                     OpenApiExample(
                         "Engine error",
                         value="Error as returned by Agent",
-                        media_type="text/plain",
+                        media_type="text/html",
                     ),
                 ],
             ),
@@ -136,7 +178,7 @@ class ContainerViewSet(NetBoxModelViewSet):
     @action(
         detail=True,
         methods=["get"],
-        renderer_classes=[PlainTextRenderer],
+        renderer_classes=[make_content_type_renderer("text/html", "txt")],
     )
     def logs(self, _request, **_kwargs):
         """Fetch container's logs"""
@@ -153,22 +195,22 @@ class ContainerViewSet(NetBoxModelViewSet):
 
         except requests.HTTPError:
             return Response(
-                resp.text,
+                escape(resp.text),
                 status=status.HTTP_502_BAD_GATEWAY,
-                content_type="text/plain",
+                content_type="text/html",
             )
 
         return Response(
-            resp.text,
+            escape(resp.text),
             status=status.HTTP_200_OK,
-            content_type="text/plain",
+            content_type="text/html",
         )
 
     @extend_schema(
         operation_id="plugins_docker_container_exec",
         request=ContainerCommandSerializer,
         responses={
-            (200, "text/plain"): OpenApiResponse(
+            (200, "application/json"): OpenApiResponse(
                 response=str,
                 examples=[
                     OpenApiExample(
@@ -178,13 +220,13 @@ class ContainerViewSet(NetBoxModelViewSet):
                     ),
                 ],
             ),
-            (502, "text/plain"): OpenApiResponse(
+            (502, "text/html"): OpenApiResponse(
                 response=str,
                 examples=[
                     OpenApiExample(
                         "Engine error",
                         value="Error as returned by Agent",
-                        media_type="text/plain",
+                        media_type="text/html",
                     ),
                 ],
             ),
@@ -215,9 +257,9 @@ class ContainerViewSet(NetBoxModelViewSet):
 
         except requests.HTTPError:
             return Response(
-                resp.text,
+                escape(resp.text),
                 status=status.HTTP_502_BAD_GATEWAY,
-                content_type="text/plain",
+                content_type="text/html",
             )
 
         return Response(data=json.loads(resp.text))

{netbox_docker_plugin-2.1.0 → netbox_docker_plugin-2.6.0}/netbox_docker_plugin/forms/container.py

@@ -15,7 +15,7 @@ from netbox.forms import (
 )
 from ..models.volume import Volume
 from ..models.host import Host
-from ..models.container import Container, ContainerRestartPolicyChoices
+from ..models.container import Container, ContainerRestartPolicyChoices, ContainerCapAddChoices
 from ..models.image import Image
 
 
@@ -31,6 +31,7 @@ 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"""
@@ -42,6 +43,7 @@ class ContainerForm(NetBoxModelForm):
             "name",
             "hostname",
             "restart_policy",
+            "cap_add",
             "tags",
         )
         labels = {
@@ -50,6 +52,7 @@ class ContainerForm(NetBoxModelForm):
             "image": "Image",
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
+            "cap_add": "Add Host capabilities",
         }
 
 
@@ -62,6 +65,7 @@ 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"""
@@ -72,6 +76,7 @@ class ContainerEditForm(NetBoxModelForm):
             "name",
             "hostname",
             "restart_policy",
+            "cap_add",
             "tags",
         )
         labels = {
@@ -79,6 +84,7 @@ class ContainerEditForm(NetBoxModelForm):
             "image": "Image",
             "hostname": "Hostname",
             "restart_policy": "Restart Policy",
+            "cap_add": "Add Host capabilities",
         }
 
 

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

@@ -0,0 +1,29 @@
+# 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.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.1.0 → netbox_docker_plugin-2.6.0}/netbox_docker_plugin/models/container.py

@@ -2,6 +2,7 @@
 
 # pylint: disable=E1101
 
+from django.contrib.postgres.fields import ArrayField
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.db.models.functions import Lower
@@ -84,6 +85,16 @@ class PortTypeChoices(ChoiceSet):
     ]
 
 
+class ContainerCapAddChoices(ChoiceSet):
+    """cap-add choices definition class"""
+
+    key = "Container.cap_add"
+
+    CHOICES = [
+        ("NET_ADMIN", "NET_ADMIN"),
+    ]
+
+
 class Container(NetBoxModel):
     """Container definition class"""
 
@@ -134,39 +145,48 @@ class Container(NetBoxModel):
         choices=ContainerRestartPolicyChoices,
         default=ContainerRestartPolicyChoices.DEFAULT_VALUE,
     )
+    cap_add = ArrayField(
+        models.CharField(
+            max_length=32, blank=True, null=True, choices=ContainerCapAddChoices
+        ),
+        null=True,
+        blank=True,
+    )
 
     @property
     def can_create(self) -> bool:
-        """ Check if the container can be created """
+        """Check if the container can be created"""
         return self.state == "none"
 
     @property
     def can_start(self) -> bool:
-        """ Check if the container can be started """
+        """Check if the container can be started"""
         return self.state in ["created", "exited", "dead"]
 
     @property
     def can_stop(self) -> bool:
-        """ Check if the container can be stopped """
+        """Check if the container can be stopped"""
         return self.state in ["running"]
 
     @property
     def can_restart(self) -> bool:
-        """ Check if the container can be restarted """
+        """Check if the container can be restarted"""
         return self.state in ["running"]
 
     @property
     def can_recreate(self) -> bool:
-        """ Check if the container can be recreated """
+        """Check if the container can be recreated"""
         return self.state in ["created", "running", "exited", "dead"]
 
     @property
     def can_delete(self) -> bool:
-        """ Check if the container can be deleted """
-        return (
-            self.host.state == HostStateChoices.STATE_DELETED
-            or self.state in ["created", "paused", "exited", "dead"]
-        )
+        """Check if the container can be deleted"""
+        return self.host.state == HostStateChoices.STATE_DELETED or self.state in [
+            "created",
+            "paused",
+            "exited",
+            "dead",
+        ]
 
     class Meta:
         """Image Model Meta Class"""

{netbox_docker_plugin-2.1.0 → netbox_docker_plugin-2.6.0}/netbox_docker_plugin/tables.py

@@ -256,6 +256,7 @@ class ContainerTable(NetBoxTable):
             "ContainerID",
             "hostname",
             "restart_policy",
+            "cap_add",
             "port_count",
             "mount_count",
             "bind_count",

{netbox_docker_plugin-2.1.0 → netbox_docker_plugin-2.6.0}/netbox_docker_plugin/templates/netbox_docker_plugin/container.html

@@ -37,6 +37,10 @@
             <th scope="row">Restart Policy</th>
             <td>{{ object.get_restart_policy_display }}</td>
           </tr>
+          <tr>
+            <th scope="row">Host Capacities added</th>
+            <td>{{ object.cap_add }}</td>
+          </tr>
           <tr>
             <th scope="row">Status</th>
             <td>{{ object.status|placeholder }}</td>
@@ -54,47 +58,61 @@
   </div>
   <div class="col col-md-6">
     <div class="card">
-      <h5 class="card-header">PORT MAPPINGS</h5>
+      <h5 class="card-header">LABELS</h5>
       <div class="card-body htmx-container table-responsive"
-        hx-get="{% url 'plugins:netbox_docker_plugin:port_list' %}?container_id={{ object.pk }}"
+        hx-get="{% url 'plugins:netbox_docker_plugin:label_list' %}?container_id={{ object.pk }}"
         hx-trigger="load"
       ></div>
       {% if perms.netbox_docker_plugin.add_env %}
         <div class="card-footer text-end noprint">
-          <a href="{% url 'plugins:netbox_docker_plugin:port_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
-            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> Add a Port Mapping
+          <a href="{% url 'plugins:netbox_docker_plugin:label_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
+            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> Add a Label
           </a>
         </div>
       {% endif %}
     </div>
+  </div>
+</div>
+
+<h2>Runtime</h2>
+<div class="row mb-3">
+  <div class="col col-md-6">
     <div class="card">
-      <h5 class="card-header">MOUNTS</h5>
+      <h5 class="card-header">ENVIRONMENT VARIABLES</h5>
       <div class="card-body htmx-container table-responsive"
-        hx-get="{% url 'plugins:netbox_docker_plugin:mount_list' %}?container_id={{ object.pk }}"
+        hx-get="{% url 'plugins:netbox_docker_plugin:env_list' %}?container_id={{ object.pk }}"
         hx-trigger="load"
       ></div>
       {% if perms.netbox_docker_plugin.add_env %}
         <div class="card-footer text-end noprint">
-          <a href="{% url 'plugins:netbox_docker_plugin:mount_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
-            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> New Mount
+          <a href="{% url 'plugins:netbox_docker_plugin:env_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
+            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> Add an Env Variable
           </a>
         </div>
       {% endif %}
     </div>
+  </div>
+</div>
+
+<h2>Networking</h2>
+<div class="row mb-3">
+  <div class="col col-md-6">
     <div class="card">
-      <h5 class="card-header">BINDS</h5>
+      <h5 class="card-header">PORT MAPPINGS</h5>
       <div class="card-body htmx-container table-responsive"
-        hx-get="{% url 'plugins:netbox_docker_plugin:bind_list' %}?container_id={{ object.pk }}"
+        hx-get="{% url 'plugins:netbox_docker_plugin:port_list' %}?container_id={{ object.pk }}"
         hx-trigger="load"
       ></div>
       {% if perms.netbox_docker_plugin.add_env %}
         <div class="card-footer text-end noprint">
-          <a href="{% url 'plugins:netbox_docker_plugin:bind_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
-            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> New Bind
+          <a href="{% url 'plugins:netbox_docker_plugin:port_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
+            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> Add a Port Mapping
           </a>
         </div>
       {% endif %}
     </div>
+  </div>
+  <div class="col col-md-6">
     <div class="card">
       <h5 class="card-header">NETWORK SETTINGS</h5>
       <div class="card-body htmx-container table-responsive"
@@ -109,30 +127,38 @@
         </div>
       {% endif %}
     </div>
+  </div>
+</div>
+
+<h2>Storage</h2>
+<div class="row mb-3">
+  <div class="col col-md-6">
     <div class="card">
-      <h5 class="card-header">ENV VARIABLE</h5>
+      <h5 class="card-header">MOUNTS</h5>
       <div class="card-body htmx-container table-responsive"
-        hx-get="{% url 'plugins:netbox_docker_plugin:env_list' %}?container_id={{ object.pk }}"
+        hx-get="{% url 'plugins:netbox_docker_plugin:mount_list' %}?container_id={{ object.pk }}"
         hx-trigger="load"
       ></div>
       {% if perms.netbox_docker_plugin.add_env %}
         <div class="card-footer text-end noprint">
-          <a href="{% url 'plugins:netbox_docker_plugin:env_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
-            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> Add an Env Variable
+          <a href="{% url 'plugins:netbox_docker_plugin:mount_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
+            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> New Mount
           </a>
         </div>
       {% endif %}
     </div>
+  </div>
+  <div class="col col-md-6">
     <div class="card">
-      <h5 class="card-header">LABELS</h5>
+      <h5 class="card-header">BINDS</h5>
       <div class="card-body htmx-container table-responsive"
-        hx-get="{% url 'plugins:netbox_docker_plugin:label_list' %}?container_id={{ object.pk }}"
+        hx-get="{% url 'plugins:netbox_docker_plugin:bind_list' %}?container_id={{ object.pk }}"
         hx-trigger="load"
       ></div>
       {% if perms.netbox_docker_plugin.add_env %}
         <div class="card-footer text-end noprint">
-          <a href="{% url 'plugins:netbox_docker_plugin:label_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
-            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> Add a Label
+          <a href="{% url 'plugins:netbox_docker_plugin:bind_add' %}?container={{ object.pk }}&return_url={{ object.get_absolute_url }}" class="btn btn-primary">
+            <i class="mdi mdi-plus-thick" aria-hidden="true"></i> New Bind
           </a>
         </div>
       {% endif %}