Initial work on config contexts

netbox/extras/admin.py

@@ -7,7 +7,8 @@ from django.utils.safestring import mark_safe
 from utilities.forms import LaxURLField
 from .constants import OBJECTCHANGE_ACTION_CREATE, OBJECTCHANGE_ACTION_DELETE, OBJECTCHANGE_ACTION_UPDATE
 from .models import (
-    CustomField, CustomFieldChoice, Graph, ExportTemplate, ObjectChange, TopologyMap, UserAction, Webhook,
+    ConfigContext, CustomField, CustomFieldChoice, Graph, ExportTemplate, ObjectChange, TopologyMap, UserAction,
+    Webhook,
 )
 
 
@@ -125,6 +126,15 @@ class TopologyMapAdmin(admin.ModelAdmin):
     }
 
 
+#
+# Config contexts
+#
+
+@admin.register(ConfigContext)
+class ConfigContextAdmin(admin.ModelAdmin):
+    list_display = ['name', 'weight']
+
+
 #
 # Change logging
 #

netbox/extras/api/serializers.py

@@ -4,10 +4,16 @@ from django.core.exceptions import ObjectDoesNotExist
 from rest_framework import serializers
 from taggit.models import Tag
 
-from dcim.api.serializers import NestedDeviceSerializer, NestedRackSerializer, NestedSiteSerializer
+from dcim.api.serializers import (
+    NestedDeviceSerializer, NestedDeviceRoleSerializer, NestedPlatformSerializer, NestedRackSerializer,
+    NestedRegionSerializer, NestedSiteSerializer,
+)
 from dcim.models import Device, Rack, Site
-from extras.models import ExportTemplate, Graph, ImageAttachment, ObjectChange, ReportResult, TopologyMap, UserAction
+from extras.models import (
+    ConfigContext, ExportTemplate, Graph, ImageAttachment, ObjectChange, ReportResult, TopologyMap, UserAction,
+)
 from extras.constants import *
