Hey Habr!
Viru kuerzem ass en Artikel hei opgedaucht wou en ähnleche Problem mat fossille Mëttelen geléist gouf. An obwuel d'Aufgab komplett typesch ass, gëtt et op Habré näischt ähnleches. Ech trauen mäi Vëlo un der respektéierter IT Gemeinschaft unzebidden.
Dëst ass net deen éischte Vëlo fir sou eng Aufgab. Déi éischt Optioun gouf virun e puer Joer ëmgesat Sprooch ass Versioun 1.x.x. De Vëlo gouf selten benotzt an dofir dauernd rustéiert. Am Sënn datt d'Aufgab selwer net sou dacks entsteet wéi d'Versioune aktualiséiert ginn Sprooch ass. An all Kéier wann Dir fuere musst, fällt d'Kette of oder d'Rad fällt of. Wéi och ëmmer, den éischten Deel, Konfiguratioun generéiert, funktionnéiert ëmmer ganz kloer, glécklecherweis jéng 2 De Motor ass laang etabléiert. Awer den zweeten Deel - d'Konfiguratioun ausrollen - huet normalerweis Iwwerraschungen bruecht. A well ech d'Konfiguratioun op en halleft Honnert Apparater muss ausrollen, vun deenen e puer Tausende vu Kilometer ewech sinn, war dëst Tool e bësse langweileg ze benotzen.
Hei muss ech zouginn datt meng Onsécherheet héchstwahrscheinlech a mengem Mangel u Bekanntschaft läit Sprooch asswéi a senge Mängel. An dat ass iwwregens e wichtege Punkt. Sprooch ass ass e komplett getrennt, eegent Wëssensberäich mat senger eegener DSL (Domain Specific Language), déi op engem zouversiichtleche Niveau erhale muss ginn. Gutt, dee Moment dat Sprooch ass Et entwéckelt sech zimlech séier, an ouni speziell Respekt fir Réckkompatibilitéit, gëtt et kee Vertrauen.
Dofir ass net esou laang virun enger zweeter Versioun vum Vëlo ëmgesat ginn. Dës Kéier op Python, oder éischter op engem Kader geschriwwen an Python a fir Python opgeruff
Also - Nornir ass e Mikroframework geschriwwen an Python a fir Python an entworf fir Automatisatioun. Déi selwecht wéi am Fall mat Sprooch ass, fir Problemer hei ze léisen, ass eng kompetent Datepräparatioun néideg, d.h. Inventar vun Hosten an hir Parameteren, mee Scripten sinn net an engem separat DSL geschriwwen, mä an der selwechter net ganz al, awer ganz gutt p[i|i]ton.
Loosst eis kucken wat et mam folgende Live Beispill benotzt.
Ech hunn e Filialnetz mat e puer Dosen Büroen am ganze Land. All Büro huet e WAN Router deen e puer Kommunikatiounskanäle vu verschiddene Betreiber ofschléisst. De Routingprotokoll ass BGP. WAN Router kommen an zwou Zorte: Cisco ISG oder Juniper SRX.
Elo ass d'Aufgab: Dir musst en dedizéierten Subnet fir Videoiwwerwaachung op engem separaten Hafen op all WAN Router vum Filialnetz konfiguréieren - dëst Subnet an BGP annoncéieren - d'Geschwindegkeetslimit vum speziellen Hafen konfiguréieren.
Als éischt musse mir e puer Template virbereeden, op Basis vun deenen Konfiguratiounen separat fir Cisco a Juniper generéiert ginn. Et ass och néideg Daten fir all Punkt a Verbindung Parameteren ze preparéieren, d.h. sammelen déi selwecht Inventar
Fäerdeg Schabloun fir 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 anySchabloun fir 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 limiterSchabloune kommen natierlech net aus der Loft. Dëst sinn wesentlech Differenzen tëscht den Aarbechtskonfiguratiounen déi no der Aufgab op zwee spezifesche Router vu verschiddene Modeller geléist goufen a waren.
Vun eise Templates gesi mir datt fir de Problem ze léisen, brauche mir nëmmen zwee Parameteren fir Juniper an 3 Parameteren fir Cisco. hei sinn se:
- ifnumm
- ipsuffix
- asn
Elo musse mir dës Parameteren fir all Apparat setzen, d.h. déi selwecht Saach maachen Stamminventar.
fir Stamminventar Mir verfollegen d'Dokumentatioun strikt
dat ass, loosse mer déi selwecht Fichier Skelett schafen:
.
├── config.yaml
├── inventory
│ ├── defaults.yaml
│ ├── groups.yaml
│ └── hosts.yamlD'config.yaml Datei ass d'Standard Nornir Konfiguratiounsdatei
$ 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"Mir wäerten d'Haaptparameter an der Datei uginn hosts.yaml, Grupp (a mengem Fall sinn dat Login / Passwierder) an groups.yamlan a defaults.yaml Mir wäerten näischt uginn, awer Dir musst dräi Minusen do aginn - wat beweist datt et ass joml de Fichier ass awer eidel.
Dëst ass wéi hosts.yaml ausgesäit:
---
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: 65111An hei ass groups.yaml:
---
cisco:
platform: ios
username: admin1
password: cisco1
juniper:
platform: junos
username: admin2
password: juniper2Dëst ass wat geschitt ass Stamminventar fir eis Aufgab. Wärend der Initialiséierung ginn Parameteren aus Inventardateien op den Objektmodell mapéiert InventoryElement.
Ënnert dem Spoiler ass en Diagramm vum InventoryElement Modell
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"
}
}
}
}
}Dëse Modell kann e bëssen konfus kucken, besonnesch am Ufank. Fir et erauszefannen, den interaktiven Modus an 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'
A schlussendlech, loosst eis op d'Skript selwer goen. Ech hunn hei näischt besonnesch houfreg op ze sinn. Ech hu just e fäerdeg Beispill vun a benotzt et bal onverännert. Dëst ass wéi de fäerdege schaffende Skript ausgesäit:
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)Opgepasst op de Parameter dry_run=Wou an Linn Objet initialization nr.
Hei d'selwecht wéi an Sprooch ass en Testrun ass implementéiert an deem eng Verbindung mam Router gemaach gëtt, eng nei modifizéiert Konfiguratioun gëtt virbereet, déi dann vum Apparat validéiert gëtt (awer dëst ass net sécher; et hänkt vun der Apparatunterstëtzung an der Treiberimplementatioun an NAPALM of) , awer déi nei Konfiguratioun gëtt net direkt ugewannt. Fir Kampf benotzt, musst Dir de Parameter ewechhuelen dry_run oder änneren hire Wäert op falsch.
Wann de Skript ausgefouert gëtt, gëtt Nornir detailléiert Logbicher op d'Konsole eraus.
Ënnert dem Spoiler ass d'Ausgab vun engem Kampflaf op zwee Testrouter:
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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^Passwierder verstoppen an ansible_vault
Am Ufank vum Artikel sinn ech e bëssen iwwer Bord gaang Sprooch ass, mee et ass net all esou schlecht. Ech hunn se wierklech gär Kapell wéi, déi entwéckelt ass fir sensibel Informatioun aus der Siicht ze verstoppen. A wahrscheinlech hu vill gemierkt datt mir all Login / Passwierder fir all Kampfrouter an oppener Form an enger Datei fonkelen gorups.yaml. Et ass net schéin, natierlech. Loosst eis dës Donnéeën schützen mat Kapell.
Loosst eis d'Parameteren vun groups.yaml op creds.yaml transferéieren, a verschlëssele se mat AES256 mat engem 20-Zifferen Passwuert:
$ 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
31393434653165613432326636616636383665316465623036376631313162646435Et ass sou einfach. Et bleift eis ze léieren Nornir-Skript fir dës Donnéeën ze recuperéieren an z'applizéieren.
Fir dëst ze maachen, an eisem Skript no der Initialiséierungslinn nr = InitNornir(config_file=... add de folgende 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
...Natierlech soll vault.passwd net nieft creds.yaml sinn wéi a mengem Beispill. Awer et ass okay fir ze spillen.
Dat ass alles fir de Moment. Et ginn e puer méi Artikelen iwwer Cisco + Zabbix kommen, awer dëst ass net e bëssen iwwer Automatioun. An an der nächster Zukunft plangen ech iwwer RESTCONF zu Cisco ze schreiwen.
Source: will.com