Terraform Provider

• Documentation: https://terraform-provider.yandexcloud.net

Requirements

• Terraform 0.12+
• Go 1.21 (to build the provider plugin)

Building The Provider

Clone repository to: $GOPATH/src/github.com/yandex-cloud/terraform-provider-yandex

$ mkdir -p $GOPATH/src/github.com/yandex-cloud; cd $GOPATH/src/github.com/yandex-cloud
$ git clone git@github.com:yandex-cloud/terraform-provider-yandex

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/yandex-cloud/terraform-provider-yandex
$ make build

Using the provider

If you're building the provider, follow the instructions to install it as a plugin. After placing it into your plugins directory, run terraform init to initialize it. Documentation about the provider specific configuration options can be found on the provider's website. An example of using an installed provider from local directory:

Write following config into ~/.terraformrc

provider_installation {
   dev_overrides {
    "yandex-cloud/yandex" = "/path/to/local/provider"
  }

   direct {}
 }

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.11+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.

$ make build
...
$ $GOPATH/bin/terraform-provider-yandex
...

In order to test the provider, you can simply run make test.

$ make test

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc

---

Documentation Guide

Documentation in docs/ is generated from provider schemas, resource and data source descriptions, public API metadata, and files in examples/. The release pipeline regenerates and validates it before creating the release commit. Do not edit generated files in docs/ directly.

To add examples for an entity named <name>, use these paths:

• resource examples: examples/<name>/r_<name>_*.tf;
• data source examples: examples/<name>/d_<name>_*.tf;
• resource import example: examples/<name>/import.sh.

Improve schema documentation by updating descriptions in the corresponding resource or data source implementation. The generated changes will appear in the release PR.

Local Documentation Website

The website build uses the documentation committed to docs/; it does not regenerate documentation.

To build the documentation website locally:

1. First, install YFM:

   make install-yfm

2. Build a local version of the documentation website:

   make build-website