Dashboard View

README.md

@@ -6,7 +6,7 @@ A plugin for [Nautobot](https://github.com/nautobot/nautobot) to easily handle C
 
 ## Installation
 
-The plugin is available as a Python package in pypi and can be installed with pip
+The plugin is available as a Python package in PyPI and can be installed with `pip`:
 
 ```shell
 pip install nautobot-circuit-maintenance
@@ -17,7 +17,7 @@ pip install nautobot-circuit-maintenance
 To ensure Circuit Maintenance is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the Nautobot root directory (alongside `requirements.txt`) and list the `nautobot-circuit-maintenance` package:
 
 ```no-highlight
-# echo nautobot-circuit-maintenance >> local_requirements.txt
+echo nautobot-circuit-maintenance >> local_requirements.txt
 ```
 
 Once installed, the plugin needs to be enabled in your `configuration.py`.
@@ -32,6 +32,7 @@ PLUGINS_CONFIG = {
     "nautobot_circuit_maintenance": {
         "raw_notification_initial_days_since": 100,
         "raw_notification_size": 16384,
+        "dashboard_n_days": 30,  # Defaults to 30 days in the configurations, change/override here
         "notification_sources": [
             {
               ...

nautobot_circuit_maintenance/__init__.py

@@ -89,8 +89,10 @@ class CircuitMaintenanceConfig(PluginConfig):
     default_settings = {
         "raw_notification_initial_days_since": 7,
         "raw_notification_size": 8192,
+        "dashboard_n_days": 30,
     }
     caching_config = {}
+    home_view_name = "plugins:nautobot_circuit_maintenance:circuitmaintenance_overview"
 
     def ready(self):
         super().ready()

nautobot_circuit_maintenance/navigation.py

@@ -3,6 +3,11 @@
 from nautobot.utilities.choices import ButtonColorChoices
 
 menu_items = (
+    PluginMenuItem(
+        link="plugins:nautobot_circuit_maintenance:circuitmaintenance_overview",
+        link_text="Dashboard",
+        permissions=["nautobot_circuit_maintenance.view_circuitmaintenance"],
+    ),
     PluginMenuItem(
         link="plugins:nautobot_circuit_maintenance:circuitmaintenance_list",
         link_text="Circuit Maintenances",

nautobot_circuit_maintenance/templates/nautobot_circuit_maintenance/circuit_maintenance_overview.html

@@ -0,0 +1,125 @@
+{% extends 'base.html' %}
+{% load buttons %}
+{% load static %}
+{% load custom_links %}
+{% load helpers %}
+{% load plugins %}
+
+{% block header %}
+{% endblock %}
+{% block content %}
+
+<h1>{% block title %}Circuit Maintenance Dashboard{% endblock %}</h1>
+<div class="col-md-3">
+    <!-- Visual block -->
+    <div class="card">
+        <div class="container">
+            <h3 class="text s-2 p-3">Circuits With Maintenances in the Next {{ n_days }} Days</h3>
+            <table class="table table-hover table-headings">
+                <thead>
+                    <tr>
+                        <th>Circuit ID</th>
+                        <th>Sites</th>
+                        <th>Circuit Status</th>
+                        <th>Maintenance Start</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    {% for maintenance in upcoming_maintenances %}
+                        {% for circuit in maintenance.circuits %}
+                            <tr>
+                                <td>
+                                    <a href="{{ circuit.get_absolute_url }}">{{ circuit.cid }}</a>
+                                </td>
+                                <td>
+                                    {% if circuit.termination_a.connected_endpoint %}
+                                        {% with circuit_term_a_site=circuit.termination_a.connected_endpoint.parent.site %}
+                                        {% comment %}Fix up this line after if move to Jinja templating. Unable to shrink due to whitespace {% endcomment %}
+                                            <a href="{{ circuit_term_a_site.get_absolute_url }}">{{ circuit_term_a_site.name }}</a>
+                                            {% if circuit.termination_z.connected_endpoint and circuit_term_a_site != circuit.termination_z.connected_endpoint.parent.site %}
+                                            | <a href="{{ circuit.termination_z.connected_endpoint.parent.site.get_absolute_url }}">{{ circuit.termination_z.connected_endpoint.parent.site.name}}</a>
+                                            {% endif %}
+                                        {% endwith %}
+                                    {% endif %}
+                                </td>
+                                <td>
+                                    {{ circuit.status.name }}
+                                </td>
+                                <td>
+                                    {{ maintenance.start_time | date:'Y-m-d H:i e' }}
+                                </td>
+                            </tr>
+                        {% endfor %}
+                    {% endfor %}
+                </tbody>
+            </table>
+        </div>
+    </div>
+    <div class="card">
+        <div class="container card-body">
+            <h3 class="text-left">Devices with Maintenances in the Next {{ n_days }} Days</h3>
+                <table class="table table-hover table-headings">
+                    <thead>
+                        <tr>
+                            <th>Device Name</th>
+                            <th>Maintenance Start</th>
+                        </tr>
+                    </thead>
+                    <tbody>
+                        {% for maintenance in upcoming_maintenances %}
+                            {% for circuit in maintenance.circuits %}
+                                {% if circuit.termination_a.connected_endpoint %}
+                                    <tr>
+                                        <td>
+                                            {% with device_obj=circuit.termination_a.connected_endpoint.parent %}
+                                            <a href="{{ device_obj.get_absolute_url }}">{{ device_obj.name }}</a> 
+                                            {% endwith %}
+                                        </td>
+                                        <td>
+                                            {{ maintenance.start_time | date:'Y-m-d H:i e' }}
+                                        </td>
+                                    </tr>
+                                {% endif %}
+                                {% if circuit.termination_z.connected_endpoint %}
+                                    <tr>
+                                        <td>
+                                            {% with device_obj=circuit.termination_z.connected_endpoint.parent %}
+                                            <a href="{{ device_obj.get_absolute_url }}">{{ device_obj.name }}</a>
+                                            {% endwith %}
+                                        </td>
+                                        <td>
+                                            {{ maintenance.start_time | date:'Y-m-d H:i e' }}
+                                        </td>
+                                    </tr>
+                                {% endif %}
+                            {% endfor %}
+                        {% endfor %}
+                    </tbody>
+                </table>
+            </div>
+        </div>
+        <div class="card">
+            <div class="container">
+                <h3 class="text-left">Metrics</h3>
+                <table class="table table-hover table-headings">
+                    <thead>
+                        <tr>
+                            <th>Metric</th>
+                            <th>Metric Value</th>
+                        </tr>
+                    </thead>
+                    <tbody>
+                        {% for cm_metric_key, cm_metric_value in circuit_maint_metric_data.items %}
+                        <tr>
+                            <td>{{ cm_metric_key }}</td>
+                            <td>{{ cm_metric_value }}</td>
+                        </tr>
+                        {% endfor %}
+                    </tbody>
+                </table>
+            </div>
+        </div>
+    </div>
+</div>
+
+{% endblock %}