+from tenancy.api.serializers import NestedTenantSerializer
 from users.api.serializers import NestedUserSerializer
 from utilities.api import (
     ChoiceFieldSerializer, ContentTypeFieldSerializer, get_serializer_for_model, ValidatedModelSerializer,
@@ -121,6 +127,22 @@ class ImageAttachmentSerializer(ValidatedModelSerializer):
         return serializer(obj.parent, context={'request': self.context['request']}).data
 
 
+#
+# Config contexts
+#
+
+class ConfigContextSerializer(ValidatedModelSerializer):
+    regions = NestedRegionSerializer(many=True)
+    sites = NestedSiteSerializer(many=True)
+    roles = NestedDeviceRoleSerializer(many=True)
+    platforms = NestedPlatformSerializer(many=True)
+    tenants = NestedTenantSerializer(many=True)
+
+    class Meta:
+        model = ConfigContext
+        fields = ['name', 'weight', 'is_active', 'regions', 'sites', 'roles', 'platforms', 'tenants', 'data']
+
+
 #
 # Reports
 #

netbox/extras/api/urls.py

@@ -34,6 +34,9 @@ router.register(r'tags', views.TagViewSet)
 # Image attachments
 router.register(r'image-attachments', views.ImageAttachmentViewSet)
 
+# Config contexts
+router.register(r'config-contexts', views.ConfigContextViewSet)
+
 # Reports
 router.register(r'reports', views.ReportViewSet, base_name='report')
 

netbox/extras/api/views.py

@@ -12,7 +12,8 @@ from taggit.models import Tag
 
 from extras import filters
 from extras.models import (
-    CustomField, ExportTemplate, Graph, ImageAttachment, ObjectChange, ReportResult, TopologyMap, UserAction,
+    ConfigContext, CustomField, ExportTemplate, Graph, ImageAttachment, ObjectChange, ReportResult, TopologyMap,
+    UserAction,
 )
 from extras.reports import get_report, get_reports
 from utilities.api import FieldChoicesViewSet, IsAuthenticatedOrLoginNotRequired, ModelViewSet
@@ -132,6 +133,15 @@ class ImageAttachmentViewSet(ModelViewSet):
     serializer_class = serializers.ImageAttachmentSerializer
 
 
+#
+# Config contexts
+#
+
+class ConfigContextViewSet(ModelViewSet):
+    queryset = ConfigContext.objects.prefetch_related('regions', 'sites', 'roles', 'platforms', 'tenants')
+    serializer_class = serializers.ConfigContextSerializer
+
+
 #
 # Reports
 #

netbox/extras/forms.py

@@ -5,14 +5,16 @@ from collections import OrderedDict
 from django import forms
 from django.contrib.auth.models import User
 from django.contrib.contenttypes.models import ContentType
+from mptt.forms import TreeNodeMultipleChoiceField
 from taggit.models import Tag
 
+from dcim.models import Region
 from utilities.forms import add_blank_choice, BootstrapMixin, BulkEditForm, LaxURLField, SlugField
 from .constants import (
     CF_FILTER_DISABLED, CF_TYPE_BOOLEAN, CF_TYPE_DATE, CF_TYPE_INTEGER, CF_TYPE_SELECT, CF_TYPE_URL,
     OBJECTCHANGE_ACTION_CHOICES,
 )
-from .models import CustomField, CustomFieldValue, ImageAttachment, ObjectChange
+from .models import ConfigContext, CustomField, CustomFieldValue, ImageAttachment, ObjectChange
 
 
 #
@@ -174,7 +176,6 @@ class CustomFieldFilterForm(forms.Form):
 #
 # Tags
 #
-#
 
 class TagForm(BootstrapMixin, forms.ModelForm):
     slug = SlugField()
@@ -184,6 +185,21 @@ class TagForm(BootstrapMixin, forms.ModelForm):
         fields = ['name', 'slug']
 
 
+#
+# Config contexts
+#
+
+class ConfigContextForm(BootstrapMixin, forms.ModelForm):
+    regions = TreeNodeMultipleChoiceField(
+        queryset=Region.objects.all(),
+        required=False
+    )
+
+    class Meta:
+        model = ConfigContext
+        fields = ['name', 'weight', 'is_active', 'regions', 'sites', 'roles', 'platforms', 'tenants', 'data']
+
+
 #
 # Image attachments
 #

netbox/extras/migrations/0014_config-contexts.py

@@ -0,0 +1,44 @@
+# Generated by Django 2.0.6 on 2018-06-27 17:45
+
+import django.contrib.postgres.fields.jsonb
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tenancy', '0005_change_logging'),
+        ('dcim', '0060_change_logging'),
+        ('extras', '0013_objectchange'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='ConfigContext',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=100, unique=True)),
+                ('weight', models.PositiveSmallIntegerField(default=1000)),
+                ('is_active', models.BooleanField(default=True)),
+                ('data', django.contrib.postgres.fields.jsonb.JSONField()),
+                ('platforms', models.ManyToManyField(blank=True, related_name='_configcontext_platforms_+', to='dcim.Platform')),
+                ('regions', models.ManyToManyField(blank=True, related_name='_configcontext_regions_+', to='dcim.Region')),
+                ('roles', models.ManyToManyField(blank=True, related_name='_configcontext_roles_+', to='dcim.DeviceRole')),
+                ('sites', models.ManyToManyField(blank=True, related_name='_configcontext_sites_+', to='dcim.Site')),
+                ('tenants', models.ManyToManyField(blank=True, related_name='_configcontext_tenants_+', to='tenancy.Tenant')),
+            ],
+            options={
+                'ordering': ['weight', 'name'],
+            },
+        ),
+        migrations.AlterField(
+            model_name='customfield',
+            name='obj_type',
+            field=models.ManyToManyField(help_text='The object(s) to which this field applies.', limit_choices_to={'model__in': ('provider', 'circuit', 'site', 'rack', 'devicetype', 'device', 'aggregate', 'prefix', 'ipaddress', 'vlan', 'vrf', 'service', 'tenant', 'cluster', 'virtualmachine')}, related_name='custom_fields', to='contenttypes.ContentType', verbose_name='Object(s)'),
+        ),
+        migrations.AlterField(
+            model_name='webhook',
+            name='obj_type',
+            field=models.ManyToManyField(help_text='The object(s) to which this Webhook applies.', limit_choices_to={'model__in': ('provider', 'circuit', 'site', 'rack', 'rackgroup', 'device', 'interface', 'aggregate', 'prefix', 'ipaddress', 'vlan', 'vlangroup', 'vrf', 'service', 'tenant', 'tenantgroup', 'cluster', 'clustergroup', 'virtualmachine')}, related_name='webhooks', to='contenttypes.ContentType', verbose_name='Object types'),
+        ),
+    ]

