Docker v4.4.1, Sep 12 23

Docker v4.4.1 published on Tuesday, Sep 12, 2023 by Pulumi

docker.Service

Explore with Pulumi AI

Docker v4.4.1 published on Tuesday, Sep 12, 2023 by Pulumi

pulumi/pulumi-docker

Import

Example Assuming you created a `service` as follows #!/bin/bash docker service create –name foo -p 8080:80 nginx prints th ID 4pcphbxkfn2rffhbhe6czytgi you provide the definition for the resource as follows terraform resource “docker_service” “foo” {

name = “foo”

task_spec {

container_spec {

image = “nginx”

}

endpoint_spec {

ports {

target_port

= “80”

published_port = “8080”

}

} } then the import command is as follows #!/bin/bash

 $ pulumi import docker:index/service:Service foo 4pcphbxkfn2rffhbhe6czytgi

Create Service Resource

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            auth: Optional[ServiceAuthArgs] = None,
            converge_config: Optional[ServiceConvergeConfigArgs] = None,
            endpoint_spec: Optional[ServiceEndpointSpecArgs] = None,
            labels: Optional[Sequence[ServiceLabelArgs]] = None,
            mode: Optional[ServiceModeArgs] = None,
            name: Optional[str] = None,
            rollback_config: Optional[ServiceRollbackConfigArgs] = None,
            task_spec: Optional[ServiceTaskSpecArgs] = None,
            update_config: Optional[ServiceUpdateConfigArgs] = None)
@overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)

public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)

public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

type: docker:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Service Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Service resource accepts the following input properties:

TaskSpec ServiceTaskSpec: User modifiable task configuration
Auth ServiceAuth: Configuration for the authentication for pulling the images of the service
ConvergeConfig ServiceConvergeConfig: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
EndpointSpec ServiceEndpointSpec: Properties that can be configured to access and load balance a service
Labels List<ServiceLabel>: User-defined key/value metadata
Mode ServiceMode: Scheduling mode for the service
Name string: Name of the service
RollbackConfig ServiceRollbackConfig: Specification for the rollback strategy of the service
UpdateConfig ServiceUpdateConfig: Specification for the update strategy of the service

TaskSpec ServiceTaskSpecArgs: User modifiable task configuration
Auth ServiceAuthArgs: Configuration for the authentication for pulling the images of the service
ConvergeConfig ServiceConvergeConfigArgs: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
EndpointSpec ServiceEndpointSpecArgs: Properties that can be configured to access and load balance a service
Labels []ServiceLabelArgs: User-defined key/value metadata
Mode ServiceModeArgs: Scheduling mode for the service
Name string: Name of the service
RollbackConfig ServiceRollbackConfigArgs: Specification for the rollback strategy of the service
UpdateConfig ServiceUpdateConfigArgs: Specification for the update strategy of the service

taskSpec ServiceTaskSpec: User modifiable task configuration
auth ServiceAuth: Configuration for the authentication for pulling the images of the service
convergeConfig ServiceConvergeConfig: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
endpointSpec ServiceEndpointSpec: Properties that can be configured to access and load balance a service
labels List<ServiceLabel>: User-defined key/value metadata
mode ServiceMode: Scheduling mode for the service
name String: Name of the service
rollbackConfig ServiceRollbackConfig: Specification for the rollback strategy of the service
updateConfig ServiceUpdateConfig: Specification for the update strategy of the service

taskSpec ServiceTaskSpec: User modifiable task configuration
auth ServiceAuth: Configuration for the authentication for pulling the images of the service
convergeConfig ServiceConvergeConfig: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
endpointSpec ServiceEndpointSpec: Properties that can be configured to access and load balance a service
labels ServiceLabel[]: User-defined key/value metadata
mode ServiceMode: Scheduling mode for the service
name string: Name of the service
rollbackConfig ServiceRollbackConfig: Specification for the rollback strategy of the service
updateConfig ServiceUpdateConfig: Specification for the update strategy of the service

task_spec ServiceTaskSpecArgs: User modifiable task configuration
auth ServiceAuthArgs: Configuration for the authentication for pulling the images of the service
converge_config ServiceConvergeConfigArgs: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
endpoint_spec ServiceEndpointSpecArgs: Properties that can be configured to access and load balance a service
labels Sequence[ServiceLabelArgs]: User-defined key/value metadata
mode ServiceModeArgs: Scheduling mode for the service
name str: Name of the service
rollback_config ServiceRollbackConfigArgs: Specification for the rollback strategy of the service
update_config ServiceUpdateConfigArgs: Specification for the update strategy of the service

taskSpec Property Map: User modifiable task configuration
auth Property Map: Configuration for the authentication for pulling the images of the service
convergeConfig Property Map: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
endpointSpec Property Map: Properties that can be configured to access and load balance a service
labels List<Property Map>: User-defined key/value metadata
mode Property Map: Scheduling mode for the service
name String: Name of the service
rollbackConfig Property Map: Specification for the rollback strategy of the service
updateConfig Property Map: Specification for the update strategy of the service

Outputs

All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Service Resource

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth: Optional[ServiceAuthArgs] = None,
        converge_config: Optional[ServiceConvergeConfigArgs] = None,
        endpoint_spec: Optional[ServiceEndpointSpecArgs] = None,
        labels: Optional[Sequence[ServiceLabelArgs]] = None,
        mode: Optional[ServiceModeArgs] = None,
        name: Optional[str] = None,
        rollback_config: Optional[ServiceRollbackConfigArgs] = None,
        task_spec: Optional[ServiceTaskSpecArgs] = None,
        update_config: Optional[ServiceUpdateConfigArgs] = None) -> Service

