Automatsko generiranje i popunjavanje konfiguracijskih elemenata mrežnog uređaja pomoću Nornira

Automatsko generiranje i popunjavanje konfiguracijskih elemenata mrežnog uređaja pomoću Nornira

Hej Habr!

Nedavno se ovdje pojavio članak Mikrotik i Linux. Rutina i automatizacija gdje je sličan problem riješen fosilnim sredstvima. I iako je zadatak sasvim tipičan, na Habréu nema ništa slično. Usuđujem se ponuditi svoj bicikl uglednoj IT zajednici.

Ovo nije prvi bicikl za takav zadatak. Prva opcija je implementirana prije nekoliko godina unazad ansible verzija 1.x.x. Bicikl se rijetko koristio i zbog toga je stalno rđao. U smislu da se sam zadatak ne javlja toliko često koliko se verzije ažuriraju ansible. I svaki put kada trebate da vozite, lanac otpada ili točak otpada. Međutim, prvi dio, generiranje konfiguracija, uvijek radi vrlo jasno, na sreću jinja2 Motor je odavno uspostavljen. Ali drugi dio - uvođenje konfiguracija - obično je donosio iznenađenja. A budući da moram daljinski razvrstati konfiguraciju na pola stotine uređaja, od kojih su neki udaljeni hiljadama kilometara, korištenje ovog alata je bilo malo dosadno.

Ovdje moram priznati da moja nesigurnost najvjerovatnije leži u nedostatku poznavanja ansiblenego u svojim nedostacima. A ovo je, inače, važna tačka. ansible je potpuno odvojeno, vlastito područje znanja sa vlastitim DSL-om (Domain Specific Language), koji se mora održavati na pouzdanom nivou. Pa, taj trenutak ansible Razvija se prilično brzo, i bez posebnog uzimanja u obzir kompatibilnosti unatrag, ne dodaje samopouzdanje.

Stoga je ne tako davno implementirana druga verzija bicikla. Ovaj put dalje python, odnosno na okviru upisanom u python i za python pod imenom Nornir

Dakle - Nornir je mikrookvir napisan python i za python i dizajniran za automatizaciju. Isto kao u slučaju sa ansible, za rješavanje problema ovdje je potrebna kompetentna priprema podataka, tj. inventar hostova i njihovih parametara, ali skripte nisu napisane u posebnom DSL-u, već na istom ne baš starom, ali vrlo dobrom p[i|i]tonu.

Pogledajmo šta je to koristeći sljedeći živi primjer.

Imam mrežu ekspozitura sa nekoliko desetina kancelarija širom zemlje. Svaka kancelarija ima WAN ruter koji završava nekoliko komunikacijskih kanala različitih operatera. Protokol rutiranja je BGP. WAN ruteri dolaze u dva tipa: Cisco ISG ili Juniper SRX.

Sada zadatak: trebate konfigurirati namjensku podmrežu za Video nadzor na posebnom portu na svim WAN ruterima mreže podružnica - reklamirati ovu podmrežu u BGP-u - konfigurirati ograničenje brzine namjenskog porta.

Prvo trebamo pripremiti nekoliko šablona, ​​na osnovu kojih će se posebno generisati konfiguracije za Cisco i Juniper. Također je potrebno pripremiti podatke za svaku tačku i parametre veze, tj. prikupiti isti inventar

Spreman šablon za 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

Šablon za 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

Šabloni, naravno, ne nastaju iz ničega. To su u suštini razlike između radnih konfiguracija koje su bile i bile nakon rješavanja zadatka na dva specifična rutera različitih modela.

Iz naših šablona vidimo da su nam za rješavanje problema potrebna samo dva parametra za Juniper i 3 parametra za Cisco. evo ih:

  • ifname
  • ipsufiks
  • asn

Sada trebamo postaviti ove parametre za svaki uređaj, tj. uradi istu stvar inventar.

Do inventar Striktno ćemo se pridržavati dokumentacije Inicijalizacija Nornira

to jest, napravimo isti kostur fajla:

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

Config.yaml datoteka je standardna nornir konfiguracijska datoteka

$ 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"

Naznačit ćemo glavne parametre u datoteci hosts.yaml, grupa (u mom slučaju to su login/lozinke) u grupe.yamland in defaults.yaml Nećemo ništa naznačiti, ali tamo morate unijeti tri minusa - što znači da jeste yaml fajl je ipak prazan.

Ovako izgleda 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

A evo grupa.yaml:

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

juniper:
    platform: junos
    username: admin2
    password: juniper2

Evo šta se desilo inventar za naš zadatak. Tokom inicijalizacije, parametri iz datoteka inventara se mapiraju u objektni model InventoryElement.

Ispod spojlera je dijagram modela 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"
                }
            }
        }
    }
}

Ovaj model može izgledati malo zbunjujuće, posebno na početku. Da biste to shvatili, uključite interaktivni način rada python.

 $ 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'

I na kraju, pređimo na sam scenario. Ovdje nemam čime biti posebno ponosan. Uzeo sam samo gotov primjer tutorial i koristio ga gotovo nepromijenjen. Ovako izgleda gotova radna skripta:

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)

Obratite pažnju na parametar dry_run=Tačno u inicijalizaciji linijskog objekta nr.
Ovdje isto kao u ansible implementiran je probni rad u kojem se vrši konekcija na ruter, priprema se nova modificirana konfiguracija koju uređaj zatim potvrđuje (ali to nije sigurno; ovisi o podršci uređaja i implementaciji drajvera u NAPALM-u) , ali se nova konfiguracija ne primjenjuje direktno. Za borbenu upotrebu, morate ukloniti parametar suho trcanje ili promijenite njegovu vrijednost u lažan.

Kada se skripta izvrši, Nornir šalje detaljne zapise na konzolu.

Ispod spojlera je izlaz borbene vožnje na dva probna rutera:

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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Skrivanje lozinki u ansible_vault

Na početku članka malo sam pretjerao ansible, ali nije sve tako loše. Stvarno mi se sviđaju trezor poput, koji je dizajniran da sakrije osjetljive informacije od očiju. I vjerovatno su mnogi primijetili da imamo sve login/lozinke za sve borbene rutere koji svjetlucaju u otvorenom obliku u datoteci gorups.yaml. Nije lepo, naravno. Zaštitimo ove podatke sa trezor.

Prenesite parametre iz groups.yaml u creds.yaml i šifrirajte ga pomoću AES256 sa 20-cifrenom lozinkom:

$ 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

To je tako jednostavno. Ostaje da naučimo naše Nornir-skripta za preuzimanje i primjenu ovih podataka.
Da biste to učinili, u našoj skripti nakon inicijalizacijske linije nr = InitNornir(config_file=… dodajte sljedeći kod:

...
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
...

Naravno, vault.passwd ne bi trebalo da se nalazi pored creds.yaml kao u mom primeru. Ali u redu je za igranje.

To je sve za sada. Stiže još nekoliko članaka o Cisco + Zabbixu, ali ovo nije nešto o automatizaciji. I u bliskoj budućnosti planiram da pišem o RESTCONF-u u Cisco-u.

izvor: www.habr.com

Dodajte komentar