Awtomatikong paghimo ug pagpuno sa mga elemento sa pagsumpo sa aparato sa network gamit ang Nornir

Awtomatikong paghimo ug pagpuno sa mga elemento sa pagsumpo sa aparato sa network gamit ang Nornir

Hoy Habr!

Bag-o lang usa ka artikulo ang mitungha dinhi Mikrotik ug Linux. Routine ug automation diin ang susamang problema nasulbad gamit ang fossil nga paagi. Ug bisan kung ang buluhaton hingpit nga kasagaran, wala’y parehas niini sa Habré. Nangahas ko sa pagtanyag sa akong bisikleta sa respetadong IT community.

Dili kini ang unang bike alang sa maong buluhaton. Ang unang kapilian gipatuman pipila ka tuig na ang milabay balik sa ansible bersyon 1.x.x. Ang bisikleta panagsa ra gigamit ug busa kanunay nga tayaon. Sa diwa nga ang buluhaton sa iyang kaugalingon dili motungha sama sa kanunay nga ang mga bersyon gi-update ansible. Ug sa matag higayon nga kinahanglan ka nga magmaneho, ang kadena mahulog o ang ligid mahulog. Bisan pa, ang una nga bahin, paghimo og mga config, kanunay nga nagtrabaho nga klaro kaayo, maayo na lang jinja2 Ang makina dugay nang natukod. Apan ang ikaduha nga bahin - ang paglansad sa mga config - kasagaran nagdala mga sorpresa. Ug tungod kay kinahanglan nako nga i-roll out ang config sa layo sa tunga sa usa ka gatos nga mga aparato, ang pipila niini nahimutang libolibo ka kilometro ang gilay-on, ang paggamit niini nga himan medyo makalaay.

Dinhi kinahanglan kong dawaton nga ang akong kawalay kasigurohan lagmit anaa sa akong kakulang sa pamilyar ansiblekay sa mga kakulangan niini. Ug kini, sa tinuud, usa ka hinungdanon nga punto. ansible usa ka hingpit nga bulag, kaugalingon nga lugar sa kahibalo nga adunay kaugalingon nga DSL (Domain Specific Language), nga kinahanglan ipadayon sa usa ka masaligon nga lebel. Aw, nianang higayona ansible Kini dali nga nag-uswag, ug kung wala’y espesyal nga pagtagad sa atrasado nga pagkaangay, wala kini makadugang pagsalig.

Busa, dili pa lang dugay gipatuman ang ikaduhang bersyon sa bisikleta. Niining higayona sa python, o kaha sa usa ka balangkas nga gisulat sa python ug alang sa python gitawag Nornir

Busa- Nornir usa ka microframework nga gisulat sa python ug alang sa python ug gidisenyo alang sa automation. Parehas sa kaso sa ansible, aron masulbad ang mga problema dinhi, gikinahanglan ang takos nga pag-andam sa datos, i.e. imbentaryo sa mga panon ug sa ilang mga parameter, apan ang mga script gisulat dili sa usa ka bulag nga DSL, apan sa mao usab nga dili kaayo daan, apan maayo kaayo p[i|i]ton.

Atong tan-awon kung unsa ang gigamit niini sa mosunod nga buhi nga pananglitan.

Duna koy branch network nga dunay daghang mga opisina sa tibuok nasod. Ang matag opisina adunay usa ka WAN router nga nagtapos sa daghang mga channel sa komunikasyon gikan sa lainlaing mga operator. Ang routing protocol mao ang BGP. Ang mga router sa WAN adunay duha ka klase: Cisco ISG o Juniper SRX.

Karon ang buluhaton: kinahanglan nimo nga i-configure ang usa ka gipahinungod nga subnet alang sa Video Surveillance sa usa ka bulag nga pantalan sa tanan nga mga WAN router sa network sa sanga - i-advertise kini nga subnet sa BGP - i-configure ang limit sa tulin sa gipahinungod nga pantalan.

Una, kinahanglan namon nga mag-andam usa ka pares nga mga template, base sa kung unsang mga pag-configure ang himuon nga gilain alang sa Cisco ug Juniper. Gikinahanglan usab ang pag-andam sa datos alang sa matag punto ug mga parameter sa koneksyon, i.e. pagkolekta sa parehas nga imbentaryo