func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)

public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)

public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Auth ServiceAuth: Configuration for the authentication for pulling the images of the service
ConvergeConfig ServiceConvergeConfig: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
EndpointSpec ServiceEndpointSpec: Properties that can be configured to access and load balance a service
Labels List<ServiceLabel>: User-defined key/value metadata
Mode ServiceMode: Scheduling mode for the service
Name string: Name of the service
RollbackConfig ServiceRollbackConfig: Specification for the rollback strategy of the service
TaskSpec ServiceTaskSpec: User modifiable task configuration
UpdateConfig ServiceUpdateConfig: Specification for the update strategy of the service

Auth ServiceAuthArgs: Configuration for the authentication for pulling the images of the service
ConvergeConfig ServiceConvergeConfigArgs: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
EndpointSpec ServiceEndpointSpecArgs: Properties that can be configured to access and load balance a service
Labels []ServiceLabelArgs: User-defined key/value metadata
Mode ServiceModeArgs: Scheduling mode for the service
Name string: Name of the service
RollbackConfig ServiceRollbackConfigArgs: Specification for the rollback strategy of the service
TaskSpec ServiceTaskSpecArgs: User modifiable task configuration
UpdateConfig ServiceUpdateConfigArgs: Specification for the update strategy of the service

auth ServiceAuth: Configuration for the authentication for pulling the images of the service
convergeConfig ServiceConvergeConfig: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
endpointSpec ServiceEndpointSpec: Properties that can be configured to access and load balance a service
labels List<ServiceLabel>: User-defined key/value metadata
mode ServiceMode: Scheduling mode for the service
name String: Name of the service
rollbackConfig ServiceRollbackConfig: Specification for the rollback strategy of the service
taskSpec ServiceTaskSpec: User modifiable task configuration
updateConfig ServiceUpdateConfig: Specification for the update strategy of the service

auth ServiceAuth: Configuration for the authentication for pulling the images of the service
convergeConfig ServiceConvergeConfig: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
endpointSpec ServiceEndpointSpec: Properties that can be configured to access and load balance a service
labels ServiceLabel[]: User-defined key/value metadata
mode ServiceMode: Scheduling mode for the service
name string: Name of the service
rollbackConfig ServiceRollbackConfig: Specification for the rollback strategy of the service
taskSpec ServiceTaskSpec: User modifiable task configuration
updateConfig ServiceUpdateConfig: Specification for the update strategy of the service

auth ServiceAuthArgs: Configuration for the authentication for pulling the images of the service
converge_config ServiceConvergeConfigArgs: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
endpoint_spec ServiceEndpointSpecArgs: Properties that can be configured to access and load balance a service
labels Sequence[ServiceLabelArgs]: User-defined key/value metadata
mode ServiceModeArgs: Scheduling mode for the service
name str: Name of the service
rollback_config ServiceRollbackConfigArgs: Specification for the rollback strategy of the service
task_spec ServiceTaskSpecArgs: User modifiable task configuration
update_config ServiceUpdateConfigArgs: Specification for the update strategy of the service

auth Property Map: Configuration for the authentication for pulling the images of the service
convergeConfig Property Map: A configuration to ensure that a service converges aka reaches the desired that of all task up and running
endpointSpec Property Map: Properties that can be configured to access and load balance a service
labels List<Property Map>: User-defined key/value metadata
mode Property Map: Scheduling mode for the service
name String: Name of the service
rollbackConfig Property Map: Specification for the rollback strategy of the service
taskSpec Property Map: User modifiable task configuration
updateConfig Property Map: Specification for the update strategy of the service

Supporting Types

ServiceAuth, ServiceAuthArgs

ServerAddress string: The address of the server for the authentication
Password string: The password
Username string: The username

ServerAddress string: The address of the server for the authentication
Password string: The password
Username string: The username

serverAddress String: The address of the server for the authentication
password String: The password
username String: The username

serverAddress string: The address of the server for the authentication
password string: The password
username string: The username

server_address str: The address of the server for the authentication
password str: The password
username str: The username

serverAddress String: The address of the server for the authentication
password String: The password
username String: The username

ServiceConvergeConfig, ServiceConvergeConfigArgs

Delay string: The interval to check if the desired state is reached (ms|s). Defaults to 7s.
Timeout string: The timeout of the service to reach the desired state (s|m). Defaults to 3m

Delay string: The interval to check if the desired state is reached (ms|s). Defaults to 7s.
Timeout string: The timeout of the service to reach the desired state (s|m). Defaults to 3m

delay String: The interval to check if the desired state is reached (ms|s). Defaults to 7s.
timeout String: The timeout of the service to reach the desired state (s|m). Defaults to 3m

delay string: The interval to check if the desired state is reached (ms|s). Defaults to 7s.
timeout string: The timeout of the service to reach the desired state (s|m). Defaults to 3m

delay str: The interval to check if the desired state is reached (ms|s). Defaults to 7s.
timeout str: The timeout of the service to reach the desired state (s|m). Defaults to 3m

delay String: The interval to check if the desired state is reached (ms|s). Defaults to 7s.
timeout String: The timeout of the service to reach the desired state (s|m). Defaults to 3m

