Управление пользователями Apache Kafka®

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

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

1. Чтобы получить список пользователей, выполните команду:

   yc managed-kafka user list --cluster-name <имя_кластера>
   

2. Чтобы получить подробную информацию по конкретному пользователю, выполните команду:

   yc managed-kafka user get <имя_пользователя> --cluster-name <имя_кластера>
   

Чтобы узнать имя кластера, получите список кластеров в каталоге.

Чтобы получить список пользователей, воспользуйтесь методом REST API list для ресурса User или вызовом gRPC API UserService/List и передайте в запросе идентификатор требуемого кластера в параметре clusterId.

Чтобы узнать идентификатор кластера, получите список кластеров в каталоге.

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

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

Чтобы создать пользователя:

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

   yc managed-kafka user create --help
   

2. Создайте пользователя с ролью producer для производителя или consumer для потребителя и выдайте права доступа к нужным топикам:

   yc managed-kafka user create <имя_пользователя> \
     --cluster-name <имя_кластера> \
     --password <пароль> \
     --permission topic=<имя_топика>,role=<роль_пользователя>
   

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

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

   yc managed-kafka user create --help
   

2. Создайте пользователя с ролью admin, действующей на все (*) топики кластера:

   yc managed-kafka user create <имя_пользователя> \
     --cluster-name <имя_кластера> \
     --password <пароль> \
     --permission topic=*,role=admin
   

Чтобы узнать имя кластера, получите список кластеров в каталоге.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Добавьте ресурс yandex_mdb_kafka_user:

   resource "yandex_mdb_kafka_user" "<имя_пользователя>" {
     cluster_id = "<идентификатор_кластера>"
     name       = "<имя_пользователя>"
     password   = "<пароль>"
     ...
   }
   

   Примечание

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

   Длина пароля от 8 до 128 символов.

3. Выдайте права доступа к нужным топикам.

4. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

5. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_kafka_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

Чтобы создать пользователя, воспользуйтесь методом REST API create для ресурса User или вызовом gRPC API UserService/Create и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
• Настройки пользователя в параметре userSpec:
  • Имя пользователя в параметре name.
  • Пароль пользователя в параметре password.
  • Права доступа к топикам (один или несколько параметров permissions, по одному на каждый топик):
    • Имя топика в параметре topicName. Чтобы узнать имя, получите список топиков в кластере.
    • Права доступа к топику в параметре role: ACCESS_ROLE_PRODUCER для производителя либо ACCESS_ROLE_CONSUMER для потребителя.

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

• topicName: *.
• role: ACCESS_ROLE_ADMIN.

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

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

С помощью CLI можно изменить пароль пользователя, а также выдать или отозвать права доступа к топикам.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Найдите в этом файле ресурс yandex_mdb_kafka_user для нужного пользователя и внесите правки.

   С помощью Terraform можно изменить пароль пользователя, а также выдать или отозвать права доступа к топикам.

Чтобы изменить настройки пользователя, воспользуйтесь методом REST API update для ресурса User или вызовом gRPC API UserService/Update и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
• Имя пользователя в параметре userName. Чтобы узнать имя, получите список пользователей в кластере.
• Список настроек, которые необходимо изменить, в параметре updateMask (одной строкой через запятую). Если не задать этот параметр, метод API сбросит на значения по умолчанию все настройки пользователя, которые не были явно указаны в запросе.
• Новый набор прав на доступ к топикам (один или несколько параметров permissions, по одному на каждый топик).

С помощью метода update вы также можете изменить пароль пользователя, а с помощью методов grantPermission и revokePermission — выдать или отозвать права доступа к топику.

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

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

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

yc managed-kafka user update <имя_пользователя> \
  --cluster-name <имя_кластера> \
  --password <новый_пароль>

Чтобы узнать имя кластера, получите список кластеров в каталоге.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Найдите в этом файле ресурс yandex_mdb_kafka_user для нужного пользователя.

3. Измените значение поля password:

   resource "yandex_mdb_kafka_user" "<имя_пользователя>" {
     ...
     password = "<пароль>"
     ...
   }
   

   Примечание

   Длина пароля от 8 до 128 символов.

4. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

5. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_kafka_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

Чтобы изменить пароль пользователя, воспользуйтесь методом REST API update для ресурса User или вызовом gRPC API UserService/Update и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.

• Имя пользователя в параметре userName. Чтобы узнать имя, получите список пользователей в кластере.

• Новый пароль пользователя в параметре password.

• Название настройки password в параметре updateMask.

  Примечание

  Длина пароля от 8 до 128 символов.

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

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

Чтобы выдать права пользователю:

1. Получите список топиков кластера:

   yc managed-kafka topic list --cluster-name <имя_кластера>
   

