terraform-provider-rancher2

Terraform Provider for Rancher v2

• Website: https://www.terraform.io
• 
• Mailing list: Google Groups

Requirements

• Terraform >= 0.11.x
• Go 1.13 to build the provider plugin
• Docker 20.10.x to run acceptance tests

Building The Provider

Clone repository to: $GOPATH/src/github.com/terraform-providers/terraform-provider-rancher2

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

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-rancher2
$ 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.

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.

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

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

To just compile provider binary on repo path and test on terraform:

$ make bin
$ terraform init
$ terraform plan
$ terraform apply

Testing the Provider

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

$ make test

In order to run the full suite of Acceptance tests, a running rancher system, a rancher API key and a working k8s cluster imported are needed. Also, acceptance tests are covering Rancher server upgrade, v2.3.6 and v2.4.2

To run acceptance tests, you can simply run make testacc. scripts/gotestacc.sh will be run, deploying all needed requirements, running acceptance tests and cleanup.

$ make testacc

Due to network limitation on docker for osx and/or windows, there is a way to run dockerized acceptance test.

$ EXPOSE_HOST_PORTS=true make docker-testacc

Releasing the Provider

The provider should be released 'out of band' from Rancher, but can be loosely tied to a Rancher release to track issues. For example: Terraform v2.6.9 should be released a few days after Rancher v2.6.9 and Terraform fixes or features in the release are said to be included in Rancher v2.6.9 (and will work if you provision with Terraform).

The RKE provider should be released after every RKE/KDM release. For example: If RKE v1.3.15 was released, bump the RKE version to v1.3.15 and release the provider.

To release the provider:

• Create a draft of the release and select create new tag for the version you are releasing
• Create release notes by clicking Generate release notes
• Copy the release notes to the CHANGELOG and update to the following format

# <tag version> (Month Day, Year)
FEATURES:
ENHANCEMENTS:
BUG FIXES:

• Create a PR to update CHANGELOG
• Copy the updated notes back to the draft release (DO NOT release with just the generated notes. Those are just a template to help you)
• Make sure the branch is up-to-date with the remote, in this example, the branch is master and the release tag is v1.24.0

git remote add upstream-release git@github.com:rancher/terraform-provider-rancher2.git
git checkout upstream-release/master
git push upstream-release v1.24.0

• Create an EIO issue for Hashicorp to publish the release