ServiceEndpointSpec, ServiceEndpointSpecArgs

Mode string: The mode of resolution to use for internal load balancing between tasks
Ports List<ServiceEndpointSpecPort>: List of exposed ports that this service is accessible on from the outside. Ports can only be provided if 'vip' resolution mode is used

Mode string: The mode of resolution to use for internal load balancing between tasks
Ports []ServiceEndpointSpecPort: List of exposed ports that this service is accessible on from the outside. Ports can only be provided if 'vip' resolution mode is used

mode String: The mode of resolution to use for internal load balancing between tasks
ports List<ServiceEndpointSpecPort>: List of exposed ports that this service is accessible on from the outside. Ports can only be provided if 'vip' resolution mode is used

mode string: The mode of resolution to use for internal load balancing between tasks
ports ServiceEndpointSpecPort[]: List of exposed ports that this service is accessible on from the outside. Ports can only be provided if 'vip' resolution mode is used

mode str: The mode of resolution to use for internal load balancing between tasks
ports Sequence[ServiceEndpointSpecPort]: List of exposed ports that this service is accessible on from the outside. Ports can only be provided if 'vip' resolution mode is used

mode String: The mode of resolution to use for internal load balancing between tasks
ports List<Property Map>: List of exposed ports that this service is accessible on from the outside. Ports can only be provided if 'vip' resolution mode is used

ServiceEndpointSpecPort, ServiceEndpointSpecPortArgs

TargetPort int
Name string: Name of the service
Protocol string
PublishMode string
PublishedPort int

TargetPort int
Name string: Name of the service
Protocol string
PublishMode string
PublishedPort int

targetPort Integer
name String: Name of the service
protocol String
publishMode String
publishedPort Integer

targetPort number
name string: Name of the service
protocol string
publishMode string
publishedPort number

target_port int
name str: Name of the service
protocol str
publish_mode str
published_port int

targetPort Number
name String: Name of the service
protocol String
publishMode String
publishedPort Number

ServiceLabel, ServiceLabelArgs

Label string: Name of the label
Value string: Value of the label

Label string: Name of the label
Value string: Value of the label

label String: Name of the label
value String: Value of the label

label string: Name of the label
value string: Value of the label

label str: Name of the label
value str: Value of the label

label String: Name of the label
value String: Value of the label

ServiceMode, ServiceModeArgs

Global bool: The global service mode. Defaults to false
Replicated ServiceModeReplicated: The replicated service mode

Global bool: The global service mode. Defaults to false
Replicated ServiceModeReplicated: The replicated service mode

global Boolean: The global service mode. Defaults to false
replicated ServiceModeReplicated: The replicated service mode

global boolean: The global service mode. Defaults to false
replicated ServiceModeReplicated: The replicated service mode

global_ bool: The global service mode. Defaults to false
replicated ServiceModeReplicated: The replicated service mode

global Boolean: The global service mode. Defaults to false
replicated Property Map: The replicated service mode

ServiceModeReplicated, ServiceModeReplicatedArgs

Replicas int

Replicas int

replicas Integer

replicas number

replicas int

replicas Number

ServiceRollbackConfig, ServiceRollbackConfigArgs

Delay string: Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to 0s.
FailureAction string: Action on rollback failure: pause | continue. Defaults to pause.
MaxFailureRatio string: Failure rate to tolerate during a rollback. Defaults to 0.0.
Monitor string: Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
Order string: Rollback order: either 'stop-first' or 'start-first'. Defaults to stop-first.
Parallelism int: Maximum number of tasks to be rollbacked in one iteration. Defaults to 1

Delay string: Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to 0s.
FailureAction string: Action on rollback failure: pause | continue. Defaults to pause.
MaxFailureRatio string: Failure rate to tolerate during a rollback. Defaults to 0.0.
Monitor string: Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
Order string: Rollback order: either 'stop-first' or 'start-first'. Defaults to stop-first.
Parallelism int: Maximum number of tasks to be rollbacked in one iteration. Defaults to 1

delay String: Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to 0s.
failureAction String: Action on rollback failure: pause | continue. Defaults to pause.
maxFailureRatio String: Failure rate to tolerate during a rollback. Defaults to 0.0.
monitor String: Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
order String: Rollback order: either 'stop-first' or 'start-first'. Defaults to stop-first.
parallelism Integer: Maximum number of tasks to be rollbacked in one iteration. Defaults to 1

delay string: Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to 0s.
failureAction string: Action on rollback failure: pause | continue. Defaults to pause.
maxFailureRatio string: Failure rate to tolerate during a rollback. Defaults to 0.0.
monitor string: Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
order string: Rollback order: either 'stop-first' or 'start-first'. Defaults to stop-first.
parallelism number: Maximum number of tasks to be rollbacked in one iteration. Defaults to 1

delay str: Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to 0s.
failure_action str: Action on rollback failure: pause | continue. Defaults to pause.
max_failure_ratio str: Failure rate to tolerate during a rollback. Defaults to 0.0.
monitor str: Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
order str: Rollback order: either 'stop-first' or 'start-first'. Defaults to stop-first.
parallelism int: Maximum number of tasks to be rollbacked in one iteration. Defaults to 1

delay String: Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to 0s.
failureAction String: Action on rollback failure: pause | continue. Defaults to pause.
maxFailureRatio String: Failure rate to tolerate during a rollback. Defaults to 0.0.
monitor String: Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
order String: Rollback order: either 'stop-first' or 'start-first'. Defaults to stop-first.
parallelism Number: Maximum number of tasks to be rollbacked in one iteration. Defaults to 1

