TÄ«kla ierīču konfigurācijas elementu automātiska Ä£enerÄ“Å”ana un aizpildÄ«Å”ana, izmantojot Nornir

TÄ«kla ierīču konfigurācijas elementu automātiska Ä£enerÄ“Å”ana un aizpildÄ«Å”ana, izmantojot Nornir

Čau Habr!

Nesen Å”eit parādÄ«jās raksts Mikrotik un Linux. RutÄ«na un automatizācija kur lÄ«dzÄ«ga problēma tika atrisināta, izmantojot fosilos lÄ«dzekļus. Un, lai gan uzdevums ir pilnÄ«gi tipisks, HabrĆ© tajā nav nekā lÄ«dzÄ«ga. UzdroÅ”inos piedāvāt savu velosipēdu cienÄ«jamai IT sabiedrÄ«bai.

Å is nav pirmais velosipēds Ŕādam uzdevumam. Pirmā iespēja tika ieviesta pirms vairākiem gadiem ansible versija 1.x.x. Velosipēds bija maz lietots un tāpēc pastāvÄ«gi rÅ«sēja. Tādā ziņā, ka pats uzdevums nerodas tik bieži, kā tiek atjauninātas versijas ansible. Un katru reizi, kad vajag braukt, ķēde nokrÄ«t vai ritenis nokrÄ«t. Tomēr pirmā daļa, Ä£enerējot konfigurācijas, vienmēr, par laimi, darbojas ļoti skaidri jinja2 Dzinējs ir sen izveidots. Bet otrā daļa ā€“ konfigurāciju izrullÄ“Å”ana ā€“ parasti nesa pārsteigumus. Un tā kā man attālināti ir jāizvērÅ” konfigurācija pussimts ierÄ«cēm, no kurām dažas atrodas tÅ«kstoÅ”iem kilometru attālumā, Ŕī rÄ«ka izmantoÅ”ana bija nedaudz garlaicÄ«ga.

Å eit man jāatzÄ«st, ka mana nenoteiktÄ«ba, visticamāk, slēpjas manā neziņā ansiblenekā tās nepilnÄ«bās. Un tas, starp citu, ir svarÄ«gs punkts. ansible ir pilnÄ«gi atseviŔķa, sava zināŔanu joma ar savu DSL (Domain Specific Language), kas ir jāuztur pārliecinoŔā lÄ«menÄ«. Nu, tas brÄ«dis, ka ansible Tas attÄ«stās diezgan ātri, un, Ä«paÅ”i neņemot vērā atpakaļejoÅ”u saderÄ«bu, tas nedod pārliecÄ«bu.

Tāpēc ne tik sen tika ieviesta otrā velosipēda versija. Šoreiz tālāk pitons, vai drīzāk uz rāmja, kas ierakstīts pitons un par pitons aicināja Nornir

Tātad - Nornir ir mikroietvars, kas ierakstÄ«ts pitons un par pitons un paredzēts automatizācijai. Tas pats, kas gadÄ«jumā ar ansible, lai Å”eit atrisinātu problēmas, nepiecieÅ”ama kompetenta datu sagatavoÅ”ana, t.i. hostu un to parametru uzskaiti, bet skriptus raksta nevis atseviŔķā DSL, bet tajā paŔā ne pārāk vecajā, bet ļoti labā p[i|i]tonā.

ApskatÄ«sim, kas tas ir, izmantojot Ŕādu reāllaika piemēru.

Man ir filiāļu tÄ«kls ar vairākiem desmitiem biroju visā valstÄ«. Katrā birojā ir WAN marÅ”rutētājs, kas pārtrauc vairākus sakaru kanālus no dažādiem operatoriem. MarÅ”rutÄ“Å”anas protokols ir BGP. WAN marÅ”rutētāji ir divu veidu: Cisco ISG vai Juniper SRX.

Tagad uzdevums: jums ir jākonfigurē speciāls apakÅ”tÄ«kls videonovēroÅ”anai atseviŔķā portā visos filiāles tÄ«kla WAN marÅ”rutētājos - reklamējiet Å”o apakÅ”tÄ«klu BGP - konfigurējiet speciālā porta ātruma ierobežojumu.

Pirmkārt, mums ir jāsagatavo pāris veidnes, uz kuru pamata tiks Ä£enerētas atseviŔķi Cisco un Juniper konfigurācijas. Tāpat ir nepiecieÅ”ams sagatavot datus par katru punktu un savienojuma parametrus, t.i. savāc to paÅ”u inventāru

Gatava Cisco veidne:

$ 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

KadiÄ·a veidne:

$ 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

Veidnes, protams, nerodas no zila gaisa. Tās bÅ«tÄ«bā ir atŔķirÄ«bas starp darba konfigurācijām, kas bija un bija pēc uzdevuma atrisināŔanas diviem konkrētiem dažādu modeļu marÅ”rutētājiem.

