Merge pull request #7575 from netbox-community/1344-contacts

Closes #1344: Contact objects

docs/core-functionality/contacts.md

@@ -0,0 +1,5 @@
+# Contacts
+
+{!models/tenancy/contact.md!}
+{!models/tenancy/contactgroup.md!}
+{!models/tenancy/contactrole.md!}

docs/models/tenancy/contact.md

@@ -0,0 +1,31 @@
+# Contacts
+
+A contact represent an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one or more operational contacts to each site. Contacts can be arranged within nested contact groups.
+
+Each contact must include a name, which is unique to its parent group (if any). The following optional descriptors are also available:
+
+* Title
+* Phone
+* Email
+* Address
+
+## Contact Assignment
+
+Each contact can be assigned to one or more objects, allowing for the efficient reuse of contact information. When assigning a contact to an object, the user may optionally specify a role and/or priority (primary, secondary, tertiary, or inactive) to better convey the nature of the contact's relationship to the assigned object.
+
+The following models support the assignment of contacts:
+
+* circuits.Circuit
+* circuits.Provider
+* dcim.Device
+* dcim.Location
+* dcim.Manufacturer
+* dcim.PowerPanel
+* dcim.Rack
+* dcim.Region
+* dcim.Site
+* dcim.SiteGroup
+* tenancy.Tenant
+* virtualization.Cluster
+* virtualization.ClusterGroup
+* virtualization.VirtualMachine

docs/models/tenancy/contactgroup.md

@@ -0,0 +1,3 @@
+# Contact Groups
+
+Contacts can be organized into arbitrary groups. These groups can be recursively nested for convenience. Each contact within a group must have a unique name, but other attributes can be repeated.

docs/models/tenancy/contactrole.md

@@ -0,0 +1,3 @@
+# Contact Roles
+
+Contacts can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for administrative, operational, or emergency contacts.

mkdocs.yml

@@ -62,6 +62,7 @@ nav:
         - Circuits: 'core-functionality/circuits.md'
         - Power Tracking: 'core-functionality/power.md'
         - Tenancy: 'core-functionality/tenancy.md'
+        - Contacts: 'core-functionality/contacts.md'
     - Customization:
         - Custom Fields: 'customization/custom-fields.md'
         - Custom Validation: 'customization/custom-validation.md'

netbox/circuits/models.py

@@ -62,6 +62,11 @@ class Provider(PrimaryModel):
         blank=True
     )
 
+    # Generic relations
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
+
     objects = RestrictedQuerySet.as_manager()
 
     clone_fields = [
@@ -203,6 +208,11 @@ class Circuit(PrimaryModel):
     comments = models.TextField(
         blank=True
     )
+
+    # Generic relations
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
     images = GenericRelation(
         to='extras.ImageAttachment'
     )

netbox/dcim/models/devices.py

@@ -54,6 +54,11 @@ class Manufacturer(OrganizationalModel):
         blank=True
     )
 
+    # Generic relations
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
+
     objects = RestrictedQuerySet.as_manager()
 
     class Meta:
@@ -584,6 +589,11 @@ class Device(PrimaryModel, ConfigContextModel):
     comments = models.TextField(
         blank=True
     )
+
+    # Generic relations
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
     images = GenericRelation(
         to='extras.ImageAttachment'
     )

netbox/dcim/models/power.py

@@ -40,6 +40,11 @@ class PowerPanel(PrimaryModel):
     name = models.CharField(
         max_length=100
     )
+
+    # Generic relations
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
     images = GenericRelation(
         to='extras.ImageAttachment'
     )

netbox/dcim/models/racks.py

@@ -175,12 +175,17 @@ class Rack(PrimaryModel):
     comments = models.TextField(
         blank=True
     )
+
+    # Generic relations
     vlan_groups = GenericRelation(
         to='ipam.VLANGroup',
         content_type_field='scope_type',
         object_id_field='scope_id',
         related_query_name='rack'
     )
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
     images = GenericRelation(
         to='extras.ImageAttachment'
     )

netbox/dcim/models/sites.py

@@ -52,12 +52,17 @@ class Region(NestedGroupModel):
         max_length=200,
         blank=True
     )
+
+    # Generic relations
     vlan_groups = GenericRelation(
         to='ipam.VLANGroup',
         content_type_field='scope_type',
         object_id_field='scope_id',
         related_query_name='region'
     )
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
 
     def get_absolute_url(self):
         return reverse('dcim:region', args=[self.pk])
@@ -100,12 +105,17 @@ class SiteGroup(NestedGroupModel):
         max_length=200,
         blank=True
     )
+
+    # Generic relations
     vlan_groups = GenericRelation(
         to='ipam.VLANGroup',
         content_type_field='scope_type',
         object_id_field='scope_id',
         related_query_name='site_group'
     )
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
 
     def get_absolute_url(self):
         return reverse('dcim:sitegroup', args=[self.pk])
@@ -221,12 +231,17 @@ class Site(PrimaryModel):
     comments = models.TextField(
         blank=True
     )
