Contact UsGet started

Installing and configuring Terraform and a provider to connect to YDB

Written by
Updated at June 6, 2024

You can download Terraform from the official HashiCorp website. If the site is unavailable, use our specially created mirror. Download the Terraform distribution for your platform and add the path to the folder with the executable to the PATH: export PATH=$PATH:/path/to/terraform variable.

Installing Terraform for Windows, Linux, and macOS from the HashiCorp website

Once you have installed Terraform, configure it to access YDB. First, install a provider to connect to YDB and provide API methods.

Installing a YDB provider

Terraform will download and install a provider from the URL specified by the user in the provider_installation section of the .terraformrc file.

  1. Open the Terraform CLI configuration file (~/.terraformrc) in any text editor.

    Note

    The .terraformrc file must be in the user's home root folder, e.g., /home/user/ or /User/user/.

  2. Add the following section to the file:

    provider_installation {
    network_mirror {
        url = "https://terraform-mirror.yandexcloud.net/"
        include = ["registry.terraform.io/*/*"]
}
    direct {
        exclude = ["registry.terraform.io/*/*"]
    }
}

  1. Open the Terraform CLI configuration file named terraform.rc in your user's %APPDATA% folder.

  2. Add the following section to the file:

    provider_installation {
    network_mirror {
        url = "https://terraform-mirror.yandexcloud.net/"
        include = ["registry.terraform.io/*/*"]
}
    direct {
        exclude = ["registry.terraform.io/*/*"]
    }
}

This completes the installation and configuration of Terraform and the provider for connection to YDB. You can move on to creating configuration files for YDB access.

Previous
Getting authentication credentials
Next
Creating configuration files and connecting to YDB