Создание брокера

Статья создана

Yandex Cloud

Улучшена

Обновлена 30 октября 2024 г.

Примечание

Брокер находится на стадии Preview.

Консоль управления

CLI

Terraform

API

В консоли управления выберите каталог, в котором вы хотите создать брокер.
Выберите сервис IoT Core.
На панели слева выберите Брокеры.
Нажмите кнопку Создать брокер.
В блоке Общая информация укажите:
- Имя брокера. Например, my-broker.
- (Опционально) Описание — дополнительную информацию о брокере.
- (Опционально) Пароль, если будете использовать его вместо сертификата для доступа к брокеру. Для создания пароля можно воспользоваться генератором паролей.
  
  Примечание
  
  Сохраните пароль, он вам понадобится для аутентификации.
- (Опционально) Для присвоения брокеру метки заполните поля Ключ и Значение и нажмите кнопку Добавить метку.
(Опционально) Добавьте сертификат:
- Чтобы добавить файл:
  1. Выберите способ Файл.
  2. Нажмите кнопку Прикрепить файл.
  3. Выберите файл с публичным ключом сертификата и нажмите кнопку Открыть.
  4. Нажмите кнопку Добавить.
- Чтобы добавить текст:
  1. Выберите способ Текст.
  2. Вставьте публичный ключ сертификата в поле Содержимое.
  3. Нажмите кнопку Добавить.
Нажмите кнопку Создать.

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

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

Создайте брокер:
```
yc iot broker create --name <имя_брокера>
```
Требования к названию брокера:
- длина — от 3 до 63 символов;
- может содержать строчные буквы латинского алфавита, цифры и дефисы;
- первый символ — буква, последний — не дефис.
Результат:
```
id: b91ki3851h**********
folder_id: aoek49ghmk*********
created_at: "2022-05-28T11:29:42.420Z"
name: <имя_брокера>
status: ACTIVE
```
(Опционально) Присвойте брокеру пароль для аутентификации с помощью логина и пароля:
```
yc iot broker password add --broker-name <имя_брокера>
```
Команда предложит ввести пароль. Требования к паролю:
- пароль должен содержать цифры, буквы в верхнем и нижнем регистре, специальные символы;
- длина пароля — не менее 14 символов.
Результат:
```
broker_id: b91ki3851h**********
id: aoek49ghmk*********
created_at: "2022-05-28T11:32:42.420Z"
```
(Опционально) Добавьте брокеру сертификат для аутентификации с помощью сертификатов:
```
yc iot broker certificate add \
   --broker-name <имя_брокера> \
   --certificate-file <сертификат>
```
Где:
- --broker-name — имя брокера;
- --certificate-file — путь к публичному ключу сертификата, например cert.pem.
Результат:
```
broker_id: b91ki3851h**********
fingerprint: 1f21cf6d0183d****
certificate_data: |
   -----BEGIN CERTIFICATE-----
   MIIEpDCCAow...
   -----END CERTIFICATE-----
created_at: "2023-07-11T16:20:53.466370019Z"
```

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

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

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

Примечание

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

Чтобы создать брокер:

Опишите в конфигурационном файле параметры ресурса, который необходимо создать:
- yandex_iot_core_broker — параметры брокера:
  - name — имя брокера;
  - description — описание брокера;
  - labels — метки брокера в формате ключ:значение;
  - certificates — список сертификатов брокера для аутентификации с помощью сертификатов.
Пример структуры ресурса в конфигурационном файле:
```
resource "yandex_iot_core_broker" "my_broker" {
  name        = "test-broker"
  description = "test broker for terraform provider documentation"
  labels = {
    test-label = "label-test"
  }

  certificates = [
    file("<путь_к_первому_файлу_с_сертификатом>"),
    file("<путь_ко_второму_файлу_с_сертификатом>")
  ]
}

output "yandex_iot_core_broker_my_broker" {
  value = "${yandex_iot_core_broker.my_broker.id}"
}
```
Более подробную информацию о ресурсах, которые вы можете создать с помощью Terraform, см. в документации провайдера.
Проверьте корректность конфигурационных файлов.
1. В командной строке перейдите в папку, где вы создали конфигурационный файл.
2. Выполните проверку с помощью команды:
```
terraform plan
```
Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, Terraform на них укажет.
Разверните облачные ресурсы.
1. Если в конфигурации нет ошибок, выполните команду:
```
terraform apply
```
2. Подтвердите создание ресурсов.
  
  После этого в указанном каталоге будут созданы все требуемые ресурсы. Проверить появление ресурсов и их настройки можно в консоли управления или с помощью команды CLI:
```
yc iot broker list
```

Чтобы создать брокер, воспользуйтесь методом REST API create для ресурса Broker или вызовом gRPC API BrokerService/Create.

Создание брокера

Была ли статья полезна?