Автоматично генериране и попълване на конфигурационни елементи на мрежово устройство с помощта на Nornir

Хей Хабр!

Наскоро тук се появи една статия Mikrotik и Linux. Рутина и автоматизация където подобен проблем е решен с помощта на изкопаеми средства. И въпреки че задачата е напълно типична, на Хабре няма нищо подобно. Осмелявам се да предложа мотора си на уважаваната IT общност.

Това не е първият мотор за подобна задача. Първият вариант беше приложен преди няколко години в ansible версия 1.x.x. Велосипедът е използван рядко и поради това постоянно ръждясвал. В смисъл, че самата задача не възниква толкова често, колкото версиите се актуализират ansible. И всеки път, когато трябва да карате, веригата пада или колелото пада. Въпреки това, първата част, генерираща конфигурации, винаги работи много ясно, за щастие джинджа2 Двигателят е отдавна монтиран. Но втората част - пускането на конфигурации - обикновено носеше изненади. И тъй като трябва да пусна конфигурацията дистанционно на половин сто устройства, някои от които са разположени на хиляди километри, използването на този инструмент беше малко скучно.

Тук трябва да призная, че моята несигурност най-вероятно се крие в липсата ми на запознанства с ansibleотколкото в своите недостатъци. И това, между другото, е важен момент. ansible е напълно отделна, собствена област на познание със собствен DSL (специфичен за домейн език), който трябва да се поддържа на уверено ниво. Е, този момент, който ansible Развива се доста бързо и без специално внимание на обратната съвместимост не добавя увереност.

Следователно не толкова отдавна беше реализирана втора версия на велосипеда. Този път на питон, или по-скоро на рамка, написана в питон и за питон нарича Норнир

Така - Норнир е микрорамка, написана на питон и за питон и предназначени за автоматизация. Същото като в случая с ansible, за решаване на проблеми тук е необходима компетентна подготовка на данни, т.е. опис на хостове и техните параметри, но скриптовете не са написани в отделен DSL, а в същия не много стар, но много добър p[i|i]ton.

Нека да разгледаме какво представлява, използвайки следния пример на живо.

Имам клонова мрежа от няколко десетки офиса в цялата страна. Всеки офис разполага с WAN рутер, който терминира няколко комуникационни канала от различни оператори. Протоколът за маршрутизиране е BGP. WAN рутерите се предлагат в два вида: Cisco ISG или Juniper SRX.

Сега задачата: трябва да конфигурирате специална подмрежа за видеонаблюдение на отделен порт на всички WAN рутери на клоновата мрежа - рекламирайте тази подмрежа в BGP - конфигурирайте ограничението на скоростта на специалния порт.

Първо, трябва да подготвим няколко шаблона, въз основа на които ще се генерират конфигурации отделно за Cisco и Juniper. Също така е необходимо да се подготвят данни за всяка точка и параметри на връзката, т.е. съберете същия инвентар

Готов шаблон за 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

Шаблоните, разбира се, не излизат от нищото. Това са по същество разлики между работните конфигурации, които бяха и бяха след решаването на задачата на два конкретни рутера от различни модели.

От нашите шаблони виждаме, че за да разрешим проблема, имаме нужда само от два параметъра за Juniper и 3 параметъра за Cisco. Ето ги и тях:

• ifname
• ипсуфикс
• асн

Сега трябва да зададем тези параметри за всяко устройство, т.е. направи същото опис.

За опис Стриктно ще спазваме документацията Инициализиране на Nornir

тоест, нека създадем същия файлов скелет:

.
├── 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, група (в моя случай това са имена/пароли) в групи.yamlИ в defaults.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

Ето какво се случи опис за нашата задача. По време на инициализацията параметрите от инвентарните файлове се нанасят върху обектния модел 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 (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'

И накрая, нека да преминем към самия сценарий. Тук няма с какво особено да се гордея. Просто взех готов пример от урок и го използва почти непроменен. Ето как изглежда готовият работещ скрипт:

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)

Обърнете внимание на параметъра dry_run=Вярно инициализация на линейни обекти nr.
Тук същото като в ansible реализирано е тестово изпълнение, при което се осъществява връзка с рутера, подготвя се нова модифицирана конфигурация, която след това се валидира от устройството (но това не е сигурно; зависи от поддръжката на устройството и внедряването на драйвера в NAPALM) , но новата конфигурация не се прилага директно. За бойна употреба трябва да премахнете параметъра суха тренировка или променете стойността му на Фалшив.

Когато скриптът се изпълни, Nornir извежда подробни регистрационни файлове към конзолата.

Под спойлера е изходът от бойно изпълнение на два тестови рутера:

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

Скриване на пароли в ansible_vault

В началото на статията малко прекалих ansible, но не всичко е толкова лошо. Много ги харесвам свод like, който е предназначен да скрие чувствителна информация извън полезрението. И вероятно мнозина са забелязали, че имаме всички данни за влизане/пароли за всички бойни рутери, искрящи в отворена форма във файл gorups.yaml. Не е красиво, разбира се. Нека защитим тези данни с свод.

Нека прехвърлим параметрите от 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  
Encryption successful
$ cat creds.yaml 
$ANSIBLE_VAULT;1.1;AES256
39656463353437333337356361633737383464383231366233386636333965306662323534626131
3964396534396333363939373539393662623164373539620a346565373439646436356438653965
39643266333639356564663961303535353364383163633232366138643132313530346661316533
6236306435613132610a656163653065633866626639613537326233653765353661613337393839
62376662303061353963383330323164633162386336643832376263343634356230613562643533
30363436343465306638653932366166306562393061323636636163373164613630643965636361
34343936323066393763323633336366366566393236613737326530346234393735306261363239
35663430623934323632616161636330353134393435396632663530373932383532316161353963
31393434653165613432326636616636383665316465623036376631313162646435

Толкова е просто. Остава да научим нашите Норнир-скрипт за извличане и прилагане на тези данни.
За да направите това, в нашия скрипт след реда за инициализация nr = InitNornir(config_file=… добавете следния код:

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

Разбира се, vault.passwd не трябва да се намира до creds.yaml, както в моя пример. Но е добре за игра.

Това е всичко за сега. Има още няколко статии за Cisco + Zabbix, но това не е малко за автоматизацията. И в близко бъдеще смятам да пиша за RESTCONF в Cisco.

Източник: www.habr.com