Terraform Veeam Provider
Terraform enables you to safely and predictably create, change, and improve infrastructure. It is an opensource tool that codifies APIs into declarative configuration files that can be shared amongst team members, treated as code, edited, reviewed, and versioned.
This is the repository for the Terraform Veeam Provider, which one can use with Terraform to work with Veeam server.
For general information about Terraform, visit the official website and the GitHub project page.
Using the Provider
The current version of this provider requires Terraform v0.12.9 or higher to run.
Note that you need to run terraform init
to fetch the provider before deploying. Read about the provider split and other changes to TF v0.10.0 in the official release announcement found here.
Full Provider Documentation
The provider is useful to add vm to the backup job
Example
# Configure the Veeam Providerprovider "veeam" { server_ip = "${var.VEEAM_SERVER_IP}" port = ${var.VEEAM_SERVER_PORT} username = "${var.VEEAM_SERVER_USERNAME}" password = "${var.VEEAM_SERVER_PASSWORD}"}# Resource veeam_job_vm to add vm to the backup job in veeam serverresource "veeam_job_vm" "addvm"{ job_name = "${var.VEEAM_JOB_NAME}" vm_name = "${var.VEEAM_VM_NAME}"}
Building The Provider
NOTE: Unless you are [developing][7] or require a pre-release bugfix or feature, you will want to use the officially released version of the provider (see [the section above][8]). [7]: #developing-the-provider [8]: #using-the-provider
Cloning the Project
First, you will want to clone the repository to $GOPATH/src/github.com/terraform-providers/terraform-provider-veeam
:
mkdir -p $GOPATH/src/github.com/terraform-providers
cd $GOPATH/src/github.com/terraform-providers
git clone git@github.com:terraform-providers/terraform-provider-veeam
Running the Build
After the clone has been completed, you can enter the provider directory and build the provider.
cd $GOPATH/src/github.com/terraform-providers/terraform-provider-veeam
make build
Installing the Local Plugin
After the build is complete, copy the terraform-provider-veeam
binary into the same path as your terraform
binary, and re-run terraform init
.
After this, your project-local .terraform/plugins/ARCH/lock.json
(where ARCH
matches the architecture of your machine) file should contain a SHA256 sum that matches the local plugin. Run shasum -a 256
on the binary to verify the values match.
Developing the Provider
If you wish to work on the provider, you'll first need Go installed on your machine (version 1.9+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin
to your $PATH
.
See [Building the Provider][11] for details on building the provider. [11]: #building-the-provider
Testing the Provider
NOTE: Testing the VEEAM provider is currently a complex operation as it requires having a VEEAM backup Server to test against.
Configuring Environment Variables
Most of the tests in this provider require a comprehensive list of environment variables to run. See the individual *_test.go
files in the veeam/
directory for more details. The next section also describes how you can manage a configuration file of the test environment variables.
Running the Acceptance Tests
After this is done, you can run the acceptance tests by running:
$ make testacc
If you want to run against a specific set of tests, run make testacc
with the TESTARGS
parameter containing the run mask as per below:
make testacc TESTARGS="-run=TestAccAddVMToJob_Basic"
This following example would run all of the acceptance tests matching TestAccAddVMToJob_Basic