Autogenerering och uppladdning av konfigurationsinstÀllningar för nÀtverksenheter med hjÀlp av Nornir

Autogenerering och uppladdning av konfigurationsinstÀllningar för nÀtverksenheter med hjÀlp av Nornir

Hej, Habr!

Nyligen dök det upp en artikel hÀr Mikrotik och Linux. Rutiner och automatisering dÀr en liknande uppgift löstes med hjÀlp av primitiva medel. Och Àven om uppgiften Àr helt typisk, hittar man inget liknande om den pÄ Habré. Jag vÄgar föreslÄ den Àrade IT-gemenskapen min egen cykel.

Detta Ă€r inte första cykeln för en liknande uppgift. Den första versionen implementerades för flera Ă„r sedan pĂ„ ansible version 1.x.x. Cykeln anvĂ€ndes sĂ€llan och dĂ€rför blev den snabbt rostig. I den meningen att sjĂ€lva uppgiften dyker upp sĂ„ sĂ€llan som versionerna uppdateras ansible. Och varje gĂ„ng nĂ€r det behövs, sĂ„ faller kedjan av eller sĂ„ ramlar hjulet av. Men den första delen, generering av konfigurationer, fungerar alltid mycket bra, tack och lov jinja2 motor Ă€r vĂ€l etablerad sedan lĂ€nge. Men den andra delen – distributionen av konfigurationerna – bjuder som regel pĂ„ överraskningar. Eftersom jag mĂ„ste distribuera konfigurationerna pĂ„ avstĂ„nd till ett femtiotal enheter, varav vissa ligger tusentals kilometer bort, var det lite nervöst att anvĂ€nda det hĂ€r verktyget.

HĂ€r mĂ„ste jag erkĂ€nna att min osĂ€kerhet mestadels beror pĂ„ min bristande kunskap om ansible, snarare Ă€n dess brister. Och det hĂ€r, förresten, Ă€r en viktig punkt. ansible – det Ă€r ett helt eget kunskapsomrĂ„de med sitt eget DSL (Domain Specific Language) som man mĂ„ste behĂ€rska pĂ„ en sĂ€ker nivĂ„. Och det faktum att ansible utvecklas ganska snabbt, utan sĂ€rskild hĂ€nsyn till bakĂ„tkompatibilitet, ger ingen trygghet.

DÀrför implementerades nyligen den andra versionen av cykeln. Denna gÄng pÄ python, eller snarare pÄ ett ramverk skrivet i python och för python som kallas Nornir

SĂ„ – Nornir detta Ă€r ett mikroramverk skrivet i python och för python och avsett för automatisering. Precis som fallet Ă€r med ansible, krĂ€ver lösningen av uppgifter hĂ€r en korrekt förberedelse av data, dvs. inventering av vĂ€rdar och deras parametrar, och skripten skrivs inte pĂ„ ett separat DSL, utan allt pĂ„ samma inte sĂ„ gamla, men ganska snĂ€lla p[Đž|аĐč]ton.

LÄt oss titta pÄ vad det Àr med ett levande exempel.

Jag har ett filialnÀtverk med flera dussin kontor över hela landet. I varje kontor finns det en WAN-router som terminerar flera kommunikationskanaler frÄn olika operatörer. Routingprotokollet Àr BGP. WAN-rutrarna finns i tvÄ typer: Cisco ISG eller Juniper SRX.

Nu Ă€r uppgiften: att konfigurera ett dedikerat nĂ€tverk för videoövervakning pĂ„ alla WAN-routrar i filialnĂ€tverket pĂ„ en separat port — annonserar detta nĂ€tverk i BGP — konfigurera hastighetsbegrĂ€nsning för den dedikerade porten.

Först mÄste vi förbereda ett par mallar, utifrÄn vilka konfigurationerna kommer att genereras separat för Cisco och Juniper. Det Àr ocksÄ nödvÀndigt att förbereda data för varje punkt och anslutningsparametrar, det vill sÀga att samla den sÄ kallade inventeringen.

FÀrdig mall för 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

Mall för Juniper:

$ cat templates/junos/base.j2 
set interfaces {{ host.task_data.ifname }} unit 0 description "Videoövervakning"
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

Mallarna kommer förstÄs inte frÄn ingenstans. De Àr i grunden diffar mellan aktiva konfigurationer före- och efter lösningen av den angivna uppgiften pÄ tvÄ specifika routrar av olika modeller.

FrÄn vÄra mallar ser vi att vi för att lösa uppgiften behöver tvÄ parametrar för Juniper och tre parametrar för Cisco. HÀr Àr de:

  • ifname
  • ipsuffix
  • asn

Nu mÄste vi ange dessa parametrar för varje enhet, det vill sÀga göra det som kallas inventory.

För inventory vi kommer att följa dokumentationen noggrant Initializing Nornir

dvs. vi skapar en liknande filstruktur:

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

Filen config.yaml — Ă€r standardkonfigurationsfilen för Nornir

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

De grundlĂ€ggande parametrarna kommer vi att ange i filen hosts.yaml, grupper (i mitt fall Ă€r det anvĂ€ndarnamn/lösenord) i groups.yaml, och i defaults.yaml vi ska inte ange nĂ„got, men tre minustecken mĂ„ste skrivas in dĂ€r — som indikerar att det Ă€r yaml filen Ă€r Ă€ven om den Ă€r tom.

SÄ hÀr ser hosts.yaml ut:

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

Och sÄ hÀr ser groups.yaml ut:

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

juniper:
    platform: junos
    username: admin2
    password: juniper2

SÄ hÀr blev det inventory för vÄr uppgift. Vid initialisering mappas parametrar frÄn inventory-filer till objektmodellen InventoryElement.

Under spoilern finns skissen pÄ modellen 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"
                }
            }
        }
    }
}

Den hÀr modellen kan verka lite förvirrande, sÀrskilt i början. Det Àr mycket hjÀlpsamt att anvÀnda det interaktiva lÀget i 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 -- En förbÀttrad interaktiv Python. Skriv '?' för hjÀlp.

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'

Till sist gÄr vi över till skriptet. HÀr finns det egentligen inte sÄ mycket att vara stolt över. Jag har helt enkelt tagit ett fÀrdigt exempel frÄn tutorialen och anvÀnt det nÀstan utan Àndringar. SÄ hÀr ser det fÀrdiga fungerande skriptet ut:

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):
    # Transformera inventariedata till konfiguration via en mallfil
    r = task.run(task=text.template_file,
                 name="Bas Konfiguration",
                 template="base.j2",
                 path=f"templates/{task.host.platform}")

    # Spara den kompilerade konfigurationen i en vÀrdvariabel
    task.host["config"] = r.result

    # Spara den kompilerade konfigurationen i en fil
    with open(f"configs/{task.host.hostname}", "w") as f:
        f.write(r.result)

    # Distribuera den konfigurationen till enheten med NAPALM
    task.run(task=networking.napalm_configure,
             name="Laddar konfiguration pÄ enheten",
             replace=False,
             configuration=task.host["config"])

nr = InitNornir(config_file="config.yaml", dry_run=True) # sÀtt dry_run=False, hÄll tummarna och kör igen

# kör uppgifter
result = nr.run(task=config_and_deploy)
print_result(result)

Observera parameter dry_run=True i raden dÀr objektet initieras nr.
HÀr liksom i ansible Àr det implementerat ett testkörning dÀr en anslutning till routern etableras, en ny Àndrad konfiguration förbereds, vilken sedan valideras av enheten (men det Àr inte sÀkert; beror pÄ enhetens stöd och implementeringen av drivrutinen i NAPALM), men den nya konfigurationen tillÀmpas inte direkt. För produktion mÄste parametern dry_run antingen tas bort eller Àndras till Falskt.

Vid körning av Nornir-skriptet ger det detaljerad loggning i konsolen.

Under spoilern visas resultatet frÄn produktionstestet pÄ tvÄ testroutrar:

config_and_deploy***************************************************************
* cisco-test ** Àndrad : Sant *******************************************
vvvv config_and_deploy ** Àndrad : Sant vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
---- Bas konfigurering ** Àndrad : Sant ------------------------------------- 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
  beskrivning 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 tillÄt 10.10.222.0 0.0.0.255
access-list 111 tillÄt ip 10.10.222.0 0.0.0.255 all
---- Laddar konfiguration pÄ enheten ** Àndrad : Sant --------------------- INFO
+class-map match-all VIDEO_SURV
+ match access-group 111
+policy-map VIDEO_SURV
+ class VIDEO_SURV
+interface GigabitEthernet0/1/1
+  beskrivning 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 tillÄt 10.10.222.0 0.0.0.255
+access-list 111 tillÄt ip 10.10.222.0 0.0.0.255 all
^^^^ SLUT config_and_deploy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* srx-test ** Àndrad : Sant *******************************************
vvvv config_and_deploy ** Àndrad : Sant vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
---- Bas konfigurering ** Àndrad : Sant ------------------------------------- INFO
set interfaces fe-0/0/2 unit 0 beskrivning "Videoövervakning"
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 exakt
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
---- Laddar konfiguration pÄ enheten ** Àndrad : Sant --------------------- INFO
[edit interfaces]
+   fe-0/0/2 {
+       unit 0 {
+           beskrivning "Videoövervakning";
+           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 exakt;
+              }
+          }
+      }
+  }
[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;
+              }
+          }
+      }
+  }
^^^^ SLUT config_and_deploy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Döljer lösenord i ansible_vault

I början av artikeln var jag lite kritisk mot ansible, men det Àr inte sÄ illa. Jag gillar verkligen deras vault det som Àr avsett att dölja kÀnslig information frÄn ögonen. Och kanske har mÄnga av er mÀrkt att vÄra inloggningar/lösenord till alla kritiska routrar visas öppet i en fil gorups.yaml. Det Àr förstÄs inte snyggt. LÄt oss skydda dessa data med hjÀlp av vault.

Vi flyttar parametrarna frÄn groups.yaml till creds.yaml och krypterar den med AES256 och ett 20-tecken lösenord:

$ 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  
Kryptering lyckades
$ cat creds.yaml 
$ANSIBLE_VAULT;1.1;AES256
39656463353437333337356361633737383464383231366233386636333965306662323534626131
3964396534396333363939373539393662623164373539620a346565373439646436356438653965
39643266333639356564663961303535353364383163633232366138643132313530346661316533
6236306435613132610a656163653065633866626639613537326233653765353661613337393839
62376662303061353963383330323164633162386336643832376263343634356230613562643533
30363436343465306638653932366166306562393061323636636163373164613630643965636361
34343936323066393763323633336366366566393236613737326530346234393735306261363239
35663430623934323632616161636330353134393435396632663530373932383532316161353963
31393434653165613432326636616636383665316465623036376631313162646435

SĂ„ enkelt Ă€r det. ÅterstĂ„r nu att lĂ€ra vĂ„rt Nornir-skript att hĂ€mta och tillĂ€mpa dessa data.
För detta lĂ€gger vi till följande kod i vĂ„rt skript efter initialiseringsraden nr = InitNornir(config_file=
 lĂ€gger till följande kod:

...
nr = InitNornir(config_file="config.yaml", dry_run=True) # sÀtt dry_run=False, hÄll tummarna och kör igen

# berika inventering med den krypterade vault-datan
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))

# kör uppgifter
...

SjÀlvklart bör vault.passwd inte ligga nÀra creds.yaml som i mitt exempel. Men för att leka fungerar det.

Det Àr allt för nu. Det kommer snart ett par artiklar om Cisco + Zabbix, men det handlar inte riktigt om automatisering. Och inom en snar framtid planerar jag att skriva om RESTCONF i Cisco.

KĂ€lla: habr.com

Köp pĂ„litlig webbhotell med DDoS-skydd, VPS VDS-servrar đŸ”„ Köp pĂ„litlig webbhotell med DDoS-skydd, VPS VDS-servrar | ProHoster