Andam nga template alang sa Cisco:

$ cat templates/ios/base.j2 
class-map match-all VIDEO_SURV
 match access-group 111

policy-map VIDEO_SURV
 class VIDEO_SURV
    police 1500000 conform-action transmit  exceed-action drop

interface {{ host.task_data.ifname }}
  description VIDEOSURV
  ip address 10.10.{{ host.task_data.ipsuffix }}.254 255.255.255.0
  service-policy input VIDEO_SURV

router bgp {{ host.task_data.asn }}
  network 10.40.{{ host.task_data.ipsuffix }}.0 mask 255.255.255.0

access-list 11 permit 10.10.{{ host.task_data.ipsuffix }}.0 0.0.0.255
access-list 111 permit ip 10.10.{{ host.task_data.ipsuffix }}.0 0.0.0.255 any

Template para sa Juniper:

$ cat templates/junos/base.j2 
set interfaces {{ host.task_data.ifname }} unit 0 description "Video surveillance"
set interfaces {{ host.task_data.ifname }} unit 0 family inet filter input limit-in
set interfaces {{ host.task_data.ifname }} unit 0 family inet address 10.10.{{ host.task_data.ipsuffix }}.254/24
set policy-options policy-statement export2bgp term 1 from route-filter 10.10.{{ host.task_data.ipsuffix }}.0/24 exact
set security zones security-zone WAN interfaces {{ host.task_data.ifname }}
set firewall policer policer-1m if-exceeding bandwidth-limit 1m
set firewall policer policer-1m if-exceeding burst-size-limit 187k
set firewall policer policer-1m then discard
set firewall policer policer-1.5m if-exceeding bandwidth-limit 1500000
set firewall policer policer-1.5m if-exceeding burst-size-limit 280k
set firewall policer policer-1.5m then discard
set firewall filter limit-in term 1 then policer policer-1.5m
set firewall filter limit-in term 1 then count limiter

Ang mga template, siyempre, dili mogawas sa manipis nga hangin. Kini sa tinuud nga mga kalainan tali sa nagtrabaho nga mga pag-configure nga kaniadto ug pagkahuman sa pagsulbad sa buluhaton sa duha ka piho nga mga router sa lainlaing mga modelo.

Gikan sa among mga templates among nakita nga aron masulbad ang problema, kinahanglan lang namon ang duha ka mga parameter alang sa Juniper ug 3 nga mga parameter alang sa Cisco. eto sila:

  • ifname
  • ipsuffix
  • asn

Karon kinahanglan namon nga itakda kini nga mga parameter alang sa matag aparato, i.e. buhata ang samang butang imbentaryo.

Sa imbentaryo Hugot nga sundon namon ang dokumentasyon Pagsugod sa Nornir

kana mao, maghimo kita sa parehas nga skeleton sa file:

.
├── config.yaml
├── inventory
│   ├── defaults.yaml
│   ├── groups.yaml
│   └── hosts.yaml

Ang config.yaml file mao ang standard nornir configuration file

$ cat config.yaml 
---
core:
    num_workers: 10

inventory:
    plugin: nornir.plugins.inventory.simple.SimpleInventory
    options:
        host_file: "inventory/hosts.yaml"
        group_file: "inventory/groups.yaml"
        defaults_file: "inventory/defaults.yaml"

Atong ipakita ang mga nag-unang parameter sa file hosts.yaml, grupo (sa akong kaso kini mga logins/password) sa mga grupo.yamlug sa defaults.yaml Wala kami magpakita bisan unsa, apan kinahanglan nimo nga mosulod sa tulo ka mga minus didto - nga nagpaila nga kini mao yaml ang file walay sulod bisan pa.

Mao kini ang hitsura sa hosts.yaml:

---
srx-test:
    hostname: srx-test
    groups: 
        - juniper
    data:
        task_data:
            ifname: fe-0/0/2
            ipsuffix: 111

