Merge pull request #386 from digitalocean/develop

Release v1.3.2

CONTRIBUTING.md

@@ -1,57 +1,71 @@
-# Contributing to NetBox
+## Getting Help
 
-Thank you for your interest in contributing to NetBox! This document contains some quick pointers on reporting bugs and
-requesting new features.
+If you encounter any issues installing or using NetBox, try one of the following resources to get assistance. Please
+**do not** open an issue on GitHub except to report bugs or request features.
 
-## Reporting Issues
+### Freenode IRC
 
-* First, ensure that you've installed the latest stable version of NetBox. If you're running an older version, it's
-possible that the bug has already been fixed.
+Join the #netbox channel on [Freenode IRC](https://freenode.net/). You can connect to Freenode at irc.freenode.net using
+an IRC client, or you can use their [webchat client](https://webchat.freenode.net/).
 
-* Check the [issues list](https://github.com/digitalocean/netbox/issues) to see if the bug you've found has already been
-reported. If you think you may be experiencing a reported issue, please add a quick comment to it with a "+1" and a
-quick description of how it's affecting your installation.
+### Reddit
 
-* If you're having trouble installing NetBox, please join #netbox on irc.freenode.net and ask for help before creating
-an issue on GitHub. Many installation problems are simple fixes. The issues list should be reserved for bug reports and
-feature requests.
+We have established [/r/netbox](https://www.reddit.com/r/netbox) on Reddit for NetBox issues and general discussion.
+Reddit registration is free and does not require providing an email address (although it is encouraged).
 
-* When submitting an issue, please be as descriptive as possible. Be sure to describe:
+## Reporting Bugs
+
+* First, ensure that you've installed the [latest stable version](https://github.com/digitalocean/netbox/releases) of
+NetBox. If you're running an older version, it's possible that the bug has already been fixed.
+
+* Next, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the bug you've found has
+already been reported. If you think you may be experiencing a reported issue that hasn't already been resolved, please
+click "add a reaction" in the top right corner of the issue and add a thumbs up (+1). You might also want to add a
+comment describing how it's affecting your installation. This will allow us to prioritize bugs based on how many users
+are affected.
+
+* If you haven't found an existing issue that describes your suspected bug, please inquire about it on IRC or Reddit.
+**Do not** file an issue until you have received confirmation that it is in fact a bug. Invalid issues are very
+distracting and slow the pace at which NetBox is developed.
+
+* When submitting an issue, please be as descriptive as possible. Be sure to include:
 
     * The environment in which NetBox is running
     * The exact steps that can be taken to reproduce the issue (if applicable)
     * Any error messages returned
+    * Screenshots (if applicable)
 
 * Keep in mind that we prioritize bugs based on their severity and how much work is required to resolve them. It may
-take some time for someone to address your issue. If it's been longer than a week with no updates, please ping us on
-IRC.
+take some time for someone to address your issue.
 
 ## Feature Requests
 
-* First, check the [issues list](https://github.com/digitalocean/netbox/issues) to see if the feature you're requesting
-has already been requested (and possibly rejected). If it has, click "add a reaction" in the top right corner of the
-issue and add a thumbs up (+1). This ensures that the issue has a better chance of making it onto the roadmap. Also feel
-free to add a comment with any additional justification for the feature.
+* First, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the feature you're
+requesting is already listed. (Be sure to search closed issues as well, since some feature requests are rejected.) If
+the feature you'd like to see has already been requested, click "add a reaction" in the top right corner of the issue
+and add a thumbs up (+1). This ensures that the issue has a better chance of making it onto the roadmap. Also feel free
+to add a comment with any additional justification for the feature.
 
-* While discussion of new features is welcome, it's important to limit the scope of NetBox's feature set to avoid
+* While suggestions for new features are welcome, it's important to limit the scope of NetBox's feature set to avoid
 feature creep. For example, the following features would be firmly out of scope for NetBox:
 
     * Ticket management
     * Network state monitoring
     * Acting as a DNS server
     * Acting as an authentication server
 
-* Feature requests must be very narrowly defined. The more effort you put into writing a feature request, the better its
-chances are of being implemented. Overly broad feature requests will be closed.
+* Before filing a new feature request, propose it on IRC or Reddit first. Feedback you receive there will help validate
+and shape the proposed feature before filing a formal issue.
 
-* If you're not sure whether the feature you want is a good fit for NetBox, please ask in #netbox on irc.freenode.net.
-Even if it's not quite right for NetBox, we may be able to point you to a tool better suited for the job.
+* Good feature requests are very narrowly defined. Be sure to enumerate specific functionality and data schema. The more
+effort you put into writing a feature request, the better its chances are of being implemented. Overly broad feature
+requests will be closed.
 
-* When submitting a feature request, be sure to include the following:
+* When submitting a feature request on GitHub, be sure to include the following:
 
-    * A detailed description of the functionality
+    * A detailed description of the proposed functionality
     * A use case for the feature; who would use it and what value it would add to NetBox
-    * A rough description of any changes necessary to the database schema (if applicable)
+    * A rough description of any changes necessary to the database schema
     * Any third-party libraries or other resources which would be involved
 
 ## Submitting Pull Requests
@@ -60,9 +74,8 @@ Even if it's not quite right for NetBox, we may be able to point you to a tool b
 before beginning work​. This will help prevent wasting time on something that might we might not be able to implement.
 When suggesting a new feature, also make sure it won't conflict with any work that's already in progress.
 
-* When submitting a pull request, please be sure to work off of branch `develop`, rather than branch `master`.
-In NetBox, the `develop` branch is used for ongoing development, while `master` is used for tagging new
-stable releases.
+* When submitting a pull request, please be sure to work off of the `develop` branch, rather than `master`. In NetBox,
+the `develop` branch is used for ongoing development, while `master` is used for tagging new stable releases.
 
 * All code submissions should meet the following criteria (CI will enforce these checks):
 

README.md

@@ -25,6 +25,6 @@ Questions? Comments? Please join us on IRC in **#netbox** on **irc.freenode.net*
 
 # Installation
 
-Please see docs/getting-started.md for instructions on installing NetBox.
+Please see [the documentation](http://netbox.readthedocs.io/en/latest/) for instructions on installing NetBox.
 
 To upgrade NetBox, please download the [latest release](https://github.com/digitalocean/netbox/releases) and run `upgrade.sh`.

docs/configuration/mandatory-settings.md

@@ -2,7 +2,7 @@ NetBox's local configuration is held in `netbox/netbox/configuration.py`. An exa
 
 ## ALLOWED_HOSTS
 
-This is a list of valid fully-qualified domain names (FQDNs) for the NetBox server. NetBox will not permit write access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name.
+This is a list of valid fully-qualified domain names (FQDNs) that is used to reach the NetBox service. Usually this is the same as the hostname for the NetBox server, but can also be different (e.g. when using a reverse proxy serving the NetBox website under a different FQDN than the hostname of the NetBox server). NetBox will not permit access to the server via any other hostnames (or IPs). The value of this option is also used to set `CSRF_TRUSTED_ORIGINS`, which restricts `HTTP POST` to the same set of hosts (more about this [here](https://docs.djangoproject.com/en/1.9/ref/settings/#std:setting-CSRF_TRUSTED_ORIGINS)). Keep in mind that NetBox, by default, has `USE_X_FORWARDED_HOST = True` (in `netbox/netbox/settings.py`) which means that if you're using a reverse proxy, it's the FQDN used to reach that reverse proxy which needs to be in this list (more about this [here](https://docs.djangoproject.com/en/1.9/ref/settings/#allowed-hosts)).
 
 Example:
 

docs/index.md

@@ -50,4 +50,4 @@ NetBox is built on the [Django](https://djangoproject.com/) Python framework and
 
 # Getting Started
 
-See the [getting started](getting-started.md) guide for help with getting NetBox up and running quickly.
+See the [installation guide](installation/postgresql.md) for help getting NetBox up and running quickly.

netbox/circuits/forms.py

@@ -3,8 +3,7 @@
 
 from dcim.models import Site, Device, Interface, Rack, IFACE_FF_VIRTUAL
 from utilities.forms import (
-    APISelect, BootstrapMixin, BulkImportForm, CommentField, ConfirmationForm, CSVDataField, Livesearch, SmallTextarea,
-    SlugField,
+    APISelect, BootstrapMixin, BulkImportForm, CommentField, CSVDataField, Livesearch, SmallTextarea, SlugField,
 )
 
 from .models import Circuit, CircuitType, Provider
@@ -55,10 +54,6 @@ class ProviderBulkEditForm(forms.Form, BootstrapMixin):
     comments = CommentField()
 
 
-class ProviderBulkDeleteForm(ConfirmationForm):
-    pk = forms.ModelMultipleChoiceField(queryset=Provider.objects.all(), widget=forms.MultipleHiddenInput)
-
-
 def provider_site_choices():
     site_choices = Site.objects.all()
     return [(s.slug, s.name) for s in site_choices]
@@ -81,10 +76,6 @@ class Meta:
         fields = ['name', 'slug']
 
 
-class CircuitTypeBulkDeleteForm(ConfirmationForm):
-    pk = forms.ModelMultipleChoiceField(queryset=CircuitType.objects.all(), widget=forms.MultipleHiddenInput)
-
-
 #
 # Circuits
 #
@@ -191,10 +182,6 @@ class CircuitBulkEditForm(forms.Form, BootstrapMixin):
     comments = CommentField()
 
 
-class CircuitBulkDeleteForm(ConfirmationForm):
-    pk = forms.ModelMultipleChoiceField(queryset=Circuit.objects.all(), widget=forms.MultipleHiddenInput)
-
-
 def circuit_type_choices():
     type_choices = CircuitType.objects.annotate(circuit_count=Count('circuits'))
     return [(t.slug, u'{} ({})'.format(t.name, t.circuit_count)) for t in type_choices]

netbox/circuits/views.py

@@ -76,7 +76,6 @@ def update_objects(self, pk_list, form):
 class ProviderBulkDeleteView(PermissionRequiredMixin, BulkDeleteView):
     permission_required = 'circuits.delete_provider'
     cls = Provider
-    form = forms.ProviderBulkDeleteForm
     default_redirect_url = 'circuits:provider_list'
 
 
@@ -102,7 +101,6 @@ class CircuitTypeEditView(PermissionRequiredMixin, ObjectEditView):
 class CircuitTypeBulkDeleteView(PermissionRequiredMixin, BulkDeleteView):
     permission_required = 'circuits.delete_circuittype'
     cls = CircuitType
-    form = forms.CircuitTypeBulkDeleteForm
     default_redirect_url = 'circuits:circuittype_list'
 
 
@@ -171,5 +169,4 @@ def update_objects(self, pk_list, form):
 class CircuitBulkDeleteView(PermissionRequiredMixin, BulkDeleteView):
     permission_required = 'circuits.delete_circuit'
     cls = Circuit
-    form = forms.CircuitBulkDeleteForm
     default_redirect_url = 'circuits:circuit_list'

netbox/dcim/admin.py

@@ -78,8 +78,8 @@ class DeviceTypeAdmin(admin.ModelAdmin):
         InterfaceTemplateAdmin,
         DeviceBayTemplateAdmin,
     ]
-    list_display = ['model', 'manufacturer', 'slug', 'u_height', 'console_ports', 'console_server_ports', 'power_ports',
-                    'power_outlets', 'interfaces', 'device_bays']
+    list_display = ['model', 'manufacturer', 'slug', 'part_number', 'u_height', 'console_ports', 'console_server_ports',
+                    'power_ports', 'power_outlets', 'interfaces', 'device_bays']
     list_filter = ['manufacturer']
 
     def get_queryset(self, request):

netbox/dcim/api/serializers.py

@@ -111,8 +111,8 @@ class DeviceTypeSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = DeviceType
-        fields = ['id', 'manufacturer', 'model', 'slug', 'u_height', 'is_full_depth', 'is_console_server', 'is_pdu',
-                  'is_network_device']
+        fields = ['id', 'manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth',
+                  'is_console_server', 'is_pdu', 'is_network_device']
 
 
 class DeviceTypeNestedSerializer(DeviceTypeSerializer):
@@ -164,9 +164,9 @@ class DeviceTypeDetailSerializer(DeviceTypeSerializer):
     interface_templates = InterfaceTemplateNestedSerializer(many=True, read_only=True)
 
     class Meta(DeviceTypeSerializer.Meta):
-        fields = ['id', 'manufacturer', 'model', 'slug', 'u_height', 'is_full_depth', 'is_console_server', 'is_pdu',
-                  'is_network_device', 'console_port_templates', 'cs_port_templates', 'power_port_templates',
-                  'power_outlet_templates', 'interface_templates']
+        fields = ['id', 'manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth',
+                  'is_console_server', 'is_pdu', 'is_network_device', 'console_port_templates', 'cs_port_templates',
+                  'power_port_templates', 'power_outlet_templates', 'interface_templates']
 
 
 #

netbox/dcim/api/views.py

@@ -419,53 +419,36 @@ def get(self, request):
                 return Response()
 
         else:
-            raise MissingFilterException(detail='Must specify search parameters (peer-device and peer-interface).')
+            raise MissingFilterException(detail='Must specify search parameters "peer-device" and "peer-interface".')
 
         # Initialize response skeleton
-        response = dict()
-        response['device'] = serializers.DeviceSerializer(device).data
-        response['console-ports'] = []
-        response['power-ports'] = []
-        response['interfaces'] = []
-
-        # Build console connections
+        response = {
+            'device': serializers.DeviceSerializer(device).data,
+            'console-ports': [],
+            'power-ports': [],
+            'interfaces': [],
+        }
+
+        # Console connections
         console_ports = ConsolePort.objects.filter(device=device).select_related('cs_port__device')
         for cp in console_ports:
-            cp_info = dict()
-            cp_info['name'] = cp.name
-            if cp.cs_port:
-                cp_info['console-server'] = cp.cs_port.device.name
-                cp_info['port'] = cp.cs_port.name
-            else:
-                cp_info['console-server'] = None
-                cp_info['port'] = None
-            response['console-ports'].append(cp_info)
+            data = serializers.ConsolePortSerializer(instance=cp).data
+            del(data['device'])
+            response['console-ports'].append(data)
 
-        # Build power connections
+        # Power connections
         power_ports = PowerPort.objects.filter(device=device).select_related('power_outlet__device')
         for pp in power_ports:
-            pp_info = dict()
-            pp_info['name'] = pp.name
-            if pp.power_outlet:
-                pp_info['pdu'] = pp.power_outlet.device.name
-                pp_info['outlet'] = pp.power_outlet.name
-            else:
-                pp_info['pdu'] = None
-                pp_info['outlet'] = None
-            response['power-ports'].append(pp_info)
+            data = serializers.PowerPortSerializer(instance=pp).data
+            del(data['device'])
+            response['power-ports'].append(data)
 
-        # Built interface connections
-        interfaces = Interface.objects.filter(device=device)
+        # Interface connections
+        interfaces = Interface.objects.filter(device=device).select_related('connected_as_a', 'connected_as_b',
+                                                                            'circuit')
         for iface in interfaces:
-            iface_info = dict()
-            iface_info['name'] = iface.name
-            peer_interface = iface.get_connected_interface()
-            if peer_interface:
-                iface_info['device'] = peer_interface.device.name
-                iface_info['interface'] = peer_interface.name
-            else:
-                iface_info['device'] = None
-                iface_info['interface'] = None
-            response['interfaces'].append(iface_info)
+            data = serializers.InterfaceDetailSerializer(instance=iface).data
+            del(data['device'])
+            response['interfaces'].append(data)
 
         return Response(response)

netbox/dcim/filters.py

@@ -102,7 +102,7 @@ class DeviceTypeFilter(django_filters.FilterSet):
 
     class Meta:
         model = DeviceType
-        fields = ['manufacturer_id', 'manufacturer', 'model', 'u_height', 'is_console_server', 'is_pdu',
+        fields = ['manufacturer_id', 'manufacturer', 'model', 'part_number', 'u_height', 'is_console_server', 'is_pdu',
                   'is_network_device']