Руководство администратора программного комплекса управления разнородными службами каталогов ПК ЦТЛ.ДОМЕН
НАЗНАЧЕНИЕ ПРОГРАММНОГО КОМПЛЕКСА
1.1. Программный комплекс ЦТЛ.Домен предназначен для решения комплекса задач по реализации единых принципов и интерфейсов управления для разнородных служб каталогов, а также обеспечения единообразной настройки разрозненных служб каталогов разных производителей.
1.2. Функционал доступный администратору домена:
– подключение к интерфейсу управления доменом;
– настройка перечней атрибутов объекта домена;
– навигация по объектам домена;
– добавление/удаление/редактирование/перемещение подразделений домена (OU);
– добавление/удаление/редактирование/перемещение пользователей домена;
– добавление/удаление/редактирование/перемещение групп домена;
– добавление/удаление/редактирование/перемещение компьютеров домена;
– добавление/удаление/редактирование записей в системе доменных имен (DNS);
– добавление/удаление записей в службе времени (NTP);
– изменение данных объекта - пользователя:
1) добавление/удаление/редактирование/ атрибутов пользователя;
2) перемещение пользователя между подразделениями (OU);
3) перемещение пользователя между группами.
– добавление/удаление/редактирование сайтов домена;
– добавление/удаление/редактирование контроллеров домена
– контроль применения изменений на домене-источнике.
УСЛОВИЯ ФУНКЦИОНИРОВАНИЯ ПРОГРАММНОГО КОМПЛЕКСА
2.1. Программные и технические средства для функционирования ПК ЦТЛ.Домен описаны в документе 643.ЦТЛС.00003-01 31 01 «Описание применения».
2.2. ПК реализована на принципах клиент-серверной архитектуры. Для функционирования ПК не требуется дополнительной установки стороннего программного обеспечения на рабочей станции.
2.3. Управление сервером ПК осуществляется посредством командного интерфейса сервера, подключение к терминалу осуществляется с клиента по ssh или непосредственно с сервера. Команды управления сервисами и их первичная настройка приведены в документе 643.ЦТЛС.00001-01 91 01 «Инструкция по установке».
2.4. Управление подключёнными доменами осуществляется посредством REST-API. Запрос к API осуществляются путем отправки http - запросов. Запросы могут быть отправлены как непосредственно с сервера, используя утилиту curl, так и удаленно с любого http-клиента или иной программы, обеспечивающей подобный функционал.
2.5. Каждый сервис ПК позволяет формировать запросы непосредственно через встроенный web-интерфейс OpenAPI/Swagger. Получить доступ к данным интерфейсам можно с помощью интернет-браузеров (Яндекс Браузер, Mozilla Firefox, Microsoft Edge, Google Chrome).
ВЫПОЛНЕНИЕ ПРОГРАММНОГО КОМПЛЕКСА
3.1. Запуск программного комплекса
3.1.1. ПК запускается автоматически. При подключении домена создаются отдельные сервисы. Процедура первичной настройки сервисов и подготовки сервисов и подготовке к работе приведены в документе 643.ЦТЛС.00001-01 91 01 «Инструкция по установке».
3.2. Управление ресурсами домена
3.2.1. Для управления ресурсами домена используется интерфейс REST API.
3.2.2. Сервисы, используемые в ПК ЦТЛ.Домен:
– сервис domain_engine: предназначен для управления инфраструктурой домена;
– сервис pt_catalog_service: предназначен для управления объектами каталога.
3.2.3. Применение сертификатов для получения доступа к API
3.2.3.1. В целях мер защиты от несанкционированного доступа рекомендуется запретить доступ к API без использования пользовательского сертификата. Данный режим установлен по умолчанию, но может быть изменен при инсталляции ПК. Во втором случае API будет открыт для любых запросов по http, что небезопасно, но может быть удобно для доверенных сред или быстрого развертывания.
3.2.3.2. Если установлена проверка пользовательских сертификатов, перед началом работы с API необходимо скопировать клиентские сертификаты каждого контейнера на машину клиента и использовать их для аутентификации клиента при обращении к серверу ПК.
3.2.3.3. Пользовательские сертификаты можно импортировать в web- браузер или явно указывать при формировании запросов к API из http-клиента.
3.2.3.4. Без наличия пользовательского сертификата работа с API, включая доступ к OpenAPI/Swagger, будет недоступена.
3.3. Описание методов API
3.3.1. Общие сведения
3.3.1.1. <BaseURL> - WEB-адрес службы (контейнера управления доменом).
3.3.1.2. Структура WEB-адреса службы: http://<serverIP>:<service_port>, где
serverIP - адрес (или имя) сервера, на который установлен ПК;
service_port - внешний порт контейнера.
3.3.1.3. Адреса Swagger/OpenAPI WebUI:
– domain_engine: <BaseURL>/docs;
– pt_catalog_service: <BaseURL>/swagger.
3.3.1.4. Логика запроса к API, на примере curl:
curl -ks --cert <mycert>:<mypassword> --key <mykey> -H Сontent-
Тype:application/json -X <method> \
<endpointURL> -d <payload>
<mycert> - путь до файла клиентского сертификата (опционально);
<password> - пароль пользователя клиентского сертификата (опционально);
<key> - ключ сертификата (опционально);
<method> - используемый http-метод (например, GET, POST);
<endpointURL> - адрес вызова метода, при при использовании сертификата используется https;
<payload> - тело запроса в формате json.
3.3.2. Описание методов API сервиса domain_engine
3.3.2.1. Запрос получения списка NTP-серверов
НАЗНАЧЕНИЕ ПРОГРАММНОГО КОМПЛЕКСА
1.1. Программный комплекс ЦТЛ.Домен предназначен для решения комплекса задач по реализации единых принципов и интерфейсов управления для разнородных служб каталогов, а также обеспечения единообразной настройки разрозненных служб каталогов разных производителей.
1.2. Функционал доступный администратору домена:
– подключение к интерфейсу управления доменом;
– настройка перечней атрибутов объекта домена;
– навигация по объектам домена;
– добавление/удаление/редактирование/перемещение подразделений домена (OU);
– добавление/удаление/редактирование/перемещение пользователей домена;
– добавление/удаление/редактирование/перемещение групп домена;
– добавление/удаление/редактирование/перемещение компьютеров домена;
– добавление/удаление/редактирование записей в системе доменных имен (DNS);
– добавление/удаление записей в службе времени (NTP);
– изменение данных объекта - пользователя:
1) добавление/удаление/редактирование/ атрибутов пользователя;
2) перемещение пользователя между подразделениями (OU);
3) перемещение пользователя между группами.
– добавление/удаление/редактирование сайтов домена;
– добавление/удаление/редактирование контроллеров домена
– контроль применения изменений на домене-источнике.
УСЛОВИЯ ФУНКЦИОНИРОВАНИЯ ПРОГРАММНОГО КОМПЛЕКСА
2.1. Программные и технические средства для функционирования ПК ЦТЛ.Домен описаны в документе 643.ЦТЛС.00003-01 31 01 «Описание применения».
2.2. ПК реализована на принципах клиент-серверной архитектуры. Для функционирования ПК не требуется дополнительной установки стороннего программного обеспечения на рабочей станции.
2.3. Управление сервером ПК осуществляется посредством командного интерфейса сервера, подключение к терминалу осуществляется с клиента по ssh или непосредственно с сервера. Команды управления сервисами и их первичная настройка приведены в документе 643.ЦТЛС.00001-01 91 01 «Инструкция по установке».
2.4. Управление подключёнными доменами осуществляется посредством REST-API. Запрос к API осуществляются путем отправки http - запросов. Запросы могут быть отправлены как непосредственно с сервера, используя утилиту curl, так и удаленно с любого http-клиента или иной программы, обеспечивающей подобный функционал.
2.5. Каждый сервис ПК позволяет формировать запросы непосредственно через встроенный web-интерфейс OpenAPI/Swagger. Получить доступ к данным интерфейсам можно с помощью интернет-браузеров (Яндекс Браузер, Mozilla Firefox, Microsoft Edge, Google Chrome).
ВЫПОЛНЕНИЕ ПРОГРАММНОГО КОМПЛЕКСА
3.1. Запуск программного комплекса
3.1.1. ПК запускается автоматически. При подключении домена создаются отдельные сервисы. Процедура первичной настройки сервисов и подготовки сервисов и подготовке к работе приведены в документе 643.ЦТЛС.00001-01 91 01 «Инструкция по установке».
3.2. Управление ресурсами домена
3.2.1. Для управления ресурсами домена используется интерфейс REST API.
3.2.2. Сервисы, используемые в ПК ЦТЛ.Домен:
– сервис domain_engine: предназначен для управления инфраструктурой домена;
– сервис pt_catalog_service: предназначен для управления объектами каталога.
3.2.3. Применение сертификатов для получения доступа к API
3.2.3.1. В целях мер защиты от несанкционированного доступа рекомендуется запретить доступ к API без использования пользовательского сертификата. Данный режим установлен по умолчанию, но может быть изменен при инсталляции ПК. Во втором случае API будет открыт для любых запросов по http, что небезопасно, но может быть удобно для доверенных сред или быстрого развертывания.
3.2.3.2. Если установлена проверка пользовательских сертификатов, перед началом работы с API необходимо скопировать клиентские сертификаты каждого контейнера на машину клиента и использовать их для аутентификации клиента при обращении к серверу ПК.
3.2.3.3. Пользовательские сертификаты можно импортировать в web- браузер или явно указывать при формировании запросов к API из http-клиента.
3.2.3.4. Без наличия пользовательского сертификата работа с API, включая доступ к OpenAPI/Swagger, будет недоступена.
3.3. Описание методов API
3.3.1. Общие сведения
3.3.1.1. <BaseURL> - WEB-адрес службы (контейнера управления доменом).
3.3.1.2. Структура WEB-адреса службы: http://<serverIP>:<service_port>, где
serverIP - адрес (или имя) сервера, на который установлен ПК;
service_port - внешний порт контейнера.
3.3.1.3. Адреса Swagger/OpenAPI WebUI:
– domain_engine: <BaseURL>/docs;
– pt_catalog_service: <BaseURL>/swagger.
3.3.1.4. Логика запроса к API, на примере curl:
curl -ks --cert <mycert>:<mypassword> --key <mykey> -H Сontent-
Тype:application/json -X <method> \
<endpointURL> -d <payload>
<mycert> - путь до файла клиентского сертификата (опционально);
<password> - пароль пользователя клиентского сертификата (опционально);
<key> - ключ сертификата (опционально);
<method> - используемый http-метод (например, GET, POST);
<endpointURL> - адрес вызова метода, при при использовании сертификата используется https;
<payload> - тело запроса в формате json.
3.3.2. Описание методов API сервиса domain_engine
3.3.2.1. Запрос получения списка NTP-серверов
3.3.2.1.1. Выходные параметры:
1) Положительный ответ:
1) Положительный ответ:
3.3.2.2. Запрос установки NTP-сервера
3.3.2.2.1. Входные параметры
3.3.2.2.2. Выходные параметры:
1) Положительный ответ:
1) Положительный ответ:
2) Ответ с ошибками:
3.3.2.3. Запрос получения списка контролеров домена FSMO (DC FSMO)
3.3.2.3.1. Входные параметры
3.3.2.3.2. Выходные параметры:
1) Положительный ответ:
1) Положительный ответ:
2) Ответ с ошибками:
3.3.2.4. Запрос редактирования контроллера домена FSMO (DC FSMO)
3.3.2.4.1. Входные параметры
3.3.2.4.2. Выходные параметры:
1) Положительный ответ:
1) Положительный ответ:
2) Ответ с ошибками:
3.3.2.5. Запрос на получение перечня зон
3.3.2.5.1. Входные параметры
3.3.2.5.2. Выходные параметры:
1) Положительный ответ:
1) Положительный ответ:
2) Ответ с ошибками:
3.3.2.6. Запрос получения данных из конкретной зоны
3.3.2.6.1. Входные параметры
3.3.2.6.2. Выходные параметры:
1) Положительный ответ:
1) Положительный ответ:
2) Ответ с ошибками:
3.3.2.7. Запрос получения списка серверов глобальной (безусловной) пересылки
3.3.2.7.1. Входные параметры
3.3.2.7.2. Выходные параметры:
1) Положительный ответ:
1) Положительный ответ:
3.3.2.8.1. Выходные параметры:
1) Положительный ответ:
1) Положительный ответ:
**"NS": {
"data": {
"fqdn_dns": "dom.test."
}
},
"SOA": {
"data": {
"fqdn_dns": "dom.test.",
"fqdn_email": "root.dom.test.",
"serial": 12300,
"refresh": 60,
"retry": 60,
"expire": 3600,
"minimumttl": 900
}
},
"PTR": {
"data": {
"fqdn_dns": "dom.test."
}
},
"CNAME": {
"data": {
"fqdn_dns": "dom.test."
}
},
"MX": {
"data": {
"fqdn_dns": "dom.test.",
"priority": 10
}
},
"SRV": {
"data": {
"fqdn_dns": "dom.test.",
"port": 389,
"priority": 10,
"weight": 300
}
},
"A": {
"data": {
"IP4address": "10.10.10.10"
}
},
"AAAA": {
"data": {
"IPv6address": "2001:0000:130F:0000:0000:09C0:876A:130B"
}
}
3.3.2.10.2. Выходные параметры:
1) Положительный ответ: соответствует входным данным.
2) Ответ с ошибками:
"data": {
"fqdn_dns": "dom.test."
}
},
"SOA": {
"data": {
"fqdn_dns": "dom.test.",
"fqdn_email": "root.dom.test.",
"serial": 12300,
"refresh": 60,
"retry": 60,
"expire": 3600,
"minimumttl": 900
}
},
"PTR": {
"data": {
"fqdn_dns": "dom.test."
}
},
"CNAME": {
"data": {
"fqdn_dns": "dom.test."
}
},
"MX": {
"data": {
"fqdn_dns": "dom.test.",
"priority": 10
}
},
"SRV": {
"data": {
"fqdn_dns": "dom.test.",
"port": 389,
"priority": 10,
"weight": 300
}
},
"A": {
"data": {
"IP4address": "10.10.10.10"
}
},
"AAAA": {
"data": {
"IPv6address": "2001:0000:130F:0000:0000:09C0:876A:130B"
}
}
3.3.2.10.2. Выходные параметры:
1) Положительный ответ: соответствует входным данным.
2) Ответ с ошибками:
*"NS": {
"data": {
"fqdn_dns": "dom.test."
}
},
"SOA": {
"data": {
"fqdn_dns": "dom.test.",
"fqdn_email": "root.dom.test.",
"serial": 12300,
"refresh": 60,
"retry": 60,
"expire": 3600,
"minimumttl": 900
}
},
"PTR": {
"data": {
"fqdn_dns": "dom.test."
}
},
"CNAME": {
"data": {
"fqdn_dns": "dom.test."
}
},
"MX": {
"data": {
"fqdn_dns": "dom.test.",
"priority": 10
}
},
"SRV": {
"data": {
"fqdn_dns": "dom.test.",
"port": 389,
"priority": 10,
"weight": 300
}
},
"A": {
"data": {
"IP4address": "10.10.10.10"
}
},
"AAAA": {
"data": {
"IPv6address": "2001:0000:130F:0000:0000:09C0:876A:130B"
}
}
3.3.2.11.2. Выходные параметры:
1) Положительный ответ: соответствуют входным данным.
2) Ответ с ошибками:
"data": {
"fqdn_dns": "dom.test."
}
},
"SOA": {
"data": {
"fqdn_dns": "dom.test.",
"fqdn_email": "root.dom.test.",
"serial": 12300,
"refresh": 60,
"retry": 60,
"expire": 3600,
"minimumttl": 900
}
},
"PTR": {
"data": {
"fqdn_dns": "dom.test."
}
},
"CNAME": {
"data": {
"fqdn_dns": "dom.test."
}
},
"MX": {
"data": {
"fqdn_dns": "dom.test.",
"priority": 10
}
},
"SRV": {
"data": {
"fqdn_dns": "dom.test.",
"port": 389,
"priority": 10,
"weight": 300
}
},
"A": {
"data": {
"IP4address": "10.10.10.10"
}
},
"AAAA": {
"data": {
"IPv6address": "2001:0000:130F:0000:0000:09C0:876A:130B"
}
}
3.3.2.11.2. Выходные параметры:
1) Положительный ответ: соответствуют входным данным.
2) Ответ с ошибками:
*"NS": {
"data": {
"fqdn_dns": "dom.test."
}
},
"SOA": {
"data": {
"fqdn_dns": "dom.test.",
"fqdn_email": "root.dom.test.",
"serial": 12300,
"refresh": 60,
"retry": 60,
"expire": 3600,
"minimumttl": 900
}
},
"PTR": {
"data": {
"fqdn_dns": "dom.test."
}
},
"CNAME": {
"data": {
"fqdn_dns": "dom.test."
}
},
"MX": {
"data": {
"fqdn_dns": "dom.test.",
"priority": 10
}
},
"SRV": {
"data": {
"fqdn_dns": "dom.test.",
"port": 389,
"priority": 10,
"weight": 300
}
},
"A": {
"data": {
"IP4address": "10.10.10.10"
}
},
"AAAA": {
"data": {
"IPv6address": "2001:0000:130F:0000:0000:09C0:876A:130B"
}
}
3.3.2.12.2. Выходные параметры:
1) Ответ с ошибками:
"data": {
"fqdn_dns": "dom.test."
}
},
"SOA": {
"data": {
"fqdn_dns": "dom.test.",
"fqdn_email": "root.dom.test.",
"serial": 12300,
"refresh": 60,
"retry": 60,
"expire": 3600,
"minimumttl": 900
}
},
"PTR": {
"data": {
"fqdn_dns": "dom.test."
}
},
"CNAME": {
"data": {
"fqdn_dns": "dom.test."
}
},
"MX": {
"data": {
"fqdn_dns": "dom.test.",
"priority": 10
}
},
"SRV": {
"data": {
"fqdn_dns": "dom.test.",
"port": 389,
"priority": 10,
"weight": 300
}
},
"A": {
"data": {
"IP4address": "10.10.10.10"
}
},
"AAAA": {
"data": {
"IPv6address": "2001:0000:130F:0000:0000:09C0:876A:130B"
}
}
3.3.2.12.2. Выходные параметры:
1) Ответ с ошибками:
СООБЩЕНИЯ АДМИНИСТРАТОРУ
4.1. Сообщения администратору не отправляются.
4.1. Сообщения администратору не отправляются.
