Перейти к содержанию

Быстрый старт

Добро пожаловать! Эта секция поможет вам начать работу с Data Contracts Platform в зависимости от вашей роли.

Выберите свой путь

Что вам понадобится?

Для Producers

  • Доступ к GitLab репозиторию контрактов
  • Python 3.11+ (для локальной валидации)
  • mTLS сертификат (выдаёт Data Platform team)
  • Базовое понимание Apache Avro

Для Consumers

  • Доступ к Kafka кластеру
  • Доступ к Data Catalog (опционально)
  • Понимание контракта данных
  • Настроенный Kafka consumer

Для Data Engineers

  • Доступ к Iceberg каталогу (Gravitino)
  • Знание Apache Iceberg + Parquet
  • Доступ к S3/HDFS хранилищу
  • SQL для Trino/Spark

15-минутный туториал

Хотите быстро попробовать? Следуйте этому туториалу:

1. Клонируйте репозиторий

git clone git@gitlab.company.ru:data/contracts.git
cd contracts

2. Установите зависимости

pip install -r requirements.txt

3. Создайте контракт

cp -r templates/complete-example domains/my-domain/my-entity
cd domains/my-domain/my-entity

4. Отредактируйте contract.yaml

metadata:
  name: "my_entity"
  namespace: "my_domain"
  owner:
    team: "my-team"
    email: "my-team@company.ru"

5. Проверьте контракт

python ../../ci/validate_contract.py contract.yaml

6. Создайте MR

git checkout -b feat/add-my-entity-contract
git add .
git commit -m "feat: add my_entity contract"
git push -u origin feat/add-my-entity-contract

7. Дождитесь approval и merge

CI/CD автоматически: - ✅ Проверит синтаксис - ✅ Обнаружит breaking changes - ✅ Предложит версию - ✅ Задеплоит в Schema Registry

Следующие шаги

Нужна помощь?