Terraform Yandex Provider

https://github.com/yandex-cloud/terraform-provider-yandex
Admin
The Yandex Cloud Terraform Provider allows users to manage Yandex Cloud resources using Terraform,...
Tokens:1,891,647
Snippets:10,651
Trust Score:7.9
License:MPL-2.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install go-version with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/hashicorp/go-version/README.md

Install the go-version library using the standard go get command.

```shell
$ go get github.com/hashicorp/go-version
```

--------------------------------

### Install gocognit with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/uudashr/gocognit/README.md

Alternative installation command using go get. Useful for older Go versions or when adding to a module.

```shell
$ go get github.com/uudashr/gocognit/cmd/gocognit
```

--------------------------------

### Install go-colorful with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/lucasb-eyer/go-colorful/README.md

Install the go-colorful library using the go get command.

```bash
$ go get github.com/lucasb-eyer/go-colorful
```

--------------------------------

### Install Objx

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/stretchr/objx/README.md

Installs Objx using go get.

```bash
go get github.com/stretchr/objx
```

--------------------------------

### Install godox with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/matoous/godox/README.md

Install the godox tool using the go get command.

```bash
go get github.com/matoous/godox
```

--------------------------------

### Install go-header with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/denis-tingaikin/go-header/README.md

Installs the go-header linter using the go get command.

```bash
go get github.com/denis-tingaikin/go-header/cmd/go-header
```

--------------------------------

### Install dupl with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/golangci/dupl/README.md

Installs the dupl tool using go get.

```bash
go get -u github.com/golangci/dupl
```

--------------------------------

### Install goldmark-frontmatter with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/go.abhg.dev/goldmark/frontmatter/README.md

Install the goldmark-frontmatter package using the go get command.

```bash
go get go.abhg.dev/goldmark/frontmatter@latest
```

--------------------------------

### Install blackfriday-tool with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/russross/blackfriday/v2/README.md

Downloads and installs the blackfriday-tool command-line utility. Installing this tool also downloads and installs blackfriday itself. The tool binary is installed in $GOPATH/bin and is statically linked.

```bash
go get github.com/russross/blackfriday-tool
```

--------------------------------

### Install pflag with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/spf13/pflag/README.md

Install pflag using the standard go get command.

```bash
go get github.com/spf13/pflag
```

--------------------------------

### Install with go get (Go version < 1.16)

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/yagipy/maintidx/README.md

Install maintidx for Go versions earlier than 1.16 using go get.

```shell
go get -u github.com/yagipy/maintidx/cmd/maintidx
```

--------------------------------

### Install ydb-go-sdk v3 with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/ydb-platform/ydb-go-sdk/v3/README.md

Install the ydb-go-sdk v3 package using the go get command.

```sh
go get -u github.com/ydb-platform/ydb-go-sdk/v3
```

--------------------------------

### Install wsl with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/bombsimon/wsl/v3/README.md

Install the wsl linter locally using the go get command. This is the recommended way to install wsl for local use.

```sh
go get -u github.com/bombsimon/wsl/v3/cmd/...
```

--------------------------------

### Install Clipboard for Go

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/atotto/clipboard/README.md

Install the clipboard package using go get.

```shell
$ go get github.com/atotto/clipboard
```

--------------------------------

### Install uniseg with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/rivo/uniseg/README.md

Install the uniseg package using the go get command.

```bash
go get github.com/rivo/uniseg
```

--------------------------------

### Install nestif via go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/nakabonne/nestif/README.md

Installs the nestif command-line tool using go get.

```bash
go get github.com/nakabonne/nestif/cmd/nestif
```

--------------------------------

### Install asciicheck

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/tdakkota/asciicheck/README.md

Install the asciicheck linter using the go get command.

```bash
go get -u github.com/tdakkota/asciicheck/cmd/asciicheck
```

--------------------------------

### Install schema-generate tool

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/securego/gosec/v2/README.md

Install the schema-generate tool using go get.

```bash
go get -u github.com/a-h/generate/cmd/schema-generate
```

--------------------------------

### Install hashstructure with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/mitchellh/hashstructure/README.md

Standard Go installation command for the hashstructure library.

```bash
$ go get github.com/mitchellh/hashstructure
```

--------------------------------

### Install multierr with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/go.uber.org/multierr/README.md

Install the multierr library using the go get command. This fetches the latest version from go.uber.org/multierr.

```bash
go get -u go.uber.org/multierr@latest
```

--------------------------------

### Install the Levenshtein package

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/agext/levenshtein/README.md

Use the go get command to download and install the package into your Go workspace.

