Implement chatops-enabled configuration consistency checks #10

Mierdin · 2017-03-18T23:37:31Z

This PR provides an action, and accompanying action-aliase for performing automated WIRI (what it really is) vs WISB (what it should be) comparisons.

Here's an example:

vagrant@st2vagrant:~$ st2 run napalm.check_consistency hostname=vsrx01
..
id: 58ebd2b6c4da5f05575d9b8d
status: succeeded
parameters:
  hostname: vsrx01
result:
  exit_code: 0
  result:
    deviation: true
    diff_contents: "---
+++
@@ -72,6 +72,7 @@
         unit 0 {
             family inet {
                 address 192.168.50.51/24;
+                address 192.168.50.50/24;
             }
         }
     }
"
  stderr: ''
  stdout: ''

Also some misc corrections/cleanups.

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

sidkrishna · 2017-04-06T08:00:05Z

aliases/check_consistency.yaml

+action_ref: "napalm.check_consistency"
+description: "Check consistency of the device's configuration"
+formats:
+  - "check consistency on {{hostname}}"


@Mierdin Since there would be other packs as well on the ST2 installation, does it make sense to give the alias a keyword at the beginning so that chatops commands for this pack are easily identifiable? Some like napalm check consistency on {{hostname}}. I normally do this for integrations.

Yeah you're right, will do

sidkrishna · 2017-04-06T08:00:58Z

Otherwise, changes LGTM...

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

lakshmi-kannan

Minor comments to be addressed.

lakshmi-kannan · 2017-04-10T18:23:53Z

actions/check_consistency.meta.yaml

+        type: "string"
+        description: "The hostname of the device to connect to. Driver must be specified if hostname is not in configuration. Hostname without FQDN can be given if device is in configuration."
+        required: true
+        position: 0


Python actions don't need positions. If it's a python script then, yes. The runner type being python-script can be confusing.

Ack that. Unfortunately all the actions in the pack are like this. So I'll address this in a follow-up PR that tackles all of them

lakshmi-kannan · 2017-04-10T18:24:18Z

actions/check_consistency.meta.yaml

+    htmlout:
+        type: "boolean"
+        description: "In addition to the normal output also includes html output."
+        required: false


You can probably supply default: false

Same as last comment - this needs to get fixed on all actions

lakshmi-kannan · 2017-04-10T18:25:10Z

actions/check_consistency.py

+                    return "".join(config_file.readlines())
+
+            except IOError:
+                self.logger.error("Golden config not present in repo")


Provide the repo name for easy debugging

Ack that, done in 651bcc2

lakshmi-kannan · 2017-04-10T18:26:03Z

actions/check_consistency.py

+            self.logger.error(str(e))
+            return (False, str(e))
+
+        return (True, result)


Can you paste an example of the diff in description please?

Just realized you meant the PR description. Duh. Posted

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Matt Oswalt added 5 commits March 18, 2017 16:32

Update gitignore

52e9751

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Add consistency check action

e2436b8

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Added repository to configuration

5b36c50

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Add GitPython to reqs

0e2931e

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Add chatops alias for getting device consistency

ac8ed15

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

sidkrishna reviewed Apr 6, 2017

View reviewed changes

Matt Oswalt added 4 commits April 7, 2017 13:16

Update consistency check action

02f768f

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Fixed string continuation

1ee8442

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Updated README with development tips

1195b46

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Added napalm keyword to action alias, and added custom response

452b59b

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Mierdin changed the title ~~[WIP] Implementing consistency checks~~ Implement chatops-enabled configuration consistency checks Apr 7, 2017

Mierdin added the RFR label Apr 7, 2017

Incremented pack version

c64d4b7

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

lakshmi-kannan approved these changes Apr 10, 2017

View reviewed changes

Added repo name to error message

651bcc2

Signed-off-by: Matt Oswalt <oswaltm@brocade.com>

Mierdin merged commit 1593ea5 into master Apr 10, 2017

Mierdin deleted the consistency-check branch April 10, 2017 19:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement chatops-enabled configuration consistency checks #10

Implement chatops-enabled configuration consistency checks #10

Mierdin commented Mar 18, 2017 •

edited

sidkrishna Apr 6, 2017

Mierdin Apr 6, 2017

sidkrishna commented Apr 6, 2017

lakshmi-kannan left a comment

lakshmi-kannan Apr 10, 2017

Mierdin Apr 10, 2017

Mierdin Apr 10, 2017

lakshmi-kannan Apr 10, 2017

Mierdin Apr 10, 2017

Mierdin Apr 10, 2017

lakshmi-kannan Apr 10, 2017

Mierdin Apr 10, 2017

lakshmi-kannan Apr 10, 2017

Mierdin Apr 10, 2017

Implement chatops-enabled configuration consistency checks #10

Implement chatops-enabled configuration consistency checks #10

Conversation

Mierdin commented Mar 18, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sidkrishna commented Apr 6, 2017

lakshmi-kannan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mierdin commented Mar 18, 2017 •

edited