Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linode/terraform-provider-linode
Terraform Linode provider
https://github.com/linode/terraform-provider-linode
linode terraform terraform-provider
Last synced: 3 months ago
JSON representation
Terraform Linode provider
- Host: GitHub
- URL: https://github.com/linode/terraform-provider-linode
- Owner: linode
- License: mpl-2.0
- Created: 2018-10-16T18:59:35.000Z (about 6 years ago)
- Default Branch: dev
- Last Pushed: 2024-05-22T18:01:14.000Z (6 months ago)
- Last Synced: 2024-05-22T18:58:07.228Z (6 months ago)
- Topics: linode, terraform, terraform-provider
- Language: Go
- Homepage: https://www.terraform.io/docs/providers/linode/
- Size: 20.8 MB
- Stars: 190
- Watchers: 16
- Forks: 91
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Support: .github/SUPPORT.md
Awesome Lists containing this project
- jimsghstars - linode/terraform-provider-linode - Terraform Linode provider (Go)
README
# Terraform Provider for Linode
[](https://github.com/linode/terraform-provider-linode/releases/latest)
[](https://godoc.org/github.com/linode/terraform-provider-linode)
[](https://goreportcard.com/report/github.com/linode/terraform-provider-linode)
[](https://gitter.im/hashicorp-terraform/Lobby)
- Website:
- Documentation:
- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)
## Maintainers
This provider plugin is maintained by Linode.
## Requirements
- [Terraform](https://www.terraform.io/downloads.html) 0.12.0+
- [Go](https://golang.org/doc/install) 1.20.0 or higher (to build the provider plugin)
## Using the provider
See the [Linode Provider documentation](https://www.terraform.io/docs/providers/linode/index.html) to get started using the Linode provider. The [examples](https://github.com/linode/terraform-provider-linode/tree/main/examples) included in this repository demonstrate usage of many of the Linode provider resources.
Additional documentation and examples are provided in the Linode Guide, [Using Terraform to Provision Linode Environments](https://linode.com/docs/platform/how-to-build-your-infrastructure-using-terraform-and-linode/).
## Development
### Building the provider
If you wish to build or contribute code to the provider, you'll first need [Git](https://git-scm.com/downloads) and [Go](http://www.golang.org) installed on your machine (version 1.11+ is *required*).
You'll also need to correctly configure a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
To compile the provider, run `make`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
Clone this repository to: `$GOPATH/src/github.com/linode/terraform-provider-linode`
```sh
mkdir -p $GOPATH/src/github.com/linode
cd $GOPATH/src/github.com/linode
git clone https://github.com/linode/terraform-provider-linode.git
```
Enter the provider directory and build the provider
```sh
cd $GOPATH/src/github.com/linode/terraform-provider-linode
make
```
### Testing the provider
In order to run the full suite of Acceptance tests, run `make int-test`. Acceptance testing will require the `LINODE_TOKEN` variable to be populated with a Linode APIv4 Token. See [Linode Provider documentation](https://www.terraform.io/docs/providers/linode/index.html) for more details.
*Note:* Acceptance tests create real resources, and often cost money to run.
```sh
make int-test
```
Use the following command template to execute specific Acceptance test
```shell
make ARGS="-run TestAccResourceVolume_basic" int-test
```
Use the following command template to execute particular Acceptance tests within a specific package
```shell
make TEST_TAGS="volume" int-test
```
There are a number of useful flags and variables to aid in debugging.
- `TF_LOG_PROVIDER` - This instructs Terraform to emit provider logging messages at the given level.
- `TF_LOG` - This instructs Terraform to emit logging messages at the given level.
- `TF_LOG_PROVIDER_LINODE_REQUESTS` - This instructs terraform-provider-linode to output API request logs at the given level.
- `TF_SCHEMA_PANIC_ON_ERROR` - This forces Terraform to panic if a Schema Set command failed.
These values (along with `LINODE_TOKEN`) can be placed in a `.env` file in the repository root to avoid repeating them on the command line.
To filter down to logs relevant to the Linode provider, the following command can be used:
```bash
terraform apply 2> >(grep '@module=linode' >&2)
```