ServiceTaskSpec, ServiceTaskSpecArgs

ContainerSpec ServiceTaskSpecContainerSpec: The spec for each container
ForceUpdate int: A counter that triggers an update even if no relevant parameters have been changed. See the spec.
LogDriver ServiceTaskSpecLogDriver: 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
NetworksAdvanceds List<ServiceTaskSpecNetworksAdvanced>: The networks the container is attached to
Placement ServiceTaskSpecPlacement: The placement preferences
Resources ServiceTaskSpecResources: Resource requirements which apply to each individual container created as part of the service
RestartPolicy ServiceTaskSpecRestartPolicy: Specification for the restart policy which applies to containers created as part of this service.
Runtime string: Runtime is the type of runtime specified for the task executor. See the types.

ContainerSpec ServiceTaskSpecContainerSpec: The spec for each container
ForceUpdate int: A counter that triggers an update even if no relevant parameters have been changed. See the spec.
LogDriver ServiceTaskSpecLogDriver: 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
NetworksAdvanceds []ServiceTaskSpecNetworksAdvanced: The networks the container is attached to
Placement ServiceTaskSpecPlacement: The placement preferences
Resources ServiceTaskSpecResources: Resource requirements which apply to each individual container created as part of the service
RestartPolicy ServiceTaskSpecRestartPolicy: Specification for the restart policy which applies to containers created as part of this service.
Runtime string: Runtime is the type of runtime specified for the task executor. See the types.

containerSpec ServiceTaskSpecContainerSpec: The spec for each container
forceUpdate Integer: A counter that triggers an update even if no relevant parameters have been changed. See the spec.
logDriver ServiceTaskSpecLogDriver: 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
networksAdvanceds List<ServiceTaskSpecNetworksAdvanced>: The networks the container is attached to
placement ServiceTaskSpecPlacement: The placement preferences
resources ServiceTaskSpecResources: Resource requirements which apply to each individual container created as part of the service
restartPolicy ServiceTaskSpecRestartPolicy: Specification for the restart policy which applies to containers created as part of this service.
runtime String: Runtime is the type of runtime specified for the task executor. See the types.

containerSpec ServiceTaskSpecContainerSpec: The spec for each container
forceUpdate number: A counter that triggers an update even if no relevant parameters have been changed. See the spec.
logDriver ServiceTaskSpecLogDriver: 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
networksAdvanceds ServiceTaskSpecNetworksAdvanced[]: The networks the container is attached to
placement ServiceTaskSpecPlacement: The placement preferences
resources ServiceTaskSpecResources: Resource requirements which apply to each individual container created as part of the service
restartPolicy ServiceTaskSpecRestartPolicy: Specification for the restart policy which applies to containers created as part of this service.
runtime string: Runtime is the type of runtime specified for the task executor. See the types.

container_spec ServiceTaskSpecContainerSpec: The spec for each container
force_update int: A counter that triggers an update even if no relevant parameters have been changed. See the spec.
log_driver ServiceTaskSpecLogDriver: 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
networks_advanceds Sequence[ServiceTaskSpecNetworksAdvanced]: The networks the container is attached to
placement ServiceTaskSpecPlacement: The placement preferences
resources ServiceTaskSpecResources: Resource requirements which apply to each individual container created as part of the service
restart_policy ServiceTaskSpecRestartPolicy: Specification for the restart policy which applies to containers created as part of this service.
runtime str: Runtime is the type of runtime specified for the task executor. See the types.

containerSpec Property Map: The spec for each container
forceUpdate Number: A counter that triggers an update even if no relevant parameters have been changed. See the spec.
logDriver Property Map: 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
networksAdvanceds List<Property Map>: The networks the container is attached to
placement Property Map: The placement preferences
resources Property Map: Resource requirements which apply to each individual container created as part of the service
restartPolicy Property Map: Specification for the restart policy which applies to containers created as part of this service.
runtime String: Runtime is the type of runtime specified for the task executor. See the types.

ServiceTaskSpecContainerSpec, ServiceTaskSpecContainerSpecArgs

Image string
Args List<string>
Commands List<string>
Configs List<ServiceTaskSpecContainerSpecConfig>
Dir string
DnsConfig ServiceTaskSpecContainerSpecDnsConfig
Env Dictionary<string, string>
Groups List<string>
Healthcheck ServiceTaskSpecContainerSpecHealthcheck
Hostname string
Hosts List<ServiceTaskSpecContainerSpecHost>
Isolation string
Labels List<ServiceTaskSpecContainerSpecLabel>: User-defined key/value metadata
Mounts List<ServiceTaskSpecContainerSpecMount>
Privileges ServiceTaskSpecContainerSpecPrivileges
ReadOnly bool
Secrets List<ServiceTaskSpecContainerSpecSecret>
StopGracePeriod string
StopSignal string
Sysctl Dictionary<string, object>
User string

Image string
Args []string
Commands []string
Configs []ServiceTaskSpecContainerSpecConfig
Dir string
DnsConfig ServiceTaskSpecContainerSpecDnsConfig
Env map[string]string
Groups []string
Healthcheck ServiceTaskSpecContainerSpecHealthcheck
Hostname string
Hosts []ServiceTaskSpecContainerSpecHost
Isolation string
Labels []ServiceTaskSpecContainerSpecLabel: User-defined key/value metadata
Mounts []ServiceTaskSpecContainerSpecMount
Privileges ServiceTaskSpecContainerSpecPrivileges
ReadOnly bool
Secrets []ServiceTaskSpecContainerSpecSecret
StopGracePeriod string
StopSignal string
Sysctl map[string]interface{}
User string

