Feature: Multiple enhancements (#854)

* feat: Implement labels for docker config

Based on #543 from @jani123

* feat: Implements timeouts for docker_container

Thanks to PR #777 from @Strafo

* chore: Fix spelling mistakes

Thanks to #588 from @vszabo2

Author: Junkern

GNUmakefile

@@ -113,8 +113,8 @@ chlog-%:
 	@echo "Review the changes made by this script then execute the following:"
 
 
-replace-occurences-%:
-	@echo "Replace occurences of old version strings..."
+replace-occurrences-%:
+	@echo "Replace occurrences of old version strings..."
 	sed -i "s/$(shell (svu --tag.prefix='' current))/$*/g" README.md docs/index.md examples/provider/provider-tf13.tf
 
 release-%:
@@ -130,15 +130,15 @@ release-%:
 
 patch:
 	@${MAKE} chlog-$(shell (svu patch))
-	@${MAKE} replace-occurences-$(shell (svu --tag.prefix='' patch))
+	@${MAKE} replace-occurrences-$(shell (svu --tag.prefix='' patch))
 	@${MAKE} release-$(shell (svu patch))
 
 minor:
 	@${MAKE} chlog-$(shell (svu minor))
-	@${MAKE} replace-occurences-$(shell (svu --tag.prefix='' minor))
+	@${MAKE} replace-occurrences-$(shell (svu --tag.prefix='' minor))
 	@${MAKE} release-$(shell (svu minor))
 
 major:
 	@${MAKE} chlog-$(shell (svu major))
-	@${MAKE} replace-occurences-$(shell (svu --tag.prefix='' major))
+	@${MAKE} replace-occurrences-$(shell (svu --tag.prefix='' major))
 	@${MAKE} release-$(shell (svu major))

docs/index.md

@@ -57,7 +57,7 @@ provider "docker" {
 }
 ```
 
-When using a remote host, the daemon configuration on the remote host can apply default configuration to your resources when running `terraform apply`, for example by appling log options to containers. When running `terraform plan` the next time, it will show up as a diff. In such cases it is recommended to use the `ignore_changes` lifecycle meta-argument to ignore the changing attribute (See [this issue](https://github.com/kreuzwerker/terraform-provider-docker/issues/473) for more information).
+When using a remote host, the daemon configuration on the remote host can apply default configuration to your resources when running `terraform apply`, for example by applying log options to containers. When running `terraform plan` the next time, it will show up as a diff. In such cases it is recommended to use the `ignore_changes` lifecycle meta-argument to ignore the changing attribute (See [this issue](https://github.com/kreuzwerker/terraform-provider-docker/issues/473) for more information).
 
 ## Disabling Docker Daemon Checking
 
@@ -110,7 +110,7 @@ When passing in a config file either the corresponding `auth` string of the repo
 used to retrieve the authentication credentials.
 
 -> **Note**
-`config_file` has predence over all other options. You can theoretically specify values for every attribute but the credentials obtained through the `config_file` will override the manually set `username`/`password`
+`config_file` has precedence over all other options. You can theoretically specify values for every attribute but the credentials obtained through the `config_file` will override the manually set `username`/`password`
 
 You can still use the environment variables `DOCKER_REGISTRY_USER` and `DOCKER_REGISTRY_PASS`.
 

docs/resources/config.md

@@ -95,10 +95,22 @@ resource "docker_service" "service" {
 - `data` (String) Base64-url-safe-encoded config data
 - `name` (String) User-defined name of the config
 
+### Optional
+
+- `labels` (Block Set) User-defined key/value metadata (see [below for nested schema](#nestedblock--labels))
+
 ### Read-Only
 
 - `id` (String) The ID of this resource.
 
+<a id="nestedblock--labels"></a>
+### Nested Schema for `labels`
+
+Required:
+
+- `label` (String) Name of the label
+- `value` (String) Value of the label
+
 ## Import
 
 Import is supported using the following syntax by providing the `id`:

docs/resources/container.md

@@ -36,7 +36,7 @@ resource "docker_image" "ubuntu" {
 ### Optional
 
 - `attach` (Boolean) If `true` attach to the container after its creation and waits the end of its execution. Defaults to `false`.
-- `capabilities` (Block Set, Max: 1) Add or drop certrain linux capabilities. (see [below for nested schema](#nestedblock--capabilities))
+- `capabilities` (Block Set, Max: 1) Add or drop certain linux capabilities. (see [below for nested schema](#nestedblock--capabilities))
 - `cgroup_parent` (String) Optional parent cgroup for the container
 - `cgroupns_mode` (String) Cgroup namespace mode to use for the container. Possible values are: `private`, `host`.
 - `command` (List of String) The command to use to start the container. For example, to run `/usr/bin/myprogram -f baz.conf` set the command to be `["/usr/bin/myprogram","-f","baz.conf"]`.
@@ -90,11 +90,12 @@ resource "docker_image" "ubuntu" {
 - `stop_timeout` (Number) Timeout (in seconds) to stop a container.
 - `storage_opts` (Map of String) Key/value pairs for the storage driver options, e.g. `size`: `120G`
 - `sysctls` (Map of String) A map of kernel parameters (sysctls) to set in the container.
+- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
 - `tmpfs` (Map of String) A map of container directories which should be replaced by `tmpfs mounts`, and their corresponding mount options.
 - `tty` (Boolean) If `true`, allocate a pseudo-tty (`docker run -t`). Defaults to `false`.
 - `ulimit` (Block Set) Ulimit options to add. (see [below for nested schema](#nestedblock--ulimit))
 - `upload` (Block Set) Specifies files to upload to the container before starting it. Only one of `content` or `content_base64` can be set and at least one of them has to be set. (see [below for nested schema](#nestedblock--upload))
-- `user` (String) User used for run the first process. Format is `user` or `user:group` which user and group can be passed literraly or by name.
+- `user` (String) User used for run the first process. Format is `user` or `user:group` which user and group can be passed literally or by name.
 - `userns_mode` (String) Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
 - `volumes` (Block Set) Spec for mounting volumes in the container. (see [below for nested schema](#nestedblock--volumes))
 - `wait` (Boolean) If `true`, then the Docker container is waited for being healthy state after creation. This requires your container to have a healthcheck, otherwise this provider will error. If `false`, then the container health state is not checked. Defaults to `false`.
@@ -249,6 +250,16 @@ Optional:
 - `protocol` (String) Protocol that can be used over this port. Defaults to `tcp`.
 
 
+<a id="nestedblock--timeouts"></a>
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `create` (String)
+- `delete` (String)
+- `update` (String)
+
+
 <a id="nestedblock--ulimit"></a>
 ### Nested Schema for `ulimit`
 

docs/resources/service.md

@@ -599,7 +599,7 @@ Optional:
 
 Optional:
 
-- `memory_bytes` (Number) The amounf of memory in bytes the container allocates
+- `memory_bytes` (Number) The amount of memory in bytes the container allocates
 - `nano_cpus` (Number) CPU shares in units of `1/1e9` (or `10^-9`) of the CPU. Should be at least `1000000`
 
 
@@ -609,7 +609,7 @@ Optional:
 Optional:
 
 - `generic_resources` (Block List, Max: 1) User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, GPU=UUID1) (see [below for nested schema](#nestedblock--task_spec--resources--reservation--generic_resources))
-- `memory_bytes` (Number) The amounf of memory in bytes the container allocates
+- `memory_bytes` (Number) The amount of memory in bytes the container allocates
 - `nano_cpus` (Number) CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least `1000000`
 
 <a id="nestedblock--task_spec--resources--reservation--generic_resources"></a>
@@ -675,7 +675,7 @@ Required:
 Optional:
 
 - `name` (String) A random name for the port
-- `protocol` (String) Rrepresents the protocol of a port: `tcp`, `udp` or `sctp`. Defaults to `tcp`.
+- `protocol` (String) Represents the protocol of a port: `tcp`, `udp` or `sctp`. Defaults to `tcp`.
 - `publish_mode` (String) Represents the mode in which the port is to be published: 'ingress' or 'host'. Defaults to `ingress`.
 - `published_port` (Number) The port on the swarm hosts
 

internal/provider/provider.go

@@ -357,7 +357,7 @@ func providerSetToRegistryAuth(authList *schema.Set) (*AuthConfigs, error) {
 			log.Println("[DEBUG] Parsing file for registry auths:", filePath)
 
 			// We manually expand the path and do not use the 'pathexpand' interpolation function
-			// because in the default of this varable we refer to '~/.docker/config.json'
+			// because in the default of this variable we refer to '~/.docker/config.json'
 			if strings.HasPrefix(filePath, "~/") {
 				usr, err := user.Current()
 				if err != nil {

internal/provider/resource_docker_config.go

@@ -38,6 +38,13 @@ func resourceDockerConfig() *schema.Resource {
 				ForceNew:         true,
 				ValidateDiagFunc: validateStringIsBase64Encoded(),
 			},
+			"labels": {
+				Type:        schema.TypeSet,
+				Description: "User-defined key/value metadata",
+				Optional:    true,
+				ForceNew:    true,
+				Elem:        labelSchema,
+			},
 		},
 	}
 }
@@ -56,6 +63,9 @@ func resourceDockerConfigCreate(ctx context.Context, d *schema.ResourceData, met
 		Data: data,
 	}
 
+	if v, ok := d.GetOk("labels"); ok {
+		configSpec.Labels = labelSetToMap(v.(*schema.Set))
+	}
 	config, err := client.ConfigCreate(ctx, configSpec)
 	if err != nil {
 		return diag.FromErr(err)
@@ -81,8 +91,9 @@ func resourceDockerConfigRead(ctx context.Context, d *schema.ResourceData, meta
 	log.Printf("[DEBUG] Docker config inspect from readFunc: %s", jsonObj)
 
 	d.SetId(config.ID)
-	d.Set("name", config.Spec.Name)                                    //nolint:errcheck
-	d.Set("data", base64.StdEncoding.EncodeToString(config.Spec.Data)) //nolint:errcheck
+	d.Set("name", config.Spec.Name)
+	d.Set("data", base64.StdEncoding.EncodeToString(config.Spec.Data))
+	d.Set("labels", mapToLabelSet(config.Spec.Labels))
 	return nil
 }
 

internal/provider/resource_docker_config_test.go

@@ -111,6 +111,41 @@ func TestAccDockerConfig_basicUpdatable(t *testing.T) {
 	})
 }
 
+func TestAccDockerConfig_labels(t *testing.T) {
+	ctx := context.Background()
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: providerFactories,
+		CheckDestroy: func(state *terraform.State) error {
+			return testCheckDockerConfigDestroy(ctx, state)
+		},
+		Steps: []resource.TestStep{
+			{
+				Config: `
+				resource "docker_config" "foo" {
+					name = "foo-config"
+					data = "Ymxhc2RzYmxhYmxhMTI0ZHNkd2VzZA=="
+					labels {
+						label = "test1"
+						value = "foo"
+					}
+					labels {
+						label = "test2"
+						value = "bar"
+					}
+				}
+				`,
+				Check: testCheckLabelMap("docker_config.foo", "labels",
+					map[string]string{
+						"test1": "foo",
+						"test2": "bar",
+					},
+				),
+			},
+		},
+	})
+}
+
 // ///////////
 // Helpers
 // ///////////

internal/provider/resource_docker_container.go

@@ -3,10 +3,17 @@ package provider
 import (
 	"context"
 	"log"
+	"time"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
+const (
+	dockerContainerCreateDefaultTimeout = 20 * time.Minute
+	dockerContainerUpdateDefaultTimeout = 20 * time.Minute
+	dockerContainerDeleteDefaultTimeout = 20 * time.Minute
+)
+
 func resourceDockerContainer() *schema.Resource {
 	return &schema.Resource{
 		Description: "Manages the lifecycle of a Docker container.",
@@ -20,12 +27,17 @@ func resourceDockerContainer() *schema.Resource {
 		Importer: &schema.ResourceImporter{
 			StateContext: schema.ImportStatePassthroughContext,
 		},
+		Timeouts: &schema.ResourceTimeout{
+			Create: schema.DefaultTimeout(dockerContainerCreateDefaultTimeout),
+			Update: schema.DefaultTimeout(dockerContainerUpdateDefaultTimeout),
+			Delete: schema.DefaultTimeout(dockerContainerDeleteDefaultTimeout),
+		},
 		StateUpgraders: []schema.StateUpgrader{
 			{
 				Version: 1,
 				Type:    resourceDockerContainerV1().CoreConfigSchema().ImpliedType(),
 				Upgrade: func(ctx context.Context, rawState map[string]interface{}, meta interface{}) (map[string]interface{}, error) {
-					// TODO do the ohter V0-to-V1 migration, unless we're okay
+					// TODO do the other V0-to-V1 migration, unless we're okay
 					// with breaking for users who straggled on their docker
 					// provider version
 
@@ -168,7 +180,7 @@ func resourceDockerContainer() *schema.Resource {
 
 			"user": {
 				Type:        schema.TypeString,
-				Description: "User used for run the first process. Format is `user` or `user:group` which user and group can be passed literraly or by name.",
+				Description: "User used for run the first process. Format is `user` or `user:group` which user and group can be passed literally or by name.",
 				Optional:    true,
 				ForceNew:    true,
 				Elem:        &schema.Schema{Type: schema.TypeString},
@@ -249,7 +261,7 @@ func resourceDockerContainer() *schema.Resource {
 			},
 			"capabilities": {
 				Type:        schema.TypeSet,
-				Description: "Add or drop certrain linux capabilities.",
+				Description: "Add or drop certain linux capabilities.",
 				Optional:    true,
 				ForceNew:    true,
 				MaxItems:    1,

internal/provider/resource_docker_container_funcs.go

@@ -976,7 +976,7 @@ func resourceDockerContainerDelete(ctx context.Context, d *schema.ResourceData,
 		if !containsIgnorableErrorMessage(err.Error(), "No such container", "is already in progress") {
 			return diag.Errorf("Error waiting for container removal '%s': %s", d.Id(), err)
 		}
-		log.Printf("[INFO] Waiting for Container '%s' errord: '%s'", d.Id(), err.Error())
+		log.Printf("[INFO] Waiting for Container '%s' error: '%s'", d.Id(), err.Error())
 	}
 
 	d.SetId("")