Связаться с намиПодключиться

Создать триггер для Container Registry, который отправляет сообщения в WebSocket-соединения

Статья создана
Обновлена 17 октября 2024 г.

Создайте триггер для Container Registry, который будет отправлять сообщения в WebSocket-соединения при создании и удалении Docker-образов Container Registry или их тегов.

Перед началом работы

Для создания триггера вам понадобятся:

Создать триггер

Примечание

Триггер начинает работать в течение 5 минут после создания.

  1. В консоли управления перейдите в каталог, в котором хотите создать триггер.

  2. Откройте сервис API Gateway.

  3. На панели слева выберите Триггеры.

  4. Нажмите кнопку Создать триггер.

  5. В блоке Базовые параметры:

    • Введите имя и описание триггера.
    • В поле Тип выберите Container Registry.
    • В поле Запускаемый ресурс выберите API-шлюз.

  6. В блоке Настройки Container Registry:

    • В поле Реестр выберите реестр, для событий с образами в котором необходимо создать триггер.
    • В поле Типы событий выберите события, после наступления которых триггер будет запускаться.
    • (Опционально) В поле Имя Docker-образа введите имя образа для фильтрации. Чтобы узнать имя Docker-образа, получите список Docker-образов в реестре.
    • (Опционально) В поле Тег Docker-образа введите тег образа для фильтрации.

  7. В блоке Настройки группирования сообщений укажите:

    • размер группы событий. Допустимые значения от 1 до 1000, значение по умолчанию — 1.
    • максимальное время ожидания. Допустимые значения от 1 до 60 секунд, значение по умолчанию — 1 секунда.

    Триггер группирует события не дольше указанного времени ожидания и отправляет их в WebSocket-соединения. Число событий при этом не превышает указанный размер группы.

  8. В блоке Настройки API-шлюза:

    • В поле API-шлюз выберите API-шлюз.
    • В поле Путь укажите путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
    • В поле Сервисный аккаунт выберите сервисный аккаунт, от имени которого в WebSocket-соединения будут отправляться сообщения.

  9. Нажмите кнопку Создать триггер.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы создать триггер, который отправляет сообщения в WebSocket-соединения, выполните команду:

yc serverless trigger create container-registry \
  --name <имя_триггера> \
  --registry-id <идентификатор_реестра> \
  --events 'create-image','delete-image','create-image-tag','delete-image-tag' \
  --batch-size <размер_группы> \
  --batch-cutoff <максимальное_время_ожидания> \
  --gateway-id <идентификатор_API-шлюза> \
  --gateway-websocket-broadcast-path <путь> \
  --gateway-websocket-broadcast-service-account-id <идентификатор_сервисного_аккаунта>

Где:

  • --batch-size — размер группы событий. Необязательный параметр. Допустимые значения от 1 до 1000, значение по умолчанию — 1.
  • --batch-cutoff — максимальное время ожидания. Необязательный параметр. Допустимые значения от 1 до 60 секунд, значение по умолчанию — 1 секунда. Триггер группирует события не дольше batch-cutoff и отправляет их в WebSocket-соединения. Число событий при этом не превышает batch-size.
  • --gateway-id — идентификатор API-шлюза.
  • --gateway-websocket-broadcast-path — путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
  • --gateway-websocket-broadcast-account-id — идентификатор сервисного аккаунта с правами на отправку сообщений в WebSocket-соединения.

Результат:

id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2023-08-04T15:19:15.353909857Z"
name: registry-trigger
rule:
  container_registry:
    event_type:
    - CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE
    - CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE
    - CONTAINER_REGISTRY_EVENT_TYPE_CREATE_IMAGE_TAG
    - CONTAINER_REGISTRY_EVENT_TYPE_DELETE_IMAGE_TAG
    registry_id: crtlds4tdfg12kil77h2********
    batch_settings:
      size: "3"
      cutoff: 20s
    gateway_websocket_broadcast:
      gateway_id: d4eofc7n0mh2********
      path: /
      service_account_id: aje3932acdh2********
status: ACTIVE

Чтобы создать триггер для Container Registry, воспользуйтесь методом REST API create для ресурса Trigger или вызовом gRPC API TriggerService/Create.

Проверить результат

Проверьте, что триггер работает корректно. Для этого посмотрите логи API-шлюза, в них отображается информация об обращениях к нему.

См. также

Предыдущая
Создать триггер для Object Storage
Следующая
Создать триггер для Cloud Logging