2. Выдайте права на доступ к нужным топикам, передав параметры --permission:

   yc managed-kafka user update <имя_пользователя> \
     --cluster-name <имя_кластера> \
     --permission topic=<имя_топика>,role=<роль_пользователя>
   

   Доступны следующие параметры --permission:

   • topic — имя топика, к которому нужно выдать права доступа.

     Если на какие-либо топики не нужны права, их можно отозвать.

   • role — роль пользователя: producer, consumer или admin.

     Роль admin доступна только если выбраны все топики (topic=*).

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

   Например, чтобы выдать права пользователю test-user в кластере kafka-cli к топику topic2 с ролью producer, при этом сохранить существующий доступ к топику topic1, выполните команду:

   yc managed-kafka user update test-user \
     --cluster-name kafka-cli \
     --permission topic=topic1,role=consumer \
     --permission topic=topic2,role=producer
   

   Вместе с доступом к топику пользователю также предоставляется доступ к субъектам схем данных. То, какие субъекты доступны, зависит от указанных ролей и топиков. Подробнее читайте в разделе Субъекты в Managed Schema Registry.

Чтобы узнать имя кластера, получите список кластеров в каталоге.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Найдите в этом файле ресурс yandex_mdb_kafka_cluster для нужного пользователя.

3. Добавьте блок permission:

   resource "yandex_mdb_kafka_user" "<имя_пользователя>" {
     ...
     permission {
       topic_name = "<топик>"
       role       = "<роль_пользователя>"
     }
   }
   

   Где:

   • topic_name — имя топика. Укажите:

     • * — чтобы разрешить доступ к любым топикам.
     • Полное название топика — чтобы разрешить доступ конкретно к нему.
     • <префикс>* — чтобы выдать доступ к топикам, названия которых начинаются с указанного префикса. Допустим, есть топики topic_a1, topic_a2, a3. Если указать значение topic*, доступ будет разрешен для топиков topic_a1 и topic_a2.

   • role — роль пользователя: ACCESS_ROLE_CONSUMER, ACCESS_ROLE_PRODUCER или ACCESS_ROLE_ADMIN. Роль ACCESS_ROLE_ADMIN доступна только если выбраны все топики (topic_name = "*").

   Вместе с доступом к топику пользователю также предоставляется доступ к субъектам схем данных. То, какие субъекты доступны, зависит от указанных ролей и топиков. Подробнее читайте в разделе Субъекты в Managed Schema Registry.

   Если на какие-либо топики не нужны права, их можно отозвать.

4. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

5. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_kafka_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

Чтобы выдать пользователю права, воспользуйтесь методом REST API grantPermission для ресурса User или вызовом gRPC API UserService/GrantPermission и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
• Имя пользователя в параметре userName. Чтобы узнать имя, получите список пользователей в кластере.
• Новое право на доступ к топику в параметре permission.

Вместе с доступом к топику пользователю также предоставляется доступ к субъектам схем данных. То, какие субъекты доступны, зависит от указанных ролей и топиков. Подробнее читайте в разделе Субъекты в Managed Schema Registry.

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

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

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

yc managed-kafka user update <имя_пользователя> \
  --cluster-name <имя_кластера> \
  --permission topic=<имя_топика>,role=<роль_пользователя>

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

Флаг --permission должен содержать хотя бы одну пару топик/роль, где:

• topic — имя топика.
• role — роль пользователя: producer, consumer или admin.

Чтобы узнать имя кластера, получите список кластеров в каталоге.

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

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Найдите в этом файле ресурс yandex_mdb_kafka_user для нужного пользователя.

3. Измените или удалите блок permission.

4. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

5. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_kafka_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

Чтобы отозвать права у пользователя, воспользуйтесь методом REST API revokePermission для ресурса User или вызовом gRPC API UserService/RevokePermission и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
• Имя пользователя в параметре userName. Чтобы узнать имя, получите список пользователей в кластере.
• Право на доступ к топику, которое требуется отозвать, в параметре permission.

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

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

Чтобы удалить пользователя, выполните команду:

yc managed-kafka user delete <имя_пользователя> --cluster-name <имя_кластера>

Чтобы узнать имя кластера, получите список кластеров в каталоге.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   О том, как создать такой файл, см. в разделе Создание кластера.

2. Удалите ресурс yandex_mdb_kafka_user для нужного пользователя.

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_kafka_cluster" "<имя_кластера>" {
  ...
  timeouts {
    create = "1h30m" # Полтора часа
    update = "2h"    # 2 часа
    delete = "30m"   # 30 минут
  }
}

Чтобы удалить пользователя, воспользуйтесь методом REST API delete для ресурса User или вызовом gRPC API UserService/Delete и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
• Имя пользователя, которого требуется удалить, в параметре userName. Чтобы узнать имя, получите список пользователей в кластере.