netbox/extras/models.py

@@ -629,6 +629,94 @@ class ImageAttachment(models.Model):
             return None
 
 
+#
+# Config contexts
+#
+
+class ConfigContext(models.Model):
+    """
+    A ConfigContext represents a set of arbitrary data available to any Device or VirtualMachine matching its assigned
+    qualifiers (region, site, etc.). For example, the data stored in a ConfigContext assigned to site A and tenant B
+    will be available to a Device in site A assigned to tenant B. Data is stored in JSON format.
+    """
+    name = models.CharField(
+        max_length=100,
+        unique=True
+    )
+    weight = models.PositiveSmallIntegerField(
+        default=1000
+    )
+    is_active = models.BooleanField(
+        default=True,
+    )
+    regions = models.ManyToManyField(
+        to='dcim.Region',
+        related_name='+',
+        blank=True
+    )
+    sites = models.ManyToManyField(
+        to='dcim.Site',
+        related_name='+',
+        blank=True
+    )
+    roles = models.ManyToManyField(
+        to='dcim.DeviceRole',
+        related_name='+',
+        blank=True
+    )
+    platforms = models.ManyToManyField(
+        to='dcim.Platform',
+        related_name='+',
+        blank=True
+    )
+    tenants = models.ManyToManyField(
+        to='tenancy.Tenant',
+        related_name='+',
+        blank=True
+    )
+    data = JSONField()
+
+    class Meta:
+        ordering = ['weight', 'name']
+
+    def __str__(self):
+        return self.name
+
+    def get_absolute_url(self):
+        return reverse('extras:configcontext', kwargs={'pk': self.pk})
+
+
+class ConfigContextModel(models.Model):
+
+    class Meta:
+        abstract = True
+
+    def get_config_context(self):
+        """
+        Return the rendered configuration context for a device or VM.
+        """
+
+        # `device_role` for Device; `role` for VirtualMachine
+        role = getattr(self, 'device_role', None) or self.role
+
+        # Gather all ConfigContexts orders by weight, name
+        contexts = ConfigContext.objects.filter(
+            Q(regions=self.site.region) | Q(regions=None),
+            Q(sites=self.site) | Q(sites=None),
+            Q(roles=role) | Q(roles=None),
+            Q(tenants=self.tenant) | Q(tenants=None),
+            Q(platforms=self.platform) | Q(platforms=None),
+            is_active=True,
+        ).order_by('weight', 'name')
+
+        # Compile all config data, overwriting lower-weight values with higher-weight values where a collision occurs
+        data = {}
+        for context in contexts:
+            data.update(context.data)
+
+        return data
+
+
 #
 # Report results
 #

netbox/extras/tables.py

@@ -4,7 +4,7 @@ import django_tables2 as tables
 from taggit.models import Tag
 
 from utilities.tables import BaseTable, ToggleColumn
-from .models import ObjectChange
+from .models import ConfigContext, ObjectChange
 
 TAG_ACTIONS = """
 {% if perms.taggit.change_tag %}
@@ -15,6 +15,15 @@ TAG_ACTIONS = """
 {% endif %}
 """
 
+CONFIGCONTEXT_ACTIONS = """
+{% if perms.extras.change_configcontext %}
+    <a href="{% url 'extras:configcontext_edit' pk=record.pk %}" class="btn btn-xs btn-warning"><i class="glyphicon glyphicon-pencil" aria-hidden="true"></i></a>
+{% endif %}
+{% if perms.extras.delete_configcontext %}
+    <a href="{% url 'extras:configcontext_delete' pk=record.pk %}" class="btn btn-xs btn-danger"><i class="glyphicon glyphicon-trash" aria-hidden="true"></i></a>
+{% endif %}
+"""
+
 OBJECTCHANGE_ACTION = """
 {% if record.action == 1 %}
     <span class="label label-success">Created</span>
@@ -44,7 +53,21 @@ class TagTable(BaseTable):
 
     class Meta(BaseTable.Meta):
         model = Tag