+
+    # Generic relations
     vlan_groups = GenericRelation(
         to='ipam.VLANGroup',
         content_type_field='scope_type',
         object_id_field='scope_id',
         related_query_name='site'
     )
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
     images = GenericRelation(
         to='extras.ImageAttachment'
     )
@@ -291,12 +306,17 @@ class Location(NestedGroupModel):
         max_length=200,
         blank=True
     )
+
+    # Generic relations
     vlan_groups = GenericRelation(
         to='ipam.VLANGroup',
         content_type_field='scope_type',
         object_id_field='scope_id',
         related_query_name='location'
     )
+    contacts = GenericRelation(
+        to='tenancy.ContactAssignment'
+    )
     images = GenericRelation(
         to='extras.ImageAttachment'
     )

netbox/netbox/navigation_menu.py

@@ -120,6 +120,14 @@ def get_model_buttons(app_label, model_name, actions=('add', 'import')):
                 get_model_item('tenancy', 'tenantgroup', 'Tenant Groups'),
             ),
         ),
+        MenuGroup(
+            label='Contacts',
+            items=(
+                get_model_item('tenancy', 'contact', 'Contacts'),
+                get_model_item('tenancy', 'contactgroup', 'Contact Groups'),
+                get_model_item('tenancy', 'contactrole', 'Contact Roles'),
+            ),
+        ),
     ),
 )
 

netbox/templates/circuits/circuit.html

@@ -70,11 +70,12 @@ <h5 class="card-header">
         {% plugin_left_page object %}
 	</div>
 	<div class="col col-md-6">
-        {% include 'circuits/inc/circuit_termination.html' with termination=object.termination_a side='A' %}
-        {% include 'circuits/inc/circuit_termination.html' with termination=object.termination_z side='Z' %}
-        {% include 'inc/image_attachments_panel.html' %}
-        {% plugin_right_page object %}
-    </div>
+    {% include 'circuits/inc/circuit_termination.html' with termination=object.termination_a side='A' %}
+    {% include 'circuits/inc/circuit_termination.html' with termination=object.termination_z side='Z' %}
+    {% include 'inc/contacts_panel.html' %}
+    {% include 'inc/image_attachments_panel.html' %}
+    {% plugin_right_page object %}
+  </div>
 </div>
 <div class="row">
     <div class="col col-md-12">

netbox/templates/circuits/provider.html

@@ -47,12 +47,13 @@ <h5 class="card-header">
                 </table>
             </div>
         </div>
+        {% include 'extras/inc/tags_panel.html' with tags=object.tags.all url='circuits:provider_list' %}
         {% plugin_left_page object %}
     </div>
     <div class="col col-md-6">
         {% include 'inc/custom_fields_panel.html' %}
-        {% include 'extras/inc/tags_panel.html' with tags=object.tags.all url='circuits:provider_list' %}
         {% include 'inc/comments_panel.html' %}
+        {% include 'inc/contacts_panel.html' %}
         {% plugin_right_page object %}
     </div>
     <div class="col col-md-12">

netbox/templates/dcim/device.html

@@ -296,6 +296,7 @@ <h5 class="card-header">
                 </div>
                 {% endif %}
             </div>
+            {% include 'inc/contacts_panel.html' %}
             {% include 'inc/image_attachments_panel.html' %}
             <div class="card noprint">
                 <h5 class="card-header">

netbox/templates/dcim/location.html

@@ -72,6 +72,7 @@ <h5 class="card-header">
   </div>
 	<div class="col col-md-6">
     {% include 'inc/custom_fields_panel.html' %}
+    {% include 'inc/contacts_panel.html' %}
     {% include 'inc/image_attachments_panel.html' %}
     {% plugin_right_page object %}
 	</div>

netbox/templates/dcim/manufacturer.html

@@ -38,6 +38,7 @@ <h5 class="card-header">
 	</div>
 	<div class="col col-md-6">
     {% include 'inc/custom_fields_panel.html' %}
+    {% include 'inc/contacts_panel.html' %}
     {% plugin_right_page object %}
   </div>
 </div>

netbox/templates/dcim/powerpanel.html

@@ -44,6 +44,7 @@ <h5 class="card-header">
     </div>
 	<div class="col col-md-6">
         {% include 'inc/custom_fields_panel.html' %}
+        {% include 'inc/contacts_panel.html' %}
         {% include 'inc/image_attachments_panel.html' %}
         {% plugin_right_page object %}
     </div>

netbox/templates/dcim/rack.html

@@ -332,6 +332,7 @@ <h5 class="card-header">
                 </div>
             {% endif %}
         </div>
+        {% include 'inc/contacts_panel.html' %}
         {% plugin_right_page object %}
     </div>
   </div>

netbox/templates/dcim/region.html

@@ -46,6 +46,7 @@ <h5 class="card-header">
       </div>
     </div>
     {% include 'inc/custom_fields_panel.html' %}
+    {% include 'inc/contacts_panel.html' %}
     {% plugin_left_page object %}
   </div>
 	<div class="col col-md-6">