Merge pull request #190 from SaaShup/log_driver_fix

🐛 Fix default logging driver value

Author: fanshan

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 = "4.0.0"
+    version = "4.0.1"
     base_url = "docker"
     min_version = "4.2.0"
     author = "Vincent Simonin <vincent@saashup.com>, David Delassus <david.jose.delassus@gmail.com>"

netbox_docker_plugin/api/views.py

@@ -145,6 +145,7 @@ class ContainerViewSet(NetBoxModelViewSet):
         "host",
         "ports",
         "labels",
+        "log_driver_options",
         "tags",
     )
     filterset_class = filtersets.ContainerFilterSet

netbox_docker_plugin/forms/container.py

@@ -19,7 +19,6 @@
     Container,
     ContainerRestartPolicyChoices,
     ContainerCapAddChoices,
-    ContainerLogDriverChoices,
 )
 from ..models.image import Image
 
@@ -122,7 +121,7 @@ class ContainerFilterForm(NetBoxModelFilterSetForm):
         label="Restart Policy", choices=ContainerRestartPolicyChoices, required=False
     )
     log_driver = forms.ChoiceField(
-        label="Logging driver", choices=ContainerLogDriverChoices, required=False
+        label="Logging driver", required=False
     )
     tag = TagFilterField(model)
 
@@ -138,11 +137,10 @@ class ContainerImportForm(NetBoxModelImportForm):
         + "`always`, `unless-stopped`.",
     )
 
-    log_driver = forms.ChoiceField(
+    log_driver = forms.CharField(
         label="Logging driver",
-        choices=ContainerLogDriverChoices,
         required=False,
-        help_text="Logging driver. Can be `json-log`, `syslog`.",
+        help_text="Logging driver. Can be `json-file`, `syslog`.",
     )
 
     class Meta:
@@ -170,10 +168,9 @@ class ContainerBulkEditForm(NetBoxModelBulkEditForm):
         choices=ContainerRestartPolicyChoices,
         required=True,
     )
-    log_driver = forms.ChoiceField(
+    log_driver = forms.CharField(
         label="Logging driver",
-        choices=ContainerLogDriverChoices,
-        required=True,
+        required=False,
     )
     hostname = forms.CharField(
         label="Hostname", max_length=256, min_length=1, required=False

netbox_docker_plugin/migrations/0036_alter_container_log_driver.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", "0035_container_log_driver_logdriveroption"),
+    ]
+
+    operations = [
+        migrations.RunSQL(
+            "UPDATE netbox_docker_plugin_container "
+            + "SET log_driver='json-file' WHERE log_driver='json-log'"
+        ),
+        migrations.AlterField(
+            model_name="container",
+            name="log_driver",
+            field=models.CharField(default="json-file", max_length=32),
+        ),
+    ]

netbox_docker_plugin/models/container.py

@@ -73,19 +73,6 @@ class ContainerRestartPolicyChoices(ChoiceSet):
     ]
 
 
-class ContainerLogDriverChoices(ChoiceSet):
-    """Container log driver choices definition class"""
-
-    key = "Container.log_driver"
-
-    DEFAULT_VALUE = "json-log"
-
-    CHOICES = [
-        ("json-log", "json-log", "blue"),
-        ("syslog", "syslog", "blue"),
-    ]
-
-
 class PortTypeChoices(ChoiceSet):
     """Port type choices definition class"""
 
@@ -112,6 +99,8 @@ class ContainerCapAddChoices(ChoiceSet):
 class Container(NetBoxModel):
     """Container definition class"""
 
+    DEFAULT_LOG_DRIVER = "json-file"
+
     host = models.ForeignKey(Host, on_delete=models.CASCADE, related_name="containers")
     image = models.ForeignKey(
         Image, on_delete=models.RESTRICT, related_name="containers"
@@ -168,8 +157,7 @@ class Container(NetBoxModel):
     )
     log_driver = models.CharField(
         max_length=32,
-        choices=ContainerLogDriverChoices,
-        default=ContainerLogDriverChoices.DEFAULT_VALUE,
+        default=DEFAULT_LOG_DRIVER,
     )
 
     @property

netbox_docker_plugin/templates/netbox_docker_plugin/container.html

@@ -51,28 +51,14 @@ <h5 class="card-header">CONTAINER</h5>
           </tr>
           <tr>
             <th scope="row">Logging driver</th>
-            <td>{{ object.get_log_driver_display }}</td>
+            <td>{{ object.log_driver }}</td>
           </tr>
         </table>
       </div>
     </div>
     {% include 'inc/panels/custom_fields.html' %}
     {% include 'inc/panels/tags.html' %}
     {% plugin_left_page object %}
-    <div class="card">
-      <h5 class="card-header">LOG DRIVER OPTIONS</h5>
-      <div class="card-body htmx-container table-responsive"
-        hx-get="{% url 'plugins:netbox_docker_plugin:logdriveroption_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:logdriveroption_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 Logging driver option
-          </a>
-        </div>
-      {% endif %}
-    </div>
   </div>
   <div class="col col-md-6">
     <div class="card">
@@ -202,5 +188,21 @@ <h5 class="card-header">DEVICES</h5>
       {% endif %}
     </div>
   </div>
+  <div class="col col-md-6">
+    <div class="card">
+      <h5 class="card-header">LOG DRIVER OPTIONS</h5>
+      <div class="card-body htmx-container table-responsive"
+        hx-get="{% url 'plugins:netbox_docker_plugin:logdriveroption_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:logdriveroption_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 Logging driver option
+          </a>
+        </div>
+      {% endif %}
+    </div>
+  </div>
 </div>
 {% endblock content %}

netbox_docker_plugin/tests/container/test_container_views.py

@@ -85,5 +85,6 @@ def setUpTestData(cls):
         cls.csv_update_data = (
             "id,name,host,image,hostname,restart_policy,log_driver",
             f"{container1.pk},container1,{host1.pk},{image1.pk},,on-failure,syslog",
-            f"{container2.pk},container2,{host1.pk},{image1.pk},container2,unless-stopped,json-log",
+            f"{container2.pk},container2,{host1.pk}"
+            + f",{image1.pk},container2,unless-stopped,json-file",
         )

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "netbox-docker-plugin"
-version = "4.0.0"
+version = "4.0.1"
 authors = [
   { name="Vincent Simonin", email="vincent@saashup.com" },
   { name="David Delassus", email="david.jose.delassus@gmail.com" }