mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2026-01-24 07:32:55 -05:00
dc824c1030
Adds docker swarm features to the provider for the Docker Engine 17.09.1 and API Version 1.32. The spec is close to the API. By default, the swarm services are fire and forget. A converging config implements the features of the docker cli to ensure a service and all its replicas are up and running. Furthermore, service can have configs, secrets, networks, mounts and be added to a network.
82 lines
2.5 KiB
Markdown
82 lines
2.5 KiB
Markdown
Terraform Provider
|
|
==================
|
|
|
|
- Website: https://www.terraform.io
|
|
- [](https://gitter.im/hashicorp-terraform/Lobby)
|
|
- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)
|
|
|
|
<img src="https://cdn.rawgit.com/hashicorp/terraform-website/master/content/source/assets/images/logo-hashicorp.svg" width="600px">
|
|
|
|
Requirements
|
|
------------
|
|
|
|
- [Terraform](https://www.terraform.io/downloads.html) 0.10.x
|
|
- [Go](https://golang.org/doc/install) 1.9.1 (to build the provider plugin)
|
|
|
|
Building The Provider
|
|
---------------------
|
|
|
|
Clone repository to: `$GOPATH/src/github.com/terraform-providers/terraform-provider-docker`
|
|
|
|
```sh
|
|
$ 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
|
|
|
|
```sh
|
|
$ 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](http://www.golang.org) installed on your machine (version 1.8+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#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.
|
|
|
|
```sh
|
|
$ make build
|
|
...
|
|
$ $GOPATH/bin/terraform-provider-docker
|
|
...
|
|
```
|
|
|
|
In order to test the provider, you can simply run `make test`.
|
|
|
|
```sh
|
|
$ 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.
|
|
|
|
```sh
|
|
$ make testacc
|
|
```
|
|
|
|
In order to extend the provider and test it with `terraform`, build the provider as mentioned above with
|
|
```sh
|
|
$ make build
|
|
```
|
|
|
|
Remove an explicit version of the provider you develop, because `terraform` will fetch
|
|
the locally built one in `$GOPATH/bin`
|
|
```hcl
|
|
provider "docker" {
|
|
# version = "~> 0.1.2"
|
|
...
|
|
}
|
|
```
|
|
|
|
|
|
Don't forget to run `terraform init` each time you rebuild the provider. Check [here](https://www.youtube.com/watch?v=TMmovxyo5sY&t=30m14s) for a more detailed explanation.
|
|
|
|
You can check the latest released version of a provider at https://releases.hashicorp.com/terraform-provider-docker/.
|