Руководство разработчика

Настоящее Руководство предназначено для разработчиков приложений, инженеров и других специалистов, взаимодействующих с TQE(MQ) для получения, обработки и отправки сообщений.

В Руководстве описаны функции API TQE(MQ).

В разделе описана спецификация API на основе протокола gRPC.

При включенной аутентификации каждый вызов требует действительных учетных данных (базовая аутентификация по TLS). При их отсутствии возвращается ошибка Unauthenticated, при отсутствии привилегии на метод или очередь — PermissionDenied, при отсутствии связи с хранилищем авторизационных данных Unavailable. Подробнее см. раздел Аутентификация и авторизация.

Примеры создания gRPC-клиента и выполнения запросов к очереди приведены в документах:

• Руководство по установке.
• Руководство пользователя.

Сервер публикации сообщений брокера очередей.

Запрос на публикацию группы сообщений в очередь.

Группа сообщений.

Ответ на публикацию группы сообщений.

Запрос на рассылку сообщения на указанные шарды.

Ответ на рассылку сообщения.

Ответ набора реплик на публикацию сообщения.

Сообщение об успешной публикации.

Сообщение об ошибке публикации.

Сервер подписок на сообщения брокера очередей.

Поток запросов на подписку.

Запрос на подписку.

Запрос на обновление курсора персистентной подписки.

Поток ответов подписки.

Сообщение в стриме подписки.

Уведомление клиента о новых сообщениях в очереди.

Сообщение в очереди.

Пара ключ-значение.

Ответ на обновление состояния подписки.

Поток запросов к группе потребителей.

Поток ответов к группе потребителей.

Запрос в группу потребителей.

Ответ с потребленными сообщениями группы.

Запрос на подтверждение обработки сообщения группы потребителей.

Ответ на подтверждение обработки сообщения группы потребителей.

Уведомление о сообщении в группу потребителей.

Сервис управления пользователями, ролями и секретами gRPC API. Полное имя метода — /tarantool.queue_ee.Iam/<Method>. Для вызова любого метода нужно право tqe.admin, тип аутентификации — базовая. Пользователи, роли и секреты хранятся в конфиг-хранилище кластера (TCS или etcd).

Права, встроенные роли и шаблоны очередей описаны в разделе Уровень gRPC (базовая аутентификация + RBAC).

Параметры запросов проверяются. При нарушении метод возвращает ошибку InvalidArgument, при попытке изменить или удалить встроенную роль — FailedPrecondition (builtin role is immutable).

• Имя пользователя и роли не может быть пустым;
• Имена Admin, Producer и Consumer зарезервированы за встроенными ролями — создать роль с таким именем нельзя;
• permissions не может быть пустым; допускаются только tqe.admin, tqe.produce и tqe.consume;
• queue_patterns в GrantRole не может быть пустым; пустая строка — ошибка;
• Пароль короче password_policy.min_length — InvalidArgument;
• Повторное использование пароля из истории — InvalidArgument (password: already used).

Пользователь.

Назначение роли пользователю на набор шаблонов очередей.

Роль.

Метаданные секрета.

Состояния locked (после lockout_threshold неудачных попыток) и expired снимаются вызовом SetPassword.

Запрос списка пользователей. Пустой запрос (не содержит полей).

Ответ со списком пользователей.

Запрос пользователя по имени.

Запрос на создание пользователя.

Созданный пользователь не имеет пароля и не может аутентифицироваться, пока не вызван SetPassword.

Запрос на обновление пользователя.

Метод переписывает только описание. Переименовать пользователя нельзя.

Запрос на удаление пользователя.

Ответное сообщение DeleteUserResponse приходит пустым (не содержит полей).

Запрос на назначение роли пользователю.

Только расширяет привилегии, добавляя шаблоны из запроса к уже выданным.

Запрос на снятие/сужение роли у пользователя.

Шаблон в запросе сравнивается с текущими шаблонами без раскрытия маски. Если пользователю выдан orders.*, отзыв orders.new ничего не изменит, потому что именно такого шаблона в гранте нет. Чтобы оставить доступ только к одной очереди, снимите orders.* и выдайте роль на нужные очереди заново.

Запрос на установку/смену пароля пользователя.

Логин, под которым предъявляется пароль (имя пользователя). Ответ Secret не содержит ни пароль, ни его хэш. Пароль не может быть длиннее 72 байт.

Запрос списка ролей. Пустой запрос (не содержит полей).

Ответ со списком ролей.

Запрос роли по имени.

Запрос на создание роли.

Запрос на обновление роли.

Запрос на удаление роли.

Роль удаляется, только если она не выдана ни одному пользователю. Сначала снимите её с держателей вызовом RevokeRole.

Ответное сообщение DeleteRoleResponse приходит пустым (не содержит полей).