image String
args List<String>
commands List<String>
configs List<ServiceTaskSpecContainerSpecConfig>
dir String
dnsConfig ServiceTaskSpecContainerSpecDnsConfig
env Map<String,String>
groups List<String>
healthcheck ServiceTaskSpecContainerSpecHealthcheck
hostname String
hosts List<ServiceTaskSpecContainerSpecHost>
isolation String
labels List<ServiceTaskSpecContainerSpecLabel>: User-defined key/value metadata
mounts List<ServiceTaskSpecContainerSpecMount>
privileges ServiceTaskSpecContainerSpecPrivileges
readOnly Boolean
secrets List<ServiceTaskSpecContainerSpecSecret>
stopGracePeriod String
stopSignal String
sysctl Map<String,Object>
user String

image string
args string[]
commands string[]
configs ServiceTaskSpecContainerSpecConfig[]
dir string
dnsConfig ServiceTaskSpecContainerSpecDnsConfig
env {[key: string]: string}
groups string[]
healthcheck ServiceTaskSpecContainerSpecHealthcheck
hostname string
hosts ServiceTaskSpecContainerSpecHost[]
isolation string
labels ServiceTaskSpecContainerSpecLabel[]: User-defined key/value metadata
mounts ServiceTaskSpecContainerSpecMount[]
privileges ServiceTaskSpecContainerSpecPrivileges
readOnly boolean
secrets ServiceTaskSpecContainerSpecSecret[]
stopGracePeriod string
stopSignal string
sysctl {[key: string]: any}
user string

image str
args Sequence[str]
commands Sequence[str]
configs Sequence[ServiceTaskSpecContainerSpecConfig]
dir str
dns_config ServiceTaskSpecContainerSpecDnsConfig
env Mapping[str, str]
groups Sequence[str]
healthcheck ServiceTaskSpecContainerSpecHealthcheck
hostname str
hosts Sequence[ServiceTaskSpecContainerSpecHost]
isolation str
labels Sequence[ServiceTaskSpecContainerSpecLabel]: User-defined key/value metadata
mounts Sequence[ServiceTaskSpecContainerSpecMount]
privileges ServiceTaskSpecContainerSpecPrivileges
read_only bool
secrets Sequence[ServiceTaskSpecContainerSpecSecret]
stop_grace_period str
stop_signal str
sysctl Mapping[str, Any]
user str

image String
args List<String>
commands List<String>
configs List<Property Map>
dir String
dnsConfig Property Map
env Map<String>
groups List<String>
healthcheck Property Map
hostname String
hosts List<Property Map>
isolation String
labels List<Property Map>: User-defined key/value metadata
mounts List<Property Map>
privileges Property Map
readOnly Boolean
secrets List<Property Map>
stopGracePeriod String
stopSignal String
sysctl Map<Any>
user String

ServiceTaskSpecContainerSpecConfig, ServiceTaskSpecContainerSpecConfigArgs

ConfigId string
FileName string
ConfigName string
FileGid string
FileMode int
FileUid string

ConfigId string
FileName string
ConfigName string
FileGid string
FileMode int
FileUid string

configId String
fileName String
configName String
fileGid String
fileMode Integer
fileUid String

configId string
fileName string
configName string
fileGid string
fileMode number
fileUid string

config_id str
file_name str
config_name str
file_gid str
file_mode int
file_uid str

configId String
fileName String
configName String
fileGid String
fileMode Number
fileUid String

ServiceTaskSpecContainerSpecDnsConfig, ServiceTaskSpecContainerSpecDnsConfigArgs

Nameservers List<string>
Options List<string>
Searches List<string>

Nameservers []string
Options []string
Searches []string

nameservers List<String>
options List<String>
searches List<String>

nameservers string[]
options string[]
searches string[]

nameservers Sequence[str]
options Sequence[str]
searches Sequence[str]

nameservers List<String>
options List<String>
searches List<String>

ServiceTaskSpecContainerSpecHealthcheck, ServiceTaskSpecContainerSpecHealthcheckArgs

Tests List<string>
Interval string
Retries int
StartPeriod string
Timeout string

Tests []string
Interval string
Retries int
StartPeriod string
Timeout string

tests List<String>
interval String
retries Integer
startPeriod String
timeout String

tests string[]
interval string
retries number
startPeriod string
timeout string

tests Sequence[str]
interval str
retries int
start_period str
timeout str

tests List<String>
interval String
retries Number
startPeriod String
timeout String

ServiceTaskSpecContainerSpecHost, ServiceTaskSpecContainerSpecHostArgs

Host string
Ip string

Host string
Ip string

host String
ip String

host string
ip string

host str
ip str

host String
ip String

ServiceTaskSpecContainerSpecLabel, ServiceTaskSpecContainerSpecLabelArgs

Label string: Name of the label
Value string: Value of the label

Label string: Name of the label
Value string: Value of the label

label String: Name of the label
value String: Value of the label

label string: Name of the label
value string: Value of the label

label str: Name of the label
value str: Value of the label

label String: Name of the label
value String: Value of the label

