Creating a broker

Written by

Yandex Cloud

Updated at November 14, 2024

Note

The broker is at the Preview stage.

Management console

CLI

Terraform

API

In the management console, select the folder where you want to create a broker.
Select IoT Core.
In the left-hand panel, select Brokers.
Click Create broker.
Under General information, specify:
- Broker Name, e.g., my-broker.
- (Optional) Description: Additional information about the broker.
- (Optional) Password if you are going to use it instead of a certificate to access the broker. To create a password, you can use the password generator.
  
  Note
  
  Make sure to save your password, as you will need it for authentication.
- (Optional) To assign a label to the broker, fill in the Key and Value fields and click Add label.
(Optional) Add a certificate:
- To add a file:
  1. Choose the File method.
  2. Click Attach file.
  3. Select the file with the public key of the certificate and click Open.
  4. Click Add.
- To add text:
  1. Choose the Text method.
  2. Paste the certificate's public key to the Content field.
  3. Click Add.
Click Create.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

Create a broker:
```
yc iot broker create --name <broker_name>
```
The naming requirements are as follows:
- The name must be from 3 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- The first character must be a letter and the last character cannot be a hyphen.
Result:
```
id: b91ki3851h**********
folder_id: aoek49ghmk*********
created_at: "2022-05-28T11:29:42.420Z"
name: <broker_name>
status: ACTIVE
```
(Optional) Assign the broker a password for authentication with a username and password:
```
yc iot broker password add --broker-name <broker_name>
```
You will be prompted to enter a password. Password requirements:
- The password must contain numbers, upper-case and lower-case letters, and special characters.
- It must be at least 14 characters long.
Result:
```
broker_id: b91ki3851h**********
id: aoek49ghmk*********
created_at: "2022-05-28T11:32:42.420Z"
```

(Optional) Add to the broker a certificate for authentication with certificates:

yc iot broker certificate add \
   --broker-name <broker_name> \
   --certificate-file <certificate>

Where:

--broker-name: Broker name.
--certificate-file: Path to the public key of the certificate, e.g., cert.pem.

Result:

broker_id: b91ki3851h**********
fingerprint: 1f21cf6d0183d****
certificate_data: |
   -----BEGIN CERTIFICATE-----
   MIIEpDCCAow...
   -----END CERTIFICATE-----
created_at: "2023-07-11T16:20:53.466370019Z"

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

For more information about the provider resources, see the documentation on the Terraform website or the mirror.

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

Note

To add certificates to a broker, generate them in advance.

To create a broker:

In the configuration file, describe the parameters of the resource to create:
- yandex_iot_core_broker: Broker parameters:
  - name: Broker name.
  - description: Broker description.
  - labels: Broker labels in key:value format.
  - certificates: List of broker certificates for authentication with certificates.
Here is an example of the resource structure in the configuration file:
```
resource "yandex_iot_core_broker" "my_broker" {
  name        = "test-broker"
  description = "test broker for terraform provider documentation"
  labels = {
    test-label = "label-test"
  }

  certificates = [
    file("<path_to_first_certificate_file>"),
    file("<path_to_second_certificate_file>")
  ]
}

output "yandex_iot_core_broker_my_broker" {
  value = "${yandex_iot_core_broker.my_broker.id}"
}
```
For more information about the resources you can create with Terraform, see the provider documentation.
Make sure the configuration files are correct.
1. In the command line, go to the folder where you created the configuration file.
2. Run a check using this command:
```
terraform plan
```
If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, Terraform will point them out.
Deploy cloud resources.
1. If the configuration does not contain any errors, run this command:
```
terraform apply
```
2. Confirm that you want to create the resources.
  
  All the resources you need will then be created in the specified folder. You can check the new resources and their settings using the management console or this CLI command:
```
yc iot broker list
```

To create a broker, use the create REST API method for the Broker resource or the BrokerService/Create gRPC API call.

Creating a broker

Was the article helpful?