Arenadata Catalog: Документация и инструкции по использованию
Назначение документации
Документация Arenadata Catalog предназначена для:
- системных администраторов,
- специалистов по данным (data stewards),
- аналитиков,
- разработчиков интеграций.
Она охватывает установку, конфигурацию, использование ключевых модулей, работу с API и примеры повседневных сценариев.
Структура документации
1. Установка и обновление
- Требования к окружению (CPU, RAM, OS, Java, PostgreSQL)
- Установка через ADCM или вручную
- Обновление между версиями (инструкции по миграции базы и манифестов)
- Бэкап и восстановление
2. Архитектура и компоненты
- Компоненты системы: backend, frontend, REST API, metadata-storage
- Взаимодействие с LDAP, LogSearch, PXF, BI и другими модулями
3. Работа с терминами и глоссарием
- Создание термина, добавление описания, синонимов, атрибутов
- Утверждение, ревизия, версия термина
- Привязка терминов к активам (таблицы, поля, отчёты)
- Импорт из Excel или CSV
4. Каталогизация активов
- Обнаружение и импорт активов
- Структура: источник → схема → таблица → колонка
- Редактирование и назначение владельцев
- Сценарии массовой загрузки через коннекторы
5. Lineage и зависимости
- Автоматическое построение lineage по DAG, BI, ETL-цепочкам
- Ручное добавление связей
- Визуальный редактор связей
6. Пользователи и роли
- Роли: редактор, наблюдатель, куратор, администратор
- Интеграция с LDAP
- Настройка прав на объекты и типы активов
7. API-интерфейсы
- Описание REST API: методы для терминов, активов, связей, ролей
- Примеры запросов и ответов (curl, Postman)
- Аутентификация через токены или LDAP
- Использование API для CI/CD (обновление моделей, валидация)
8. Аудит и логирование
- Журнал действий пользователей
- Интеграция с LogSearch
- Алёрты на изменения и действия (через webhook)
Форматы документации
- HTML-версия (встроена в систему)
- PDF-руководство администратора
- Markdown-репозиторий для внутренней вики
- Swagger/OpenAPI-спецификация API
Рекомендованные практики
- Вести changelog терминов и активов
- Создавать шаблоны бизнес-глоссариев по доменам
- Связывать глоссарий с реальными источниками данных
- Настраивать регулярный аудит и оповещения
Заключение
Хорошо структурированная документация — это основа успешного внедрения и использования Arenadata Catalog. Она помогает организовать процесс работы с метаданными, наладить сотрудничество между ИТ и бизнесом и обеспечить единое понимание данных на всех уровнях организации.
