Skip to content

zczm2/terraform-provider-ucloud

 
 

Repository files navigation

Terraform Provider

Requirements

  • Terraform 0.13.x
  • Go 1.16+ (to build the provider plugin)

Building The Provider

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

$ mkdir -p $GOPATH/src/github.com/ucloud; cd $GOPATH/src/github.com/ucloud
$ git clone [email protected]:ucloud/terraform-provider-ucloud

Enter the provider directory and build the provider

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

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.14+ 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 the $GOPATH/bin directory.

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

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

$ 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.

$ make testacc

Acceptance Testing

Before making a release, the resources and data sources are tested automatically with acceptance tests (the tests are located in the ucloud/*_test.go files).

You can run them by entering the following instructions in a terminal:

cd $GOPATH/src/github.com/ucloud/terraform-provider-ucloud
export UCLOUD_PUBLIC_KEY=xxx
export UCLOUD_PRIVATE_KEY=xxx
export UCLOUD_REGION=xxx
export UCLOUD_PROJECT_ID=xxx
TF_ACC=1 TF_LOG=INFO go test ./ucloud -v -run="^TestAccUCloud" -timeout=1440m

Reference

UCloud Provider Official Docs

Packages

No packages published

Languages

  • Go 99.1%
  • Other 0.9%