Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hashicorp/terraform-provider-docker

As part of our introduction to self-service publishing in the Terraform Registry, this copy of the provider has been archived, and ownership has been transferred to active maintainers in the community. Please see the new location on the Terraform Registry: https://registry.terraform.io/providers/kreuzwerker/docker/latest
https://github.com/hashicorp/terraform-provider-docker

docker terraform terraform-provider

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/hashicorp/terraform-provider-docker
Owner: hashicorp
License: mpl-2.0
Archived: true
Created: 2017-06-05T20:59:07.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2020-12-10T22:00:15.000Z (about 4 years ago)
Last Synced: 2024-05-23T02:29:55.711Z (7 months ago)
Topics: docker, terraform, terraform-provider
Language: Go
Homepage: https://registry.terraform.io/providers/kreuzwerker/docker/latest
Size: 9.65 MB
Stars: 131
Watchers: 12
Forks: 92
Open Issues: 62
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-tf - terraform-provider-docker - Provider for Docker. :skull: (Providers / Hashicorp supported providers)

README

Please Note: As part of our introduction to self-service publishing in the Terraform Registry, this copy of the provider has been archived, and ownership has been transferred to its active maintainers in the community. Please see the new location on the [Terraform Registry](https://registry.terraform.io/providers/kreuzwerker/docker/latest). You can use the provider from its new location in the Registry by updating your configuration in Terraform with the following:

```hcl
terraform {
required_providers {
docker = {
source = "kreuzwerker/docker"
}
}
}

provider "docker" {
# Configuration options
}
```

Terraform Provider
==================

- Website: https://www.terraform.io
- [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby)
- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)

Requirements
------------

- [Terraform](https://www.terraform.io/downloads.html) 0.12.x
- [Go](https://golang.org/doc/install) 1.15.x (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 [email protected]: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 the latest version of [Go](http://www.golang.org) installed on your machine (currently 1.15). 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` (note that we typically test older versions of golang as long as they are supported upstream, though we recommend new development to happen on the latest release).

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 run only single Acceptance tests, execute the following steps:

```sh
# setup the testing environment
$ make testacc_setup

# run single tests
TF_LOG=INFO TF_ACC=1 go test -v ./docker -run ^TestAccDockerImage_data_private_config_file$ -timeout 360s

# cleanup the local testing resources
$ make testacc_cleanup
```

In order to extend the provider and test it with `terraform`, build the provider as mentioned above with
```sh
$ make build
# or a specific version
$ go build -o terraform-provider-docker_v1.2.0_x4
```

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

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.