No mÅ«su veidnēm mēs redzam, ka, lai atrisinātu problēmu, mums ir nepiecieÅ”ami tikai divi Juniper parametri un 3 parametri Cisco. Å”eit tie ir:

  • ifname
  • ipsufikss
  • asn

Tagad mums ir jāiestata Ŕie parametri katrai ierīcei, t.i. darīt to paŔu inventārs.

Par inventārs Mēs stingri ievērosim dokumentāciju Nornira inicializācija

tas ir, izveidosim to paŔu faila skeletu:

.
ā”œā”€ā”€ config.yaml
ā”œā”€ā”€ inventory
ā”‚   ā”œā”€ā”€ defaults.yaml
ā”‚   ā”œā”€ā”€ groups.yaml
ā”‚   ā””ā”€ā”€ hosts.yaml

Fails config.yaml ir standarta nornir konfigurācijas fails

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

Mēs norādÄ«sim galvenos parametrus failā hosts.yaml, grupā (manā gadÄ«jumā tie ir logins/paroles) iekŔā grupas.yamlun noklusējuma iestatÄ«jumi.yaml Mēs neko nenorādÄ«sim, bet tur jāievada trÄ«s mÄ«nusi - norādot, ka tā ir jams tomēr fails ir tukÅ”s.

Lūk, kā izskatās 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

Un Ŕeit ir groups.yaml:

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

juniper:
    platform: junos
    username: admin2
    password: juniper2

Tā tas notika inventārs mūsu uzdevumam. Inicializācijas laikā parametri no inventarizācijas failiem tiek kartēti uz objekta modeli InventoryElement.

Zem spoilera ir InventoryElement modeļa diagramma

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

Å is modelis var izskatÄ«ties nedaudz mulsinoÅ”i, it Ä«paÅ”i sākumā. Lai to noskaidrotu, tiek ieslēgts interaktÄ«vais režīms 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'

Un visbeidzot, pāriesim pie paÅ”a skripta. Man te nav ar ko Ä«paÅ”i lepoties. Es tikko paņēmu gatavu piemēru no pamācÄ«ba un izmantoja to gandrÄ«z nemainÄ«tā veidā. Šādi izskatās gatavais darba skripts:

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)

Pievērsiet uzmanību parametram dry_run=Tiesa rindā objekta inicializācija nr.
Å eit tas pats, kas iekŔā ansible ir ieviesta testa palaiÅ”ana, kurā tiek izveidots savienojums ar marÅ”rutētāju, tiek sagatavota jauna modificēta konfigurācija, kuru pēc tam apstiprina ierÄ«ce (bet tas nav droÅ”i; tas ir atkarÄ«gs no ierÄ«ces atbalsta un draivera ievieÅ”anas NAPALM) , taču jaunā konfigurācija netiek tieÅ”i piemērota. Lai izmantotu kaujas, jums ir jānoņem parametrs sausais_skrējiens vai mainiet tā vērtÄ«bu uz Nepatiess.

Kad skripts tiek izpildīts, Nornir konsolei izvada detalizētus žurnālus.

Zem spoilera ir divu testa marÅ”rutētāju kaujas rezultāts:

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

Paroļu slēpÅ”ana ansible_vault

Raksta sākumā es nedaudz pārspÄ«lēju ansible, bet tas nemaz nav tik slikti. Man tie ļoti patÄ«k velvi patÄ«k, kas ir paredzēts, lai paslēptu sensitÄ«vu informāciju no redzesloka. Un droÅ”i vien daudzi ir pamanÄ«juÅ”i, ka mums visi pieteikÅ”anās logi/paroles visiem kaujas marÅ”rutētājiem dzirkstÄ« atvērtā formā failā gorups.yaml. Tas, protams, nav skaisti. Aizsargāsim Å”os datus ar velvi.

PārsÅ«tÄ«sim parametrus no groups.yaml uz creds.yaml un Å”ifrēsim to ar AES256 ar 20 ciparu paroli:

$ 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

Tas ir tik vienkārŔi. Atliek mācīt mūsu Nornir-skripts, lai izgūtu un lietotu Ŕos datus.
Lai to izdarÄ«tu, mÅ«su skriptā pēc inicializācijas rindas nr = InitNornir(config_file=ā€¦ pievienojiet Ŕādu kodu:

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

Protams, vault.passwd nedrÄ«kst atrasties blakus creds.yaml, kā manā piemērā. Bet spēlÄ“Å”anai der.

Tas pagaidām ir viss. Ir vēl daži raksti par Cisco + Zabbix, taču Å”eit nav runa par automatizāciju. Un tuvākajā laikā es plānoju rakstÄ«t par RESTCONF vietnē Cisco.

Avots: www.habr.com

Pievieno komentāru