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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-docker-plugin
-Version: 2.0.0
+Version: 2.5.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.0.0 → netbox_docker_plugin-2.5.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.0.0"
+    version = "2.5.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.5.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.0.0 → netbox_docker_plugin-2.5.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.0.0 → netbox_docker_plugin-2.5.0}/netbox_docker_plugin/templates/netbox_docker_plugin/container.html

@@ -54,47 +54,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 +123,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 %}

netbox_docker_plugin-2.5.0/netbox_docker_plugin/templates/netbox_docker_plugin/host-graph.html

@@ -0,0 +1,211 @@
+{% extends 'generic/object.html' %}
+
+{% load plugins %}
+
+{% block content %}
+<div class="row mb-3">
+  <div class="col col-md-12">
+    <div class="card">
+      <div class="card-body">
+        <div
+          id="graph"
+          style="
+            display: block;
+            width: 100%;
+            min-height: 350px;
+          "
+        ></div>
+      </div>
+    </div>
+  </div>
+</div>
+{% endblock %}
+
+{% block head %}
+<script
+  type="application/javascript"
+  src="https://cdnjs.cloudflare.com/ajax/libs/cytoscape/3.30.1/cytoscape.min.js"
+  integrity="sha512-kv2oCpI8sYlWvr442qCcFNgXW9swhLRlDJ/39GlfZLGAWOqgU/Kz30YCYBm0yLumVzRvYEMU6uSxFniGzitKiA=="
+  crossorigin="anonymous"
+  referrerpolicy="no-referrer"
+></script>
+
+<script type="application/javascript">
+  document.addEventListener('DOMContentLoaded', () => {
+    const elt = document.getElementById('graph');
+
+    const cy = cytoscape({
+      container: elt,
+      elements: [
+        // {% for registry in object.registries.all %}
+          {
+            data: {
+              id: 'registry:{{ registry.pk }}',
+              name: '{{ registry.name }}',
+            },
+            classes: ['registry'],
+          },
+        // {% endfor %}
+        // {% for image in object.images.all %}
+          {
+            data: {
+              id: 'image:{{ image.pk }}',
+              name: '{{ image.name }}',
+            },
+            classes: [
+              'image',
+              // {% if image.Digest %}
+                'pulled',
+              // {% endif %}
+            ],
+          },
+          {
+            data: {
+              id: 'registry-image:{{ image.registry.pk }}:{{ image.pk }}',
+              source: 'registry:{{ image.registry.pk }}',
+              target: 'image:{{ image.pk }}',
+            },
+          },
+        // {% endfor %}
+        // {% for network in object.networks.all %}
+          {
+            data: {
+              id: 'network:{{ network.pk }}',
+              name: '{{ network.name }}',
+            },
+            classes: ['network'],
+          },
+        // {% endfor %}
+        // {% for volume in object.volumes.all %}
+          {
+            data: {
+              id: 'volume:{{ volume.pk }}',
+              name: '{{ volume.name }}',
+            },
+            classes: ['volume'],
+          },
+        // {% endfor %}
+        // {% for container in object.containers.all %}
+          {
+            data: {
+              id: 'container:{{ container.pk }}',
+              name: '{{ container.name }}',
+            },
+            classes: [
+              'container',
+              // {% if container.state == "running" %}
+                'running',
+              // {% endif %}
+            ],
+          },
+          {
+            data: {
+              id: 'image-container:{{ container.image.pk }}:{{ container.pk }}',
+              source: 'image:{{ container.image.pk }}',
+              target: 'container:{{ container.pk }}',
+            },
+          },
+          // {% for network in container.networks.all %}
+            {
+              data: {
+                id: 'network-container:{{ network.pk }}:{{ container.pk }}',
+                source: 'network:{{ network.pk }}',
+                target: 'container:{{ container.pk }}',
+              },
+            },
+          // {% endfor %}
+          // {% for volume in container.volumes.all %}
+            {
+              data: {
+                id: 'volume-container:{{ volume.pk }}:{{ container.pk }}',
+                source: 'volume:{{ volume.pk }}',
+                target: 'container:{{ container.pk }}',
+              },
+            },
+          // {% endfor %}
+        // {% endfor %}
+      ],
+
+      style: [ // the stylesheet for the graph
+        {
+          selector: 'node',
+          style: {
+            'outline-width': 2,
+            'outline-color': '#CCCCCC',
+            'background-color': '#59594A',
+            'label': ''
+          },
+        },
+        {
+          selector: 'node.hover',
+          style: {
+            'label': 'data(name)',
+          },
+        },
+        {
+          selector: 'node.image',
+          style: {
+            'background-color': '#BE6E46',
+          },
+        },
+        {
+          selector: 'node.image.pulled',
+          style: {
+            'background-color': '#A3BFA8',
+          }
+        },
+        {
+          selector: 'node.network',
+          style: {
+            'shape': 'hexagon',
+          },
+        },
+        {
+          selector: 'node.volume',
+          style: {
+            'shape': 'triangle',
+          },
+        },
+        {
+          selector: 'node.container',
+          style: {
+            'background-color': '#BE6E46',
+            'shape': 'rectangle',
+          },
+        },
+        {
+          selector: 'node.container.running',
+          style: {
+            'background-color': '#A3BFA8',
+          },
+        },
+        {
+          selector: 'edge',
+          style: {
+            'width': 3,
+            'line-color': '#ccc',
+            'target-arrow-color': '#ccc',
+            'target-arrow-shape': 'triangle',
+            'curve-style': 'bezier'
+          }
+        }
+      ],
+
+      layout: {
+        name: 'cose',
+        nodeDimensionsIncludeLabels: true,
+      },
+    })
+
+    cy.on('mouseover', 'node', function (evt) {
+      const node = evt.target
+      node.addClass('hover')
+    })
+
+    cy.on('mouseout', 'node', function (evt) {
+      const node = evt.target
+      node.removeClass('hover')
+    })
+  })
+</script>
+{% endblock %}