ServiceTaskSpecContainerSpecMount, ServiceTaskSpecContainerSpecMountArgs

Target string
Type string
BindOptions ServiceTaskSpecContainerSpecMountBindOptions
ReadOnly bool
Source string
TmpfsOptions ServiceTaskSpecContainerSpecMountTmpfsOptions
VolumeOptions ServiceTaskSpecContainerSpecMountVolumeOptions

Target string
Type string
BindOptions ServiceTaskSpecContainerSpecMountBindOptions
ReadOnly bool
Source string
TmpfsOptions ServiceTaskSpecContainerSpecMountTmpfsOptions
VolumeOptions ServiceTaskSpecContainerSpecMountVolumeOptions

target String
type String
bindOptions ServiceTaskSpecContainerSpecMountBindOptions
readOnly Boolean
source String
tmpfsOptions ServiceTaskSpecContainerSpecMountTmpfsOptions
volumeOptions ServiceTaskSpecContainerSpecMountVolumeOptions

target string
type string
bindOptions ServiceTaskSpecContainerSpecMountBindOptions
readOnly boolean
source string
tmpfsOptions ServiceTaskSpecContainerSpecMountTmpfsOptions
volumeOptions ServiceTaskSpecContainerSpecMountVolumeOptions

target str
type str
bind_options ServiceTaskSpecContainerSpecMountBindOptions
read_only bool
source str
tmpfs_options ServiceTaskSpecContainerSpecMountTmpfsOptions
volume_options ServiceTaskSpecContainerSpecMountVolumeOptions

target String
type String
bindOptions Property Map
readOnly Boolean
source String
tmpfsOptions Property Map
volumeOptions Property Map

ServiceTaskSpecContainerSpecMountBindOptions, ServiceTaskSpecContainerSpecMountBindOptionsArgs

Propagation string

Propagation string

propagation String

propagation string

propagation str

propagation String

ServiceTaskSpecContainerSpecMountTmpfsOptions, ServiceTaskSpecContainerSpecMountTmpfsOptionsArgs

Mode int: Scheduling mode for the service
SizeBytes int

Mode int: Scheduling mode for the service
SizeBytes int

mode Integer: Scheduling mode for the service
sizeBytes Integer

mode number: Scheduling mode for the service
sizeBytes number

mode int: Scheduling mode for the service
size_bytes int

mode Number: Scheduling mode for the service
sizeBytes Number

ServiceTaskSpecContainerSpecMountVolumeOptions, ServiceTaskSpecContainerSpecMountVolumeOptionsArgs

DriverName string
DriverOptions Dictionary<string, string>
Labels List<ServiceTaskSpecContainerSpecMountVolumeOptionsLabel>: User-defined key/value metadata
NoCopy bool

DriverName string
DriverOptions map[string]string
Labels []ServiceTaskSpecContainerSpecMountVolumeOptionsLabel: User-defined key/value metadata
NoCopy bool

driverName String
driverOptions Map<String,String>
labels List<ServiceTaskSpecContainerSpecMountVolumeOptionsLabel>: User-defined key/value metadata
noCopy Boolean

driverName string
driverOptions {[key: string]: string}
labels ServiceTaskSpecContainerSpecMountVolumeOptionsLabel[]: User-defined key/value metadata
noCopy boolean

driver_name str
driver_options Mapping[str, str]
labels Sequence[ServiceTaskSpecContainerSpecMountVolumeOptionsLabel]: User-defined key/value metadata
no_copy bool

driverName String
driverOptions Map<String>
labels List<Property Map>: User-defined key/value metadata
noCopy Boolean

ServiceTaskSpecContainerSpecMountVolumeOptionsLabel, ServiceTaskSpecContainerSpecMountVolumeOptionsLabelArgs

Label string: Name of the label
Value string: Value of the label

Label string: Name of the label
Value string: Value of the label

label String: Name of the label
value String: Value of the label

label string: Name of the label
value string: Value of the label

label str: Name of the label
value str: Value of the label

label String: Name of the label
value String: Value of the label

ServiceTaskSpecContainerSpecPrivileges, ServiceTaskSpecContainerSpecPrivilegesArgs

CredentialSpec ServiceTaskSpecContainerSpecPrivilegesCredentialSpec
SeLinuxContext ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext

CredentialSpec ServiceTaskSpecContainerSpecPrivilegesCredentialSpec
SeLinuxContext ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext

credentialSpec ServiceTaskSpecContainerSpecPrivilegesCredentialSpec
seLinuxContext ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext

credentialSpec ServiceTaskSpecContainerSpecPrivilegesCredentialSpec
seLinuxContext ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext

credential_spec ServiceTaskSpecContainerSpecPrivilegesCredentialSpec
se_linux_context ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext

credentialSpec Property Map
seLinuxContext Property Map

ServiceTaskSpecContainerSpecPrivilegesCredentialSpec, ServiceTaskSpecContainerSpecPrivilegesCredentialSpecArgs

File string
Registry string

File string
Registry string

file String
registry String

file string
registry string

file str
registry str

file String
registry String

ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext, ServiceTaskSpecContainerSpecPrivilegesSeLinuxContextArgs

Disable bool
Level string
Role string
Type string
User string

Disable bool
Level string
Role string
Type string
User string

disable Boolean
level String
role String
type String
user String

disable boolean
level string
role string
type string
user string

disable bool
level str
role str
type str
user str

disable Boolean
level String
role String
type String
user String

