https://github.com/vultr/terraform-provider-vultr
Terraform Vultr provider
https://github.com/vultr/terraform-provider-vultr
terraform terraform-provider vultr
Last synced: 6 days ago
JSON representation
Terraform Vultr provider
- Host: GitHub
- URL: https://github.com/vultr/terraform-provider-vultr
- Owner: vultr
- License: mpl-2.0
- Created: 2019-10-22T20:16:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-05-07T17:00:16.000Z (6 days ago)
- Last Synced: 2025-05-07T17:15:20.630Z (6 days ago)
- Topics: terraform, terraform-provider, vultr
- Language: Go
- Homepage: https://www.terraform.io/docs/providers/vultr/
- Size: 16.4 MB
- Stars: 197
- Watchers: 12
- Forks: 69
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Terraform Provider for Vultr
==================
- Quickstart Guide: [How to Provision a Vultr Cloud Server with Terraform and Cloud-Init](https://www.vultr.com/docs/provision-a-vultr-cloud-server-with-terraform-and-cloud-init/)
- Vultr Website: https://www.vultr.com
- Terraform Website: https://www.terraform.io
Requirements
------------
- [Terraform](https://www.terraform.io/downloads.html) 0.12.x+
- [Go](https://golang.org/doc/install) 1.22.x+ (to build the provider plugin)
Building The Provider
---------------------
Clone repository to: `$GOPATH/src/github.com/vultr/terraform-provider-vultr`
``` sh
$ mkdir -p $GOPATH/src/github.com/vultr; cd $GOPATH/src/github.com/vultr
$ git clone [email protected]:vultr/terraform-provider-vultr.git
```
Enter the provider directory and build the provider
``` sh
$ cd $GOPATH/src/github.com/vultr/terraform-provider-vultr
$ make build
```
Using the provider
----------------------
See the [Vultr Provider documentation](website/docs/index.html.markdown) to get started using the Vultr provider.
Please read about [V2 changes from V1](example/V2Changes.md) for a list of new changes made to the Vultr Terraform Provider
### Installation
In your terraform config, define `vultr/vultr` in your `required_providers` and set your API key:
``` hcl
terraform {
required_providers {
vultr = {
source = "vultr/vultr"
version = "2.22.1"
}
}
}
provider "vultr" {
api_key = "..."
}
```
After, run `terraform init` to install the provider.
#### Manual Installation
If you don't have internet access on the target machine or prefer to install
the provider locally follow the steps for the relevant operating system and architecture.
1) [Download](https://github.com/vultr/terraform-provider-vultr/releases) and
extract the binary for your system and architecture
2) Make the local plugins directory:
On linux
``` sh
export VERSION=2.22.1 OS=linux ARCH=amd64
mkdir -p ~/.terraform.d/plugins/local/vultr/vultr/${VERSION}/${OS}_${ARCH}/'
```
On mac
``` sh
export VERSION=2.22.1 OS=darwin ARCH=arm64
mkdir -p ~/.terraform.d/plugins/local/vultr/vultr/${VERSION}/${OS}_${ARCH}/'
```
3) Rename and copy the binary into the local plugins directory:
``` sh
mv terraform-provider-vultr_v${VERSION} ~/.terraform.d/plugins/local/vultr/vultr/${VERSION}/${OS}_${ARCH}/terraform-provider-vultr_v${VERSION}
```
4) Add the local provider to your terraform `main.tf` config:
``` hcl
terraform {
required_providers {
vultr = {
source = "local/vultr/vultr"
version = "2.22.1"
}
}
}
provider "vultr" {
api_key = "..."
}
```
5) Test everything by running `terraform init` in that same directory.
Developing the Provider
---------------------------
If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.11+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#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.
``` sh
$ make build
...
$ $GOPATH/bin/terraform-provider-vultr
...
```
In order to test the provider, you can simply run `make test`.
``` sh
$ 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.
``` sh
$ make testacc
```
In order to run a specific acceptance test, use the `TESTARGS` environment variable. For example, the following command will run `TestAccVultrUser_base` acceptance test only:
``` sh
$ make testacc TESTARGS='-run=TestAccVultrUser_base'
```