```bash
go get github.com/agext/levenshtein
```

--------------------------------

### Install strcase package

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/ettle/strcase/README.md

Install the strcase package using go get.

```bash
go get -u github.com/ettle/strcase
```

--------------------------------

### Install goconst with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/jgautheron/goconst/README.md

Install the goconst command-line tool using the Go package manager.

```shell
$ go get github.com/jgautheron/goconst/cmd/goconst
```

--------------------------------

### Install color with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/fatih/color/README.md

Install the color package using the standard Go module command.

```bash
go get github.com/fatih/color
```

--------------------------------

### Install metalint command

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/mvdan.cc/lint/README.md

Install the metalint linter runner using go get. This is the start of a linter that runs many linters leveraging the common interface.

```bash
go get -u mvdan.cc/lint/cmd/metalint
```

--------------------------------

### Setup example .go-header.yml

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/denis-tingaikin/go-header/README.md

Example .go-header.yml configuration file with a const value and a multi-line template for an Apache-2.0 license header.

```yaml
---
values:
  const:
    MY COMPANY: mycompany.com
template: |
  {{ MY COMPANY }}
  SPDX-License-Identifier: Apache-2.0

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at:

  	  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
```

--------------------------------

### Install mirror with go install

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/butuzov/mirror/readme.md

Installs the `mirror` linter using `go install`. This is the recommended installation method.

```bash
go install github.com/butuzov/mirror/cmd/mirror@latest
```

--------------------------------

### Build the binary with make

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/securego/gosec/v2/README.md

Run the make command in the project root to build the binary.

```bash
make
```

--------------------------------

### Build promlinter from source with make

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/yeya24/promlinter/README.md

Clone the repository and run make build. Requires Go >= 1.13 and make. The resulting binary is placed in the ./bin directory.

```bash
git clone https://github.com/yeya24/promlinter.git
make build
```

--------------------------------

### Install golint with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/golangci/lint-1/README.md

Installs the golint binary. Requires a supported release of Go. Use `go list -f {{.Target}} github.com/golangci/lint-1/golint` to find the installation directory and add it to `$PATH` for global use.

```shell
go get -u github.com/golangci/lint-1/golint
```

--------------------------------

### Install execinquery with go install

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/lufeee/execinquery/README.md

Install the execinquery linter using the go install command.

```sh
go install github.com/lufeee/execinquery/cmd/execinquery
```

--------------------------------

### Clone repository and run make all

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/grpc-ecosystem/go-grpc-middleware/CONTRIBUTING.md

First, fork and clone the repository from your own GitHub account. Then run `make all` before submitting a pull request to vet the code, format it, regenerate documentation, and run all tests.

```bash
git clone git@github.com:your-username/go-grpc-middleware.git
```

```bash
make all
```

--------------------------------

### Install goldmark-meta

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/yuin/goldmark-meta/README.md

Install the goldmark-meta extension using the Go module system.

```bash
go get github.com/yuin/goldmark-meta
```

--------------------------------

### Install depguard via go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/OpenPeeDeeP/depguard/v2/README.md

Install the depguard Go linter using the go get command.

```bash
go get github.com/OpenPeeDeeP/depguard/v2
```

--------------------------------

### Getting Started with properties library

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/magiconair/properties/README.md

Shows how to load properties from files, maps, strings, URLs, and flags, and how to retrieve values and decode into a struct. Requires importing the properties package and using the provided functions.

```go
import (
	"flag"
	"github.com/magiconair/properties"
)

func main() {
	// init from a file
	p := properties.MustLoadFile("${HOME}/config.properties", properties.UTF8)

	// or multiple files
	p = properties.MustLoadFiles([]string{
			"${HOME}/config.properties",
			"${HOME}/config-${USER}.properties",
		}, properties.UTF8, true)

	// or from a map
	p = properties.LoadMap(map[string]string{"key": "value", "abc": "def"})

	// or from a string
	p = properties.MustLoadString("key=value\nabc=def")

	// or from a URL
	p = properties.MustLoadURL("http://host/path")

	// or from multiple URLs
	p = properties.MustLoadURL([]string{
			"http://host/config",
			"http://host/config-${USER}",
		}, true)

	// or from flags
	p.MustFlag(flag.CommandLine)

	// get values through getters
	host := p.MustGetString("host")
	port := p.GetInt("port", 8080)

	// or through Decode
	type Config struct {
		Host    string        `properties:"host"`
		Port    int           `properties:"port,default=9000"`
		Accept  []string      `properties:"accept,default=image/png;image;gif"`
		Timeout time.Duration `properties:"timeout,default=5s"`
	}
	var cfg Config
	if err := p.Decode(&cfg); err != nil {
		log.Fatal(err)
	}
}
```

