Terraform RKE providers can easily deploy Kubernetes clusters with Rancher Kubernetes Engine.
For terraform 0.13 or above users, manual installation is not required anymore. Provider will be downloaded by
terraform init from terraform rke registry.
For upgrade terraform to 0.13, please follow upgrade_to_0.13 guide
Note: If you are using terraform 0.12 or lower, the provider should be installed manually. Downloadable packages are available at rke provider releases
How to install manually:
curl -L https://github.com/rancher/terraform-provider-rke/releases/download/vX.Y.Z/terraform-provider-rke_X.Y.Z_<OS>_<ARCH>.zip | unzip -
chmod 755 terraform-provider-rke_vX.Y.Z
mv terraform-provider-rke_vX.Y.Z <TERRAFORM_PLUGIN_DIRECTORY>
terraform initwill search the following terraform plugin directories (More info at terra-farm.github.io):
|.||In case the provider is only used in a single Terraform project.|
|Location of the terraform binary (/usr/local/bin, for example.)||For airgapped installations; see terraform bundle.|
||For checking custom providers into a configuration’s VCS repository. Not usually desirable, but sometimes necessary in Terraform Enterprise.|
||Automatically downloaded providers.|
|~/.terraform.d/plugins||The user plugins directory.|
||The user plugins directory, with explicit OS and architecture.|
|/my/custom/path||Custom plugin directory. Use the
Clone repository to:
$ mkdir -p $GOPATH/src/github.com/rancher $ cd $GOPATH/src/github.com/rancher $ go get github.com/rancher/terraform-provider-rke $ go install github.com/rancher/terraform-provider-rke
Enter the provider directory and build the provider
$ cd $GOPATH/src/github.com/rancher/terraform-provider-rke $ make build
Current master is focusing on RKE v1.0.x There are some breaking changes from previous provider version.
If you use RKE v0.2.x or v0.1.x, please set proper branch.
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 at rke provider docs.
If you wish to work on the provider, you'll first need Go installed on your machine (version 1.13+ is required). You'll also need to correctly setup a GOPATH, as well as adding
$GOPATH/bin to your
To compile the provider, run
make build. This will build the provider and put the provider binary in
$ make build ... $ $GOPATH/bin/terraform-provider-rke ...
To just compile provider binary on repo path and test on terraform:
$ make bin $ terraform init $ terraform plan $ terraform apply
In order to test structures on the provider, you can simply run
$ make test
In order to run the full suite of Acceptance tests, you can simply run
scripts/gotestacc.sh will be run, deploying all needed requirements, running acceptance tests and cleanup.
$ make testacc
Due to network limitations on docker for Mac OSX and windows, on these platforms acceptance tests should run on a dockerized enviroment.
$ make dapper-testacc
You can view some tf file examples, here.
On Openstack you can use terraform-openstack-rke module.
Generate release notes
# <tag version> (Month Day, Year) FEATURES: ENHANCEMENTS: BUG FIXES:
git remote add upstream-release [email protected]:rancher/terraform-provider-rke.git git checkout upstream-release/master git push upstream-release v1.24.0