Management profiles by lunkwill42 · Pull Request #1947 · Uninett/nav

lunkwill42 · 2019-05-09T12:42:39Z

This implements v1 of Management profiles in NAV, with attempted minimum invasiveness to existing SNMP-based code.

A management profile contains the necessary details needed to communicate with a device using some management protocol, save for an actual IP address to communicate with.

A Netbox/IP device will have a relation to 0 or more management profiles, which is a statement about how this device can be managed.

This PR:

Introduces the concept of management profiles
Converts the distinct set of existing SNMP credentials from the Netbox table into a set of initial profiles.
Relates the new profiles to the existing Netboxes and removes the old SNMP credential fields from the Netbox model.
Retains some backward compatibility with SNMP-only NAV-code by adding properties to the Netbox model to access SNMP credentials as if the model was unchanged.
- However, a DeprecationWarning will be issued when these properties are accessed, to identify code that should probably change in the future.
Updates the bulk import/export formats for Netbox to comply with the model changes.
- And, of course, adds bulk import/export formats for management profiles.
Updates SeedDB to be able to create and edit SNMP management profiles, and to attach these to IP devices.
Adds conceptual code to show how SeedDB implementations for different management protocols can be added (The DEBUG protocol, which is only enabled in DEBUG mode).
REMOVES compatibility statement for Django versions prior to 1.11
- The ManagementProfile model requires JSONField, which was only introduced in Django 1.9, to allow protocol implementations to store arbitrary profile information. This means Django 1.8 support must be dropped, and 1.11 is the next logical candidate, since all tests are passing on that version also on the master branch.

This PR lacks:

The proper updates to the documentation. These will be updated ASAP.

Management profiles are a prerequisite to begin implementation of either #1177 or #1176.

This table will be used in combination with the netbox_profile table to define management profiles that can be attached to zero or more netboxes. The changescript also creates initial profiles from the existing netboxes, removes the old SNMP fields from Netbox and attaches the corresponding profiles to the existing netboxes.

We want/need proper JSONField support on this branch, which Django 1.8 does not support. Time to move right up there!

This will retain backwards-compatibility with SNMP-specific code that has not yet been ported to use management profiles.

Also rework Netbox bulk parser/importer to accept lists of management profiles rather than snmp config parameters.

Ensure all test fixtures use management profiles rather than setting or referencing the old SNMP attributes of Netboxes.

The bulk format now takes the names of profiles instead of SNMP config directly.

This is all taken care of in conftest!

The read_only attribute is, in fact, read only now. To remove SNMP config from the localhost netbox, delete its NetboxProfile entries.

Mimic these interim properties when fed an existing nav.models.manage.Netbox object to shadow, since they are still used by code.

This type will only be enabled when settings.DEBUG is True.

This includes moving the form implementations to a separate module.

The former is used by crispyforms to indicate what manually coded form fields from NAV/SeedDB indicate using the 'required' class.

This enabled the SeedDB interface to edit management profiles to dynamically switch out a fieldset of form fields related to specific protocol implementations. By selecting a protocol from the protocol dropdown, the correct fieldset for that protocol is made visible, while all the other protocol-specific fieldsets are hidden (and their form fields disabled).

This ensures that SeedDB is able to follow the relationships of ManagementProfiles to Netboxes when attempting to delete a profile (so the user can properly see that 42 Netboxes are using the profile they are about to delete).

sigmunau · 2019-05-14T08:08:57Z

Maybe just a nitpick, but the third commit here e65784b depends on code that gets added in the fourth commit fb3df11 If you ever rebase this request you should change the order of these commits

sigmunau

Are there no existing tests for parsing and importing netboxes that should be updated here?

hmpf · 2019-05-16T07:56:12Z

+        self.helper.layout = get_single_layout('Filter connection profiles', 'protocol')
+
+
+class ProtocolSpecificMixIn(object):


hmpf · 2019-05-16T07:57:28Z

+    def __init__(self, *args, **kwargs):
+        super(ManagementProfileForm, self).__init__(*args, **kwargs)
+
+    def get_protocol_form_class(self):


hmpf

What a monster, but kinda tricky to split it into several branches too.

lunkwill42 · 2019-05-27T10:42:16Z

Maybe just a nitpick, but the third commit here e65784b depends on code that gets added in the fourth commit fb3df11 If you ever rebase this request you should change the order of these commits

It's not a nitpick, but it's also not an issue. I remember seeing the same thing before once, when reviewing one of your PRs: fb3df11 is in fact the direct parent of e65784b already, but it seems GitHub is displaying them in order of commit date in the PR view, not in their graph order (these commits have been heavily rebased back and forth).

lunkwill42 · 2019-05-27T10:43:44Z

