mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2026-01-31 10:49:28 -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.
99 lines
2.4 KiB
Markdown
99 lines
2.4 KiB
Markdown
---
|
|
layout: "docker"
|
|
page_title: "Docker: docker_config"
|
|
sidebar_current: "docs-docker-resource-config"
|
|
description: |-
|
|
Manages the configs of a Docker service in a swarm.
|
|
---
|
|
|
|
# docker\_config
|
|
|
|
Manages the configuration of a Docker service in a swarm.
|
|
|
|
## Example Usage
|
|
|
|
## Basic
|
|
```hcl
|
|
# Creates a config
|
|
resource "docker_config" "foo_config" {
|
|
name = "foo_config"
|
|
data = "ewogICJzZXJIfQo="
|
|
}
|
|
```
|
|
|
|
### Advanced
|
|
#### Dynamically set config with a template
|
|
In this example you can use the `${var.foo_port}` variable to dynamically
|
|
set the `${port}` variable in the `foo.configs.json.tpl` template and create
|
|
the data of the `foo_config` with the help of the `base64encode` interpolation
|
|
function.
|
|
|
|
File `foo.config.json.tpl`
|
|
|
|
```json
|
|
{
|
|
"server": {
|
|
"public_port": ${port}
|
|
}
|
|
}
|
|
```
|
|
|
|
File `main.tf`
|
|
|
|
```hcl
|
|
# Creates the template in renders the variable
|
|
data "template_file" "foo_config_tpl" {
|
|
template = "${file("foo.config.json.tpl")}"
|
|
|
|
vars {
|
|
port = "${var.foo_port}"
|
|
}
|
|
}
|
|
|
|
# Creates the config
|
|
resource "docker_config" "foo_config" {
|
|
name = "foo_config"
|
|
data = "${base64encode(data.template_file.foo_config_tpl.rendered)}"
|
|
}
|
|
```
|
|
|
|
#### Update config with no downtime
|
|
To update a `config`, Terraform will destroy the existing resource and create a replacement. To effectively use a `docker_config` resource with a `docker_service` resource, it's recommended to specify `create_before_destroy` in a `lifecycle` block. Provide a uniqie `name` attribute, for example
|
|
with one of the interpolation functions `uuid` or `timestamp` as shown
|
|
in the example below. The reason is [moby-35803](https://github.com/moby/moby/issues/35803).
|
|
|
|
```hcl
|
|
resource "docker_config" "service_config" {
|
|
name = "${var.service_name}-config-${replace(timestamp(),":", ".")}"
|
|
data = "${base64encode(data.template_file.service_config_tpl.rendered)}"
|
|
|
|
lifecycle {
|
|
ignore_changes = ["name"]
|
|
create_before_destroy = true
|
|
}
|
|
}
|
|
resource "docker_service" "service" {
|
|
# ...
|
|
configs = [
|
|
{
|
|
config_id = "${docker_config.service_config.id}"
|
|
config_name = "${docker_config.service_config.name}"
|
|
file_name = "/root/configs/configs.json"
|
|
},
|
|
]
|
|
}
|
|
```
|
|
|
|
## Argument Reference
|
|
|
|
The following arguments are supported:
|
|
|
|
* `name` - (Required, string) The name of the Docker config.
|
|
* `data` - (Required, string) The base64 encoded data of the config.
|
|
|
|
|
|
## Attributes Reference
|
|
|
|
The following attributes are exported in addition to the above configuration:
|
|
|
|
* `id` (string)
|