netbox_docker_plugin-2.5.0/netbox_docker_plugin/templates/netbox_docker_plugin/image.html

@@ -0,0 +1,122 @@
+{% extends 'generic/object.html' %}
+
+{% load plugins %}
+
+{% block extra_controls %}
+<button
+  class="btn btn-sm btn-success"
+  onclick="
+    (async () => {
+      this.setAttribute('disabled', 'disabled')
+      const notificationData = {}
+      try {
+        const resp = await fetch(
+          '/api/plugins/docker/images/{{ object.pk }}/force_pull/',
+          {
+            method: 'POST',
+            headers: {
+              'X-CSRFToken': window.CSRF_TOKEN,
+            },
+          },
+        )
+        const data = await resp.json()
+        console.log(data)
+        notificationData.kind = 'success'
+        notificationData.icon = ['mdi', 'mdi-check']
+        notificationData.message = 'Pulling image again'
+      }
+      catch (err) {
+        console.error(err)
+        notificationData.kind = 'danger'
+        notificationData.icon = ['mdi', 'mdi-alert']
+        notificationData.message = 'Failed to force pull image'
+      }
+      finally {
+        this.removeAttribute('disabled')
+      }
+      const notification = document.createElement('div')
+      notification.classList.add('toast', 'toast-dark', 'border-0', 'shadow-sm', 'rounded-0')
+      notification.setAttribute('role', 'alert')
+      notification.setAttribute('aria-live', 'assertive')
+      notification.setAttribute('aria-atomic', 'true')
+      notification.dataset['bsDelay'] = 10_000
+      const header = document.createElement('div')
+      header.classList.add('toast-header', `bg-${notificationData.kind}`, 'rounded-0')
+      const headerIcon = document.createElement('i')
+      headerIcon.classList.add(...notificationData.icon, 'me-2')
+      const headerTitle = document.createElement('span')
+      headerTitle.innerText = notificationData.message
+      const closeButton = document.createElement('button')
+      closeButton.classList.add('btn-close', 'me-0', 'm-auto')
+      closeButton.setAttribute('type', 'button')
+      closeButton.setAttribute('aria-label', 'Close')
+      closeButton.dataset['bsDismiss'] = 'toast'
+      header.appendChild(headerIcon)
+      header.appendChild(headerTitle)
+      header.appendChild(closeButton)
+      notification.appendChild(header)
+      document.querySelector('.toast-container').appendChild(notification)
+      const toast = new Toast(notification)
+      toast.show()
+    })()
+  "
+>
+  <i class="mdi mdi-reload"></i> Force Pull
+</button>
+{% endblock %}
+
+{% block content %}
+<div class="row mb-3">
+  <div class="col col-md-6">
+    <div class="card">
+      <h5 class="card-header">IMAGE</h5>
+      <div class="card-body">
+        <table class="table table-hover attr-table">
+          <tr>
+            <th scope="row">Host</th>
+            <td><a href="{{ object.host.get_absolute_url }}">{{ object.host }}</a></td>
+          </tr>
+          <tr>
+            <th scope="row">Name & Version</th>
+            <td>{{ object.name }}:{{ object.version }}</td>
+          </tr>
+          <tr>
+            <th scope="row">Registry</th>
+            <td><a href="{{ object.registry.get_absolute_url }}">{{ object.registry }}</a></td>
+          </tr>
+          <tr>
+            <th scope="row">Size</th>
+            <td>{{ object.size }}&nbsp;MByte</td>
+          </tr>
+          <tr>
+            <th scope="row">ImageID</th>
+            <td>{{ object.ImageID|placeholder }}</td>
+          </tr>
+          <tr>
+            <th scope="row">Digest</th>
+            <td>
+              {% if object.Digest is None %}
+                {{ object.Digest|placeholder }}
+              {% else %}
+                {{ object.Digest|truncatechars:32 }}
+              {% endif %}
+            </td>
+          </tr>
+        </table>
+      </div>
+    </div>
+    {% include 'inc/panels/custom_fields.html' %}
+    {% include 'inc/panels/tags.html' %}
+    {% plugin_left_page object %}
+  </div>
+  <div class="col col-md-6">
+    <div class="card">
+      <h5 class="card-header">USED BY</h5>
+      <div class="card-body htmx-container table-responsive"
+        hx-get="{% url 'plugins:netbox_docker_plugin:container_list' %}?image_id={{ object.pk }}"
+        hx-trigger="load"
+      ></div>
+    </div>
+  </div>
+</div>
+{% endblock content %}

{netbox_docker_plugin-2.0.0 → netbox_docker_plugin-2.5.0}/netbox_docker_plugin/tests/container/test_container_api.py

@@ -266,12 +266,12 @@ class ContainerApiTestCase(
         with requests_mock.Mocker() as m:
             m.get(
                 f"http://localhost:8080/api/engine/containers/{container_id}/logs",
-                text="Hello World",
+                text="Hello > World",
             )
 
             response = self.client.get(endpoint, **self.header)
             self.assertHttpStatus(response, status.HTTP_200_OK)
-            self.assertEqual(response.data, "Hello World")
+            self.assertEqual(response.data, "Hello > World")
 
     def test_that_container_host_cannot_be_changed(self):
         """Test that container's host cannot be changed"""