Nornir erabiliz sareko gailuen konfigurazio elementuak automatikoki sortzea eta betetzea

Nornir erabiliz sareko gailuen konfigurazio elementuak automatikoki sortzea eta betetzea

Aupa Habr!

Duela gutxi artikulu bat agertu da hemen Mikrotik eta Linux. Errutina eta automatizazioa non antzeko arazo bat bide fosilak erabiliz ebatzi zen. Eta zeregina guztiz tipikoa den arren, ez dago antzekorik Habré-n. Ausartzen naiz nire bizikleta IT komunitate errespetatuari eskaintzera.

Hau ez da horrelako zeregin baterako lehen bizikleta. Lehen aukera duela urte batzuk ezarri zen berriro ansible 1.x.x bertsioa. Bizikleta gutxi erabiltzen zen eta, beraz, etengabe herdoildu egiten zen. Zeregin bera bertsioak eguneratzen diren bezain maiz sortzen ez den zentzuan ansible. Eta gidatu behar duzun bakoitzean, katea erortzen da edo gurpila erortzen da. Hala ere, lehenengo zatia, konfigurazioak sortzea, beti oso argi funtzionatzen du, zorionez jinja2 Motorra aspaldi ezarrita dago. Baina bigarren zatiak - konfigurazioak zabaltzea - ​​normalean sorpresak ekarri zituen. Eta konfigurazioa urrunetik zabaldu behar dudanez ehun erdi gailutara, horietako batzuk milaka kilometrotara daudenez, tresna hau erabiltzea apur bat aspergarria zen.

Hemen aitortu behar dut ziurrenik nire ziurgabetasuna ezagutzen ez dudanean datzala ansiblebere gabezietan baino. Eta hau, bide batez, puntu garrantzitsua da. ansible guztiz bereizia da, bere ezagutza-eremua bere DSL (Domain Specific Language), konfiantza mailan mantendu behar dena. Beno, momentu horretan hori ansible Nahiko azkar garatzen ari da, eta atzerako bateragarritasunari arreta berezia jarri gabe, ez du konfiantza gehitzen.

Hori dela eta, duela ez hainbeste bizikletaren bigarren bertsioa ezarri zen. Oraingoan python, edo hobeto esanda, idatzitako esparru batean python eta for python izeneko Nornir

Beraz - Nornir bertan idatzitako mikroesparru bat da python eta for python eta automatizaziorako diseinatua. -rekin gertatzen den berdina ansible, hemen arazoak konpontzeko, datuen prestaketa konpetentea behar da, hau da. ostalarien eta haien parametroen inbentarioa, baina script-ak ez dira DSL bereizi batean idazten, baina berdin ez oso zaharra, baina oso p[i|i]ton ona.

Ikus dezagun zer den hurrengo zuzeneko adibidea erabiliz.

Sukurtsal sare bat daukat herrialde osoan dozena bat bulego dituena. Bulego bakoitzak WAN bideratzaile bat du, operadore ezberdinen hainbat komunikazio kanal amaitzen dituena. Bideratze-protokoloa BGP da. WAN bideratzaileak bi motatakoak dira: Cisco ISG edo Juniper SRX.

Orain zeregina: Bideo-zaintzarako azpisare dedikatu bat konfiguratu behar duzu adar-sareko WAN bideratzaile guztietan aparteko atakan - iragar ezazu azpisare hau BGPn - konfiguratu dedikatu atakaren abiadura-muga.

Lehenik eta behin, txantiloi pare bat prestatu behar ditugu, eta horien arabera konfigurazioak bereizita sortuko dira Cisco eta Juniperrentzat. Puntu eta konexio-parametro bakoitzerako datuak ere prestatu behar dira, hau da. inbentario bera bildu

Ciscorako prest dagoen txantiloia:

$ 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

Juniperrako txantiloia:

$ 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

Txantiloiak, noski, ez dira hutsetik ateratzen. Funtsean, zeregina ebatzi ondoren izan ziren eta zeuden lan-konfigurazioen arteko desberdintasunak dira eredu desberdinetako bi bideratzaile zehatzetan.