ServiceTaskSpecContainerSpecSecret, ServiceTaskSpecContainerSpecSecretArgs

FileName string
SecretId string
FileGid string
FileMode int
FileUid string
SecretName string

FileName string
SecretId string
FileGid string
FileMode int
FileUid string
SecretName string

fileName String
secretId String
fileGid String
fileMode Integer
fileUid String
secretName String

fileName string
secretId string
fileGid string
fileMode number
fileUid string
secretName string

file_name str
secret_id str
file_gid str
file_mode int
file_uid str
secret_name str

fileName String
secretId String
fileGid String
fileMode Number
fileUid String
secretName String

ServiceTaskSpecLogDriver, ServiceTaskSpecLogDriverArgs

Name string: Name of the service
Options Dictionary<string, string>

Name string: Name of the service
Options map[string]string

name String: Name of the service
options Map<String,String>

name string: Name of the service
options {[key: string]: string}

name str: Name of the service
options Mapping[str, str]

name String: Name of the service
options Map<String>

ServiceTaskSpecNetworksAdvanced, ServiceTaskSpecNetworksAdvancedArgs

Name string: Name of the service
Aliases List<string>
DriverOpts List<string>

Name string: Name of the service
Aliases []string
DriverOpts []string

name String: Name of the service
aliases List<String>
driverOpts List<String>

name string: Name of the service
aliases string[]
driverOpts string[]

name str: Name of the service
aliases Sequence[str]
driver_opts Sequence[str]

name String: Name of the service
aliases List<String>
driverOpts List<String>

ServiceTaskSpecPlacement, ServiceTaskSpecPlacementArgs

Constraints List<string>
MaxReplicas int
Platforms List<ServiceTaskSpecPlacementPlatform>
Prefs List<string>

Constraints []string
MaxReplicas int
Platforms []ServiceTaskSpecPlacementPlatform
Prefs []string

constraints List<String>
maxReplicas Integer
platforms List<ServiceTaskSpecPlacementPlatform>
prefs List<String>

constraints string[]
maxReplicas number
platforms ServiceTaskSpecPlacementPlatform[]
prefs string[]

constraints Sequence[str]
max_replicas int
platforms Sequence[ServiceTaskSpecPlacementPlatform]
prefs Sequence[str]

constraints List<String>
maxReplicas Number
platforms List<Property Map>
prefs List<String>

ServiceTaskSpecPlacementPlatform, ServiceTaskSpecPlacementPlatformArgs

Architecture string
Os string

Architecture string
Os string

architecture String
os String

architecture string
os string

architecture str
os str

architecture String
os String

ServiceTaskSpecResourcesReservationGenericResources, ServiceTaskSpecResourcesReservationGenericResourcesArgs

DiscreteResourcesSpecs List<string>
NamedResourcesSpecs List<string>

DiscreteResourcesSpecs []string
NamedResourcesSpecs []string

discreteResourcesSpecs List<String>
namedResourcesSpecs List<String>

discreteResourcesSpecs string[]
namedResourcesSpecs string[]

discrete_resources_specs Sequence[str]
named_resources_specs Sequence[str]

discreteResourcesSpecs List<String>
namedResourcesSpecs List<String>

ServiceTaskSpecRestartPolicy, ServiceTaskSpecRestartPolicyArgs

Condition string
Delay string
MaxAttempts int
Window string

Condition string
Delay string
MaxAttempts int
Window string

condition String
delay String
maxAttempts Integer
window String

condition string
delay string
maxAttempts number
window string

condition str
delay str
max_attempts int
window str

condition String
delay String
maxAttempts Number
window String

ServiceUpdateConfig, ServiceUpdateConfigArgs

Delay string: Delay between task updates (ns|us|ms|s|m|h). Defaults to 0s.
FailureAction string: Action on update failure: pause, continue or rollback. Defaults to pause.
MaxFailureRatio string: Failure rate to tolerate during an update. Defaults to 0.0.
Monitor string: Duration after each task update to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
Order string: Update order: either 'stop-first' or 'start-first'. Defaults to stop-first.
Parallelism int: Maximum number of tasks to be updated in one iteration. Defaults to 1

Delay string: Delay between task updates (ns|us|ms|s|m|h). Defaults to 0s.
FailureAction string: Action on update failure: pause, continue or rollback. Defaults to pause.
MaxFailureRatio string: Failure rate to tolerate during an update. Defaults to 0.0.
Monitor string: Duration after each task update to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
Order string: Update order: either 'stop-first' or 'start-first'. Defaults to stop-first.
Parallelism int: Maximum number of tasks to be updated in one iteration. Defaults to 1

delay String: Delay between task updates (ns|us|ms|s|m|h). Defaults to 0s.
failureAction String: Action on update failure: pause, continue or rollback. Defaults to pause.
maxFailureRatio String: Failure rate to tolerate during an update. Defaults to 0.0.
monitor String: Duration after each task update to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
order String: Update order: either 'stop-first' or 'start-first'. Defaults to stop-first.
parallelism Integer: Maximum number of tasks to be updated in one iteration. Defaults to 1

delay string: Delay between task updates (ns|us|ms|s|m|h). Defaults to 0s.
failureAction string: Action on update failure: pause, continue or rollback. Defaults to pause.
maxFailureRatio string: Failure rate to tolerate during an update. Defaults to 0.0.
monitor string: Duration after each task update to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
order string: Update order: either 'stop-first' or 'start-first'. Defaults to stop-first.
parallelism number: Maximum number of tasks to be updated in one iteration. Defaults to 1

