Docs Home
Docker v4.6.2 published on Saturday, Mar 15, 2025 by Pulumi
docker.Service
Explore with Pulumi AI
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);@overload
def Service(resource_name: str,
args: ServiceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Service(resource_name: str,
opts: Optional[ResourceOptions] = None,
task_spec: Optional[ServiceTaskSpecArgs] = 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,
update_config: Optional[ServiceUpdateConfigArgs] = 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.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ServiceArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. ServiceArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ServiceArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ServiceArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var serviceResource = new Docker.Service("serviceResource", new()
{
TaskSpec = new Docker.Inputs.ServiceTaskSpecArgs
{
ContainerSpec = new Docker.Inputs.ServiceTaskSpecContainerSpecArgs
{
Image = "string",
Env =
{
{ "string", "string" },
},
StopSignal = "string",
Dir = "string",
DnsConfig = new Docker.Inputs.ServiceTaskSpecContainerSpecDnsConfigArgs
{
Nameservers = new[]
{
"string",
},
Options = new[]
{
"string",
},
Searches = new[]
{
"string",
},
},
Args = new[]
{
"string",
},
Groups = new[]
{
"string",
},
Healthcheck = new Docker.Inputs.ServiceTaskSpecContainerSpecHealthcheckArgs
{
Tests = new[]
{
"string",
},
Interval = "string",
Retries = 0,
StartPeriod = "string",
Timeout = "string",
},
Isolation = "string",
User = "string",
Configs = new[]
{
new Docker.Inputs.ServiceTaskSpecContainerSpecConfigArgs
{
ConfigId = "string",
FileName = "string",
ConfigName = "string",
FileGid = "string",
FileMode = 0,
FileUid = "string",
},
},
Hostname = "string",
Labels = new[]
{
new Docker.Inputs.ServiceTaskSpecContainerSpecLabelArgs
{
Label = "string",
Value = "string",
},
},
Mounts = new[]
{
new Docker.Inputs.ServiceTaskSpecContainerSpecMountArgs
{
Target = "string",
Type = "string",
BindOptions = new Docker.Inputs.ServiceTaskSpecContainerSpecMountBindOptionsArgs
{
Propagation = "string",
},
ReadOnly = false,
Source = "string",
TmpfsOptions = new Docker.Inputs.ServiceTaskSpecContainerSpecMountTmpfsOptionsArgs
{
Mode = 0,
SizeBytes = 0,
},
VolumeOptions = new Docker.Inputs.ServiceTaskSpecContainerSpecMountVolumeOptionsArgs
{
DriverName = "string",
DriverOptions =
{
{ "string", "string" },
},
Labels = new[]
{
new Docker.Inputs.ServiceTaskSpecContainerSpecMountVolumeOptionsLabelArgs
{
Label = "string",
Value = "string",
},
},
NoCopy = false,
},
},
},
Privileges = new Docker.Inputs.ServiceTaskSpecContainerSpecPrivilegesArgs
{
CredentialSpec = new Docker.Inputs.ServiceTaskSpecContainerSpecPrivilegesCredentialSpecArgs
{
File = "string",
Registry = "string",
},
SeLinuxContext = new Docker.Inputs.ServiceTaskSpecContainerSpecPrivilegesSeLinuxContextArgs
{
Disable = false,
Level = "string",
Role = "string",
Type = "string",
User = "string",
},
},
ReadOnly = false,
Secrets = new[]
{
new Docker.Inputs.ServiceTaskSpecContainerSpecSecretArgs
{
FileName = "string",
SecretId = "string",
FileGid = "string",
FileMode = 0,
FileUid = "string",
SecretName = "string",
},
},
StopGracePeriod = "string",
Commands = new[]
{
"string",
},
Sysctl =
{
{ "string", "string" },
},
Hosts = new[]
{
new Docker.Inputs.ServiceTaskSpecContainerSpecHostArgs
{
Host = "string",
Ip = "string",
},
},
},
ForceUpdate = 0,
LogDriver = new Docker.Inputs.ServiceTaskSpecLogDriverArgs
{
Name = "string",
Options =
{
{ "string", "string" },
},
},
NetworksAdvanceds = new[]
{
new Docker.Inputs.ServiceTaskSpecNetworksAdvancedArgs
{
Name = "string",
Aliases = new[]
{
"string",
},
DriverOpts = new[]
{
"string",
},
},
},
Placement = new Docker.Inputs.ServiceTaskSpecPlacementArgs
{
Constraints = new[]
{
"string",
},
MaxReplicas = 0,
Platforms = new[]
{
new Docker.Inputs.ServiceTaskSpecPlacementPlatformArgs
{
Architecture = "string",
Os = "string",
},
},
Prefs = new[]
{
"string",
},
},
Resources = new Docker.Inputs.ServiceTaskSpecResourcesArgs
{
Limits = new Docker.Inputs.ServiceTaskSpecResourcesLimitsArgs
{
MemoryBytes = 0,
NanoCpus = 0,
},
Reservation = new Docker.Inputs.ServiceTaskSpecResourcesReservationArgs
{
GenericResources = new Docker.Inputs.ServiceTaskSpecResourcesReservationGenericResourcesArgs
{
DiscreteResourcesSpecs = new[]
{
"string",
},
NamedResourcesSpecs = new[]
{
"string",
},
},
MemoryBytes = 0,
NanoCpus = 0,
},
},
RestartPolicy = new Docker.Inputs.ServiceTaskSpecRestartPolicyArgs
{
Condition = "string",
Delay = "string",
MaxAttempts = 0,
Window = "string",
},
Runtime = "string",
},
Auth = new Docker.Inputs.ServiceAuthArgs
{
ServerAddress = "string",
Password = "string",
Username = "string",
},
ConvergeConfig = new Docker.Inputs.ServiceConvergeConfigArgs
{
Delay = "string",
Timeout = "string",
},
EndpointSpec = new Docker.Inputs.ServiceEndpointSpecArgs
{
Mode = "string",
Ports = new[]
{
new Docker.Inputs.ServiceEndpointSpecPortArgs
{
TargetPort = 0,
Name = "string",
Protocol = "string",
PublishMode = "string",
PublishedPort = 0,
},
},
},
Labels = new[]
{
new Docker.Inputs.ServiceLabelArgs
{
Label = "string",
Value = "string",
},
},
Mode = new Docker.Inputs.ServiceModeArgs
{
Global = false,
Replicated = new Docker.Inputs.ServiceModeReplicatedArgs
{
Replicas = 0,
},
},
Name = "string",
RollbackConfig = new Docker.Inputs.ServiceRollbackConfigArgs
{
Delay = "string",
FailureAction = "string",
MaxFailureRatio = "string",
Monitor = "string",
Order = "string",
Parallelism = 0,
},
UpdateConfig = new Docker.Inputs.ServiceUpdateConfigArgs
{
Delay = "string",
FailureAction = "string",
MaxFailureRatio = "string",
Monitor = "string",
Order = "string",
Parallelism = 0,
},
});
example, err := docker.NewService(ctx, "serviceResource", &docker.ServiceArgs{
TaskSpec: &docker.ServiceTaskSpecArgs{
ContainerSpec: &docker.ServiceTaskSpecContainerSpecArgs{
Image: pulumi.String("string"),
Env: pulumi.StringMap{
"string": pulumi.String("string"),
},
StopSignal: pulumi.String("string"),
Dir: pulumi.String("string"),
DnsConfig: &docker.ServiceTaskSpecContainerSpecDnsConfigArgs{
Nameservers: pulumi.StringArray{
pulumi.String("string"),
},
Options: pulumi.StringArray{
pulumi.String("string"),
},
Searches: pulumi.StringArray{
pulumi.String("string"),
},
},
Args: pulumi.StringArray{
pulumi.String("string"),
},
Groups: pulumi.StringArray{
pulumi.String("string"),
},
Healthcheck: &docker.ServiceTaskSpecContainerSpecHealthcheckArgs{
Tests: pulumi.StringArray{
pulumi.String("string"),
},
Interval: pulumi.String("string"),
Retries: pulumi.Int(0),
StartPeriod: pulumi.String("string"),
Timeout: pulumi.String("string"),
},
Isolation: pulumi.String("string"),
User: pulumi.String("string"),
Configs: docker.ServiceTaskSpecContainerSpecConfigArray{
&docker.ServiceTaskSpecContainerSpecConfigArgs{
ConfigId: pulumi.String("string"),
FileName: pulumi.String("string"),
ConfigName: pulumi.String("string"),
FileGid: pulumi.String("string"),
FileMode: pulumi.Int(0),
FileUid: pulumi.String("string"),
},
},
Hostname: pulumi.String("string"),
Labels: docker.ServiceTaskSpecContainerSpecLabelArray{
&docker.ServiceTaskSpecContainerSpecLabelArgs{
Label: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Mounts: docker.ServiceTaskSpecContainerSpecMountArray{
&docker.ServiceTaskSpecContainerSpecMountArgs{
Target: pulumi.String("string"),
Type: pulumi.String("string"),
BindOptions: &docker.ServiceTaskSpecContainerSpecMountBindOptionsArgs{
Propagation: pulumi.String("string"),
},
ReadOnly: pulumi.Bool(false),
Source: pulumi.String("string"),
TmpfsOptions: &docker.ServiceTaskSpecContainerSpecMountTmpfsOptionsArgs{
Mode: pulumi.Int(0),
SizeBytes: pulumi.Int(0),
},
VolumeOptions: &docker.ServiceTaskSpecContainerSpecMountVolumeOptionsArgs{
DriverName: pulumi.String("string"),
DriverOptions: pulumi.StringMap{
"string": pulumi.String("string"),
},
Labels: docker.ServiceTaskSpecContainerSpecMountVolumeOptionsLabelArray{
&docker.ServiceTaskSpecContainerSpecMountVolumeOptionsLabelArgs{
Label: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
NoCopy: pulumi.Bool(false),
},
},
},
Privileges: &docker.ServiceTaskSpecContainerSpecPrivilegesArgs{
CredentialSpec: &docker.ServiceTaskSpecContainerSpecPrivilegesCredentialSpecArgs{
File: pulumi.String("string"),
Registry: pulumi.String("string"),
},
SeLinuxContext: &docker.ServiceTaskSpecContainerSpecPrivilegesSeLinuxContextArgs{
Disable: pulumi.Bool(false),
Level: pulumi.String("string"),
Role: pulumi.String("string"),
Type: pulumi.String("string"),
User: pulumi.String("string"),
},
},
ReadOnly: pulumi.Bool(false),
Secrets: docker.ServiceTaskSpecContainerSpecSecretArray{
&docker.ServiceTaskSpecContainerSpecSecretArgs{
FileName: pulumi.String("string"),
SecretId: pulumi.String("string"),
FileGid: pulumi.String("string"),
FileMode: pulumi.Int(0),
FileUid: pulumi.String("string"),
SecretName: pulumi.String("string"),
},
},
StopGracePeriod: pulumi.String("string"),
Commands: pulumi.StringArray{
pulumi.String("string"),
},
Sysctl: pulumi.StringMap{
"string": pulumi.String("string"),
},
Hosts: docker.ServiceTaskSpecContainerSpecHostArray{
&docker.ServiceTaskSpecContainerSpecHostArgs{
Host: pulumi.String("string"),
Ip: pulumi.String("string"),
},
},
},
ForceUpdate: pulumi.Int(0),
LogDriver: &docker.ServiceTaskSpecLogDriverArgs{
Name: pulumi.String("string"),
Options: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
NetworksAdvanceds: docker.ServiceTaskSpecNetworksAdvancedArray{
&docker.ServiceTaskSpecNetworksAdvancedArgs{
Name: pulumi.String("string"),
Aliases: pulumi.StringArray{
pulumi.String("string"),
},
DriverOpts: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Placement: &docker.ServiceTaskSpecPlacementArgs{
Constraints: pulumi.StringArray{
pulumi.String("string"),
},
MaxReplicas: pulumi.Int(0),
Platforms: docker.ServiceTaskSpecPlacementPlatformArray{
&docker.ServiceTaskSpecPlacementPlatformArgs{
Architecture: pulumi.String("string"),
Os: pulumi.String("string"),
},
},
Prefs: pulumi.StringArray{
pulumi.String("string"),
},
},
Resources: &docker.ServiceTaskSpecResourcesArgs{
Limits: &docker.ServiceTaskSpecResourcesLimitsArgs{
MemoryBytes: pulumi.Int(0),
NanoCpus: pulumi.Int(0),
},
Reservation: &docker.ServiceTaskSpecResourcesReservationArgs{
GenericResources: &docker.ServiceTaskSpecResourcesReservationGenericResourcesArgs{
DiscreteResourcesSpecs: pulumi.StringArray{
pulumi.String("string"),
},
NamedResourcesSpecs: pulumi.StringArray{
pulumi.String("string"),
},
},
MemoryBytes: pulumi.Int(0),
NanoCpus: pulumi.Int(0),
},
},
RestartPolicy: &docker.ServiceTaskSpecRestartPolicyArgs{
Condition: pulumi.String("string"),
Delay: pulumi.String("string"),
MaxAttempts: pulumi.Int(0),
Window: pulumi.String("string"),
},
Runtime: pulumi.String("string"),
},
Auth: &docker.ServiceAuthArgs{
ServerAddress: pulumi.String("string"),
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
ConvergeConfig: &docker.ServiceConvergeConfigArgs{
Delay: pulumi.String("string"),
Timeout: pulumi.String("string"),
},
EndpointSpec: &docker.ServiceEndpointSpecArgs{
Mode: pulumi.String("string"),
Ports: docker.ServiceEndpointSpecPortArray{
&docker.ServiceEndpointSpecPortArgs{
TargetPort: pulumi.Int(0),
Name: pulumi.String("string"),
Protocol: pulumi.String("string"),
PublishMode: pulumi.String("string"),
PublishedPort: pulumi.Int(0),
},
},
},
Labels: docker.ServiceLabelArray{
&docker.ServiceLabelArgs{
Label: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Mode: &docker.ServiceModeArgs{
Global: pulumi.Bool(false),
Replicated: &docker.ServiceModeReplicatedArgs{
Replicas: pulumi.Int(0),
},
},
Name: pulumi.String("string"),
RollbackConfig: &docker.ServiceRollbackConfigArgs{
Delay: pulumi.String("string"),
FailureAction: pulumi.String("string"),
MaxFailureRatio: pulumi.String("string"),
Monitor: pulumi.String("string"),
Order: pulumi.String("string"),
Parallelism: pulumi.Int(0),
},
UpdateConfig: &docker.ServiceUpdateConfigArgs{
Delay: pulumi.String("string"),
FailureAction: pulumi.String("string"),
MaxFailureRatio: pulumi.String("string"),
Monitor: pulumi.String("string"),
Order: pulumi.String("string"),
Parallelism: pulumi.Int(0),
},
})
var serviceResource = new Service("serviceResource", ServiceArgs.builder()
.taskSpec(ServiceTaskSpecArgs.builder()
.containerSpec(ServiceTaskSpecContainerSpecArgs.builder()
.image("string")
.env(Map.of("string", "string"))
.stopSignal("string")
.dir("string")
.dnsConfig(ServiceTaskSpecContainerSpecDnsConfigArgs.builder()
.nameservers("string")
.options("string")
.searches("string")
.build())
.args("string")
.groups("string")
.healthcheck(ServiceTaskSpecContainerSpecHealthcheckArgs.builder()
.tests("string")
.interval("string")
.retries(0)
.startPeriod("string")
.timeout("string")
.build())
.isolation("string")
.user("string")
.configs(ServiceTaskSpecContainerSpecConfigArgs.builder()
.configId("string")
.fileName("string")
.configName("string")
.fileGid("string")
.fileMode(0)
.fileUid("string")
.build())
.hostname("string")
.labels(ServiceTaskSpecContainerSpecLabelArgs.builder()
.label("string")
.value("string")
.build())
.mounts(ServiceTaskSpecContainerSpecMountArgs.builder()
.target("string")
.type("string")
.bindOptions(ServiceTaskSpecContainerSpecMountBindOptionsArgs.builder()
.propagation("string")
.build())
.readOnly(false)
.source("string")
.tmpfsOptions(ServiceTaskSpecContainerSpecMountTmpfsOptionsArgs.builder()
.mode(0)
.sizeBytes(0)
.build())
.volumeOptions(ServiceTaskSpecContainerSpecMountVolumeOptionsArgs.builder()
.driverName("string")
.driverOptions(Map.of("string", "string"))
.labels(ServiceTaskSpecContainerSpecMountVolumeOptionsLabelArgs.builder()
.label("string")
.value("string")
.build())
.noCopy(false)
.build())
.build())
.privileges(ServiceTaskSpecContainerSpecPrivilegesArgs.builder()
.credentialSpec(ServiceTaskSpecContainerSpecPrivilegesCredentialSpecArgs.builder()
.file("string")
.registry("string")
.build())
.seLinuxContext(ServiceTaskSpecContainerSpecPrivilegesSeLinuxContextArgs.builder()
.disable(false)
.level("string")
.role("string")
.type("string")
.user("string")
.build())
.build())
.readOnly(false)
.secrets(ServiceTaskSpecContainerSpecSecretArgs.builder()
.fileName("string")
.secretId("string")
.fileGid("string")
.fileMode(0)
.fileUid("string")
.secretName("string")
.build())
.stopGracePeriod("string")
.commands("string")
.sysctl(Map.of("string", "string"))
.hosts(ServiceTaskSpecContainerSpecHostArgs.builder()
.host("string")
.ip("string")
.build())
.build())
.forceUpdate(0)
.logDriver(ServiceTaskSpecLogDriverArgs.builder()
.name("string")
.options(Map.of("string", "string"))
.build())
.networksAdvanceds(ServiceTaskSpecNetworksAdvancedArgs.builder()
.name("string")
.aliases("string")
.driverOpts("string")
.build())
.placement(ServiceTaskSpecPlacementArgs.builder()
.constraints("string")
.maxReplicas(0)
.platforms(ServiceTaskSpecPlacementPlatformArgs.builder()
.architecture("string")
.os("string")
.build())
.prefs("string")
.build())
.resources(ServiceTaskSpecResourcesArgs.builder()
.limits(ServiceTaskSpecResourcesLimitsArgs.builder()
.memoryBytes(0)
.nanoCpus(0)
.build())
.reservation(ServiceTaskSpecResourcesReservationArgs.builder()
.genericResources(ServiceTaskSpecResourcesReservationGenericResourcesArgs.builder()
.discreteResourcesSpecs("string")
.namedResourcesSpecs("string")
.build())
.memoryBytes(0)
.nanoCpus(0)
.build())
.build())
.restartPolicy(ServiceTaskSpecRestartPolicyArgs.builder()
.condition("string")
.delay("string")
.maxAttempts(0)
.window("string")
.build())
.runtime("string")
.build())
.auth(ServiceAuthArgs.builder()
.serverAddress("string")
.password("string")
.username("string")
.build())
.convergeConfig(ServiceConvergeConfigArgs.builder()
.delay("string")
.timeout("string")
.build())
.endpointSpec(ServiceEndpointSpecArgs.builder()
.mode("string")
.ports(ServiceEndpointSpecPortArgs.builder()
.targetPort(0)
.name("string")
.protocol("string")
.publishMode("string")
.publishedPort(0)
.build())
.build())
.labels(ServiceLabelArgs.builder()
.label("string")
.value("string")
.build())
.mode(ServiceModeArgs.builder()
.global(false)
.replicated(ServiceModeReplicatedArgs.builder()
.replicas(0)
.build())
.build())
.name("string")
.rollbackConfig(ServiceRollbackConfigArgs.builder()
.delay("string")
.failureAction("string")
.maxFailureRatio("string")
.monitor("string")
.order("string")
.parallelism(0)
.build())
.updateConfig(ServiceUpdateConfigArgs.builder()
.delay("string")
.failureAction("string")
.maxFailureRatio("string")
.monitor("string")
.order("string")
.parallelism(0)
.build())
.build());
service_resource = docker.Service("serviceResource",
task_spec={
"container_spec": {
"image": "string",
"env": {
"string": "string",
},
"stop_signal": "string",
"dir": "string",
"dns_config": {
"nameservers": ["string"],
"options": ["string"],
"searches": ["string"],
},
"args": ["string"],
"groups": ["string"],
"healthcheck": {
"tests": ["string"],
"interval": "string",
"retries": 0,
"start_period": "string",
"timeout": "string",
},
"isolation": "string",
"user": "string",
"configs": [{
"config_id": "string",
"file_name": "string",
"config_name": "string",
"file_gid": "string",
"file_mode": 0,
"file_uid": "string",
}],
"hostname": "string",
"labels": [{
"label": "string",
"value": "string",
}],
"mounts": [{
"target": "string",
"type": "string",
"bind_options": {
"propagation": "string",
},
"read_only": False,
"source": "string",
"tmpfs_options": {
"mode": 0,
"size_bytes": 0,
},
"volume_options": {
"driver_name": "string",
"driver_options": {
"string": "string",
},
"labels": [{
"label": "string",
"value": "string",
}],
"no_copy": False,
},
}],
"privileges": {
"credential_spec": {
"file": "string",
"registry": "string",
},
"se_linux_context": {
"disable": False,
"level": "string",
"role": "string",
"type": "string",
"user": "string",
},
},
"read_only": False,
"secrets": [{
"file_name": "string",
"secret_id": "string",
"file_gid": "string",
"file_mode": 0,
"file_uid": "string",
"secret_name": "string",
}],
"stop_grace_period": "string",
"commands": ["string"],
"sysctl": {
"string": "string",
},
"hosts": [{
"host": "string",
"ip": "string",
}],
},
"force_update": 0,
"log_driver": {
"name": "string",
"options": {
"string": "string",
},
},
"networks_advanceds": [{
"name": "string",
"aliases": ["string"],
"driver_opts": ["string"],
}],
"placement": {
"constraints": ["string"],
"max_replicas": 0,
"platforms": [{
"architecture": "string",
"os": "string",
}],
"prefs": ["string"],
},
"resources": {
"limits": {
"memory_bytes": 0,
"nano_cpus": 0,
},
"reservation": {
"generic_resources": {
"discrete_resources_specs": ["string"],
"named_resources_specs": ["string"],
},
"memory_bytes": 0,
"nano_cpus": 0,
},
},
"restart_policy": {
"condition": "string",
"delay": "string",
"max_attempts": 0,
"window": "string",
},
"runtime": "string",
},
auth={
"server_address": "string",
"password": "string",
"username": "string",
},
converge_config={
"delay": "string",
"timeout": "string",
},
endpoint_spec={
"mode": "string",
"ports": [{
"target_port": 0,
"name": "string",
"protocol": "string",
"publish_mode": "string",
"published_port": 0,
}],
},
labels=[{
"label": "string",
"value": "string",
}],
mode={
"global_": False,
"replicated": {
"replicas": 0,
},
},
name="string",
rollback_config={
"delay": "string",
"failure_action": "string",
"max_failure_ratio": "string",
"monitor": "string",
"order": "string",
"parallelism": 0,
},
update_config={
"delay": "string",
"failure_action": "string",
"max_failure_ratio": "string",
"monitor": "string",
"order": "string",
"parallelism": 0,
})
const serviceResource = new docker.Service("serviceResource", {
taskSpec: {
containerSpec: {
image: "string",
env: {
string: "string",
},
stopSignal: "string",
dir: "string",
dnsConfig: {
nameservers: ["string"],
options: ["string"],
searches: ["string"],
},
args: ["string"],
groups: ["string"],
healthcheck: {
tests: ["string"],
interval: "string",
retries: 0,
startPeriod: "string",
timeout: "string",
},
isolation: "string",
user: "string",
configs: [{
configId: "string",
fileName: "string",
configName: "string",
fileGid: "string",
fileMode: 0,
fileUid: "string",
}],
hostname: "string",
labels: [{
label: "string",
value: "string",
}],
mounts: [{
target: "string",
type: "string",
bindOptions: {
propagation: "string",
},
readOnly: false,
source: "string",
tmpfsOptions: {
mode: 0,
sizeBytes: 0,
},
volumeOptions: {
driverName: "string",
driverOptions: {
string: "string",
},
labels: [{
label: "string",
value: "string",
}],
noCopy: false,
},
}],
privileges: {
credentialSpec: {
file: "string",
registry: "string",
},
seLinuxContext: {
disable: false,
level: "string",
role: "string",
type: "string",
user: "string",
},
},
readOnly: false,
secrets: [{
fileName: "string",
secretId: "string",
fileGid: "string",
fileMode: 0,
fileUid: "string",
secretName: "string",
}],
stopGracePeriod: "string",
commands: ["string"],
sysctl: {
string: "string",
},
hosts: [{
host: "string",
ip: "string",
}],
},
forceUpdate: 0,
logDriver: {
name: "string",
options: {
string: "string",
},
},
networksAdvanceds: [{
name: "string",
aliases: ["string"],
driverOpts: ["string"],
}],
placement: {
constraints: ["string"],
maxReplicas: 0,
platforms: [{
architecture: "string",
os: "string",
}],
prefs: ["string"],
},
resources: {
limits: {
memoryBytes: 0,
nanoCpus: 0,
},
reservation: {
genericResources: {
discreteResourcesSpecs: ["string"],
namedResourcesSpecs: ["string"],
},
memoryBytes: 0,
nanoCpus: 0,
},
},
restartPolicy: {
condition: "string",
delay: "string",
maxAttempts: 0,
window: "string",
},
runtime: "string",
},
auth: {
serverAddress: "string",
password: "string",
username: "string",
},
convergeConfig: {
delay: "string",
timeout: "string",
},
endpointSpec: {
mode: "string",
ports: [{
targetPort: 0,
name: "string",
protocol: "string",
publishMode: "string",
publishedPort: 0,
}],
},
labels: [{
label: "string",
value: "string",
}],
mode: {
global: false,
replicated: {
replicas: 0,
},
},
name: "string",
rollbackConfig: {
delay: "string",
failureAction: "string",
maxFailureRatio: "string",
monitor: "string",
order: "string",
parallelism: 0,
},
updateConfig: {
delay: "string",
failureAction: "string",
maxFailureRatio: "string",
monitor: "string",
order: "string",
parallelism: 0,
},
});
type: docker:Service
properties:
auth:
password: string
serverAddress: string
username: string
convergeConfig:
delay: string
timeout: string
endpointSpec:
mode: string
ports:
- name: string
protocol: string
publishMode: string
publishedPort: 0
targetPort: 0
labels:
- label: string
value: string
mode:
global: false
replicated:
replicas: 0
name: string
rollbackConfig:
delay: string
failureAction: string
maxFailureRatio: string
monitor: string
order: string
parallelism: 0
taskSpec:
containerSpec:
args:
- string
commands:
- string
configs:
- configId: string
configName: string
fileGid: string
fileMode: 0
fileName: string
fileUid: string
dir: string
dnsConfig:
nameservers:
- string
options:
- string
searches:
- string
env:
string: string
groups:
- string
healthcheck:
interval: string
retries: 0
startPeriod: string
tests:
- string
timeout: string
hostname: string
hosts:
- host: string
ip: string
image: string
isolation: string
labels:
- label: string
value: string
mounts:
- bindOptions:
propagation: string
readOnly: false
source: string
target: string
tmpfsOptions:
mode: 0
sizeBytes: 0
type: string
volumeOptions:
driverName: string
driverOptions:
string: string
labels:
- label: string
value: string
noCopy: false
privileges:
credentialSpec:
file: string
registry: string
seLinuxContext:
disable: false
level: string
role: string
type: string
user: string
readOnly: false
secrets:
- fileGid: string
fileMode: 0
fileName: string
fileUid: string
secretId: string
secretName: string
stopGracePeriod: string
stopSignal: string
sysctl:
string: string
user: string
forceUpdate: 0
logDriver:
name: string
options:
string: string
networksAdvanceds:
- aliases:
- string
driverOpts:
- string
name: string
placement:
constraints:
- string
maxReplicas: 0
platforms:
- architecture: string
os: string
prefs:
- string
resources:
limits:
memoryBytes: 0
nanoCpus: 0
reservation:
genericResources:
discreteResourcesSpecs:
- string
namedResourcesSpecs:
- string
memoryBytes: 0
nanoCpus: 0
restartPolicy:
condition: string
delay: string
maxAttempts: 0
window: string
runtime: string
updateConfig:
delay: string
failureAction: string
maxFailureRatio: string
monitor: string
order: string
parallelism: 0
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Service resource accepts the following input properties:
- Task
Spec This property is required. ServiceTask Spec - User modifiable task configuration
- Auth
Changes to this property will trigger replacement.Auth - Configuration for the authentication for pulling the images of the service
- Converge
Config ServiceConverge Config - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- Endpoint
Spec ServiceEndpoint Spec - Properties that can be configured to access and load balance a service
- Labels
List<Service
Label> - User-defined key/value metadata
- Mode
Mode - Scheduling mode for the service
- Name
- Name of the service
- Rollback
Config ServiceRollback Config - Specification for the rollback strategy of the service
- Update
Config ServiceUpdate Config - Specification for the update strategy of the service
- Task
Spec This property is required. ServiceTask Spec Args - User modifiable task configuration
- Auth
Auth Args - Configuration for the authentication for pulling the images of the service
- Converge
Config ServiceConverge Config Args - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- Endpoint
Spec ServiceEndpoint Spec Args - Properties that can be configured to access and load balance a service
- Labels
[]Service
Label Args - User-defined key/value metadata
- Mode
Mode Args - Scheduling mode for the service
- Name
- Name of the service
- Rollback
Config ServiceRollback Config Args - Specification for the rollback strategy of the service
- Update
Config ServiceUpdate Config Args - Specification for the update strategy of the service
- task
Spec This property is required. ServiceTask Spec - User modifiable task configuration
- auth
Auth - Configuration for the authentication for pulling the images of the service
- converge
Config ServiceConverge Config - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- endpoint
Spec ServiceEndpoint Spec - Properties that can be configured to access and load balance a service
- labels
List<Service
Label> - User-defined key/value metadata
- mode
Mode - Scheduling mode for the service
- name
- Name of the service
- rollback
Config ServiceRollback Config - Specification for the rollback strategy of the service
- update
Config ServiceUpdate Config - Specification for the update strategy of the service
- task
Spec This property is required. ServiceTask Spec - User modifiable task configuration
- auth
Auth - Configuration for the authentication for pulling the images of the service
- converge
Config ServiceConverge Config - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- endpoint
Spec ServiceEndpoint Spec - Properties that can be configured to access and load balance a service
- labels
Service
Label[] - User-defined key/value metadata
- mode
Mode - Scheduling mode for the service
- name
- Name of the service
- rollback
Config ServiceRollback Config - Specification for the rollback strategy of the service
- update
Config ServiceUpdate Config - Specification for the update strategy of the service
- task_
spec This property is required. ServiceTask Spec Args - User modifiable task configuration
- auth
Auth Args - Configuration for the authentication for pulling the images of the service
- converge_
config ServiceConverge Config Args - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- endpoint_
spec ServiceEndpoint Spec Args - Properties that can be configured to access and load balance a service
- labels
Sequence[Service
Label Args] - User-defined key/value metadata
- mode
Mode Args - Scheduling mode for the service
- name
- Name of the service
- rollback_
config ServiceRollback Config Args - Specification for the rollback strategy of the service
- update_
config ServiceUpdate Config Args - Specification for the update strategy of the service
- task
Spec This property is required. Property Map - User modifiable task configuration
- auth
- Configuration for the authentication for pulling the images of the service
- converge
Config Property Map - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- endpoint
Spec Property Map - Properties that can be configured to access and load balance a service
- labels List<Property Map>
- User-defined key/value metadata
- mode
- Scheduling mode for the service
- name
- Name of the service
- rollback
Config Property Map - Specification for the rollback strategy of the service
- update
Config 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) -> Servicefunc 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)resources: _: type: docker:Service get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
Auth - Configuration for the authentication for pulling the images of the service
- Converge
Config ServiceConverge Config - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- Endpoint
Spec ServiceEndpoint Spec - Properties that can be configured to access and load balance a service
- Labels
List<Service
Label> - User-defined key/value metadata
- Mode
Mode - Scheduling mode for the service
- Name
- Name of the service
- Rollback
Config ServiceRollback Config - Specification for the rollback strategy of the service
- Task
Spec ServiceTask Spec - User modifiable task configuration
- Update
Config ServiceUpdate Config - Specification for the update strategy of the service
- Auth
Auth Args - Configuration for the authentication for pulling the images of the service
- Converge
Config ServiceConverge Config Args - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- Endpoint
Spec ServiceEndpoint Spec Args - Properties that can be configured to access and load balance a service
- Labels
[]Service
Label Args - User-defined key/value metadata
- Mode
Mode Args - Scheduling mode for the service
- Name
- Name of the service
- Rollback
Config ServiceRollback Config Args - Specification for the rollback strategy of the service
- Task
Spec ServiceTask Spec Args - User modifiable task configuration
- Update
Config ServiceUpdate Config Args - Specification for the update strategy of the service
- auth
Auth - Configuration for the authentication for pulling the images of the service
- converge
Config ServiceConverge Config - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- endpoint
Spec ServiceEndpoint Spec - Properties that can be configured to access and load balance a service
- labels
List<Service
Label> - User-defined key/value metadata
- mode
Mode - Scheduling mode for the service
- name
- Name of the service
- rollback
Config ServiceRollback Config - Specification for the rollback strategy of the service
- task
Spec ServiceTask Spec - User modifiable task configuration
- update
Config ServiceUpdate Config - Specification for the update strategy of the service
- auth
Auth - Configuration for the authentication for pulling the images of the service
- converge
Config ServiceConverge Config - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- endpoint
Spec ServiceEndpoint Spec - Properties that can be configured to access and load balance a service
- labels
Service
Label[] - User-defined key/value metadata
- mode
Mode - Scheduling mode for the service
- name
- Name of the service
- rollback
Config ServiceRollback Config - Specification for the rollback strategy of the service
- task
Spec ServiceTask Spec - User modifiable task configuration
- update
Config ServiceUpdate Config - Specification for the update strategy of the service
- auth
Auth Args - Configuration for the authentication for pulling the images of the service
- converge_
config ServiceConverge Config Args - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- endpoint_
spec ServiceEndpoint Spec Args - Properties that can be configured to access and load balance a service
- labels
Sequence[Service
Label Args] - User-defined key/value metadata
- mode
Mode Args - Scheduling mode for the service
- name
- Name of the service
- rollback_
config ServiceRollback Config Args - Specification for the rollback strategy of the service
- task_
spec ServiceTask Spec Args - User modifiable task configuration
- update_
config ServiceUpdate Config Args - Specification for the update strategy of the service
- auth
- Configuration for the authentication for pulling the images of the service
- converge
Config Property Map - A configuration to ensure that a service converges aka reaches the desired that of all task up and running
- endpoint
Spec Property Map - Properties that can be configured to access and load balance a service
- labels List<Property Map>
- User-defined key/value metadata
- mode
- Scheduling mode for the service
- name
- Name of the service
- rollback
Config Property Map - Specification for the rollback strategy of the service
- task
Spec Property Map - User modifiable task configuration
- update
Config Property Map - Specification for the update strategy of the service
Supporting Types
ServiceAuth, ServiceAuthArgs
, ServiceAuthArgs
- Server
Address stringThis property is required. Changes to this property will trigger replacement. - The address of the server for the authentication
- Password
- The password
- Username
- The username
- Server
Address stringThis property is required. Changes to this property will trigger replacement. - The address of the server for the authentication
- Password
- The password
- Username
- The username
- server
Address StringThis property is required. Changes to this property will trigger replacement. - The address of the server for the authentication
- password
- The password
- username
- The username
- server
Address stringThis property is required. Changes to this property will trigger replacement. - The address of the server for the authentication
- password
- The password
- username
- The username
- server_
address strThis property is required. Changes to this property will trigger replacement. - The address of the server for the authentication
- password
- The password
- username
- The username
- server
Address StringThis property is required. Changes to this property will trigger replacement. - The address of the server for the authentication
- password
- The password
- username
- The username
ServiceConvergeConfig, ServiceConvergeConfigArgs
, ServiceConvergeConfigArgs
ServiceEndpointSpec, ServiceEndpointSpecArgs
, ServiceEndpointSpecArgs
- Mode string
- The mode of resolution to use for internal load balancing between tasks
- Ports
List<Service
Endpoint Spec Port> - 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
[]Service
Endpoint Spec Port - 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<Service
Endpoint Spec Port> - 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
Service
Endpoint Spec Port[] - 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[Service
Endpoint Spec Port] - 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
, ServiceEndpointSpecPortArgs
- Target
Port This property is required. int - The port inside the container
- Name string
- A random name for the port
- Protocol string
- Rrepresents the protocol of a port:
tcp,udporsctp. Defaults totcp. - Publish
Mode string - Represents the mode in which the port is to be published: 'ingress' or 'host'. Defaults to
ingress. - Published
Port int - The port on the swarm hosts
- Target
Port This property is required. int - The port inside the container
- Name string
- A random name for the port
- Protocol string
- Rrepresents the protocol of a port:
tcp,udporsctp. Defaults totcp. - Publish
Mode string - Represents the mode in which the port is to be published: 'ingress' or 'host'. Defaults to
ingress. - Published
Port int - The port on the swarm hosts
- target
Port This property is required. Integer - The port inside the container
- name String
- A random name for the port
- protocol String
- Rrepresents the protocol of a port:
tcp,udporsctp. Defaults totcp. - publish
Mode String - Represents the mode in which the port is to be published: 'ingress' or 'host'. Defaults to
ingress. - published
Port Integer - The port on the swarm hosts
- target
Port This property is required. number - The port inside the container
- name string
- A random name for the port
- protocol string
- Rrepresents the protocol of a port:
tcp,udporsctp. Defaults totcp. - 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
- target_
port This property is required. int - The port inside the container
- name str
- A random name for the port
- protocol str
- Rrepresents the protocol of a port:
tcp,udporsctp. Defaults totcp. - publish_
mode str - Represents the mode in which the port is to be published: 'ingress' or 'host'. Defaults to
ingress. - published_
port int - The port on the swarm hosts
- target
Port This property is required. Number - The port inside the container
- name String
- A random name for the port
- protocol String
- Rrepresents the protocol of a port:
tcp,udporsctp. Defaults totcp. - 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
ServiceLabel, ServiceLabelArgs
, ServiceLabelArgs
ServiceMode, ServiceModeArgs
, ServiceModeArgs
- Global bool
- When
true, tasks will run on every worker node. Conflicts withreplicated - Replicated
Service
Mode Replicated - The replicated service mode
- Global bool
- When
true, tasks will run on every worker node. Conflicts withreplicated - Replicated
Service
Mode Replicated - The replicated service mode
- global Boolean
- When
true, tasks will run on every worker node. Conflicts withreplicated - replicated
Service
Mode Replicated - The replicated service mode
- global boolean
- When
true, tasks will run on every worker node. Conflicts withreplicated - replicated
Service
Mode Replicated - The replicated service mode
- global_ bool
- When
true, tasks will run on every worker node. Conflicts withreplicated - replicated
Service
Mode Replicated - The replicated service mode
- global Boolean
- When
true, tasks will run on every worker node. Conflicts withreplicated - replicated Property Map
- The replicated service mode
ServiceModeReplicated, ServiceModeReplicatedArgs
, ServiceModeReplicatedArgs
- Replicas int
- The amount of replicas of the service. Defaults to
1
- Replicas int
- The amount of replicas of the service. Defaults to
1
- replicas Integer
- The amount of replicas of the service. Defaults to
1
- replicas number
- The amount of replicas of the service. Defaults to
1
- replicas int
- The amount of replicas of the service. Defaults to
1
- replicas Number
- The amount of replicas of the service. Defaults to
1
ServiceRollbackConfig, ServiceRollbackConfigArgs
, ServiceRollbackConfigArgs
- Delay string
- Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to
0s. - Failure
Action string - Action on rollback failure: pause | continue. Defaults to
pause. - Max
Failure stringRatio - 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. - Failure
Action string - Action on rollback failure: pause | continue. Defaults to
pause. - Max
Failure stringRatio - 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. - failure
Action String - Action on rollback failure: pause | continue. Defaults to
pause. - max
Failure StringRatio - 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. - failure
Action string - Action on rollback failure: pause | continue. Defaults to
pause. - max
Failure stringRatio - 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_ strratio - 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. - failure
Action String - Action on rollback failure: pause | continue. Defaults to
pause. - max
Failure StringRatio - 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
, ServiceTaskSpecArgs
- Container
Spec This property is required. ServiceTask Spec Container Spec - 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 ServiceTask Spec Log Driver - 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 List<ServiceTask Spec Networks Advanced> - The networks the container is attached to
- Placement
Service
Task Spec Placement - The placement preferences
- Resources
Service
Task Spec Resources - Resource requirements which apply to each individual container created as part of the service
- Restart
Policy ServiceTask Spec Restart Policy - 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 This property is required. ServiceTask Spec Container Spec - 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 ServiceTask Spec Log Driver - 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 []ServiceTask Spec Networks Advanced - The networks the container is attached to
- Placement
Service
Task Spec Placement - The placement preferences
- Resources
Service
Task Spec Resources - Resource requirements which apply to each individual container created as part of the service
- Restart
Policy ServiceTask Spec Restart Policy - 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 This property is required. ServiceTask Spec Container Spec - The spec for each container
- force
Update Integer - A counter that triggers an update even if no relevant parameters have been changed. See the spec.
- log
Driver ServiceTask Spec Log Driver - 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 List<ServiceTask Spec Networks Advanced> - The networks the container is attached to
- placement
Service
Task Spec Placement - The placement preferences
- resources
Service
Task Spec Resources - Resource requirements which apply to each individual container created as part of the service
- restart
Policy ServiceTask Spec Restart Policy - 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 This property is required. ServiceTask Spec Container Spec - The spec for each container
- force
Update number - A counter that triggers an update even if no relevant parameters have been changed. See the spec.
- log
Driver ServiceTask Spec Log Driver - 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 ServiceTask Spec Networks Advanced[] - The networks the container is attached to
- placement
Service
Task Spec Placement - The placement preferences
- resources
Service
Task Spec Resources - Resource requirements which apply to each individual container created as part of the service
- restart
Policy ServiceTask Spec Restart Policy - 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 This property is required. ServiceTask Spec Container Spec - 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 ServiceTask Spec Log Driver - 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[ServiceTask Spec Networks Advanced] - The networks the container is attached to
- placement
Service
Task Spec Placement - The placement preferences
- resources
Service
Task Spec Resources - Resource requirements which apply to each individual container created as part of the service
- restart_
policy ServiceTask Spec Restart Policy - 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.
- container
Spec This property is required. Property Map - The spec for each container
- force
Update Number - A counter that triggers an update even if no relevant parameters have been changed. See the spec.
- log
Driver 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
- networks
Advanceds 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
- restart
Policy 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
, ServiceTaskSpecContainerSpecArgs
- Image
This property is required. string - The image name to use for the containers of the service, like
nginx:1.17.6. Also use the data-source or resource ofdocker.RemoteImagewith therepo_digestordocker.RegistryImagewith thenameattribute for this, as shown in the examples. - Args List<string>
- Arguments to the command
- Commands List<string>
- The command/entrypoint to be run in the image. According to the docker cli the override of the entrypoint is also passed to the
commandproperty and there is noentrypointattribute in theContainerSpecof the service. - Configs
List<Service
Task Spec Container Spec Config> - References to zero or more configs that will be exposed to the service
- Dir string
- The working directory for commands to run in
- Dns
Config ServiceTask Spec Container Spec Dns Config - Specification for DNS related configurations in resolver configuration file (
resolv.conf) - Env Dictionary<string, string>
- A list of environment variables in the form VAR="value"
- Groups List<string>
- A list of additional groups that the container process will run as
- Healthcheck
Service
Task Spec Container Spec Healthcheck - A test to perform to check that the container is healthy
- Hostname string
- The hostname to use for the container, as a valid RFC 1123 hostname
- Hosts
Task Spec Container Spec Host> - A list of hostname/IP mappings to add to the container's hosts file
- Isolation string
- Isolation technology of the containers running the service. (Windows only). Defaults to
default. - Labels
List<Service
Task Spec Container Spec Label> - User-defined key/value metadata
- Mounts
List<Service
Task Spec Container Spec Mount> - Specification for mounts to be added to containers created as part of the service
- Privileges
Service
Task Spec Container Spec Privileges - Security options for the container
- Read
Only bool - Mount the container's root filesystem as read only
- Secrets
List<Service
Task Spec Container Spec Secret> - References to zero or more secrets that will be exposed to the service
- Stop
Grace stringPeriod - 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.
- Stop
Signal string - Signal to stop the container
- Sysctl
- Sysctls config (Linux only)
- User string
- The user inside the container
- Image
This property is required. string - The image name to use for the containers of the service, like
nginx:1.17.6. Also use the data-source or resource ofdocker.RemoteImagewith therepo_digestordocker.RegistryImagewith thenameattribute for this, as shown in the examples. - Args []string
- Arguments to the command
- Commands []string
- The command/entrypoint to be run in the image. According to the docker cli the override of the entrypoint is also passed to the
commandproperty and there is noentrypointattribute in theContainerSpecof the service. - Configs
[]Service
Task Spec Container Spec Config - References to zero or more configs that will be exposed to the service
- Dir string
- The working directory for commands to run in
- Dns
Config ServiceTask Spec Container Spec Dns Config - Specification for DNS related configurations in resolver configuration file (
resolv.conf) - Env map[string]string
- A list of environment variables in the form VAR="value"
- Groups []string
- A list of additional groups that the container process will run as
- Healthcheck
Service
Task Spec Container Spec Healthcheck - A test to perform to check that the container is healthy
- Hostname string
- The hostname to use for the container, as a valid RFC 1123 hostname
- Hosts
Task Spec Container Spec Host - A list of hostname/IP mappings to add to the container's hosts file
- Isolation string
- Isolation technology of the containers running the service. (Windows only). Defaults to
default. - Labels
[]Service
Task Spec Container Spec Label - User-defined key/value metadata
- Mounts
[]Service
Task Spec Container Spec Mount - Specification for mounts to be added to containers created as part of the service
- Privileges
Service
Task Spec Container Spec Privileges - Security options for the container
- Read
Only bool - Mount the container's root filesystem as read only
- Secrets
[]Service
Task Spec Container Spec Secret - References to zero or more secrets that will be exposed to the service
- Stop
Grace stringPeriod - 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.
- Stop
Signal string - Signal to stop the container
- Sysctl
- Sysctls config (Linux only)
- User string
- The user inside the container
- image
This property is required. String - The image name to use for the containers of the service, like
nginx:1.17.6. Also use the data-source or resource ofdocker.RemoteImagewith therepo_digestordocker.RegistryImagewith thenameattribute for this, as shown in the examples. - args List<String>
- Arguments to the command
- commands List<String>
- The command/entrypoint to be run in the image. According to the docker cli the override of the entrypoint is also passed to the
commandproperty and there is noentrypointattribute in theContainerSpecof the service. - configs
List<Service
Task Spec Container Spec Config> - References to zero or more configs that will be exposed to the service
- dir String
- The working directory for commands to run in
- dns
Config ServiceTask Spec Container Spec Dns Config - Specification for DNS related configurations in resolver configuration file (
resolv.conf) - env Map<String,String>
- A list of environment variables in the form VAR="value"
- groups List<String>
- A list of additional groups that the container process will run as
- healthcheck
Service
Task Spec Container Spec Healthcheck - A test to perform to check that the container is healthy
- hostname String
- The hostname to use for the container, as a valid RFC 1123 hostname
- hosts
Task Spec Container Spec Host> - A list of hostname/IP mappings to add to the container's hosts file
- isolation String
- Isolation technology of the containers running the service. (Windows only). Defaults to
default. - labels
List<Service
Task Spec Container Spec Label> - User-defined key/value metadata
- mounts
List<Service
Task Spec Container Spec Mount> - Specification for mounts to be added to containers created as part of the service
- privileges
Service
Task Spec Container Spec Privileges - Security options for the container
- read
Only Boolean - Mount the container's root filesystem as read only
- secrets
List<Service
Task Spec Container Spec Secret> - References to zero or more secrets that will be exposed to the service
- stop
Grace StringPeriod - 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.
- stop
Signal String - Signal to stop the container
- sysctl
- Sysctls config (Linux only)
- user String
- The user inside the container
- image
This property is required. string - The image name to use for the containers of the service, like
nginx:1.17.6. Also use the data-source or resource ofdocker.RemoteImagewith therepo_digestordocker.RegistryImagewith thenameattribute for this, as shown in the examples. - args string[]
- Arguments to the command
- commands string[]
- The command/entrypoint to be run in the image. According to the docker cli the override of the entrypoint is also passed to the
commandproperty and there is noentrypointattribute in theContainerSpecof the service. - configs
Service
Task Spec Container Spec Config[] - References to zero or more configs that will be exposed to the service
- dir string
- The working directory for commands to run in
- dns
Config ServiceTask Spec Container Spec Dns Config - Specification for DNS related configurations in resolver configuration file (
resolv.conf) - env {[key: string]: string}
- A list of environment variables in the form VAR="value"
- groups string[]
- A list of additional groups that the container process will run as
- healthcheck
Service
Task Spec Container Spec Healthcheck - A test to perform to check that the container is healthy
- hostname string
- The hostname to use for the container, as a valid RFC 1123 hostname
- hosts
Task Spec Container Spec Host[] - A list of hostname/IP mappings to add to the container's hosts file
- isolation string
- Isolation technology of the containers running the service. (Windows only). Defaults to
default. - labels
Service
Task Spec Container Spec Label[] - User-defined key/value metadata
- mounts
Service
Task Spec Container Spec Mount[] - Specification for mounts to be added to containers created as part of the service
- privileges
Service
Task Spec Container Spec Privileges - Security options for the container
- read
Only boolean - Mount the container's root filesystem as read only
- secrets
Service
Task Spec Container Spec Secret[] - References to zero or more secrets that will be exposed to the service
- stop
Grace stringPeriod - 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.
- stop
Signal string - Signal to stop the container
- sysctl
- Sysctls config (Linux only)
- user string
- The user inside the container
- image
This property is required. str - The image name to use for the containers of the service, like
nginx:1.17.6. Also use the data-source or resource ofdocker.RemoteImagewith therepo_digestordocker.RegistryImagewith thenameattribute for this, as shown in the examples. - args Sequence[str]
- Arguments to the command
- commands Sequence[str]
- The command/entrypoint to be run in the image. According to the docker cli the override of the entrypoint is also passed to the
commandproperty and there is noentrypointattribute in theContainerSpecof the service. - configs
Sequence[Service
Task Spec Container Spec Config] - References to zero or more configs that will be exposed to the service
- dir str
- The working directory for commands to run in
- dns_
config ServiceTask Spec Container Spec Dns Config - Specification for DNS related configurations in resolver configuration file (
resolv.conf) - env Mapping[str, str]
- A list of environment variables in the form VAR="value"
- groups Sequence[str]
- A list of additional groups that the container process will run as
- healthcheck
Service
Task Spec Container Spec Healthcheck - A test to perform to check that the container is healthy
- hostname str
- The hostname to use for the container, as a valid RFC 1123 hostname
- hosts
Task Spec Container Spec Host] - A list of hostname/IP mappings to add to the container's hosts file
- isolation str
- Isolation technology of the containers running the service. (Windows only). Defaults to
default. - labels
Sequence[Service
Task Spec Container Spec Label] - User-defined key/value metadata
- mounts
Sequence[Service
Task Spec Container Spec Mount] - Specification for mounts to be added to containers created as part of the service
- privileges
Service
Task Spec Container Spec Privileges - Security options for the container
- read_
only bool - Mount the container's root filesystem as read only
- secrets
Sequence[Service
Task Spec Container Spec Secret] - References to zero or more secrets that will be exposed to the service
- stop_
grace_ strperiod - 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.
- stop_
signal str - Signal to stop the container
- sysctl
- Sysctls config (Linux only)
- user str
- The user inside the container
- image
This property is required. String - The image name to use for the containers of the service, like
nginx:1.17.6. Also use the data-source or resource ofdocker.RemoteImagewith therepo_digestordocker.RegistryImagewith thenameattribute for this, as shown in the examples. - args List<String>
- Arguments to the command
- commands List<String>
- The command/entrypoint to be run in the image. According to the docker cli the override of the entrypoint is also passed to the
commandproperty and there is noentrypointattribute in theContainerSpecof the service. - configs List<Property Map>
- References to zero or more configs that will be exposed to the service
- dir String
- The working directory for commands to run in
- dns
Config Property Map - Specification for DNS related configurations in resolver configuration file (
resolv.conf) - env Map<String>
- A list of environment variables in the form VAR="value"
- groups List<String>
- A list of additional groups that the container process will run as
- healthcheck Property Map
- A test to perform to check that the container is healthy
- hostname String
- The hostname to use for the container, as a valid RFC 1123 hostname
- hosts
- A list of hostname/IP mappings to add to the container's hosts file
- isolation String
- Isolation technology of the containers running the service. (Windows only). Defaults to
default. - labels List<Property Map>
- User-defined key/value metadata
- mounts List<Property Map>
- Specification for mounts to be added to containers created as part of the service
- privileges Property Map
- Security options for the container
- read
Only Boolean - Mount the container's root filesystem as read only
- secrets List<Property Map>
- References to zero or more secrets that will be exposed to the service
- stop
Grace StringPeriod - 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.
- stop
Signal String - Signal to stop the container
- sysctl
- Sysctls config (Linux only)
- user String
- The user inside the container
ServiceTaskSpecContainerSpecConfig, ServiceTaskSpecContainerSpecConfigArgs
, ServiceTaskSpecContainerSpecConfigArgs
- Config
Id This property is required. string - ID of the specific config that we're referencing
- File
Name This property is required. string - Represents the final filename in the filesystem
- Config
Name string - 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
- File
Gid string - Represents the file GID. Defaults to
0. - File
Mode int - Represents represents the FileMode of the file. Defaults to
0o444. - File
Uid string - Represents the file UID. Defaults to
0.
- Config
Id This property is required. string - ID of the specific config that we're referencing
- File
Name This property is required. string - Represents the final filename in the filesystem
- Config
Name string - 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
- File
Gid string - Represents the file GID. Defaults to
0. - File
Mode int - Represents represents the FileMode of the file. Defaults to
0o444. - File
Uid string - Represents the file UID. Defaults to
0.
- config
Id This property is required. String - ID of the specific config that we're referencing
- file
Name This property is required. String - Represents the final filename in the filesystem
- config
Name String - 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
- file
Gid String - Represents the file GID. Defaults to
0. - file
Mode Integer - Represents represents the FileMode of the file. Defaults to
0o444. - file
Uid String - Represents the file UID. Defaults to
0.
- config
Id This property is required. string - ID of the specific config that we're referencing
- file
Name This property is required. string - Represents the final filename in the filesystem
- config
Name string - 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
- file
Gid string - Represents the file GID. Defaults to
0. - file
Mode number - Represents represents the FileMode of the file. Defaults to
0o444. - file
Uid string - Represents the file UID. Defaults to
0.
- config_
id This property is required. str - ID of the specific config that we're referencing
- file_
name This property is required. str - Represents the final filename in the filesystem
- config_
name str - 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
- file_
gid str - Represents the file GID. Defaults to
0. - file_
mode int - Represents represents the FileMode of the file. Defaults to
0o444. - file_
uid str - Represents the file UID. Defaults to
0.
- config
Id This property is required. String - ID of the specific config that we're referencing
- file
Name This property is required. String - Represents the final filename in the filesystem
- config
Name String - 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
- file
Gid String - Represents the file GID. Defaults to
0. - file
Mode Number - Represents represents the FileMode of the file. Defaults to
0o444. - file
Uid String - Represents the file UID. Defaults to
0.
ServiceTaskSpecContainerSpecDnsConfig, ServiceTaskSpecContainerSpecDnsConfigArgs
, ServiceTaskSpecContainerSpecDnsConfigArgs
- Nameservers
This property is required. List<string> - The IP addresses of the name servers
- Options List<string>
- A list of internal resolver variables to be modified (e.g.,
debug,ndots:3, etc.) - Searches List<string>
- A search list for host-name lookup
- Nameservers
This property is required. []string - The IP addresses of the name servers
- Options []string
- A list of internal resolver variables to be modified (e.g.,
debug,ndots:3, etc.) - Searches []string
- A search list for host-name lookup
- nameservers
This property is required. List<String> - The IP addresses of the name servers
- options List<String>
- A list of internal resolver variables to be modified (e.g.,
debug,ndots:3, etc.) - searches List<String>
- A search list for host-name lookup
- nameservers
This property is required. string[] - The IP addresses of the name servers
- options string[]
- A list of internal resolver variables to be modified (e.g.,
debug,ndots:3, etc.) - searches string[]
- A search list for host-name lookup
- nameservers
This property is required. Sequence[str] - The IP addresses of the name servers
- options Sequence[str]
- A list of internal resolver variables to be modified (e.g.,
debug,ndots:3, etc.) - searches Sequence[str]
- A search list for host-name lookup
- nameservers
This property is required. List<String> - The IP addresses of the name servers
- options List<String>
- A list of internal resolver variables to be modified (e.g.,
debug,ndots:3, etc.) - searches List<String>
- A search list for host-name lookup
ServiceTaskSpecContainerSpecHealthcheck, ServiceTaskSpecContainerSpecHealthcheckArgs
, ServiceTaskSpecContainerSpecHealthcheckArgs
- Tests
This property is required. List<string> - The test to perform as list
- Interval string
- Time between running the check (ms|s|m|h). Defaults to
0s. - Retries int
- Consecutive failures needed to report unhealthy. Defaults to
0 - Start
Period string - Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to
0s. - Timeout string
- Maximum time to allow one check to run (ms|s|m|h). Defaults to
0s.
- Tests
This property is required. []string - The test to perform as list
- Interval string
- Time between running the check (ms|s|m|h). Defaults to
0s. - Retries int
- Consecutive failures needed to report unhealthy. Defaults to
0 - Start
Period string - Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to
0s. - Timeout string
- Maximum time to allow one check to run (ms|s|m|h). Defaults to
0s.
- tests
This property is required. List<String> - The test to perform as list
- interval String
- Time between running the check (ms|s|m|h). Defaults to
0s. - retries Integer
- Consecutive failures needed to report unhealthy. Defaults to
0 - start
Period String - Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to
0s. - timeout String
- Maximum time to allow one check to run (ms|s|m|h). Defaults to
0s.
- tests
This property is required. string[] - The test to perform as list
- interval string
- Time between running the check (ms|s|m|h). Defaults to
0s. - retries number
- Consecutive failures needed to report unhealthy. Defaults to
0 - start
Period string - Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to
0s. - timeout string
- Maximum time to allow one check to run (ms|s|m|h). Defaults to
0s.
- tests
This property is required. Sequence[str] - The test to perform as list
- interval str
- Time between running the check (ms|s|m|h). Defaults to
0s. - retries int
- Consecutive failures needed to report unhealthy. Defaults to
0 - start_
period str - Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to
0s. - timeout str
- Maximum time to allow one check to run (ms|s|m|h). Defaults to
0s.
- tests
This property is required. List<String> - The test to perform as list
- interval String
- Time between running the check (ms|s|m|h). Defaults to
0s. - retries Number
- Consecutive failures needed to report unhealthy. Defaults to
0 - start
Period String - Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to
0s. - timeout String
- Maximum time to allow one check to run (ms|s|m|h). Defaults to
0s.
ServiceTaskSpecContainerSpecHost, ServiceTaskSpecContainerSpecHostArgs
, ServiceTaskSpecContainerSpecHostArgs
ServiceTaskSpecContainerSpecLabel, ServiceTaskSpecContainerSpecLabelArgs
, ServiceTaskSpecContainerSpecLabelArgs
ServiceTaskSpecContainerSpecMount, ServiceTaskSpecContainerSpecMountArgs
, ServiceTaskSpecContainerSpecMountArgs
- Target
This property is required. string - Container path
- Type
This property is required. string - The mount type
- Bind
Options ServiceTask Spec Container Spec Mount Bind Options - Optional configuration for the bind type
- Read
Only bool - Whether the mount should be read-only
- Source string
- Mount source (e.g. a volume name, a host path)
- Tmpfs
Options ServiceTask Spec Container Spec Mount Tmpfs Options - Optional configuration for the tmpfs type
- Volume
Options ServiceTask Spec Container Spec Mount Volume Options - Optional configuration for the volume type
- Target
This property is required. string - Container path
- Type
This property is required. string - The mount type
- Bind
Options ServiceTask Spec Container Spec Mount Bind Options - Optional configuration for the bind type
- Read
Only bool - Whether the mount should be read-only
- Source string
- Mount source (e.g. a volume name, a host path)
- Tmpfs
Options ServiceTask Spec Container Spec Mount Tmpfs Options - Optional configuration for the tmpfs type
- Volume
Options ServiceTask Spec Container Spec Mount Volume Options - Optional configuration for the volume type
- target
This property is required. String - Container path
- type
This property is required. String - The mount type
- bind
Options ServiceTask Spec Container Spec Mount Bind Options - Optional configuration for the bind type
- read
Only Boolean - Whether the mount should be read-only
- source String
- Mount source (e.g. a volume name, a host path)
- tmpfs
Options ServiceTask Spec Container Spec Mount Tmpfs Options - Optional configuration for the tmpfs type
- volume
Options ServiceTask Spec Container Spec Mount Volume Options - Optional configuration for the volume type
- target
This property is required. string - Container path
- type
This property is required. string - The mount type
- bind
Options ServiceTask Spec Container Spec Mount Bind Options - Optional configuration for the bind type
- read
Only boolean - Whether the mount should be read-only
- source string
- Mount source (e.g. a volume name, a host path)
- tmpfs
Options ServiceTask Spec Container Spec Mount Tmpfs Options - Optional configuration for the tmpfs type
- volume
Options ServiceTask Spec Container Spec Mount Volume Options - Optional configuration for the volume type
- target
This property is required. str - Container path
- type
This property is required. str - The mount type
- bind_
options ServiceTask Spec Container Spec Mount Bind Options - Optional configuration for the bind type
- read_
only bool - Whether the mount should be read-only
- source str
- Mount source (e.g. a volume name, a host path)
- tmpfs_
options ServiceTask Spec Container Spec Mount Tmpfs Options - Optional configuration for the tmpfs type
- volume_
options ServiceTask Spec Container Spec Mount Volume Options - Optional configuration for the volume type
- target
This property is required. String - Container path
- type
This property is required. String - The mount type
- bind
Options Property Map - Optional configuration for the bind type
- read
Only Boolean - Whether the mount should be read-only
- source String
- Mount source (e.g. a volume name, a host path)
- tmpfs
Options Property Map - Optional configuration for the tmpfs type
- volume
Options Property Map - Optional configuration for the volume type
ServiceTaskSpecContainerSpecMountBindOptions, ServiceTaskSpecContainerSpecMountBindOptionsArgs
, ServiceTaskSpecContainerSpecMountBindOptionsArgs
- Propagation string
- 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 for details. Defaults to
rprivate
- Propagation string
- 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 for details. Defaults to
rprivate
- propagation String
- 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 for details. Defaults to
rprivate
- propagation string
- 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 for details. Defaults to
rprivate
- propagation str
- 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 for details. Defaults to
rprivate
- propagation String
- 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 for details. Defaults to
rprivate
ServiceTaskSpecContainerSpecMountTmpfsOptions, ServiceTaskSpecContainerSpecMountTmpfsOptionsArgs
, ServiceTaskSpecContainerSpecMountTmpfsOptionsArgs
- mode int
- The permission mode for the tmpfs mount in an integer
- size_
bytes int - The size for the tmpfs mount in bytes
ServiceTaskSpecContainerSpecMountVolumeOptions, ServiceTaskSpecContainerSpecMountVolumeOptionsArgs
, ServiceTaskSpecContainerSpecMountVolumeOptionsArgs
- Driver
Name string - Name of the driver to use to create the volume
- Driver
Options Dictionary<string, string> - key/value map of driver specific options
- Labels
List<Service
Task Spec Container Spec Mount Volume Options Label> - User-defined key/value metadata
- No
Copy bool - Populate volume with data from the target
- Driver
Name string - Name of the driver to use to create the volume
- Driver
Options map[string]string - key/value map of driver specific options
- Labels
[]Service
Task Spec Container Spec Mount Volume Options Label - User-defined key/value metadata
- No
Copy bool - Populate volume with data from the target
- driver
Name String - Name of the driver to use to create the volume
- driver
Options Map<String,String> - key/value map of driver specific options
- labels
List<Service
Task Spec Container Spec Mount Volume Options Label> - User-defined key/value metadata
- no
Copy Boolean - Populate volume with data from the target
- driver
Name string - Name of the driver to use to create the volume
- driver
Options {[key: string]: string} - key/value map of driver specific options
- labels
Service
Task Spec Container Spec Mount Volume Options Label[] - User-defined key/value metadata
- no
Copy boolean - Populate volume with data from the target
- driver_
name str - Name of the driver to use to create the volume
- driver_
options Mapping[str, str] - key/value map of driver specific options
- labels
Sequence[Service
Task Spec Container Spec Mount Volume Options Label] - User-defined key/value metadata
- no_
copy bool - Populate volume with data from the target
- driver
Name String - Name of the driver to use to create the volume
- driver
Options Map<String> - key/value map of driver specific options
- labels List<Property Map>
- User-defined key/value metadata
- no
Copy Boolean - Populate volume with data from the target
ServiceTaskSpecContainerSpecMountVolumeOptionsLabel, ServiceTaskSpecContainerSpecMountVolumeOptionsLabelArgs
, ServiceTaskSpecContainerSpecMountVolumeOptionsLabelArgs
ServiceTaskSpecContainerSpecPrivileges, ServiceTaskSpecContainerSpecPrivilegesArgs
, ServiceTaskSpecContainerSpecPrivilegesArgs
- Credential
Spec ServiceTask Spec Container Spec Privileges Credential Spec - CredentialSpec for managed service account (Windows only)
- Se
Linux ServiceContext Task Spec Container Spec Privileges Se Linux Context - SELinux labels of the container
- Credential
Spec ServiceTask Spec Container Spec Privileges Credential Spec - CredentialSpec for managed service account (Windows only)
- Se
Linux ServiceContext Task Spec Container Spec Privileges Se Linux Context - SELinux labels of the container
- credential
Spec ServiceTask Spec Container Spec Privileges Credential Spec - CredentialSpec for managed service account (Windows only)
- se
Linux ServiceContext Task Spec Container Spec Privileges Se Linux Context - SELinux labels of the container
- credential
Spec ServiceTask Spec Container Spec Privileges Credential Spec - CredentialSpec for managed service account (Windows only)
- se
Linux ServiceContext Task Spec Container Spec Privileges Se Linux Context - SELinux labels of the container
- credential_
spec ServiceTask Spec Container Spec Privileges Credential Spec - CredentialSpec for managed service account (Windows only)
- se_
linux_ Servicecontext Task Spec Container Spec Privileges Se Linux Context - SELinux labels of the container
- credential
Spec Property Map - CredentialSpec for managed service account (Windows only)
- se
Linux Property MapContext - SELinux labels of the container
ServiceTaskSpecContainerSpecPrivilegesCredentialSpec, ServiceTaskSpecContainerSpecPrivilegesCredentialSpecArgs
, ServiceTaskSpecContainerSpecPrivilegesCredentialSpecArgs
ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext, ServiceTaskSpecContainerSpecPrivilegesSeLinuxContextArgs
, ServiceTaskSpecContainerSpecPrivilegesSeLinuxContextArgs
ServiceTaskSpecContainerSpecSecret, ServiceTaskSpecContainerSpecSecretArgs
, ServiceTaskSpecContainerSpecSecretArgs
- File
Name This property is required. string - Represents the final filename in the filesystem
- Secret
Id This property is required. string - ID of the specific secret that we're referencing
- File
Gid string - Represents the file GID. Defaults to
0 - File
Mode int - Represents represents the FileMode of the file. Defaults to
0o444 - File
Uid string - Represents the file UID. Defaults to
0 - Secret
Name string - 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
- File
Name This property is required. string - Represents the final filename in the filesystem
- Secret
Id This property is required. string - ID of the specific secret that we're referencing
- File
Gid string - Represents the file GID. Defaults to
0 - File
Mode int - Represents represents the FileMode of the file. Defaults to
0o444 - File
Uid string - Represents the file UID. Defaults to
0 - Secret
Name string - 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
- file
Name This property is required. String - Represents the final filename in the filesystem
- secret
Id This property is required. String - ID of the specific secret that we're referencing
- file
Gid String - Represents the file GID. Defaults to
0 - file
Mode Integer - Represents represents the FileMode of the file. Defaults to
0o444 - file
Uid String - Represents the file UID. Defaults to
0 - secret
Name String - 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
- file
Name This property is required. string - Represents the final filename in the filesystem
- secret
Id This property is required. string - ID of the specific secret that we're referencing
- file
Gid string - Represents the file GID. Defaults to
0 - file
Mode number - Represents represents the FileMode of the file. Defaults to
0o444 - file
Uid string - Represents the file UID. Defaults to
0 - secret
Name string - 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
- file_
name This property is required. str - Represents the final filename in the filesystem
- secret_
id This property is required. str - ID of the specific secret that we're referencing
- file_
gid str - Represents the file GID. Defaults to
0 - file_
mode int - Represents represents the FileMode of the file. Defaults to
0o444 - file_
uid str - Represents the file UID. Defaults to
0 - secret_
name str - 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
- file
Name This property is required. String - Represents the final filename in the filesystem
- secret
Id This property is required. String - ID of the specific secret that we're referencing
- file
Gid String - Represents the file GID. Defaults to
0 - file
Mode Number - Represents represents the FileMode of the file. Defaults to
0o444 - file
Uid String - Represents the file UID. Defaults to
0 - secret
Name String - 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
ServiceTaskSpecLogDriver, ServiceTaskSpecLogDriverArgs
, ServiceTaskSpecLogDriverArgs
ServiceTaskSpecNetworksAdvanced, ServiceTaskSpecNetworksAdvancedArgs
, ServiceTaskSpecNetworksAdvancedArgs
- Name
string
This property is required. Changes to this property will trigger replacement. - The name/id of the network.
- Aliases
- The network aliases of the container in the specific network.
- Driver
Opts - An array of driver options for the network, e.g.
opts1=value
- Name
string
This property is required. Changes to this property will trigger replacement. - The name/id of the network.
- Aliases
- The network aliases of the container in the specific network.
- Driver
Opts - An array of driver options for the network, e.g.
opts1=value
- name
String
This property is required. Changes to this property will trigger replacement. - The name/id of the network.
- aliases
- The network aliases of the container in the specific network.
- driver
Opts - An array of driver options for the network, e.g.
opts1=value
- name
string
This property is required. Changes to this property will trigger replacement. - The name/id of the network.
- aliases
- The network aliases of the container in the specific network.
- driver
Opts - An array of driver options for the network, e.g.
opts1=value
- name
str
This property is required. Changes to this property will trigger replacement. - The name/id of the network.
- aliases
- The network aliases of the container in the specific network.
- driver_
opts - An array of driver options for the network, e.g.
opts1=value
- name
String
This property is required. Changes to this property will trigger replacement. - The name/id of the network.
- aliases
- The network aliases of the container in the specific network.
- driver
Opts - An array of driver options for the network, e.g.
opts1=value
ServiceTaskSpecPlacement, ServiceTaskSpecPlacementArgs
, ServiceTaskSpecPlacementArgs
- Constraints List<string>
- An array of constraints. e.g.:
node.role==manager - Max
Replicas int - Maximum number of replicas for per node (default value is
0, which is unlimited) - Platforms
List<Service
Task Spec Placement Platform> - Platforms stores all the platforms that the service's image can run on
- Prefs List<string>
- 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
- Constraints []string
- An array of constraints. e.g.:
node.role==manager - Max
Replicas int - Maximum number of replicas for per node (default value is
0, which is unlimited) - Platforms
[]Service
Task Spec Placement Platform - Platforms stores all the platforms that the service's image can run on
- Prefs []string
- 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
- constraints List<String>
- An array of constraints. e.g.:
node.role==manager - max
Replicas Integer - Maximum number of replicas for per node (default value is
0, which is unlimited) - platforms
List<Service
Task Spec Placement Platform> - Platforms stores all the platforms that the service's image can run on
- prefs List<String>
- 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
- constraints string[]
- An array of constraints. e.g.:
node.role==manager - max
Replicas number - Maximum number of replicas for per node (default value is
0, which is unlimited) - platforms
Service
Task Spec Placement Platform[] - Platforms stores all the platforms that the service's image can run on
- prefs string[]
- 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
- constraints Sequence[str]
- An array of constraints. e.g.:
node.role==manager - max_
replicas int - Maximum number of replicas for per node (default value is
0, which is unlimited) - platforms
Sequence[Service
Task Spec Placement Platform] - Platforms stores all the platforms that the service's image can run on
- prefs Sequence[str]
- 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
- constraints List<String>
- An array of constraints. e.g.:
node.role==manager - max
Replicas Number - Maximum number of replicas for per node (default value is
0, which is unlimited) - platforms List<Property Map>
- Platforms stores all the platforms that the service's image can run on
- prefs List<String>
- 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
ServiceTaskSpecPlacementPlatform, ServiceTaskSpecPlacementPlatformArgs
, ServiceTaskSpecPlacementPlatformArgs
- Architecture
This property is required. string - The architecture, e.g.
amd64 - Os
This property is required. string - The operation system, e.g.
linux
- Architecture
This property is required. string - The architecture, e.g.
amd64 - Os
This property is required. string - The operation system, e.g.
linux
- architecture
This property is required. String - The architecture, e.g.
amd64 - os
This property is required. String - The operation system, e.g.
linux
- architecture
This property is required. string - The architecture, e.g.
amd64 - os
This property is required. string - The operation system, e.g.
linux
- architecture
This property is required. str - The architecture, e.g.
amd64 - os
This property is required. str - The operation system, e.g.
linux
- architecture
This property is required. String - The architecture, e.g.
amd64 - os
This property is required. String - The operation system, e.g.
linux
ServiceTaskSpecResources, ServiceTaskSpecResourcesArgs
, ServiceTaskSpecResourcesArgs
- Limits
Service
Task Spec Resources Limits - Describes the resources which can be advertised by a node and requested by a task
- Reservation
Service
Task Spec Resources Reservation - An object describing the resources which can be advertised by a node and requested by a task
- Limits
Service
Task Spec Resources Limits - Describes the resources which can be advertised by a node and requested by a task
- Reservation
Service
Task Spec Resources Reservation - An object describing the resources which can be advertised by a node and requested by a task
- limits
Service
Task Spec Resources Limits - Describes the resources which can be advertised by a node and requested by a task
- reservation
Service
Task Spec Resources Reservation - An object describing the resources which can be advertised by a node and requested by a task
- limits
Service
Task Spec Resources Limits - Describes the resources which can be advertised by a node and requested by a task
- reservation
Service
Task Spec Resources Reservation - An object describing the resources which can be advertised by a node and requested by a task
- limits
Service
Task Spec Resources Limits - Describes the resources which can be advertised by a node and requested by a task
- reservation
Service
Task Spec Resources Reservation - An object describing the resources which can be advertised by a node and requested by a task
- limits Property Map
- Describes the resources which can be advertised by a node and requested by a task
- reservation Property Map
- An object describing the resources which can be advertised by a node and requested by a task
ServiceTaskSpecResourcesLimits, ServiceTaskSpecResourcesLimitsArgs
, ServiceTaskSpecResourcesLimitsArgs
- Memory
Bytes int - The amounf of memory in bytes the container allocates
- Nano
Cpus int - CPU shares in units of
1/1e9(or10^-9) of the CPU. Should be at least1000000
- Memory
Bytes int - The amounf of memory in bytes the container allocates
- Nano
Cpus int - CPU shares in units of
1/1e9(or10^-9) of the CPU. Should be at least1000000
- memory
Bytes Integer - The amounf of memory in bytes the container allocates
- nano
Cpus Integer - CPU shares in units of
1/1e9(or10^-9) of the CPU. Should be at least1000000
- memory
Bytes number - The amounf of memory in bytes the container allocates
- nano
Cpus number - CPU shares in units of
1/1e9(or10^-9) of the CPU. Should be at least1000000
- memory_
bytes int - The amounf of memory in bytes the container allocates
- nano_
cpus int - CPU shares in units of
1/1e9(or10^-9) of the CPU. Should be at least1000000
- memory
Bytes Number - The amounf of memory in bytes the container allocates
- nano
Cpus Number - CPU shares in units of
1/1e9(or10^-9) of the CPU. Should be at least1000000
ServiceTaskSpecResourcesReservation, ServiceTaskSpecResourcesReservationArgs
, ServiceTaskSpecResourcesReservationArgs
- Generic
Resources ServiceTask Spec Resources Reservation Generic Resources - User-defined resources can be either Integer resources (e.g,
SSD=3) or String resources (e.g, GPU=UUID1) - Memory
Bytes int - The amounf of memory in bytes the container allocates
- Nano
Cpus int - CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least
1000000
- Generic
Resources ServiceTask Spec Resources Reservation Generic Resources - User-defined resources can be either Integer resources (e.g,
SSD=3) or String resources (e.g, GPU=UUID1) - Memory
Bytes int - The amounf of memory in bytes the container allocates
- Nano
Cpus int - CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least
1000000
- generic
Resources ServiceTask Spec Resources Reservation Generic Resources - User-defined resources can be either Integer resources (e.g,
SSD=3) or String resources (e.g, GPU=UUID1) - memory
Bytes Integer - The amounf of memory in bytes the container allocates
- nano
Cpus Integer - CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least
1000000
- generic
Resources ServiceTask Spec Resources Reservation Generic Resources - User-defined resources can be either Integer resources (e.g,
SSD=3) or String resources (e.g, GPU=UUID1) - memory
Bytes number - The amounf 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
- generic_
resources ServiceTask Spec Resources Reservation Generic Resources - User-defined resources can be either Integer resources (e.g,
SSD=3) or String resources (e.g, GPU=UUID1) - memory_
bytes int - The amounf of memory in bytes the container allocates
- nano_
cpus int - CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least
1000000
- generic
Resources Property Map - User-defined resources can be either Integer resources (e.g,
SSD=3) or String resources (e.g, GPU=UUID1) - memory
Bytes Number - The amounf 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
ServiceTaskSpecResourcesReservationGenericResources, ServiceTaskSpecResourcesReservationGenericResourcesArgs
, ServiceTaskSpecResourcesReservationGenericResourcesArgs
- Discrete
Resources List<string>Specs - The Integer resources
- Named
Resources List<string>Specs - The String resources
- Discrete
Resources []stringSpecs - The Integer resources
- Named
Resources []stringSpecs - The String resources
- discrete
Resources List<String>Specs - The Integer resources
- named
Resources List<String>Specs - The String resources
- discrete
Resources string[]Specs - The Integer resources
- named
Resources string[]Specs - The String resources
- discrete_
resources_ Sequence[str]specs - The Integer resources
- named_
resources_ Sequence[str]specs - The String resources
- discrete
Resources List<String>Specs - The Integer resources
- named
Resources List<String>Specs - The String resources
ServiceTaskSpecRestartPolicy, ServiceTaskSpecRestartPolicyArgs
, ServiceTaskSpecRestartPolicyArgs
- Condition string
- Condition for restart
- Delay string
- Delay between restart attempts (ms|s|m|h)
- Max
Attempts int - Maximum attempts to restart a given container before giving up (default value is
0, which is ignored) - Window string
- The time window used to evaluate the restart policy (default value is
0, which is unbounded) (ms|s|m|h)
- Condition string
- Condition for restart
- Delay string
- Delay between restart attempts (ms|s|m|h)
- Max
Attempts int - Maximum attempts to restart a given container before giving up (default value is
0, which is ignored) - Window string
- The time window used to evaluate the restart policy (default value is
0, which is unbounded) (ms|s|m|h)
- condition String
- Condition for restart
- delay String
- Delay between restart attempts (ms|s|m|h)
- max
Attempts Integer - Maximum attempts to restart a given container before giving up (default value is
0, which is ignored) - window String
- The time window used to evaluate the restart policy (default value is
0, which is unbounded) (ms|s|m|h)
- condition string
- Condition for restart
- delay string
- Delay between restart attempts (ms|s|m|h)
- max
Attempts number - Maximum attempts to restart a given container before giving up (default value is
0, which is ignored) - window string
- The time window used to evaluate the restart policy (default value is
0, which is unbounded) (ms|s|m|h)
- condition str
- Condition for restart
- delay str
- Delay between restart attempts (ms|s|m|h)
- max_
attempts int - Maximum attempts to restart a given container before giving up (default value is
0, which is ignored) - window str
- The time window used to evaluate the restart policy (default value is
0, which is unbounded) (ms|s|m|h)
- condition String
- Condition for restart
- delay String
- Delay between restart attempts (ms|s|m|h)
- max
Attempts Number - Maximum attempts to restart a given container before giving up (default value is
0, which is ignored) - window String
- The time window used to evaluate the restart policy (default value is
0, which is unbounded) (ms|s|m|h)
ServiceUpdateConfig, ServiceUpdateConfigArgs
, ServiceUpdateConfigArgs
- Delay string
- Delay between task updates
(ns|us|ms|s|m|h). Defaults to0s. - Failure
Action string - Action on update failure:
pause,continueorrollback. Defaults topause. - Max
Failure stringRatio - 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 to0s. - Failure
Action string - Action on update failure:
pause,continueorrollback. Defaults topause. - Max
Failure stringRatio - 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 to0s. - failure
Action String - Action on update failure:
pause,continueorrollback. Defaults topause. - max
Failure StringRatio - 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 to0s. - failure
Action string - Action on update failure:
pause,continueorrollback. Defaults topause. - max
Failure stringRatio - 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 to0s. - failure_
action str - Action on update failure:
pause,continueorrollback. Defaults topause. - max_
failure_ strratio - 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 to0s. - failure
Action String - Action on update failure:
pause,continueorrollback. Defaults topause. - max
Failure StringRatio - 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
dockerTerraform Provider.