Gure txantiloietatik ikusten dugu arazoa konpontzeko, Juniperrentzat bi parametro eta Ciscorentzat 3 parametro besterik ez ditugula behar. hona hemen:

  • bada izena
  • ipatzizkia
  • asn

Orain parametro hauek ezarri behar ditugu gailu bakoitzeko, hau da. gauza bera egin inbentarioa.

For inbentarioa Dokumentazioa zorrotz jarraituko dugu Nornir hasieratzen

hau da, sor dezagun fitxategi-hezurdura bera:

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

config.yaml fitxategia nornir konfigurazio fitxategi estandarra da

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

Fitxategian parametro nagusiak adieraziko ditugu ostalariak.yaml, taldea (nire kasuan saio-hasiera/pasahitza dira) in taldeak.yamleta lehenetsiak.yaml Ez dugu ezer adieraziko, baina hiru minus idatzi behar dituzu bertan, hala dela adieraziz yaml fitxategia hutsik dago ordea.

Hau da hosts.yaml-ren itxura:

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

Eta hona hemen groups.yaml:

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

juniper:
    platform: junos
    username: admin2
    password: juniper2

Hau da gertatu dena inbentarioa gure zereginerako. Hasieran, inbentario-fitxategietako parametroak objektu-ereduarekin mapatzen dira InbentarioElementua.

Spoiler-aren azpian InventoryElement ereduaren diagrama bat dago

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

Eredu honek apur bat nahasia izan dezake, batez ere hasieran. Irudikatu ahal izateko, modu interaktiboa sartu da 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'

Eta azkenik, gidoiari berari pasa gaitezen. Ez dut hemen bereziki harro egoteko ezer. Hemendik prest egindako adibide bat hartu dut tutoretza eta ia aldatu gabe erabili zuen. Hau da amaitutako laneko scriptaren itxura:

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)

Erreparatu parametroari dry_run=Egia lerroko objektuaren hasierako nr.
Hemen bertan bezala ansible proba-exekutatu bat ezarri da eta bertan bideratzailearekin konexioa egiten da, aldatutako konfigurazio berri bat prestatzen da, eta gero gailuak baliozkotzen du (baina hori ez da ziurra; gailuaren euskarriaren eta NAPALM-en kontrolatzailearen ezarpenaren araberakoa da) , baina konfigurazio berria ez da zuzenean aplikatzen. Borroka erabiltzeko, parametroa kendu behar duzu korrika_lehorra edo aldatu bere balioa False.

Scripta exekutatzen denean, Nornir-ek erregistro zehatzak ateratzen ditu kontsolara.

Spoiler-aren azpian borroka baten irteera dago bi proba bideratzailetan:

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

Pasahitzak ansible_vault-en ezkutatzen

Artikuluaren hasieran pixka bat gainditzen nuen ansible, baina ez da horren txarra. Asko gustatzen zaizkit ganga bezalako, informazio sentikorra bistatik kanpo ezkutatzeko diseinatuta dagoena. Eta ziurrenik askok ohartu dira borroka bideratzaile guztien saio-hasiera/pasahitz guztiak forma irekian distiratsuak ditugula fitxategi batean gorups.yaml. Ez da polita, noski. Babes ditzagun datu hauek ganga.

Transferi ditzagun parametroak groups.yaml-tik creds.yaml-ra, eta enkriptatu AES256-rekin 20 digituko pasahitz batekin:

$ 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

Hain sinplea da. Gure irakastea geratzen da Nornir-gidoia datu hauek berreskuratu eta aplikatzeko.
Horretarako, gure gidoian hasierako lerroaren ondoren nr = InitNornir(config_file=… gehitu kode hau:

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

Jakina, vault.passwd ez litzateke creds.yaml-ren ondoan kokatu behar nire adibidean bezala. Baina ondo dago jolasteko.

Hori da guztia oraingoz. Cisco + Zabbix-i buruzko artikulu pare bat gehiago datoz, baina hau ez da automatizazioari buruz. Eta etorkizun hurbilean RESTCONF-i buruz idazteko asmoa dut Cisco-n.

Iturria: www.habr.com

Gehitu iruzkin berria