delay str: Delay between task updates (ns|us|ms|s|m|h). Defaults to 0s.
failure_action str: Action on update failure: pause, continue or rollback. Defaults to pause.
max_failure_ratio str: Failure rate to tolerate during an update. Defaults to 0.0.
monitor str: Duration after each task update to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
order str: Update order: either 'stop-first' or 'start-first'. Defaults to stop-first.
parallelism int: Maximum number of tasks to be updated in one iteration. Defaults to 1

delay String: Delay between task updates (ns|us|ms|s|m|h). Defaults to 0s.
failureAction String: Action on update failure: pause, continue or rollback. Defaults to pause.
maxFailureRatio String: Failure rate to tolerate during an update. Defaults to 0.0.
monitor String: Duration after each task update to monitor for failure (ns|us|ms|s|m|h). Defaults to 5s.
order String: Update order: either 'stop-first' or 'start-first'. Defaults to stop-first.
parallelism Number: Maximum number of tasks to be updated in one iteration. Defaults to 1

Package Details

Repository: Docker pulumi/pulumi-docker
License: Apache-2.0
Notes: This Pulumi package is based on the docker Terraform Provider.

Docker v4.4.1 published on Tuesday, Sep 12, 2023 by Pulumi

pulumi/pulumi-docker

docker.Service

On this page

On this page

Import

Example Assuming you created a service as follows #!/bin/bash docker service create –name foo -p 8080:80 nginx prints th ID 4pcphbxkfn2rffhbhe6czytgi you provide the definition for the resource as follows terraform resource “docker_service” “foo” {

Create Service Resource

Service Resource Properties

Inputs

Outputs

Look up Existing Service Resource

Supporting Types

ServiceAuth, ServiceAuthArgs

ServiceConvergeConfig, ServiceConvergeConfigArgs

ServiceEndpointSpec, ServiceEndpointSpecArgs

ServiceEndpointSpecPort, ServiceEndpointSpecPortArgs

ServiceLabel, ServiceLabelArgs

ServiceMode, ServiceModeArgs

ServiceModeReplicated, ServiceModeReplicatedArgs

ServiceRollbackConfig, ServiceRollbackConfigArgs

ServiceTaskSpec, ServiceTaskSpecArgs

ServiceTaskSpecContainerSpec, ServiceTaskSpecContainerSpecArgs

ServiceTaskSpecContainerSpecConfig, ServiceTaskSpecContainerSpecConfigArgs

ServiceTaskSpecContainerSpecDnsConfig, ServiceTaskSpecContainerSpecDnsConfigArgs

ServiceTaskSpecContainerSpecHealthcheck, ServiceTaskSpecContainerSpecHealthcheckArgs

ServiceTaskSpecContainerSpecHost, ServiceTaskSpecContainerSpecHostArgs

ServiceTaskSpecContainerSpecLabel, ServiceTaskSpecContainerSpecLabelArgs

ServiceTaskSpecContainerSpecMount, ServiceTaskSpecContainerSpecMountArgs

ServiceTaskSpecContainerSpecMountBindOptions, ServiceTaskSpecContainerSpecMountBindOptionsArgs

ServiceTaskSpecContainerSpecMountTmpfsOptions, ServiceTaskSpecContainerSpecMountTmpfsOptionsArgs

ServiceTaskSpecContainerSpecMountVolumeOptions, ServiceTaskSpecContainerSpecMountVolumeOptionsArgs

ServiceTaskSpecContainerSpecMountVolumeOptionsLabel, ServiceTaskSpecContainerSpecMountVolumeOptionsLabelArgs

ServiceTaskSpecContainerSpecPrivileges, ServiceTaskSpecContainerSpecPrivilegesArgs

ServiceTaskSpecContainerSpecPrivilegesCredentialSpec, ServiceTaskSpecContainerSpecPrivilegesCredentialSpecArgs

ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext, ServiceTaskSpecContainerSpecPrivilegesSeLinuxContextArgs

ServiceTaskSpecContainerSpecSecret, ServiceTaskSpecContainerSpecSecretArgs

ServiceTaskSpecLogDriver, ServiceTaskSpecLogDriverArgs

ServiceTaskSpecNetworksAdvanced, ServiceTaskSpecNetworksAdvancedArgs

ServiceTaskSpecPlacement, ServiceTaskSpecPlacementArgs

ServiceTaskSpecPlacementPlatform, ServiceTaskSpecPlacementPlatformArgs

ServiceTaskSpecResources, ServiceTaskSpecResourcesArgs

ServiceTaskSpecResourcesLimits, ServiceTaskSpecResourcesLimitsArgs

ServiceTaskSpecResourcesReservation, ServiceTaskSpecResourcesReservationArgs

ServiceTaskSpecResourcesReservationGenericResources, ServiceTaskSpecResourcesReservationGenericResourcesArgs

ServiceTaskSpecRestartPolicy, ServiceTaskSpecRestartPolicyArgs

ServiceUpdateConfig, ServiceUpdateConfigArgs

Package Details

On this page

On this page

Example Assuming you created a `service` as follows #!/bin/bash docker service create –name foo -p 8080:80 nginx prints th ID 4pcphbxkfn2rffhbhe6czytgi you provide the definition for the resource as follows terraform resource “docker_service” “foo” {