-        fields = ('pk', 'name', 'items')
+        fields = ('pk', 'name', 'weight')
+
+
+class ConfigContextTable(BaseTable):
+    pk = ToggleColumn()
+    name = tables.LinkColumn()
+    actions = tables.TemplateColumn(
+        template_code=CONFIGCONTEXT_ACTIONS,
+        attrs={'td': {'class': 'text-right'}},
+        verbose_name=''
+    )
+
+    class Meta(BaseTable.Meta):
+        model = ConfigContext
+        fields = ('pk', 'name', 'weight', 'active')
 
 
 class ObjectChangeTable(BaseTable):

netbox/extras/urls.py

@@ -13,6 +13,14 @@ urlpatterns = [
     url(r'^tags/(?P<slug>[\w-]+)/delete/$', views.TagDeleteView.as_view(), name='tag_delete'),
     url(r'^tags/delete/$', views.TagBulkDeleteView.as_view(), name='tag_bulk_delete'),
 
+    # Config contexts
+    url(r'^config-contexts/$', views.ConfigContextListView.as_view(), name='configcontext_list'),
+    url(r'^config-contexts/add/$', views.ConfigContextCreateView.as_view(), name='configcontext_add'),
+    url(r'^config-contexts/(?P<pk>\d+)/$', views.ConfigContextView.as_view(), name='configcontext'),
+    url(r'^config-contexts/(?P<pk>\d+)/edit/$', views.ConfigContextEditView.as_view(), name='configcontext_edit'),
+    url(r'^config-contexts/(?P<pk>\d+)/delete/$', views.ConfigContextDeleteView.as_view(), name='configcontext_delete'),
+    url(r'^config-contexts/delete/$', views.ConfigContextBulkDeleteView.as_view(), name='configcontext_bulk_delete'),
+
     # Image attachments
     url(r'^image-attachments/(?P<pk>\d+)/edit/$', views.ImageAttachmentEditView.as_view(), name='imageattachment_edit'),
     url(r'^image-attachments/(?P<pk>\d+)/delete/$', views.ImageAttachmentDeleteView.as_view(), name='imageattachment_delete'),

netbox/extras/views.py

@@ -14,10 +14,10 @@ from taggit.models import Tag
 from utilities.forms import ConfirmationForm
 from utilities.views import BulkDeleteView, ObjectDeleteView, ObjectEditView, ObjectListView
 from . import filters
-from .forms import ObjectChangeFilterForm, ImageAttachmentForm, TagForm
-from .models import ImageAttachment, ObjectChange, ReportResult
+from .forms import ConfigContextForm, ImageAttachmentForm, ObjectChangeFilterForm, TagForm
+from .models import ConfigContext, ImageAttachment, ObjectChange, ReportResult
 from .reports import get_report, get_reports
-from .tables import ObjectChangeTable, TagTable
+from .tables import ConfigContextTable, ObjectChangeTable, TagTable
 
 
 #
@@ -53,6 +53,53 @@ class TagBulkDeleteView(PermissionRequiredMixin, BulkDeleteView):
     default_return_url = 'extras:tag_list'
 
 
+#
+# Config contexts
+#
+
+class ConfigContextListView(ObjectListView):
+    queryset = ConfigContext.objects.all()
+    table = ConfigContextTable
+    template_name = 'extras/configcontext_list.html'
+
+
+class ConfigContextView(View):
+
+    def get(self, request, pk):
+
+        configcontext = get_object_or_404(ConfigContext, pk=pk)
+
+        return render(request, 'extras/configcontext.html', {
+            'configcontext': configcontext,
+        })
+
+
+class ConfigContextCreateView(PermissionRequiredMixin, ObjectEditView):
+    permission_required = 'extras.add_configcontext'
+    model = ConfigContext
+    model_form = ConfigContextForm
+    default_return_url = 'extras:configcontext_list'
+    template_name = 'extras/configcontext_edit.html'
+
+
+class ConfigContextEditView(ConfigContextCreateView):
+    permission_required = 'extras.change_configcontext'
+
+
+class ConfigContextDeleteView(PermissionRequiredMixin, ObjectDeleteView):
+    permission_required = 'extras.delete_configcontext'
+    model = ConfigContext
+    default_return_url = 'extras:configcontext_list'
+
+
+class ConfigContextBulkDeleteView(PermissionRequiredMixin, BulkDeleteView):
+    permission_required = 'extras.delete_cconfigcontext'
+    cls = ConfigContext
+    queryset = ConfigContext.objects.all()
+    table = ConfigContextTable
+    default_return_url = 'extras:configcontext_list'
+
+
 #
 # Change logging
 #