Ahoj, Habr!
Nedávno se zde objevily články kde podobné úkoly byly řešeny zastaralými prostředky. Ačkoli je úkol zcela typický, na Habr o něm jaksi nic podobného není. Odvážím se navrhnout váženému IT společenství svůj vlastní projekt.
To není první projekt na řešení podobného úkolu. První verze byla realizována před několika lety ještě na ansible verzi 1.x.x. Tento projekt byl využíván zřídka a proto neustále rezivěl. V tom smyslu, že se úkol neobjevuje tak často, jak se aktualizují verze ansible. A pokaždé, když je potřeba něco udělat, tak spadne řetěz, nebo se odlomí kolo. První část, generace konfigurací, však vždy funguje velmi spolehlivě, naštěstí jinja2 je motor již dlouho ustálený. Druhá část, nasazení konfigurací, většinou přinášela překvapení. A jelikož je nutné rozkládat konfigurace vzdáleně na několik desítek zařízení, z nichž některé se nacházejí tisíce kilometrů daleko, působilo mi to trochu obavy.
Tady je třeba uznat, že moje nejistota pramení spíše z nedostatečné znalosti ansible, než z jejích nedostatků. A to je mimochodem důležitý moment. ansible — to je zcela samostatná oblast znalostí se svým vlastním DSL (Domain Specific Language), který je třeba udržovat na jisté úrovni. A ten moment, že ansible se rychle vyvíjí, aniž by se příliš dívalo na zpětnou kompatibilitu, také nepřidává na jistotě.
Proto byl nedávno realizován druhý projekt. Tentokrát na python, přesněji na frameworku napsaném v python a pro python nazvanou
Takže — Nornir to je mikroframework napsaný v python a pro python a určený pro automatizaci. Podobně jako v případě ansible, pro řešení úkolů zde vyžaduje důkladnou přípravu dat, tj. inventarizaci hostitelů a jejich parametrů, ale scénáře se píší nikoli v samostatném DSL, ale stále v tom samém, stále dobrém p[í|a]ythone.
Pojďme se podívat, co to vlastně je, na dalším živém příkladu.
Mám pobočkovou síť s několika desítkami kanceláří po celé zemi. V každé kanceláři je WAN router, který terminuje několik komunikačních kanálů od různých operátorů. Protokol směrování je BGP. WAN routery jsou dvou typů: Cisco ISG nebo Juniper SRX.
Nyní je úkol: je třeba nakonfigurovat na všech WAN routerech pobočkové sítě vyhrazenou podsíť pro videonahledování na samostatném portu — oznámit tuto podsíť v BGP — nakonfigurovat omezení rychlosti pro vyhrazený port.
Nejprve je třeba připravit několik šablon, na jejichž základě budou generovány konfigurace pro Cisco a Juniper. Dále je nutné připravit údaje pro každé místo a parametry připojení, tzn. shromáždit inventář.
Hotová šablona pro 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Šablona pro Juniper:
$ cat templates/junos/base.j2
set interfaces {{ host.task_data.ifname }} unit 0 description "Videonahledování"
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Šablony samozřejmě nejsou brány z ničeho. V podstatě se jedná o rozdíly mezi pracovními konfiguracemi před a po vyřešení zadaného úkolu na dvou konkrétních modelech routerů.
Z našich šablon vidíme, že pro vyřešení úkolu potřebujeme dva parametry pro Juniper a tři parametry pro Cisco. Tady jsou:
- ifname
- ipsuffix
- asn
Nyní je třeba nastavit tyto parametry pro každé zařízení, tedy provést to samé. inventář.
Pro inventář budeme přesně dodržovat dokumentaci
to znamená, vytvoříme stejnou strukturu souborů:
.
├── config.yaml
├── inventory
│ ├── defaults.yaml
│ ├── groups.yaml
│ └── hosts.yamlSoubor config.yaml je standardní konfigurační soubor 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"Hlavní parametry uvedeme v souboru hosts.yaml, skupinové (v mém případě to jsou přihlašovací údaje) v groups.yaml, a v defaults.yaml nebudeme nic uvádět, ale je nutné tam zapsat tři pomlčky — které ukazují, že se jedná o yaml soubor, i když je prázdný.
Takto vypadá 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: 65111A takto groups.yaml:
---
cisco:
platform: ios
username: admin1
password: cisco1
juniper:
platform: junos
username: admin2
password: juniper2Tohle se podařilo inventář pro náš úkol. Při inicializaci se parametry z inventory souborů mapují na objektový model InventoryElement.
Pod spoilerem je schéma modelu 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"
}
}
}
}
}Tento model může na první pohled vypadat trochu zmateně. Abychom se v tom vyznali, velmi pomáhá interaktivní režim v ipython.
$ ipython3
Python 3.6.9 (výchozí, 7. listopadu 2019, 10:44:02)
Zadejte 'copyright', 'credits' nebo 'license' pro více informací
IPython 7.1.1 -- Vylepšená interaktivní verze Pythonu. Zadejte '?' pro pomoc.
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 nakonec přecházíme vlastně k samotnému skriptu. Tady se nemám čím chlubit. Jen jsem vzal hotový příklad z a téměř bez změn ho použil. Takto vypadá hotový pracovní skript:
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):
# Transformuj inventářová data do konfigurace přes šablonový soubor
r = task.run(task=text.template_file,
name="Základní konfigurace",
template="base.j2",
path=f"templates/{task.host.platform}")
# Ulož zkompilovanou konfiguraci do proměnné hosta
task.host["config"] = r.result
# Ulož zkompilovanou konfiguraci do souboru
with open(f"configs/{task.host.hostname}", "w") as f:
f.write(r.result)
# Nasazení této konfigurace na zařízení pomocí NAPALM
task.run(task=networking.napalm_configure,
name="Načítání konfigurace na zařízení",
replace=False,
configuration=task.host["config"])
nr = InitNornir(config_file="config.yaml", dry_run=True) # nastavte dry_run=False, zkřížte prsty a spusťte to znovu
# spusťte úlohy
result = nr.run(task=config_and_deploy)
print_result(result)Všimněte si parametru dry_run=True ve řádku inicializace objektu nr.
Tady je také realizována zkušební jízda, při které se provede spojení s routerem, připraví se nová změněná konfigurace, která je poté ověřena zařízením (ale to není zaručeno; závisí na podpoře ze strany zařízení a implementaci ovladače v NAPALM), ale nová konfigurace se přímo nepoužije. Pro skutečné nasazení je nutné odstranit parametr ansible dry_run nebo změnit jeho hodnotu na False Při provádění scénáře Nornir se do konzole vyprodukují podrobné logy..
Pod spoilerem je výstup reálného běhu na dvou testovacích routrech:
Pod spoilerem je výstup skutečného běhu na dvou testovacích routerech:
config_and_deploy***************************************************************
* cisco-test ** změněno: True *******************************************
vvvv config_and_deploy ** změněno: True vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
---- Základní konfigurace ** změněno: 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
---- Načítání konfigurace na zařízení ** změněno: 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
^^^^ KONEC config_and_deploy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* srx-test ** změněno: True *******************************************
vvvv config_and_deploy ** změněno: True vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
---- Základní konfigurace ** změněno: 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
---- Načítání konfigurace na zařízení ** změněno: 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;
+ }
+ }
+ }
+ }
^^^^ KONEC config_and_deploy ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^Skrýváme hesla v ansible_vault
Na začátku článku jsem trochu kričel na ansible, ale není to tam tak špatné. Opravdu se mi líbí jejich vault líbí se, který je určen pro skrytí citlivých informací z očí. A asi si mnozí všimli, že všechny naše přihlašovací údaje ke všem produkčním směrovačům svítí na otevřeném místě v souboru gorups.yaml. To samozřejmě nevypadá dobře. Pojďme chránit tato data pomocí vault.
Přeneste parametry z groups.yaml do creds.yaml a zašifrujte jej AES256 s 20-místným heslem:
$ 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
Šifrování bylo úspěšné
$ cat creds.yaml
$ANSIBLE_VAULT;1.1;AES256
39656463353437333337356361633737383464383231366233386636333965306662323534626131
3964396534396333363939373539393662623164373539620a346565373439646436356438653965
39643266333639356564663961303535353364383163633232366138643132313530346661316533
6236306435613132610a656163653065633866626639613537326233653765353661613337393839
62376662303061353963383330323164633162386336643832376263343634356230613562643533
30363436343465306638653932366166306562393061323636636163373164613630643965636361
34343936323066393763323633336366366566393236613737326530346234393735306261363239
35663430623934323632616161636330353134393435396632663530373932383532316161353963
31393434653165613432326636616636383665316465623036376631313162646435Takto snadno. Zbývá naučit náš Nornir-skript získávat a používat tato data.
Proto v našem skriptu po řádku inicializace nr = InitNornir(config_file=… přidáme následující kód:
...
nr = InitNornir(config_file="config.yaml", dry_run=True) # nastavte dry_run=False, zkřížte prsty a spusťte znovu
# obohacení inventáře o zašifrovaná data trezoru
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))
# spusťte úkoly
...Samozřejmě vault.passwd by neměl ležet vedle creds.yaml jako v mém příkladu. Ale pro hraní to stačí.
Na tom to zatím končí. Přichází ještě pár článků o Cisco + Zabbix, ale to je trochu o něčem jiném než automatizace. A v blízké budoucnosti plánuju napsat o RESTCONF v Cisco.
Zdroj: habr.com
