Здравейте, Хабр!
Наскоро тук мина статия където подобна задача е решавана с остарели средства. И макар задачата да е напълно типична, на Хабре не се среща нищо подобно. Осмелявам се да предложа на уважавания ИТ-допустително своя велосипед.
Това не е първият велосипед за подобна задача. Първият вариант беше реализиран преди няколко години още на ansible версия 1.x.x. Велосипедът се използваше рядко и затова постоянно ръждясваше. В този смисъл, самата задача не възниква толкова често, колкото се обновяват версиите ansible. И всеки път, когато е нужно, то веригата пада, то колелото се откачва. Впрочем, първата част, генерирането на конфигурации — винаги работи много прецизно, благодарение на jinja2 добрия и утвърден двигател. А втората част — разпределянето на конфигурациите, обикновено беше изненада. А като вземам предвид, че разпределянето на конфигурацията ми се налага да правя дистанционно на почти петдесет устройства, някои от които се намират на хиляди километри, ползването на този инструмент беше малко притеснително.
Тук трябва да призная, че моята несигурност, най-вече се крие в липсата на опит с ansible, а не в неговите недостатъци. И това, между другото, е важен момент. ansible — това е напълно отделна, собствена област на знания с свой собствен DSL (Domain Specific Language), който трябва да се поддържа на уверено ниво. А и фактът, че ansible се развива бързо, без особени огледи за обратно съвместимост, не добавя увереност.
Затова не така отдавна беше реализиран вторият вариант на велосипеда. Този път на python, а именно на фреймворка, написан на python и за python с името
И така — Nornir това е микрофреймворк, написан на python и за python и предназначен за автоматизация. Както и в случая с ansible, за решаване на задачите тук е необходима добра подготовка на данните, т.е. инвентаризация на хостовете и техните параметри, а сценарии се пишат не на отделен DSL, а всичко на този не много стар, но много добър питон.
Нека разгледаме какво точно представлява това на следващия жив пример.
Имам филиална мрежа с няколко десетки офиса в цялата страна. Във всеки офис има WAN маршрутизатор, който приключва няколко канала от различни оператори. Протоколът за маршрутизация е BGP. WAN маршрутизаторите са от два типа: Cisco ISG или Juniper SRX.
Сега задачата: необходимо е да конфигурираме на всички WAN маршрутизатори в клоновата мрежа отделна подсетка за Видеонаблюдение в отделен порт — да обявим тази подсетка в BGP — да конфигурираме ограничение на скоростта за отделния порт.
Първо, необходимо е да подготвим набор от шаблони, на базата на които ще се генерират конфигурации за Cisco и Juniper. Също така, трябва да подготвим данни за всяка точка и параметрите за свързване, т.е. да съберем онова inventory.
Готов шаблон за 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Шаблон за 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 limiterШаблоните, разбира се, не са взети от въздуха. Това по същество са diff-ове между работещите конфигурации преди-след решение на поставената задача на два конкретни маршрутизатора с различни модели.
От нашите шаблони виждаме, че за решаване на задачата ни трябват два параметъра за Juniper и три параметъра за Cisco. Ето ги:
- ifname
- ipsuffix
- asn
Сега трябва да зададем тези параметри за всяко устройство, т.е. да направим онова. инвентор.
За инвентор ще следваме внимателно документацията
т.е. ще създадем същия файлов скелет:
.
├── config.yaml
├── inventory
│ ├── defaults.yaml
│ ├── groups.yaml
│ └── hosts.yamlФайлът config.yaml — стандартен файл за конфигурация на 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"Основните параметри ще бъдат посочени в файла hosts.yaml, групови (в моя случай това са логини/пароли) в groups.yaml, а в defaults.yaml няма да посочваме нищо, но там е необходимо да запишем три минуса — указващи, че това е yaml файл пуст.
Ето как изглежда 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А ето как изглежда groups.yaml:
---
cisco:
platform: ios
username: admin1
password: cisco1
juniper:
platform: junos
username: admin2
password: juniper2Така се получи инвентор за нашата задача. При инициализация параметрите от inventory файловете се мащабират на обектния модел InventoryElement.
Под спойлера е схемата на модела 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"
}
}
}
}
}Този модел може да изглежда малко объркващ, особено в началото. За да се ориентирате, много помага интерактивният режим в ipython.
$ ipython3
Python 3.6.9 (по подразбиране, 7 Ноември 2019, 10:44:02)
Напишете 'copyright', 'credits' или 'license' за повече информация
IPython 7.1.1 -- Подобрен интерактивен Python. Напишете '?' за помощ.
В [1]: от nornir импортирайте InitNornir
В [2]: nr = InitNornir(config_file="config.yaml", dry_run=True)
В [3]: nr.inventory.hosts
Out[3]:
{'srx-test': Host: srx-test, 'cisco-test': Host: cisco-test}
В [4]: nr.inventory.hosts['srx-test'].data
Out[4]: {'task_data': {'ifname': 'fe-0\/0\/2', 'ipsuffix': 111}}
В [5]: nr.inventory.hosts['srx-test']['task_data']
Out[5]: {'ifname': 'fe-0\/0\/2', 'ipsuffix': 111}
В [6]: nr.inventory.hosts['srx-test'].platform
Out[6]: 'junos'
И накрая преминаваме към самия скрипт. Тук нямам много да се похваля. Просто взех готов пример от и почти без изменения го използвах. Ето как изглежда готовият работещ скрипт:
от nornir импортирайте InitNornir
от nornir.plugins.tasks импортирайте networking, text
от nornir.plugins.functions.text импортирайте print_title, print_result
def config_and_deploy(task):
# Преобразувайте данните от инвентаря в конфигурация чрез файл с шаблон
r = task.run(task=text.template_file,
name="Основна конфигурация",
template="base.j2",
path=f"templates\/{{task.host.platform}}")
# Запишете компилираната конфигурация в променлива на хоста
task.host["config"] = r.result
# Запишете компилираната конфигурация в файл
with open(f"configs\/{{task.host.hostname}}", "w") as f:
f.write(r.result)
# Разгърнете тази конфигурация на устройството с NAPALM
task.run(task=networking.napalm_configure,
name="Зареждане на конфигурацията на устройството",
replace=False,
configuration=task.host["config"])
nr = InitNornir(config_file="config.yaml", dry_run=True) # задайте dry_run=False, стискайте палци и стартирайте отново
# стартирайте задачите
result = nr.run(task=config_and_deploy)
print_result(result)Обърнете внимание на параметъра dry_run=True в реда на инициализация на обекта nr.
Тук също като в ansible е реализирано тестово стартиране, при което се свързва с маршрутизатора, подготвя се нова изменена конфигурация, която след това се валидира от устройството (но това не е сигурно; зависи от поддръжката на устройството и реализирането на драйвера в NAPALM), но реалното прилагане на новата конфигурация не се извършва. За производство е необходимо да се премахне параметърът dry_run или да се смени стойността му на False.
При изпълнение на сценария Nornir извежда подробни логове в конзолата.
Под спойлера е изходът от производственото стартиране на два тестови маршрутизатора:
config_and_deploy***************************************************************
* cisco-test ** променено : True *******************************************
vvvv config_and_deploy ** променено : True vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
---- Основна конфигурация ** променено : 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
описание VIDEOSURV
ip адрес 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
---- Зареждане на конфигурация на устройството ** променено : True --------------------- INFO
+class-map match-all VIDEO_SURV
+ match access-group 111
+policy-map VIDEO_SURV
+ class VIDEO_SURV
+interface GigabitEthernet0/1/1
+ описание VIDEOSURV
+ ip адрес 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 ** променено : True *******************************************
vvvv config_and_deploy ** променено : True vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
---- Основна конфигурация ** променено : True ------------------------------------- INFO
set interfaces fe-0/0/2 unit 0 описание "Видео наблюдение"
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
---- Зареждане на конфигурация на устройството ** променено : True --------------------- INFO
[edit interfaces]
+ fe-0/0/2 {
+ unit 0 {
+ описание "Видео наблюдение";
+ 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^Крием пароли в ansible_vault
В началото на статията малко се оплаках от ansible, но там не е толкова зле. Много ми харесват vault харесва, предназначен за скриване на чувствителна информация от погледа. И вероятно много от вас забелязаха, че всички наши логини/пароли за всички боеви маршрутизатори се показват в открит вид в файла gorups.yaml. Това определено не е красиво. Нека защитим данните с помощта на vault.
Ще преместим параметрите от groups.yaml в creds.yaml и ще ги шифрираме с AES256 с 20-значна парола:
$ 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
Шифроването е успешно
$ cat creds.yaml
$ANSIBLE_VAULT;1.1;AES256
39656463353437333337356361633737383464383231366233386636333965306662323534626131
3964396534396333363939373539393662623164373539620a346565373439646436356438653965
39643266333639356564663961303535353364383163633232366138643132313530346661316533
6236306435613132610a656163653065633866626639613537326233653765353661613337393839
62376662303061353963383330323164633162386336643832376263343634356230613562643533
30363436343465306638653932366166306562393061323636636163373164613630643965636361
34343936323066393763323633336366366566393236613737326530346234393735306261363239
35663430623934323632616161636330353134393435396632663530373932383532316161353963
31393434653165613432326636616636383665316465623036376631313162646435Толкова е просто. Остава само да научим нашия Nornir-скрипт да извлича и прилага тези данни.
За целта в нашия скрипт след реда на инициализация nr = InitNornir(config_file=… добавяме следния код:
...
nr = InitNornir(config_file="config.yaml", dry_run=True) # задайте dry_run=False, свийте палци и стартирайте отново
# обогатете инвентара с шифрованите данни от хранилището
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))
# изпълнявайте задачи
...Разбира се, vault.passwd не трябва да се намира до creds.yaml, както в моя пример. Но за игра е приемливо.
Засега това е всичко. Очаквайте още две статии за Cisco + Zabbix, но те не са точно за автоматизация. В близко бъдеще планирам да напиша за RESTCONF в Cisco.
Източник: habr.com