--------------------------------

### Install with go install (Go 1.16+)

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/yagipy/maintidx/README.md

Install maintidx for Go 1.16 and later using go install.

```shell
go install github.com/yagipy/maintidx/cmd/maintidx
```

--------------------------------

### Install tparallel via go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/moricho/tparallel/README.md

Install tparallel using the go get command. This fetches the latest version from the repository.

```sh
$ go get -u github.com/moricho/tparallel/cmd/tparallel
```

--------------------------------

### Install GoUtils with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/Masterminds/goutils/README.md

Install the GoUtils package from the GOPATH directory using the command line. Requires Go to be set up on the system first.

```bash
go get github.com/Masterminds/goutils
```

--------------------------------

### Install go-toml CLI tools and show help

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/pelletier/go-toml/README.md

Install and check the help option for the three go-toml CLI tools: tomll (TOML linter), tomljson (TOML to JSON), and jsontoml (JSON to TOML). Each command is run separately.

```shell
go install github.com/pelletier/go-toml/cmd/tomll
tomll --help
```

```shell
go install github.com/pelletier/go-toml/cmd/tomljson
tomljson --help
```

```shell
go install github.com/pelletier/go-toml/cmd/jsontoml
jsontoml --help
```

--------------------------------

### Install astfmt with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/go-toolsmith/astfmt/README.md

Install the astfmt package using go get. Requires Go version 1.16 or later.

```bash
go get github.com/go-toolsmith/astfmt
```

--------------------------------

### Install Viper with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/spf13/viper/README.md

Installs the Viper package using the Go module-aware go get command. Requires Go Modules to be enabled.

```shell
go get github.com/spf13/viper
```

--------------------------------

### Install decorder with go install

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/gitlab.com/bosi/decorder/README.md

Installs the decorder linter binary from the GitLab repository.

```shell
go install gitlab.com/bosi/decorder/cmd/decorder
```

--------------------------------

### Install ghodss/yaml

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/ghodss/yaml/README.md

Installs the ghodss/yaml package using the go get command.

```bash
$ go get github.com/ghodss/yaml
```

--------------------------------

### Install gocognit with go install

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/uudashr/gocognit/README.md

Installation command using go install with the @latest version. Requires Go module support.

```shell
$ go install github.com/uudashr/gocognit/cmd/gocognit@latest
```

--------------------------------

### Install gocomplete

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/posener/complete/README.md

Install the gocomplete tool and its bash completion for the go command. Run these commands in your shell, then restart your shell. Uninstall with 'gocomplete -uninstall'.

```go
go get -u github.com/posener/complete/gocomplete
gocomplete -install
```

--------------------------------

### Install ini package with go get

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/gopkg.in/ini.v1/README.md

Install the ini package with go get. The minimum Go version required is 1.13. Add the -u flag to update the package in the future.

```sh
$ go get gopkg.in/ini.v1

```

--------------------------------

### Install err113

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/Djarvur/go-err113/README.adoc

Use the go get command to install the err113 linter binary.

```bash
go get -u github.com/Djarvur/go-err113/cmd/err113
```

--------------------------------

### Install and import jwt-go

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/golang-jwt/jwt/v4/README.md

Install the jwt-go package with go get and then import it in your Go program. Requires Go to be installed first.

```sh
go get -u github.com/golang-jwt/jwt/v4
```

```go
import "github.com/golang-jwt/jwt/v4"
```

--------------------------------

### go-osc52 usage example

Source: https://github.com/yandex-cloud/terraform-provider-yandex/blob/master/vendor/github.com/aymanbagabas/go-osc52/v2/README.md

Shows how to import the go-osc52 package and use the osc52 API to copy a string to the system clipboard, copy to the primary clipboard (X11), query the clipboard, and clear the system clipboard. The example writes each sequence to os.Stderr.

```go
import (
  "os"
  "fmt"

  "github.com/aymanbagabas/go-osc52/v2"
)

func main() {
  s := "Hello World!"

  // Copy `s` to system clipboard
  osc52.New(s).WriteTo(os.Stderr)

  // Copy `s` to primary clipboard (X11)
  osc52.New(s).Primary().WriteTo(os.Stderr)

  // Query the clipboard
  osc52.Query().WriteTo(os.Stderr)

  // Clear system clipboard
  osc52.Clear().WriteTo(os.Stderr)
}
```
Tokens:
Raw