Terraform Provider - Docker
Find a file
Nemo abcdd9ac29 docker_network data source (#87). Closes #84
* Adds docker_network data source
* Adds documentation for the docker_network data source
* Adding basic network data source test
2019-05-26 21:20:01 +02:00
.github Make CoC and support channels more visible 2017-11-01 23:04:55 +01:00
docker docker_network data source (#87). Closes #84 2019-05-26 21:20:01 +02:00
examples/ssh-protocol Add ssh protocol (copy) (#153). Closes #112 2019-05-26 21:06:10 +02:00
scripts Fixes for image pulling and local registry (#143) 2019-05-26 11:42:53 +02:00
vendor Add ssh protocol (copy) (#153). Closes #112 2019-05-26 21:06:10 +02:00
website docker_network data source (#87). Closes #84 2019-05-26 21:20:01 +02:00
.gitignore Migrate/docker-client (#70) 2018-07-03 17:30:53 +02:00
.go-version provider: Ensured Go 1.11 in TravisCI and README 2019-03-11 18:19:29 -04:00
.travis.yml Update to docker to 18.09 (#152) 2019-05-26 14:20:39 +02:00
CHANGELOG.md Cleanup after v1.1.1 release 2019-03-08 07:17:27 +00:00
GNUmakefile deps: use go modules for dep mgmt 2019-03-11 18:19:30 -04:00
go.mod Add ssh protocol (copy) (#153). Closes #112 2019-05-26 21:06:10 +02:00
go.sum Add ssh protocol (copy) (#153). Closes #112 2019-05-26 21:06:10 +02:00
LICENSE initial commit 2017-06-05 20:59:08 +00:00
main.go Initial transfer of provider code 2017-06-06 11:50:36 -04:00
README.md provider: Ensured Go 1.11 in TravisCI and README 2019-03-11 18:19:29 -04:00

Terraform Provider

Requirements

  • Terraform 0.10.x
  • Go 1.11.1 (to build the provider plugin)

Building The Provider

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

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

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-docker
$ make build

Using the provider

Fill in for each provider

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.11+ 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-docker
...

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 a local registry which will be deleted afterwards.

$ make testacc

In order to extend the provider and test it with terraform, build the provider as mentioned above with

$ make build

Remove an explicit version of the provider you develop, because terraform will fetch the locally built one in $GOPATH/bin

provider "docker" {
  # version = "~> 0.1.2"
  ...
}

Don't forget to run terraform init each time you rebuild the provider. Check here for a more detailed explanation.

You can check the latest released version of a provider at https://releases.hashicorp.com/terraform-provider-docker/.

Developing on Windows

You can build and test on Widows without make. Run go install to build and Scripts\runAccTests.bat to run the test suite.

Continuous integration for Windows is not available at the moment due to lack of a CI provider that is free for open source projects and supports running Linux containers in Docker for Windows. For example, AppVeyor is free for open source projects and provides Docker on its Windows builds, but only offers Linux containers on Windows as a paid upgrade.