From a32c2969790211574f85fea79ec27d4c992d0573 Mon Sep 17 00:00:00 2001 From: RSA Date: Tue, 23 Aug 2022 01:36:50 +0300 Subject: [PATCH 1/3] add(doc): about peering management module --- docs/ru/docs/user/background/index.md | 4 +- .../background/peering-management/index.md | 73 +++++++++++++++++++ docs/ru/mkdocs.yml | 1 + 3 files changed, 77 insertions(+), 1 deletion(-) create mode 100644 docs/ru/docs/user/background/peering-management/index.md diff --git a/docs/ru/docs/user/background/index.md b/docs/ru/docs/user/background/index.md index 13bb985ad3..49d62ef9ef 100644 --- a/docs/ru/docs/user/background/index.md +++ b/docs/ru/docs/user/background/index.md @@ -1 +1,3 @@ -# Background Information \ No newline at end of file +# Background Information + +[Учет и управление BGP сессиями](peering-management/peering-management.md) \ No newline at end of file diff --git a/docs/ru/docs/user/background/peering-management/index.md b/docs/ru/docs/user/background/peering-management/index.md new file mode 100644 index 0000000000..efe5352151 --- /dev/null +++ b/docs/ru/docs/user/background/peering-management/index.md @@ -0,0 +1,73 @@ +# Учет и управление BGP сессиями: + +Модуль `Peering Management` позволяет вести учет: + + - RPSL объектов и историю их изменений + - BGP сессий + - Автоматически или полу-автоматически подготавливать и выгружать актуальные данные в базу RIR + - Построение префикс листов на основе внесенных данных + - Уведомление о изменении списка IP сетей анонсиремых клиентами + - Позволяет заполнить дополнительной информацией карточку аварии при классификации события BGP. + + +!!! info "" + + Если нужен только учет BGP сессий, то настройку можно начинать с раздела ["Настройка основных параметров"](#настройка-основных-параметров) + +## Порядок настройки модуля + +Предварительная настройка - почти все поля соответствуют таковым в **RIPE DB**, обязательные поля подсвеченны красным, если каких-то полей не хватает, то эти параметры можно указать в поле `Extra`. + +1. **Управление ПИРами** - **Настройки** - **Persons**: + + - Добавляем все необходимые объекты с типом **Persons** + - Добавляем все необходимые объекты с типом **Role** (noc, abuse, tech, и т.п) + +2. **Управление ПИРами** - **Настройки** - **Ответственный**: + + - Добавляем Mainteiner`а(ов) + +3. **Управление ПИРами** - **Настройки** - **Организации**: + + - Добавляем свою органихацию(и). В поле `Org. Type` указываем `LIR`, если она является лиром. Для всех остальных - `Other`. + +4. **Управление ПИРами** - **Настройки** - **Профили AS**: + + - Создаем необходимое кол-во профилей с разными цветами, которыми потом ASN будут помеченны в списке. Например для визуального разделения различных подведомственных организаций, и т.п. + + +## Настройка основных параметров + +1. **Управление ПИРами** - **Настройки** - **Группы пиров**: + + - Создаем все необходимые группы, на которые будем разделять наши сессии, например `left`(uplinks), `right`(downlinks), и т.п. Тут же можо указать основные параметры влияющие на приоритет маршрутов, которые действуют на всю группу. + +1. **Управление ПИРами** - **ASes** + + - Добавляем сюда все свои автономные системы, с которыми будем работать. После добавления, изменения, удаления сессий с данными AS в **Управление ПИРами** - **Пиры**, можно сгенерировать описание для этого обекта(AS) в RIPEDB. Для этого необходимо пересохранить нужную AS и нажать на значок с изображением лупы. + +1. **Управление ПИРами** - **Настройки** - **Peering Points**: + + - Добавляем все роутеры на которых у нас будут BGP сесии(для которых нужно вести учет). Галочка `Enable Prefix-List Provisioning` отвечает за включение функции периодического запроса префиксов по всем внесенным сессиям из базы RIR, если обнаруженны изменения - отправляет уведомление в группу `Prefix-List Notification Group`. В поле `Location` при желании указывается физическое расположение. Если профиля под используеммый маршрутизатор нет, то выбираем `Generic`. + +1. **Управление ПИРами** - **Communities** и **Наборы AS**: + + - Добавляем все свои комьюнити и as-set, которые планируем использовать. + +## Добавление BGP сессий + +Раздел **Управление ПИРами** - **Пиры**, добавить новую запись с обязательным заполнением следующих полей: + + - **Peering Point** - оборудование, на котором будет создана сессия + - **Peer Group** - группа(тип: Клиенты, Поставщики, и т.д) сессии + - **Проект** - номер договора + - **Локальная AS** - номер автономной системы с нашей стороны + - **Remote AS** - номер автономной системы со стороны клиента, поставщика, или др. + - **Статус** - планируеммое состаяние, например активная, запланированно включение, деактивированна + - **Локальный IP** - ip на нашей стороне, обязательно __указывать с маской сети!__(с которой он прописан на интерефейсе оборудования) + - **Remote IP** - ip на противоположной стороне, обязательно __указывать с маской сети!__(с которой он прописан на интерефейсе оборудования) + - **Описание** - можно указать краткое наименование организации с которой настраивается сессия. Данное поле в дальнейшем может использоваться в шаблонах текста аварий. + - **RPSL Remark** - краткое наименование организации в нижнем регистре с использованием только латинских букв, цифр и символов тире(**-**) или нижнего подчеркивания(**\_**). Это поле используется для комментария в RPSL описании ASN, так же может использоваться в названии каких-либо объектов при настройке на оборудовании через персональные скрипты или сниппеты. + - **Import Filter** - AS-SET или номер автономной системы (напр. `AS12345`), которые клиент указал в заказе для формирования списка его сетей. Если сессия настраивается не для клиента, то указывается имя policy-statement, которое будет использованно в этой сессии. + - **Export Filter** - имя фильтра для исходящих анонсов или AS-SET, на основе которого противоположная сторона будет строить свои фильтры. + - **Import Communities** - указываются через _пробел_ комьюнити для управления трафиком. Например `RTK-3P`(если роутер поддреживает в текстовом виде) или `65535:666`. diff --git a/docs/ru/mkdocs.yml b/docs/ru/mkdocs.yml index fe156da7a9..06c2365d94 100644 --- a/docs/ru/mkdocs.yml +++ b/docs/ru/mkdocs.yml @@ -22,6 +22,7 @@ nav: - Работа с конфигурацией оборудования: user/background/configuration-management/index.md - Работа с топологией: user/background/topology/index.md - Работа с авариями: user/background/fault-management/index.md + - Учет BGP сессий: user/background/peering-management/index.md - Reference: - Overview: user/reference/index.md - Concepts: -- GitLab From a902fbe6f87a3697b547132a4fa3f001cc3b62de Mon Sep 17 00:00:00 2001 From: RSA Date: Tue, 23 Aug 2022 11:42:09 +0000 Subject: [PATCH 2/3] Update docs/ru/docs/user/background/index.md --- docs/ru/docs/user/background/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ru/docs/user/background/index.md b/docs/ru/docs/user/background/index.md index 49d62ef9ef..8cd0c35c92 100644 --- a/docs/ru/docs/user/background/index.md +++ b/docs/ru/docs/user/background/index.md @@ -1,3 +1,3 @@ # Background Information -[Учет и управление BGP сессиями](peering-management/peering-management.md) \ No newline at end of file +[Учет и управление BGP сессиями](peering-management/index.md) -- GitLab From a66e9607f3ac6c50e321d0bdb93b98aa5425f76c Mon Sep 17 00:00:00 2001 From: RSA Date: Tue, 23 Aug 2022 11:55:35 +0000 Subject: [PATCH 3/3] Update formating --- docs/ru/docs/user/background/peering-management/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ru/docs/user/background/peering-management/index.md b/docs/ru/docs/user/background/peering-management/index.md index efe5352151..e91ee074cc 100644 --- a/docs/ru/docs/user/background/peering-management/index.md +++ b/docs/ru/docs/user/background/peering-management/index.md @@ -64,8 +64,8 @@ - **Локальная AS** - номер автономной системы с нашей стороны - **Remote AS** - номер автономной системы со стороны клиента, поставщика, или др. - **Статус** - планируеммое состаяние, например активная, запланированно включение, деактивированна - - **Локальный IP** - ip на нашей стороне, обязательно __указывать с маской сети!__(с которой он прописан на интерефейсе оборудования) - - **Remote IP** - ip на противоположной стороне, обязательно __указывать с маской сети!__(с которой он прописан на интерефейсе оборудования) + - **Локальный IP** - ip на нашей стороне, обязательно ^^указывать с маской сети!^^(с которой он прописан на интерефейсе оборудования) + - **Remote IP** - ip на противоположной стороне, обязательно ^^указывать с маской сети!^^(с которой он прописан на интерефейсе оборудования) - **Описание** - можно указать краткое наименование организации с которой настраивается сессия. Данное поле в дальнейшем может использоваться в шаблонах текста аварий. - **RPSL Remark** - краткое наименование организации в нижнем регистре с использованием только латинских букв, цифр и символов тире(**-**) или нижнего подчеркивания(**\_**). Это поле используется для комментария в RPSL описании ASN, так же может использоваться в названии каких-либо объектов при настройке на оборудовании через персональные скрипты или сниппеты. - **Import Filter** - AS-SET или номер автономной системы (напр. `AS12345`), которые клиент указал в заказе для формирования списка его сетей. Если сессия настраивается не для клиента, то указывается имя policy-statement, которое будет использованно в этой сессии. -- GitLab