cisco-test:
    hostname: cisco-test
    groups: 
        - cisco
    data:
        task_data:
            ifname: GigabitEthernet0/1/1
            ipsuffix: 222
            asn: 65111

Ug ania ang mga grupo.yaml:

---
cisco:
    platform: ios
    username: admin1
    password: cisco1

juniper:
    platform: junos
    username: admin2
    password: juniper2

Mao ni ang nahitabo imbentaryo para sa atong buluhaton. Atol sa pagsugod, ang mga parametro gikan sa mga file sa imbentaryo gimapa ngadto sa modelo sa butang Elemento sa Imbentaryo.

Ubos sa spoiler usa ka diagram sa modelo sa InventoryElement

print(json.dumps(InventoryElement.schema(), indent=4))
{
    "title": "InventoryElement",
    "type": "object",
    "properties": {
        "hostname": {
            "title": "Hostname",
            "type": "string"
        },
        "port": {
            "title": "Port",
            "type": "integer"
        },
        "username": {
            "title": "Username",
            "type": "string"
        },
        "password": {
            "title": "Password",
            "type": "string"
        },
        "platform": {
            "title": "Platform",
            "type": "string"
        },
        "groups": {
            "title": "Groups",
            "default": [],
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "data": {
            "title": "Data",
            "default": {},
            "type": "object"
        },
        "connection_options": {
            "title": "Connection_Options",
            "default": {},
            "type": "object",
            "additionalProperties": {
                "$ref": "#/definitions/ConnectionOptions"
            }
        }
    },
    "definitions": {
        "ConnectionOptions": {
            "title": "ConnectionOptions",
            "type": "object",
            "properties": {
                "hostname": {
                    "title": "Hostname",
                    "type": "string"
                },
                "port": {
                    "title": "Port",
                    "type": "integer"
                },
                "username": {
                    "title": "Username",
                    "type": "string"
                },
                "password": {
                    "title": "Password",
                    "type": "string"
                },
                "platform": {
                    "title": "Platform",
                    "type": "string"
                },
                "extras": {
                    "title": "Extras",
                    "type": "object"
                }
            }
        }
    }
}

Kini nga modelo mahimong tan-awon nga medyo makalibog, labi na sa una. Aron mahibal-an kini, ang interactive mode sa ipython.

 $ ipython3
Python 3.6.9 (default, Nov  7 2019, 10:44:02) 
Type 'copyright', 'credits' or 'license' for more information
IPython 7.1.1 -- An enhanced Interactive Python. Type '?' for help.

In [1]: from nornir import InitNornir                                                                           

In [2]: nr = InitNornir(config_file="config.yaml", dry_run=True)                                                

In [3]: nr.inventory.hosts                                                                                      
Out[3]: 
{'srx-test': Host: srx-test, 'cisco-test': Host: cisco-test}

In [4]: nr.inventory.hosts['srx-test'].data                                                                                    
Out[4]: {'task_data': {'ifname': 'fe-0/0/2', 'ipsuffix': 111}}

In [5]: nr.inventory.hosts['srx-test']['task_data']                                                     
Out[5]: {'ifname': 'fe-0/0/2', 'ipsuffix': 111}

In [6]: nr.inventory.hosts['srx-test'].platform                                                                                
Out[6]: 'junos'

Ug sa katapusan, magpadayon kita sa script mismo. Wala koy angay ikapasigarbo dinhi. Nagkuha lang ako usa ka andam nga gihimo nga pananglitan gikan sa tutorial ug gigamit kini nga halos wala mausab. Mao kini ang hitsura sa nahuman nga nagtrabaho nga script:

from nornir import InitNornir
from nornir.plugins.tasks import networking, text
from nornir.plugins.functions.text import print_title, print_result

def config_and_deploy(task):
    # Transform inventory data to configuration via a template file
    r = task.run(task=text.template_file,
                 name="Base Configuration",
                 template="base.j2",
                 path=f"templates/{task.host.platform}")

    # Save the compiled configuration into a host variable
    task.host["config"] = r.result

    # Save the compiled configuration into a file
    with open(f"configs/{task.host.hostname}", "w") as f:
        f.write(r.result)

    # Deploy that configuration to the device using NAPALM
    task.run(task=networking.napalm_configure,
             name="Loading Configuration on the device",
             replace=False,
             configuration=task.host["config"])

nr = InitNornir(config_file="config.yaml", dry_run=True) # set dry_run=False, cross your fingers and run again

# run tasks
result = nr.run(task=config_and_deploy)
print_result(result)

Hatagi'g pagtagad ang parameter dry_run=Tinuod sa linya nga butang initialization nr.
Dinhi parehas sa ansible gipatuman ang usa ka pagsulay nga pagdagan diin gihimo ang usa ka koneksyon sa router, giandam ang usa ka bag-ong gibag-o nga pagsumpo, nga dayon gi-validate sa aparato (apan dili kini sigurado; nagdepende kini sa suporta sa aparato ug ang pagpatuman sa drayber sa NAPALM) , apan ang bag-ong configuration dili direktang gipadapat. Alang sa paggamit sa kombat, kinahanglan nimong tangtangon ang parameter dry_run o usbon ang bili niini ngadto sa bakak nga mga.

Kung ang script gipatuman, ang Nornir nagpagawas sa mga detalyado nga log sa console.

Ubos sa spoiler mao ang output sa usa ka combat run sa duha ka test routers:

config_and_deploy***************************************************************
* cisco-test ** changed : True *******************************************
vvvv config_and_deploy ** changed : True vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
---- Base Configuration ** changed : True ------------------------------------- INFO
class-map match-all VIDEO_SURV
 match access-group 111

policy-map VIDEO_SURV
 class VIDEO_SURV
    police 1500000 conform-action transmit  exceed-action drop

interface GigabitEthernet0/1/1
  description VIDEOSURV
  ip address 10.10.222.254 255.255.255.0
  service-policy input VIDEO_SURV

router bgp 65001
  network 10.10.222.0 mask 255.255.255.0

access-list 11 permit 10.10.222.0 0.0.0.255
access-list 111 permit ip 10.10.222.0 0.0.0.255 any
---- Loading Configuration on the device ** changed : True --------------------- INFO
+class-map match-all VIDEO_SURV
+ match access-group 111
+policy-map VIDEO_SURV
+ class VIDEO_SURV
+interface GigabitEthernet0/1/1
+  description VIDEOSURV
+  ip address 10.10.222.254 255.255.255.0
+  service-policy input VIDEO_SURV
+router bgp 65001
+  network 10.10.222.0 mask 255.255.255.0
+access-list 11 permit 10.10.222.0 0.0.0.255
+access-list 111 permit ip 10.10.222.0 0.0.0.255 any
^^^^ END config_and_deploy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* srx-test ** changed : True *******************************************
vvvv config_and_deploy ** changed : True vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
---- Base Configuration ** changed : True ------------------------------------- INFO
set interfaces fe-0/0/2 unit 0 description "Video surveillance"
set interfaces fe-0/0/2 unit 0 family inet filter input limit-in
set interfaces fe-0/0/2 unit 0 family inet address 10.10.111.254/24
set policy-options policy-statement export2bgp term 1 from route-filter 10.10.111.0/24 exact
set security zones security-zone WAN interfaces fe-0/0/2
set firewall policer policer-1m if-exceeding bandwidth-limit 1m
set firewall policer policer-1m if-exceeding burst-size-limit 187k
set firewall policer policer-1m then discard
set firewall policer policer-1.5m if-exceeding bandwidth-limit 1500000
set firewall policer policer-1.5m if-exceeding burst-size-limit 280k
set firewall policer policer-1.5m then discard
set firewall filter limit-in term 1 then policer policer-1.5m
set firewall filter limit-in term 1 then count limiter
---- Loading Configuration on the device ** changed : True --------------------- INFO
[edit interfaces]
+   fe-0/0/2 {
+       unit 0 {
+           description "Video surveillance";
+           family inet {
+               filter {
+                   input limit-in;
+               }
+               address 10.10.111.254/24;
+           }
+       }
+   }
[edit]
+  policy-options {
+      policy-statement export2bgp {
+          term 1 {
+              from {
+                  route-filter 10.10.111.0/24 exact;
+              }
+          }
+      }
+  }
[edit security zones]
     security-zone test-vpn { ... }
+    security-zone WAN {
+        interfaces {
+            fe-0/0/2.0;
+        }
+    }
[edit]
+  firewall {
+      policer policer-1m {
+          if-exceeding {
+              bandwidth-limit 1m;
+              burst-size-limit 187k;
+          }
+          then discard;
+      }
+      policer policer-1.5m {
+          if-exceeding {
+              bandwidth-limit 1500000;
+              burst-size-limit 280k;
+          }
+          then discard;
+      }
+      filter limit-in {
+          term 1 {
+              then {
+                  policer policer-1.5m;
+                  count limiter;
+              }
+          }
+      }
+  }
^^^^ END config_and_deploy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Pagtago sa mga password sa ansible_vault

Sa sinugdanan sa artikulo, medyo nasobrahan ko ansible, apan dili kini tanan daotan. Ganahan kaayo ko nila vault sama sa, nga gidisenyo sa pagtago sa sensitibo nga impormasyon gikan sa panan-aw. Ug tingali daghan ang nakamatikod nga kami adunay tanan nga mga logins / password alang sa tanan nga mga combat routers nga nagkidlap sa bukas nga porma sa usa ka file gorups.yaml. Dili kini gwapa, siyempre. Atong panalipdan kini nga datos gamit ang vault.

Atong ibalhin ang mga parameter gikan sa groups.yaml ngadto sa creds.yaml, ug i-encrypt kini gamit ang AES256 nga adunay 20-digit nga password:

$ cd inventory
$ cat creds.yaml
---
cisco:
    username: admin1
    password: cisco1

juniper:
    username: admin2
    password: juniper2

$ pwgen 20 -N 1 > vault.passwd
ansible-vault encrypt creds.yaml --vault-password-file vault.passwd  
Encryption successful
$ cat creds.yaml 
$ANSIBLE_VAULT;1.1;AES256
39656463353437333337356361633737383464383231366233386636333965306662323534626131
3964396534396333363939373539393662623164373539620a346565373439646436356438653965
39643266333639356564663961303535353364383163633232366138643132313530346661316533
6236306435613132610a656163653065633866626639613537326233653765353661613337393839
62376662303061353963383330323164633162386336643832376263343634356230613562643533
30363436343465306638653932366166306562393061323636636163373164613630643965636361
34343936323066393763323633336366366566393236613737326530346234393735306261363239
35663430623934323632616161636330353134393435396632663530373932383532316161353963
31393434653165613432326636616636383665316465623036376631313162646435

Ingon ana ka simple. Kini nagpabilin sa pagtudlo sa atong Nornir-script aron makuha ug magamit kini nga datos.
Aron mahimo kini, sa among script pagkahuman sa linya sa pagsugod nr = InitNornir(config_file=… idugang ang mosunod nga code:

...
nr = InitNornir(config_file="config.yaml", dry_run=True) # set dry_run=False, cross your fingers and run again

# enrich Inventory with the encrypted vault data
from ansible_vault import Vault
vault_password_file="inventory/vault.passwd"
vault_file="inventory/creds.yaml"
with open(vault_password_file, "r") as fp:
    password = fp.readline().strip()   
    vault = Vault(password)
    vaultdata = vault.load(open(vault_file).read())

for a in nr.inventory.hosts.keys():
    item = nr.inventory.hosts[a]
    item.username = vaultdata[item.groups[0]]['username']
    item.password = vaultdata[item.groups[0]]['password']
    #print("hostname={}, username={}, password={}n".format(item.hostname, item.username, item.password))

# run tasks
...

Siyempre, ang vault.passwd kinahanglan dili mahimutang sunod sa creds.yaml sama sa akong pananglitan. Apan ok ra sa pagdula.

Kana lang sa pagkakaron. Adunay usa ka magtiayon nga dugang nga mga artikulo bahin sa Cisco + Zabbix nga moabut, apan kini dili gamay bahin sa automation. Ug sa umaabot nga umaabot nagplano ako nga magsulat bahin sa RESTCONF sa Cisco.

Source: www.habr.com

Idugang sa usa ka comment