Are there no existing tests for parsing and importing netboxes that should be updated here?

Obviously not (or they would have failed) :-(

lunkwill42 · 2019-05-27T11:54:12Z

Alright, the docs have been sufficiently updated, finally merging this :-)

lunkwill42 added 23 commits May 6, 2019 15:56

Move default Django version target to 1.11.

3ad6ed2

We want/need proper JSONField support on this branch, which Django 1.8 does not support. Time to move right up there!

Define new ORM models for management profiles.

fb3df11

(Netbox): Add properties to mimic the old SNMP attributes

e65784b

This will retain backwards-compatibility with SNMP-specific code that has not yet been ported to use management profiles.

Create bulk parser and importer for management profiles.

bf7c3b5

Also rework Netbox bulk parser/importer to accept lists of management profiles rather than snmp config parameters.

Add management profiles to SeedDB

431eac5

Refactor test fixtures to account for management profiles

8dc2dac

Ensure all test fixtures use management profiles rather than setting or referencing the old SNMP attributes of Netboxes.

Rewrite bulk parser/importer tests to account for mgmt profiles

076e9bb

The bulk format now takes the names of profiles instead of SNMP config directly.

(navoidverify): Refactor box filter to use management profiles.

f70ce56

Remove useless Django bootstrap from test modules.

410b602

This is all taken care of in conftest!

Update tests to use management profiles.

6356ca4

The read_only attribute is, in fact, read only now. To remove SNMP config from the localhost netbox, delete its NetboxProfile entries.

(shadows.netbox): Mimic read_only and snmp_version properties of Netbox

df49ff3

Mimic these interim properties when fed an existing nav.models.manage.Netbox object to shadow, since they are still used by code.

Remove workaround for now non-supported Django 1.7

7246cbb

Include mgmt profile data in netbox dump format.

bccdfc4

Attempt to allay PyLint's fears about non-conforming import order.

2bee09c

(navdump): Add management profile output

6db8d1d

Introduce a debug protocol type for management profiles.

9135fdc

This type will only be enabled when settings.DEBUG is True.

Rework SeedDB forms for management profiles.

ec7e48a

This includes moving the form implementations to a separate module.

Style 'asteriskField' similar to 'required'.

f25d518

The former is used by crispyforms to indicate what manually coded form fields from NAV/SeedDB indicate using the 'required' class.

Clean/reformat code.

88ccffb

Display a number of netboxes affected when editing a mgmt profile

fb16a03

lunkwill42 added enhancement snmp labels May 9, 2019

lunkwill42 requested review from hmpf and sigmunau May 9, 2019 12:42

sigmunau reviewed May 14, 2019

View reviewed changes

hmpf reviewed May 16, 2019

View reviewed changes

hmpf approved these changes May 16, 2019

View reviewed changes

lunkwill42 and others added 3 commits May 27, 2019 12:45

Merge branch 'master' into management-profiles

00cf79f

Update the getting-started docs to include mgmt profiles.

8a7569f

Update SNMP community/profile wording in Arnold and Portadmin docs

6801621

lunkwill42 added this to the 4.10.0 milestone May 27, 2019

lunkwill42 merged commit 6801621 into master May 27, 2019

lunkwill42 deleted the management-profiles branch May 27, 2019 11:56

Navigation Menu

Uh oh!

Management profiles - #1947

Management profiles#1947
lunkwill42 merged 26 commits into
masterfrom
management-profiles

lunkwill42 commented May 9, 2019 •

edited

Loading

Uh oh!

sigmunau commented May 14, 2019

Uh oh!

sigmunau left a comment

Uh oh!

hmpf May 16, 2019

Uh oh!

hmpf May 16, 2019

Uh oh!

hmpf left a comment

Uh oh!

lunkwill42 commented May 27, 2019 •

edited

Loading

Uh oh!

lunkwill42 commented May 27, 2019

Uh oh!

lunkwill42 commented May 27, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		self.helper.layout = get_single_layout('Filter connection profiles', 'protocol')


		class ProtocolSpecificMixIn(object):

Uh oh!

Conversation

lunkwill42 commented May 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sigmunau commented May 14, 2019

Uh oh!

sigmunau left a comment

Choose a reason for hiding this comment

Uh oh!

hmpf May 16, 2019

Choose a reason for hiding this comment

Uh oh!

hmpf May 16, 2019

Choose a reason for hiding this comment

Uh oh!

hmpf left a comment

Choose a reason for hiding this comment

Uh oh!

lunkwill42 commented May 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lunkwill42 commented May 27, 2019

Uh oh!

lunkwill42 commented May 27, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lunkwill42 commented May 9, 2019 •

edited

Loading

lunkwill42 commented May 27, 2019 •

edited

Loading