mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2025-12-18 23:06:10 -05:00
ec595a4ade
Some checks failed
Acc Tests / acc-test (TestAccDockerConfig, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerConfig, 1.8.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerNetwork, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerNetwork, 1.8.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerPlugin, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerPlugin, 1.8.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerSecret, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerSecret, 1.8.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerTag, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerTag, 1.8.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerVolume, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (TestAccDockerVolume, 1.8.x) (push) Has been cancelled
Acc Tests / acc-test (true, TestAccDockerContainer, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (true, TestAccDockerContainer, 1.8.x) (push) Has been cancelled
Acc Tests / acc-test (true, TestAccDockerImage, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (true, TestAccDockerImage, 1.8.x) (push) Has been cancelled
Acc Tests / acc-test (true, TestAccDockerRegistryImage, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (true, TestAccDockerRegistryImage, 1.8.x) (push) Has been cancelled
Acc Tests / acc-test (true, TestAccDockerService, 0.15.x) (push) Has been cancelled
Acc Tests / acc-test (true, TestAccDockerService, 1.8.x) (push) Has been cancelled
Compile Binaries / compile-fast (push) Has been cancelled
Compile Binaries / compile (push) Has been cancelled
golangci-lint / lint (push) Has been cancelled
Unit Tests / unit-test (push) Has been cancelled
Website Checks / markdown-link-check (push) Has been cancelled
Docs and Website Lint / website-generation (push) Has been cancelled
Docs and Website Lint / website-lint-spellcheck-tffmt (push) Has been cancelled
Docs and Website Lint / markdown-lint (push) Has been cancelled
983 lines
38 KiB
Go
983 lines
38 KiB
Go
package provider
|
|
|
|
import (
|
|
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
|
|
)
|
|
|
|
// resourceDockerService create a docker service
|
|
// https://docs.docker.com/engine/api/v1.32/#operation/ServiceCreate
|
|
func resourceDockerService() *schema.Resource {
|
|
return &schema.Resource{
|
|
Description: "This resource manages the lifecycle of a Docker service. By default, the creation, update and delete of services are detached.\n With the [Converge Config](#convergeconfig) the behavior of the `docker cli` is imitated to guarantee tha for example, all tasks of a service are running or successfully updated or to inform `terraform` that a service could no be updated and was successfully rolled back.",
|
|
|
|
CreateContext: resourceDockerServiceCreate,
|
|
ReadContext: resourceDockerServiceRead,
|
|
UpdateContext: resourceDockerServiceUpdate,
|
|
DeleteContext: resourceDockerServiceDelete,
|
|
Importer: &schema.ResourceImporter{
|
|
StateContext: schema.ImportStatePassthroughContext,
|
|
},
|
|
|
|
Schema: map[string]*schema.Schema{
|
|
"auth": {
|
|
Type: schema.TypeList,
|
|
Description: "Configuration for the authentication for pulling the images of the service",
|
|
Optional: true,
|
|
ForceNew: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"server_address": {
|
|
Type: schema.TypeString,
|
|
Description: "The address of the server for the authentication",
|
|
Required: true,
|
|
ForceNew: true,
|
|
},
|
|
"username": {
|
|
Type: schema.TypeString,
|
|
Description: "The username",
|
|
Optional: true,
|
|
ForceNew: true,
|
|
DefaultFunc: schema.EnvDefaultFunc("DOCKER_REGISTRY_USER", ""),
|
|
},
|
|
"password": {
|
|
Type: schema.TypeString,
|
|
Description: "The password",
|
|
Optional: true,
|
|
ForceNew: true,
|
|
DefaultFunc: schema.EnvDefaultFunc("DOCKER_REGISTRY_PASS", ""),
|
|
Sensitive: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"name": {
|
|
Type: schema.TypeString,
|
|
Description: "Name of the service",
|
|
Required: true,
|
|
ForceNew: true,
|
|
},
|
|
"labels": {
|
|
Type: schema.TypeSet,
|
|
Description: "User-defined key/value metadata",
|
|
Optional: true,
|
|
Computed: true,
|
|
Elem: labelSchemaUpdatable,
|
|
},
|
|
"task_spec": {
|
|
Type: schema.TypeList,
|
|
Description: "User modifiable task configuration",
|
|
MaxItems: 1,
|
|
Required: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"container_spec": {
|
|
Type: schema.TypeList,
|
|
Description: "The spec for each container",
|
|
Required: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"image": {
|
|
Type: schema.TypeString,
|
|
Description: "The image name to use for the containers of the service, like `nginx:1.17.6`. Also use the data-source or resource of `docker_image` with the `repo_digest` or `docker_registry_image` with the `name` attribute for this, as shown in the examples.",
|
|
Required: true,
|
|
},
|
|
"labels": {
|
|
Type: schema.TypeSet,
|
|
Description: "User-defined key/value metadata",
|
|
Optional: true,
|
|
Elem: labelSchema,
|
|
},
|
|
"command": {
|
|
Type: schema.TypeList,
|
|
Description: "The command/entrypoint to be run in the image. According to the [docker cli](https://github.com/docker/cli/blob/v20.10.7/cli/command/service/opts.go#L705) the override of the entrypoint is also passed to the `command` property and there is no `entrypoint` attribute in the `ContainerSpec` of the service.",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
"args": {
|
|
Type: schema.TypeList,
|
|
Description: "Arguments to the command",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
"hostname": {
|
|
Type: schema.TypeString,
|
|
Description: "The hostname to use for the container, as a valid RFC 1123 hostname",
|
|
Optional: true,
|
|
},
|
|
"env": {
|
|
Type: schema.TypeMap,
|
|
Description: "A list of environment variables in the form VAR=\"value\"",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
"dir": {
|
|
Type: schema.TypeString,
|
|
Description: "The working directory for commands to run in",
|
|
Optional: true,
|
|
},
|
|
"user": {
|
|
Type: schema.TypeString,
|
|
Description: "The user inside the container",
|
|
Optional: true,
|
|
},
|
|
"groups": {
|
|
Type: schema.TypeList,
|
|
Description: "A list of additional groups that the container process will run as",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
"privileges": {
|
|
Type: schema.TypeList,
|
|
Description: "Security options for the container",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"credential_spec": {
|
|
Type: schema.TypeList,
|
|
Description: "CredentialSpec for managed service account (Windows only)",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"file": {
|
|
Type: schema.TypeString,
|
|
Description: "Load credential spec from this file",
|
|
Optional: true,
|
|
},
|
|
"registry": {
|
|
Type: schema.TypeString,
|
|
Description: "Load credential spec from this value in the Windows registry",
|
|
Optional: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"se_linux_context": {
|
|
Type: schema.TypeList,
|
|
Description: "SELinux labels of the container",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"disable": {
|
|
Type: schema.TypeBool,
|
|
Description: "Disable SELinux",
|
|
Optional: true,
|
|
},
|
|
"user": {
|
|
Type: schema.TypeString,
|
|
Description: "SELinux user label",
|
|
Optional: true,
|
|
},
|
|
"role": {
|
|
Type: schema.TypeString,
|
|
Description: "SELinux role label",
|
|
Optional: true,
|
|
},
|
|
"type": {
|
|
Type: schema.TypeString,
|
|
Description: "SELinux type label",
|
|
Optional: true,
|
|
},
|
|
"level": {
|
|
Type: schema.TypeString,
|
|
Description: "SELinux level label",
|
|
Optional: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"read_only": {
|
|
Type: schema.TypeBool,
|
|
Description: "Mount the container's root filesystem as read only",
|
|
Optional: true,
|
|
},
|
|
"mounts": {
|
|
Type: schema.TypeSet,
|
|
Description: "Specification for mounts to be added to containers created as part of the service",
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"target": {
|
|
Type: schema.TypeString,
|
|
Description: "Container path",
|
|
Required: true,
|
|
},
|
|
"source": {
|
|
Type: schema.TypeString,
|
|
Description: "Mount source (e.g. a volume name, a host path)",
|
|
Optional: true,
|
|
},
|
|
"type": {
|
|
Type: schema.TypeString,
|
|
Description: "The mount type",
|
|
Required: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern(`^(bind|volume|tmpfs)$`),
|
|
},
|
|
"read_only": {
|
|
Type: schema.TypeBool,
|
|
Description: "Whether the mount should be read-only",
|
|
Optional: true,
|
|
},
|
|
"bind_options": {
|
|
Type: schema.TypeList,
|
|
Description: "Optional configuration for the bind type",
|
|
Optional: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"propagation": {
|
|
Type: schema.TypeString,
|
|
Description: "Bind propagation refers to whether or not mounts created within a given bind-mount or named volume can be propagated to replicas of that mount. See the [docs](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) for details. Defaults to `rprivate`",
|
|
Default: "rprivate",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern(`^(private|rprivate|shared|rshared|slave|rslave)$`),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"volume_options": {
|
|
Type: schema.TypeList,
|
|
Description: "Optional configuration for the volume type",
|
|
Optional: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"no_copy": {
|
|
Type: schema.TypeBool,
|
|
Description: "Populate volume with data from the target",
|
|
Optional: true,
|
|
},
|
|
"labels": {
|
|
Type: schema.TypeSet,
|
|
Description: "User-defined key/value metadata",
|
|
Optional: true,
|
|
Elem: labelSchema,
|
|
},
|
|
"driver_name": {
|
|
Type: schema.TypeString,
|
|
Description: "Name of the driver to use to create the volume",
|
|
Optional: true,
|
|
},
|
|
"driver_options": {
|
|
Type: schema.TypeMap,
|
|
Description: "key/value map of driver specific options",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"tmpfs_options": {
|
|
Type: schema.TypeList,
|
|
Description: "Optional configuration for the tmpfs type",
|
|
Optional: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"size_bytes": {
|
|
Type: schema.TypeInt,
|
|
Description: "The size for the tmpfs mount in bytes",
|
|
Optional: true,
|
|
},
|
|
"mode": {
|
|
Type: schema.TypeInt,
|
|
Description: "The permission mode for the tmpfs mount in an integer",
|
|
Optional: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"stop_signal": {
|
|
Type: schema.TypeString,
|
|
Description: "Signal to stop the container",
|
|
Optional: true,
|
|
},
|
|
"stop_grace_period": {
|
|
Type: schema.TypeString,
|
|
Description: "Amount of time to wait for the container to terminate before forcefully removing it (ms|s|m|h). If not specified or '0s' the destroy will not check if all tasks/containers of the service terminate.",
|
|
Optional: true,
|
|
Computed: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"healthcheck": {
|
|
Type: schema.TypeList,
|
|
Description: "A test to perform to check that the container is healthy. It works in the same way, and has the same default values, as the HEALTHCHECK Dockerfile instruction set by the service's Docker image. Your Compose file can override the values set in the Dockerfile.",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Computed: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"test": {
|
|
Type: schema.TypeList,
|
|
Description: "The test to perform as list",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
"interval": {
|
|
Type: schema.TypeString,
|
|
Description: "Time between running the check (ms|s|m|h). Defaults to `0s`.",
|
|
Default: "0s",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"timeout": {
|
|
Type: schema.TypeString,
|
|
Description: "Maximum time to allow one check to run (ms|s|m|h). Defaults to `0s`.",
|
|
Default: "0s",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"start_period": {
|
|
Type: schema.TypeString,
|
|
Description: "Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to `0s`.",
|
|
Default: "0s",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"retries": {
|
|
Type: schema.TypeInt,
|
|
Description: "Consecutive failures needed to report unhealthy. Defaults to `0`",
|
|
Default: 0,
|
|
Optional: true,
|
|
ValidateDiagFunc: validateIntegerGeqThan(0),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"hosts": {
|
|
Type: schema.TypeSet,
|
|
Description: "A list of hostname/IP mappings to add to the container's hosts file",
|
|
Optional: true,
|
|
ForceNew: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"ip": {
|
|
Type: schema.TypeString,
|
|
Description: "The ip of the host",
|
|
Required: true,
|
|
ForceNew: true,
|
|
},
|
|
|
|
"host": {
|
|
Type: schema.TypeString,
|
|
Description: "The name of the host",
|
|
Required: true,
|
|
ForceNew: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"dns_config": {
|
|
Type: schema.TypeList,
|
|
Description: "Specification for DNS related configurations in resolver configuration file (`resolv.conf`)",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Computed: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"nameservers": {
|
|
Type: schema.TypeList,
|
|
Description: "The IP addresses of the name servers",
|
|
Required: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
"search": {
|
|
Type: schema.TypeList,
|
|
Description: "A search list for host-name lookup",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
"options": {
|
|
Type: schema.TypeList,
|
|
Description: "A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.)",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"secrets": {
|
|
Type: schema.TypeSet,
|
|
Description: "References to zero or more secrets that will be exposed to the service",
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"secret_id": {
|
|
Type: schema.TypeString,
|
|
Description: "ID of the specific secret that we're referencing",
|
|
Required: true,
|
|
},
|
|
"secret_name": {
|
|
Type: schema.TypeString,
|
|
Description: "Name of the secret that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID",
|
|
Optional: true,
|
|
},
|
|
"file_name": {
|
|
Type: schema.TypeString,
|
|
Description: "Represents the final filename in the filesystem",
|
|
Required: true,
|
|
},
|
|
"file_uid": {
|
|
Type: schema.TypeString,
|
|
Description: "Represents the file UID. Defaults to `0`",
|
|
Default: "0",
|
|
Optional: true,
|
|
},
|
|
"file_gid": {
|
|
Type: schema.TypeString,
|
|
Description: "Represents the file GID. Defaults to `0`",
|
|
Default: "0",
|
|
Optional: true,
|
|
},
|
|
"file_mode": {
|
|
Type: schema.TypeInt,
|
|
Description: "Represents represents the FileMode of the file. Defaults to `0o444`",
|
|
Default: 0o444,
|
|
Optional: true,
|
|
ValidateDiagFunc: validateIntegerGeqThan(0),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"configs": {
|
|
Type: schema.TypeSet,
|
|
Description: "References to zero or more configs that will be exposed to the service",
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"config_id": {
|
|
Type: schema.TypeString,
|
|
Description: "ID of the specific config that we're referencing",
|
|
Required: true,
|
|
},
|
|
"config_name": {
|
|
Type: schema.TypeString,
|
|
Description: "Name of the config that this references, but this is just provided for lookup/display purposes. The config in the reference will be identified by its ID",
|
|
Optional: true,
|
|
},
|
|
"file_name": {
|
|
Type: schema.TypeString,
|
|
Description: "Represents the final filename in the filesystem",
|
|
Required: true,
|
|
},
|
|
"file_uid": {
|
|
Type: schema.TypeString,
|
|
Description: "Represents the file UID. Defaults to `0`.",
|
|
Default: "0",
|
|
Optional: true,
|
|
},
|
|
"file_gid": {
|
|
Type: schema.TypeString,
|
|
Description: "Represents the file GID. Defaults to `0`.",
|
|
Default: "0",
|
|
Optional: true,
|
|
},
|
|
"file_mode": {
|
|
Type: schema.TypeInt,
|
|
Description: "Represents represents the FileMode of the file. Defaults to `0o444`.",
|
|
Default: 0o444,
|
|
Optional: true,
|
|
ValidateDiagFunc: validateIntegerGeqThan(0),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"isolation": {
|
|
Type: schema.TypeString,
|
|
Description: "Isolation technology of the containers running the service. (Windows only). Defaults to `default`.",
|
|
Default: "default",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern(`^(default|process|hyperv)$`),
|
|
},
|
|
"sysctl": {
|
|
Type: schema.TypeMap,
|
|
Description: "Sysctls config (Linux only)",
|
|
Optional: true,
|
|
ForceNew: true,
|
|
},
|
|
"cap_add": {
|
|
Type: schema.TypeList,
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
Description: "List of Linux capabilities to add to the container",
|
|
},
|
|
"cap_drop": {
|
|
Type: schema.TypeList,
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
Description: "List of Linux capabilities to drop from the container",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"resources": {
|
|
Type: schema.TypeList,
|
|
Description: "Resource requirements which apply to each individual container created as part of the service",
|
|
Optional: true,
|
|
Computed: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"limits": {
|
|
Type: schema.TypeList,
|
|
Description: "Describes the resources which can be advertised by a node and requested by a task",
|
|
Optional: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"nano_cpus": {
|
|
Type: schema.TypeInt,
|
|
Description: "CPU shares in units of `1/1e9` (or `10^-9`) of the CPU. Should be at least `1000000`",
|
|
Optional: true,
|
|
},
|
|
"memory_bytes": {
|
|
Type: schema.TypeInt,
|
|
Description: "The amounf of memory in bytes the container allocates",
|
|
Optional: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"reservation": {
|
|
Type: schema.TypeList,
|
|
Description: "An object describing the resources which can be advertised by a node and requested by a task",
|
|
Optional: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"nano_cpus": {
|
|
Description: "CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least `1000000`",
|
|
Type: schema.TypeInt,
|
|
Optional: true,
|
|
},
|
|
"memory_bytes": {
|
|
Type: schema.TypeInt,
|
|
Description: "The amounf of memory in bytes the container allocates",
|
|
Optional: true,
|
|
},
|
|
"generic_resources": {
|
|
Type: schema.TypeList,
|
|
Description: "User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, GPU=UUID1)",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"named_resources_spec": {
|
|
Type: schema.TypeSet,
|
|
Description: "The String resources",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
"discrete_resources_spec": {
|
|
Type: schema.TypeSet,
|
|
Description: "The Integer resources",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"restart_policy": {
|
|
Type: schema.TypeList,
|
|
Description: "Specification for the restart policy which applies to containers created as part of this service.",
|
|
Optional: true,
|
|
Computed: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"condition": {
|
|
Type: schema.TypeString,
|
|
Description: "Condition for restart",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern(`^(none|on-failure|any)$`),
|
|
},
|
|
"delay": {
|
|
Type: schema.TypeString,
|
|
Description: "Delay between restart attempts (ms|s|m|h)",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"max_attempts": {
|
|
Type: schema.TypeInt,
|
|
Description: "Maximum attempts to restart a given container before giving up (default value is `0`, which is ignored)",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateIntegerGeqThan(0),
|
|
},
|
|
"window": {
|
|
Type: schema.TypeString,
|
|
Description: "The time window used to evaluate the restart policy (default value is `0`, which is unbounded) (ms|s|m|h)",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"placement": {
|
|
Type: schema.TypeList,
|
|
Description: "The placement preferences",
|
|
Optional: true,
|
|
Computed: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"constraints": {
|
|
Type: schema.TypeSet,
|
|
Description: "An array of constraints. e.g.: `node.role==manager`",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
Set: schema.HashString,
|
|
},
|
|
"prefs": {
|
|
Type: schema.TypeSet,
|
|
Description: "Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence, e.g.: `spread=node.role.manager`",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
Set: schema.HashString,
|
|
},
|
|
"max_replicas": {
|
|
Type: schema.TypeInt,
|
|
Description: "Maximum number of replicas for per node (default value is `0`, which is unlimited)",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateIntegerGeqThan(0),
|
|
},
|
|
"platforms": {
|
|
Type: schema.TypeSet,
|
|
Description: "Platforms stores all the platforms that the service's image can run on",
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"architecture": {
|
|
Type: schema.TypeString,
|
|
Description: "The architecture, e.g. `amd64`",
|
|
Required: true,
|
|
},
|
|
"os": {
|
|
Type: schema.TypeString,
|
|
Description: "The operation system, e.g. `linux`",
|
|
Required: true,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"force_update": {
|
|
Type: schema.TypeInt,
|
|
Description: "A counter that triggers an update even if no relevant parameters have been changed. See the [spec](https://github.com/docker/swarmkit/blob/master/api/specs.proto#L126).",
|
|
Optional: true,
|
|
Computed: true,
|
|
ValidateDiagFunc: validateIntegerGeqThan(0),
|
|
},
|
|
"runtime": {
|
|
Type: schema.TypeString,
|
|
Description: "Runtime is the type of runtime specified for the task executor. See the [types](https://github.com/moby/moby/blob/master/api/types/swarm/runtime.go).",
|
|
Optional: true,
|
|
Computed: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern("^(container|plugin)$"),
|
|
},
|
|
"networks_advanced": {
|
|
Type: schema.TypeSet,
|
|
Description: "The networks the container is attached to",
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"name": {
|
|
Type: schema.TypeString,
|
|
Description: "The name/id of the network.",
|
|
Required: true,
|
|
ForceNew: true,
|
|
},
|
|
"aliases": {
|
|
Type: schema.TypeSet,
|
|
Description: "The network aliases of the container in the specific network.",
|
|
Optional: true,
|
|
ForceNew: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
Set: schema.HashString,
|
|
},
|
|
"driver_opts": {
|
|
Type: schema.TypeSet,
|
|
Description: "An array of driver options for the network, e.g. `opts1=value`",
|
|
Optional: true,
|
|
ForceNew: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"log_driver": {
|
|
Type: schema.TypeList,
|
|
Description: "Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"name": {
|
|
Type: schema.TypeString,
|
|
Description: "The logging driver to use",
|
|
Required: true,
|
|
},
|
|
"options": {
|
|
Type: schema.TypeMap,
|
|
Description: "The options for the logging driver",
|
|
Optional: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"mode": {
|
|
Type: schema.TypeList,
|
|
Description: "Scheduling mode for the service",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Computed: true,
|
|
ForceNew: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"replicated": {
|
|
Type: schema.TypeList,
|
|
Description: "The replicated service mode",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Computed: true,
|
|
ConflictsWith: []string{"mode.0.global"},
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"replicas": {
|
|
Type: schema.TypeInt,
|
|
Description: "The amount of replicas of the service. Defaults to `1`",
|
|
Default: 1,
|
|
Optional: true,
|
|
ValidateDiagFunc: validateIntegerGeqThan(0),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"global": {
|
|
Type: schema.TypeBool,
|
|
Description: "The global service mode. Defaults to `false`",
|
|
Default: false,
|
|
Optional: true,
|
|
ConflictsWith: []string{"mode.0.replicated", "converge_config"},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"update_config": {
|
|
Type: schema.TypeList,
|
|
Description: "Specification for the update strategy of the service",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"parallelism": {
|
|
Type: schema.TypeInt,
|
|
Description: "Maximum number of tasks to be updated in one iteration. Defaults to `1`",
|
|
Default: 1,
|
|
Optional: true,
|
|
ValidateDiagFunc: validateIntegerGeqThan(0),
|
|
},
|
|
"delay": {
|
|
Type: schema.TypeString,
|
|
Description: "Delay between task updates `(ns|us|ms|s|m|h)`. Defaults to `0s`.",
|
|
Default: "0s",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"failure_action": {
|
|
Type: schema.TypeString,
|
|
Description: "Action on update failure: `pause`, `continue` or `rollback`. Defaults to `pause`.",
|
|
Default: "pause",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern("^(pause|continue|rollback)$"),
|
|
},
|
|
"monitor": {
|
|
Type: schema.TypeString,
|
|
Description: "Duration after each task update to monitor for failure (ns|us|ms|s|m|h). Defaults to `5s`.",
|
|
Default: "5s",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"max_failure_ratio": {
|
|
Type: schema.TypeString,
|
|
Description: "Failure rate to tolerate during an update. Defaults to `0.0`.",
|
|
Default: "0.0",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringIsFloatRatio(),
|
|
},
|
|
"order": {
|
|
Type: schema.TypeString,
|
|
Description: "Update order: either 'stop-first' or 'start-first'. Defaults to `stop-first`.",
|
|
Default: "stop-first",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern("^(stop-first|start-first)$"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"rollback_config": {
|
|
Type: schema.TypeList,
|
|
Description: "Specification for the rollback strategy of the service",
|
|
Optional: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"parallelism": {
|
|
Type: schema.TypeInt,
|
|
Description: "Maximum number of tasks to be rollbacked in one iteration. Defaults to `1`",
|
|
Default: 1,
|
|
Optional: true,
|
|
ValidateDiagFunc: validateIntegerGeqThan(0),
|
|
},
|
|
"delay": {
|
|
Type: schema.TypeString,
|
|
Description: "Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to `0s`.",
|
|
Default: "0s",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"failure_action": {
|
|
Type: schema.TypeString,
|
|
Description: "Action on rollback failure: pause | continue. Defaults to `pause`.",
|
|
Default: "pause",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern("(pause|continue)"),
|
|
},
|
|
"monitor": {
|
|
Type: schema.TypeString,
|
|
Description: "Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h). Defaults to `5s`.",
|
|
Default: "5s",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"max_failure_ratio": {
|
|
Type: schema.TypeString,
|
|
Description: "Failure rate to tolerate during a rollback. Defaults to `0.0`.",
|
|
Default: "0.0",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringIsFloatRatio(),
|
|
},
|
|
"order": {
|
|
Type: schema.TypeString,
|
|
Description: "Rollback order: either 'stop-first' or 'start-first'. Defaults to `stop-first`.",
|
|
Default: "stop-first",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern("(stop-first|start-first)"),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"endpoint_spec": {
|
|
Type: schema.TypeList,
|
|
Description: "Properties that can be configured to access and load balance a service",
|
|
Optional: true,
|
|
Computed: true,
|
|
MaxItems: 1,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"mode": {
|
|
Type: schema.TypeString,
|
|
Description: "The mode of resolution to use for internal load balancing between tasks",
|
|
Optional: true,
|
|
Computed: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern(`^(vip|dnsrr)$`),
|
|
},
|
|
"ports": {
|
|
Type: schema.TypeList,
|
|
Description: "List of exposed ports that this service is accessible on from the outside. Ports can only be provided if 'vip' resolution mode is used",
|
|
Optional: true,
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"name": {
|
|
Type: schema.TypeString,
|
|
Description: "A random name for the port",
|
|
Optional: true,
|
|
},
|
|
"protocol": {
|
|
Type: schema.TypeString,
|
|
Description: "Rrepresents the protocol of a port: `tcp`, `udp` or `sctp`. Defaults to `tcp`.",
|
|
Default: "tcp",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern(`^(tcp|udp|sctp)$`),
|
|
},
|
|
"target_port": {
|
|
Type: schema.TypeInt,
|
|
Description: "The port inside the container",
|
|
Required: true,
|
|
},
|
|
"published_port": {
|
|
Type: schema.TypeInt,
|
|
Description: "The port on the swarm hosts",
|
|
Optional: true,
|
|
Computed: true,
|
|
},
|
|
"publish_mode": {
|
|
Type: schema.TypeString,
|
|
Description: "Represents the mode in which the port is to be published: 'ingress' or 'host'. Defaults to `ingress`.",
|
|
Default: "ingress",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateStringMatchesPattern(`^(host|ingress)$`),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"converge_config": {
|
|
Type: schema.TypeList,
|
|
Description: "A configuration to ensure that a service converges aka reaches the desired that of all task up and running",
|
|
MaxItems: 1,
|
|
Optional: true,
|
|
ConflictsWith: []string{"mode.0.global"},
|
|
Elem: &schema.Resource{
|
|
Schema: map[string]*schema.Schema{
|
|
"delay": {
|
|
Type: schema.TypeString,
|
|
Description: "The interval to check if the desired state is reached `(ms|s)`. Defaults to `7s`.",
|
|
Default: "7s",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
"timeout": {
|
|
Type: schema.TypeString,
|
|
Description: "The timeout of the service to reach the desired state `(s|m)`. Defaults to `3m`",
|
|
Default: "3m",
|
|
Optional: true,
|
|
ValidateDiagFunc: validateDurationGeq0(),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
SchemaVersion: 2,
|
|
StateUpgraders: []schema.StateUpgrader{
|
|
{
|
|
Version: 1,
|
|
Type: resourceDockerServiceV1().CoreConfigSchema().ImpliedType(),
|
|
Upgrade: resourceDockerServiceStateUpgradeV2,
|
|
},
|
|
},
|
|
}
|
|
}
|