@pulumi/docker 4.6.0-alpha.1706746135 → 4.6.0-alpha.1706812288

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pulumi/docker",
-    "version": "v4.6.0-alpha.1706746135+cad68734",
+    "version": "v4.6.0-alpha.1706812288+75e33952",
     "description": "A Pulumi package for interacting with Docker in Pulumi programs",
     "keywords": [
         "pulumi",

package/types/input.d.ts

@@ -153,13 +153,37 @@ export interface ContainerMountVolumeOptionsLabel {
     value: pulumi.Input<string>;
 }
 export interface ContainerNetworkData {
+    /**
+     * The network gateway of the container.
+     */
     gateway?: pulumi.Input<string>;
+    /**
+     * The IPV6 address of the container.
+     */
     globalIpv6Address?: pulumi.Input<string>;
+    /**
+     * The IPV6 prefix length address of the container.
+     */
     globalIpv6PrefixLength?: pulumi.Input<number>;
+    /**
+     * The IP address of the container.
+     */
     ipAddress?: pulumi.Input<string>;
+    /**
+     * The IP prefix length of the container.
+     */
     ipPrefixLength?: pulumi.Input<number>;
+    /**
+     * The IPV6 gateway of the container.
+     */
     ipv6Gateway?: pulumi.Input<string>;
+    /**
+     * The MAC address of the container.
+     */
     macAddress?: pulumi.Input<string>;
+    /**
+     * The name of the network
+     */
     networkName?: pulumi.Input<string>;
 }
 export interface ContainerNetworksAdvanced {
@@ -344,11 +368,26 @@ export interface PluginGrantPermission {
     values: pulumi.Input<pulumi.Input<string>[]>;
 }
 export interface ProviderRegistryAuth {
+    /**
+     * Address of the registry
+     */
     address: pulumi.Input<string>;
     authDisabled?: pulumi.Input<boolean>;
+    /**
+     * Path to docker json file for registry auth. Defaults to `~/.docker/config.json`. If `DOCKER_CONFIG` is set, the value of `DOCKER_CONFIG` is used as the path. `configFile` has predencen over all other options.
+     */
     configFile?: pulumi.Input<string>;
+    /**
+     * Plain content of the docker json file for registry auth. `configFileContent` has precedence over username/password.
+     */
     configFileContent?: pulumi.Input<string>;
+    /**
+     * Password for the registry. Defaults to `DOCKER_REGISTRY_PASS` env variable if set.
+     */
     password?: pulumi.Input<string>;
+    /**
+     * Username for the registry. Defaults to `DOCKER_REGISTRY_USER` env variable if set.
+     */
     username?: pulumi.Input<string>;
 }
 /**
@@ -577,210 +616,603 @@ export interface SecretLabel {
     value: pulumi.Input<string>;
 }
 export interface ServiceAuth {
+    /**
+     * The password
+     */
     password?: pulumi.Input<string>;
+    /**
+     * The address of the server for the authentication
+     */
     serverAddress: pulumi.Input<string>;
+    /**
+     * The username
+     */
     username?: pulumi.Input<string>;
 }
 export interface ServiceConvergeConfig {
+    /**
+     * The interval to check if the desired state is reached `(ms|s)`. Defaults to `7s`.
+     */
     delay?: pulumi.Input<string>;
+    /**
+     * The timeout of the service to reach the desired state `(s|m)`. Defaults to `3m`
+     */
     timeout?: pulumi.Input<string>;
 }
 export interface ServiceEndpointSpec {
+    /**
+     * The mode of resolution to use for internal load balancing between tasks
+     */
     mode?: pulumi.Input<string>;
+    /**
+     * List of exposed ports that this service is accessible on from the outside. Ports can only be provided if 'vip' resolution mode is used
+     */
     ports?: pulumi.Input<pulumi.Input<inputs.ServiceEndpointSpecPort>[]>;
 }
 export interface ServiceEndpointSpecPort {
+    /**
+     * A random name for the port
+     */
     name?: pulumi.Input<string>;
+    /**
+     * Rrepresents the protocol of a port: `tcp`, `udp` or `sctp`. Defaults to `tcp`.
+     */
     protocol?: pulumi.Input<string>;
+    /**
+     * Represents the mode in which the port is to be published: 'ingress' or 'host'. Defaults to `ingress`.
+     */
     publishMode?: pulumi.Input<string>;
+    /**
+     * The port on the swarm hosts
+     */
     publishedPort?: pulumi.Input<number>;
+    /**
+     * The port inside the container
+     */
     targetPort: pulumi.Input<number>;
 }
 export interface ServiceLabel {
+    /**
+     * Name of the label
+     */
     label: pulumi.Input<string>;
+    /**
+     * Value of the label
+     */
     value: pulumi.Input<string>;
 }
 export interface ServiceMode {
+    /**
+     * When `true`, tasks will run on every worker node. Conflicts with `replicated`
+     */
     global?: pulumi.Input<boolean>;
+    /**
+     * The replicated service mode
+     */
     replicated?: pulumi.Input<inputs.ServiceModeReplicated>;
 }
 export interface ServiceModeReplicated {
+    /**
+     * The amount of replicas of the service. Defaults to `1`
+     */
     replicas?: pulumi.Input<number>;
 }
 export interface ServiceRollbackConfig {
+    /**
+     * Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to `0s`.
+     */
     delay?: pulumi.Input<string>;
+    /**
+     * Action on rollback failure: pause | continue. Defaults to `pause`.
+     */
     failureAction?: pulumi.Input<string>;
+    /**
+     * Failure rate to tolerate during a rollback. Defaults to `0.0`.
+     */
     maxFailureRatio?: pulumi.Input<string>;
+    /**
+     * Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h). Defaults to `5s`.
+     */
     monitor?: pulumi.Input<string>;
+    /**
+     * Rollback order: either 'stop-first' or 'start-first'. Defaults to `stop-first`.
+     */
     order?: pulumi.Input<string>;
+    /**
+     * Maximum number of tasks to be rollbacked in one iteration. Defaults to `1`
+     */
     parallelism?: pulumi.Input<number>;
 }
 export interface ServiceTaskSpec {
+    /**
+     * The spec for each container
+     */
     containerSpec: pulumi.Input<inputs.ServiceTaskSpecContainerSpec>;
+    /**
+     * A counter that triggers an update even if no relevant parameters have been changed. See the [spec](https://github.com/docker/swarmkit/blob/master/api/specs.proto#L126).
+     */
     forceUpdate?: pulumi.Input<number>;
+    /**
+     * 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
+     */
     logDriver?: pulumi.Input<inputs.ServiceTaskSpecLogDriver>;
+    /**
+     * The networks the container is attached to
+     */
     networksAdvanceds?: pulumi.Input<pulumi.Input<inputs.ServiceTaskSpecNetworksAdvanced>[]>;
+    /**
+     * The placement preferences
+     */
     placement?: pulumi.Input<inputs.ServiceTaskSpecPlacement>;
+    /**
+     * Resource requirements which apply to each individual container created as part of the service
+     */
     resources?: pulumi.Input<inputs.ServiceTaskSpecResources>;
+    /**
+     * Specification for the restart policy which applies to containers created as part of this service.
+     */
     restartPolicy?: pulumi.Input<inputs.ServiceTaskSpecRestartPolicy>;
+    /**
+     * Runtime is the type of runtime specified for the task executor. See the [types](https://github.com/moby/moby/blob/master/api/types/swarm/runtime.go).
+     */
     runtime?: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpec {
+    /**
+     * Arguments to the command
+     */
     args?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * The command/entrypoint to be run in the image. According to the [docker cli](https://github.com/docker/cli/blob/v20.10.7/cli/command/service/opts.go#L705) the override of the entrypoint is also passed to the `command` property and there is no `entrypoint` attribute in the `ContainerSpec` of the service.
+     */
     commands?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * References to zero or more configs that will be exposed to the service
+     */
     configs?: pulumi.Input<pulumi.Input<inputs.ServiceTaskSpecContainerSpecConfig>[]>;
+    /**
+     * The working directory for commands to run in
+     */
     dir?: pulumi.Input<string>;
+    /**
+     * Specification for DNS related configurations in resolver configuration file (`resolv.conf`)
+     */
     dnsConfig?: pulumi.Input<inputs.ServiceTaskSpecContainerSpecDnsConfig>;
+    /**
+     * A list of environment variables in the form VAR="value"
+     */
     env?: pulumi.Input<{
         [key: string]: pulumi.Input<string>;
     }>;
+    /**
+     * A list of additional groups that the container process will run as
+     */
     groups?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * A test to perform to check that the container is healthy
+     */
     healthcheck?: pulumi.Input<inputs.ServiceTaskSpecContainerSpecHealthcheck>;
+    /**
+     * The hostname to use for the container, as a valid RFC 1123 hostname
+     */
     hostname?: pulumi.Input<string>;
+    /**
+     * A list of hostname/IP mappings to add to the container's hosts file
+     */
     hosts?: pulumi.Input<pulumi.Input<inputs.ServiceTaskSpecContainerSpecHost>[]>;
+    /**
+     * The image name to use for the containers of the service, like `nginx:1.17.6`. Also use the data-source or resource of `docker.RemoteImage` with the `repoDigest` or `docker.RegistryImage` with the `name` attribute for this, as shown in the examples.
+     */
     image: pulumi.Input<string>;
+    /**
+     * Isolation technology of the containers running the service. (Windows only). Defaults to `default`.
+     */
     isolation?: pulumi.Input<string>;
+    /**
+     * User-defined key/value metadata
+     */
     labels?: pulumi.Input<pulumi.Input<inputs.ServiceTaskSpecContainerSpecLabel>[]>;
+    /**
+     * Specification for mounts to be added to containers created as part of the service
+     */
     mounts?: pulumi.Input<pulumi.Input<inputs.ServiceTaskSpecContainerSpecMount>[]>;
+    /**
+     * Security options for the container
+     */
     privileges?: pulumi.Input<inputs.ServiceTaskSpecContainerSpecPrivileges>;
+    /**
+     * Mount the container's root filesystem as read only
+     */
     readOnly?: pulumi.Input<boolean>;
+    /**
+     * References to zero or more secrets that will be exposed to the service
+     */
     secrets?: pulumi.Input<pulumi.Input<inputs.ServiceTaskSpecContainerSpecSecret>[]>;
+    /**
+     * 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.
+     */
     stopGracePeriod?: pulumi.Input<string>;
+    /**
+     * Signal to stop the container
+     */
     stopSignal?: pulumi.Input<string>;
+    /**
+     * Sysctls config (Linux only)
+     */
     sysctl?: pulumi.Input<{
         [key: string]: any;
     }>;
+    /**
+     * The user inside the container
+     */
     user?: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpecConfig {
+    /**
+     * ID of the specific config that we're referencing
+     */
     configId: pulumi.Input<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
+     */
     configName?: pulumi.Input<string>;
+    /**
+     * Represents the file GID. Defaults to `0`.
+     */
     fileGid?: pulumi.Input<string>;
+    /**
+     * Represents represents the FileMode of the file. Defaults to `0o444`.
+     */
     fileMode?: pulumi.Input<number>;
+    /**
+     * Represents the final filename in the filesystem
+     */
     fileName: pulumi.Input<string>;
+    /**
+     * Represents the file UID. Defaults to `0`.
+     */
     fileUid?: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpecDnsConfig {
+    /**
+     * The IP addresses of the name servers
+     */
     nameservers: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.)
+     */
     options?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * A search list for host-name lookup
+     */
     searches?: pulumi.Input<pulumi.Input<string>[]>;
 }
 export interface ServiceTaskSpecContainerSpecHealthcheck {
+    /**
+     * Time between running the check (ms|s|m|h). Defaults to `0s`.
+     */
     interval?: pulumi.Input<string>;
+    /**
+     * Consecutive failures needed to report unhealthy. Defaults to `0`
+     */
     retries?: pulumi.Input<number>;
+    /**
+     * Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to `0s`.
+     */
     startPeriod?: pulumi.Input<string>;
+    /**
+     * The test to perform as list
+     */
     tests: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Maximum time to allow one check to run (ms|s|m|h). Defaults to `0s`.
+     */
     timeout?: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpecHost {
+    /**
+     * The name of the host
+     */
     host: pulumi.Input<string>;
+    /**
+     * The ip of the host
+     */
     ip: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpecLabel {
+    /**
+     * Name of the label
+     */
     label: pulumi.Input<string>;
+    /**
+     * Value of the label
+     */
     value: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpecMount {
+    /**
+     * Optional configuration for the bind type
+     */
     bindOptions?: pulumi.Input<inputs.ServiceTaskSpecContainerSpecMountBindOptions>;
+    /**
+     * Whether the mount should be read-only
+     */
     readOnly?: pulumi.Input<boolean>;
+    /**
+     * Mount source (e.g. a volume name, a host path)
+     */
     source?: pulumi.Input<string>;
+    /**
+     * Container path
+     */
     target: pulumi.Input<string>;
+    /**
+     * Optional configuration for the tmpfs type
+     */
     tmpfsOptions?: pulumi.Input<inputs.ServiceTaskSpecContainerSpecMountTmpfsOptions>;
+    /**
+     * The mount type
+     */
     type: pulumi.Input<string>;
+    /**
+     * Optional configuration for the volume type
+     */
     volumeOptions?: pulumi.Input<inputs.ServiceTaskSpecContainerSpecMountVolumeOptions>;
 }
 export interface ServiceTaskSpecContainerSpecMountBindOptions {
+    /**
+     * Bind propagation refers to whether or not mounts created within a given bind-mount or named volume can be propagated to replicas of that mount. See the [docs](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) for details. Defaults to `rprivate`
+     */
     propagation?: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpecMountTmpfsOptions {
+    /**
+     * The permission mode for the tmpfs mount in an integer
+     */
     mode?: pulumi.Input<number>;
+    /**
+     * The size for the tmpfs mount in bytes
+     */
     sizeBytes?: pulumi.Input<number>;
 }
 export interface ServiceTaskSpecContainerSpecMountVolumeOptions {
+    /**
+     * Name of the driver to use to create the volume
+     */
     driverName?: pulumi.Input<string>;
+    /**
+     * key/value map of driver specific options
+     */
     driverOptions?: pulumi.Input<{
         [key: string]: pulumi.Input<string>;
     }>;
+    /**
+     * User-defined key/value metadata
+     */
     labels?: pulumi.Input<pulumi.Input<inputs.ServiceTaskSpecContainerSpecMountVolumeOptionsLabel>[]>;
+    /**
+     * Populate volume with data from the target
+     */
     noCopy?: pulumi.Input<boolean>;
 }
 export interface ServiceTaskSpecContainerSpecMountVolumeOptionsLabel {
+    /**
+     * Name of the label
+     */
     label: pulumi.Input<string>;
+    /**
+     * Value of the label
+     */
     value: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpecPrivileges {
+    /**
+     * CredentialSpec for managed service account (Windows only)
+     */
     credentialSpec?: pulumi.Input<inputs.ServiceTaskSpecContainerSpecPrivilegesCredentialSpec>;
+    /**
+     * SELinux labels of the container
+     */
     seLinuxContext?: pulumi.Input<inputs.ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext>;
 }
 export interface ServiceTaskSpecContainerSpecPrivilegesCredentialSpec {
+    /**
+     * Load credential spec from this file
+     */
     file?: pulumi.Input<string>;
+    /**
+     * Load credential spec from this value in the Windows registry
+     */
     registry?: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext {
+    /**
+     * Disable SELinux
+     */
     disable?: pulumi.Input<boolean>;
+    /**
+     * SELinux level label
+     */
     level?: pulumi.Input<string>;
+    /**
+     * SELinux role label
+     */
     role?: pulumi.Input<string>;
+    /**
+     * SELinux type label
+     */
     type?: pulumi.Input<string>;
+    /**
+     * SELinux user label
+     */
     user?: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecContainerSpecSecret {
+    /**
+     * Represents the file GID. Defaults to `0`
+     */
     fileGid?: pulumi.Input<string>;
+    /**
+     * Represents represents the FileMode of the file. Defaults to `0o444`
+     */
     fileMode?: pulumi.Input<number>;
+    /**
+     * Represents the final filename in the filesystem
+     */
     fileName: pulumi.Input<string>;
+    /**
+     * Represents the file UID. Defaults to `0`
+     */
     fileUid?: pulumi.Input<string>;
+    /**
+     * ID of the specific secret that we're referencing
+     */
     secretId: pulumi.Input<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
+     */
     secretName?: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecLogDriver {
+    /**
+     * The logging driver to use
+     */
     name: pulumi.Input<string>;
+    /**
+     * The options for the logging driver
+     */
     options?: pulumi.Input<{
         [key: string]: pulumi.Input<string>;
     }>;
 }
 export interface ServiceTaskSpecNetworksAdvanced {
+    /**
+     * The network aliases of the container in the specific network.
+     */
     aliases?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * An array of driver options for the network, e.g. `opts1=value`
+     */
     driverOpts?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * The name/id of the network.
+     */
     name: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecPlacement {
+    /**
+     * An array of constraints. e.g.: `node.role==manager`
+     */
     constraints?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Maximum number of replicas for per node (default value is `0`, which is unlimited)
+     */
     maxReplicas?: pulumi.Input<number>;
+    /**
+     * Platforms stores all the platforms that the service's image can run on
+     */
     platforms?: pulumi.Input<pulumi.Input<inputs.ServiceTaskSpecPlacementPlatform>[]>;
+    /**
+     * 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`
+     */
     prefs?: pulumi.Input<pulumi.Input<string>[]>;
 }
 export interface ServiceTaskSpecPlacementPlatform {
+    /**
+     * The architecture, e.g. `amd64`
+     */
     architecture: pulumi.Input<string>;
+    /**
+     * The operation system, e.g. `linux`
+     */
     os: pulumi.Input<string>;
 }
 export interface ServiceTaskSpecResources {
+    /**
+     * Describes the resources which can be advertised by a node and requested by a task
+     */
     limits?: pulumi.Input<inputs.ServiceTaskSpecResourcesLimits>;
+    /**
+     * An object describing the resources which can be advertised by a node and requested by a task
+     */
     reservation?: pulumi.Input<inputs.ServiceTaskSpecResourcesReservation>;
 }
 export interface ServiceTaskSpecResourcesLimits {
+    /**
+     * The amounf of memory in bytes the container allocates
+     */
     memoryBytes?: pulumi.Input<number>;
+    /**
+     * CPU shares in units of `1/1e9` (or `10^-9`) of the CPU. Should be at least `1000000`
+     */
     nanoCpus?: pulumi.Input<number>;
 }
 export interface ServiceTaskSpecResourcesReservation {
+    /**
+     * User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, GPU=UUID1)
+     */
     genericResources?: pulumi.Input<inputs.ServiceTaskSpecResourcesReservationGenericResources>;
+    /**
+     * The amounf of memory in bytes the container allocates
+     */
     memoryBytes?: pulumi.Input<number>;
+    /**
+     * CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least `1000000`
+     */
     nanoCpus?: pulumi.Input<number>;
 }
 export interface ServiceTaskSpecResourcesReservationGenericResources {
+    /**
+     * The Integer resources
+     */
     discreteResourcesSpecs?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * The String resources
+     */
     namedResourcesSpecs?: pulumi.Input<pulumi.Input<string>[]>;
 }
 export interface ServiceTaskSpecRestartPolicy {
+    /**
+     * Condition for restart
+     */
     condition?: pulumi.Input<string>;
+    /**
+     * Delay between restart attempts (ms|s|m|h)
+     */
     delay?: pulumi.Input<string>;
+    /**
+     * Maximum attempts to restart a given container before giving up (default value is `0`, which is ignored)
+     */
     maxAttempts?: pulumi.Input<number>;
+    /**
+     * The time window used to evaluate the restart policy (default value is `0`, which is unbounded) (ms|s|m|h)
+     */
     window?: pulumi.Input<string>;
 }
 export interface ServiceUpdateConfig {
+    /**
+     * Delay between task updates `(ns|us|ms|s|m|h)`. Defaults to `0s`.
+     */
     delay?: pulumi.Input<string>;
+    /**
+     * Action on update failure: `pause`, `continue` or `rollback`. Defaults to `pause`.
+     */
     failureAction?: pulumi.Input<string>;
+    /**
+     * Failure rate to tolerate during an update. Defaults to `0.0`.
+     */
     maxFailureRatio?: pulumi.Input<string>;
+    /**
+     * Duration after each task update to monitor for failure (ns|us|ms|s|m|h). Defaults to `5s`.
+     */
     monitor?: pulumi.Input<string>;
+    /**
+     * Update order: either 'stop-first' or 'start-first'. Defaults to `stop-first`.
+     */
     order?: pulumi.Input<string>;
+    /**
+     * Maximum number of tasks to be updated in one iteration. Defaults to `1`
+     */
     parallelism?: pulumi.Input<number>;
 }
 export interface VolumeLabel {

package/types/output.d.ts

@@ -142,13 +142,37 @@ export interface ContainerMountVolumeOptionsLabel {
     value: string;
 }
 export interface ContainerNetworkData {
+    /**
+     * The network gateway of the container.
+     */
     gateway: string;
+    /**
+     * The IPV6 address of the container.
+     */
     globalIpv6Address: string;
+    /**
+     * The IPV6 prefix length address of the container.
+     */
     globalIpv6PrefixLength: number;
+    /**
+     * The IP address of the container.
+     */
     ipAddress: string;
+    /**
+     * The IP prefix length of the container.
+     */
     ipPrefixLength: number;
+    /**
+     * The IPV6 gateway of the container.
+     */
     ipv6Gateway: string;
+    /**
+     * The MAC address of the container.
+     */
     macAddress: string;
+    /**
+     * The name of the network
+     */
     networkName: string;
 }
 export interface ContainerNetworksAdvanced {
@@ -250,11 +274,23 @@ export interface ContainerVolume {
     volumeName?: string;
 }
 export interface GetNetworkIpamConfig {
+    /**
+     * Auxiliary IPv4 or IPv6 addresses used by Network driver
+     */
     auxAddress?: {
         [key: string]: any;
     };
+    /**
+     * The IP address of the gateway
+     */
     gateway?: string;
+    /**
+     * The ip range in CIDR form
+     */
     ipRange?: string;
+    /**
+     * The subnet in CIDR form
+     */
     subnet?: string;
 }
 export interface NetworkIpamConfig {
@@ -506,210 +542,603 @@ export interface SecretLabel {
     value: string;
 }
 export interface ServiceAuth {
+    /**
+     * The password
+     */
     password?: string;
+    /**
+     * The address of the server for the authentication
+     */
     serverAddress: string;
+    /**
+     * The username
+     */
     username?: string;
 }
 export interface ServiceConvergeConfig {
+    /**
+     * The interval to check if the desired state is reached `(ms|s)`. Defaults to `7s`.
+     */
     delay?: string;
+    /**
+     * The timeout of the service to reach the desired state `(s|m)`. Defaults to `3m`
+     */
     timeout?: string;
 }
 export interface ServiceEndpointSpec {
+    /**
+     * The mode of resolution to use for internal load balancing between tasks
+     */
     mode: string;
+    /**
+     * List of exposed ports that this service is accessible on from the outside. Ports can only be provided if 'vip' resolution mode is used
+     */
     ports?: outputs.ServiceEndpointSpecPort[];
 }
 export interface ServiceEndpointSpecPort {
+    /**
+     * A random name for the port
+     */
     name?: string;
+    /**
+     * Rrepresents the protocol of a port: `tcp`, `udp` or `sctp`. Defaults to `tcp`.
+     */
     protocol?: string;
+    /**
+     * Represents the mode in which the port is to be published: 'ingress' or 'host'. Defaults to `ingress`.
+     */
     publishMode?: string;
+    /**
+     * The port on the swarm hosts
+     */
     publishedPort: number;
+    /**
+     * The port inside the container
+     */
     targetPort: number;
 }
 export interface ServiceLabel {
+    /**
+     * Name of the label
+     */
     label: string;
+    /**
+     * Value of the label
+     */
     value: string;
 }
 export interface ServiceMode {
+    /**
+     * When `true`, tasks will run on every worker node. Conflicts with `replicated`
+     */
     global?: boolean;
+    /**
+     * The replicated service mode
+     */
     replicated: outputs.ServiceModeReplicated;
 }
 export interface ServiceModeReplicated {
+    /**
+     * The amount of replicas of the service. Defaults to `1`
+     */
     replicas?: number;
 }
 export interface ServiceRollbackConfig {
+    /**
+     * Delay between task rollbacks (ns|us|ms|s|m|h). Defaults to `0s`.
+     */
     delay?: string;
+    /**
+     * Action on rollback failure: pause | continue. Defaults to `pause`.
+     */
     failureAction?: string;
+    /**
+     * Failure rate to tolerate during a rollback. Defaults to `0.0`.
+     */
     maxFailureRatio?: string;
+    /**
+     * Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h). Defaults to `5s`.
+     */
     monitor?: string;
+    /**
+     * Rollback order: either 'stop-first' or 'start-first'. Defaults to `stop-first`.
+     */
     order?: string;
+    /**
+     * Maximum number of tasks to be rollbacked in one iteration. Defaults to `1`
+     */
     parallelism?: number;
 }
 export interface ServiceTaskSpec {
+    /**
+     * The spec for each container
+     */
     containerSpec: outputs.ServiceTaskSpecContainerSpec;
+    /**
+     * A counter that triggers an update even if no relevant parameters have been changed. See the [spec](https://github.com/docker/swarmkit/blob/master/api/specs.proto#L126).
+     */
     forceUpdate: number;
+    /**
+     * 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
+     */
     logDriver?: outputs.ServiceTaskSpecLogDriver;
+    /**
+     * The networks the container is attached to
+     */
     networksAdvanceds?: outputs.ServiceTaskSpecNetworksAdvanced[];
+    /**
+     * The placement preferences
+     */
     placement: outputs.ServiceTaskSpecPlacement;
+    /**
+     * Resource requirements which apply to each individual container created as part of the service
+     */
     resources: outputs.ServiceTaskSpecResources;
+    /**
+     * Specification for the restart policy which applies to containers created as part of this service.
+     */
     restartPolicy: outputs.ServiceTaskSpecRestartPolicy;
+    /**
+     * Runtime is the type of runtime specified for the task executor. See the [types](https://github.com/moby/moby/blob/master/api/types/swarm/runtime.go).
+     */
     runtime: string;
 }
 export interface ServiceTaskSpecContainerSpec {
+    /**
+     * Arguments to the command
+     */
     args?: string[];
+    /**
+     * The command/entrypoint to be run in the image. According to the [docker cli](https://github.com/docker/cli/blob/v20.10.7/cli/command/service/opts.go#L705) the override of the entrypoint is also passed to the `command` property and there is no `entrypoint` attribute in the `ContainerSpec` of the service.
+     */
     commands?: string[];
+    /**
+     * References to zero or more configs that will be exposed to the service
+     */
     configs?: outputs.ServiceTaskSpecContainerSpecConfig[];
+    /**
+     * The working directory for commands to run in
+     */
     dir?: string;
+    /**
+     * Specification for DNS related configurations in resolver configuration file (`resolv.conf`)
+     */
     dnsConfig: outputs.ServiceTaskSpecContainerSpecDnsConfig;
+    /**
+     * A list of environment variables in the form VAR="value"
+     */
     env?: {
         [key: string]: string;
     };
+    /**
+     * A list of additional groups that the container process will run as
+     */
     groups?: string[];
+    /**
+     * A test to perform to check that the container is healthy
+     */
     healthcheck: outputs.ServiceTaskSpecContainerSpecHealthcheck;
+    /**
+     * The hostname to use for the container, as a valid RFC 1123 hostname
+     */
     hostname?: string;
+    /**
+     * A list of hostname/IP mappings to add to the container's hosts file
+     */
     hosts?: outputs.ServiceTaskSpecContainerSpecHost[];
+    /**
+     * The image name to use for the containers of the service, like `nginx:1.17.6`. Also use the data-source or resource of `docker.RemoteImage` with the `repoDigest` or `docker.RegistryImage` with the `name` attribute for this, as shown in the examples.
+     */
     image: string;
+    /**
+     * Isolation technology of the containers running the service. (Windows only). Defaults to `default`.
+     */
     isolation?: string;
+    /**
+     * User-defined key/value metadata
+     */
     labels?: outputs.ServiceTaskSpecContainerSpecLabel[];
+    /**
+     * Specification for mounts to be added to containers created as part of the service
+     */
     mounts?: outputs.ServiceTaskSpecContainerSpecMount[];
+    /**
+     * Security options for the container
+     */
     privileges?: outputs.ServiceTaskSpecContainerSpecPrivileges;
+    /**
+     * Mount the container's root filesystem as read only
+     */
     readOnly?: boolean;
+    /**
+     * References to zero or more secrets that will be exposed to the service
+     */
     secrets?: outputs.ServiceTaskSpecContainerSpecSecret[];
+    /**
+     * 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.
+     */
     stopGracePeriod: string;
+    /**
+     * Signal to stop the container
+     */
     stopSignal?: string;
+    /**
+     * Sysctls config (Linux only)
+     */
     sysctl?: {
         [key: string]: any;
     };
+    /**
+     * The user inside the container
+     */
     user?: string;
 }
 export interface ServiceTaskSpecContainerSpecConfig {
+    /**
+     * ID of the specific config that we're referencing
+     */
     configId: 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
+     */
     configName?: string;
+    /**
+     * Represents the file GID. Defaults to `0`.
+     */
     fileGid?: string;
+    /**
+     * Represents represents the FileMode of the file. Defaults to `0o444`.
+     */
     fileMode?: number;
+    /**
+     * Represents the final filename in the filesystem
+     */
     fileName: string;
+    /**
+     * Represents the file UID. Defaults to `0`.
+     */
     fileUid?: string;
 }
 export interface ServiceTaskSpecContainerSpecDnsConfig {
+    /**
+     * The IP addresses of the name servers
+     */
     nameservers: string[];
+    /**
+     * A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.)
+     */
     options?: string[];
+    /**
+     * A search list for host-name lookup
+     */
     searches?: string[];
 }
 export interface ServiceTaskSpecContainerSpecHealthcheck {
+    /**
+     * Time between running the check (ms|s|m|h). Defaults to `0s`.
+     */
     interval?: string;
+    /**
+     * Consecutive failures needed to report unhealthy. Defaults to `0`
+     */
     retries?: number;
+    /**
+     * Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to `0s`.
+     */
     startPeriod?: string;
+    /**
+     * The test to perform as list
+     */
     tests: string[];
+    /**
+     * Maximum time to allow one check to run (ms|s|m|h). Defaults to `0s`.
+     */
     timeout?: string;
 }
 export interface ServiceTaskSpecContainerSpecHost {
+    /**
+     * The name of the host
+     */
     host: string;
+    /**
+     * The ip of the host
+     */
     ip: string;
 }
 export interface ServiceTaskSpecContainerSpecLabel {
+    /**
+     * Name of the label
+     */
     label: string;
+    /**
+     * Value of the label
+     */
     value: string;
 }
 export interface ServiceTaskSpecContainerSpecMount {
+    /**
+     * Optional configuration for the bind type
+     */
     bindOptions?: outputs.ServiceTaskSpecContainerSpecMountBindOptions;
+    /**
+     * Whether the mount should be read-only
+     */
     readOnly?: boolean;
+    /**
+     * Mount source (e.g. a volume name, a host path)
+     */
     source?: string;
+    /**
+     * Container path
+     */
     target: string;
+    /**
+     * Optional configuration for the tmpfs type
+     */
     tmpfsOptions?: outputs.ServiceTaskSpecContainerSpecMountTmpfsOptions;
+    /**
+     * The mount type
+     */
     type: string;
+    /**
+     * Optional configuration for the volume type
+     */
     volumeOptions?: outputs.ServiceTaskSpecContainerSpecMountVolumeOptions;
 }
 export interface ServiceTaskSpecContainerSpecMountBindOptions {
+    /**
+     * Bind propagation refers to whether or not mounts created within a given bind-mount or named volume can be propagated to replicas of that mount. See the [docs](https://docs.docker.com/storage/bind-mounts/#configure-bind-propagation) for details. Defaults to `rprivate`
+     */
     propagation?: string;
 }
 export interface ServiceTaskSpecContainerSpecMountTmpfsOptions {
+    /**
+     * The permission mode for the tmpfs mount in an integer
+     */
     mode?: number;
+    /**
+     * The size for the tmpfs mount in bytes
+     */
     sizeBytes?: number;
 }
 export interface ServiceTaskSpecContainerSpecMountVolumeOptions {
+    /**
+     * Name of the driver to use to create the volume
+     */
     driverName?: string;
+    /**
+     * key/value map of driver specific options
+     */
     driverOptions?: {
         [key: string]: string;
     };
+    /**
+     * User-defined key/value metadata
+     */
     labels?: outputs.ServiceTaskSpecContainerSpecMountVolumeOptionsLabel[];
+    /**
+     * Populate volume with data from the target
+     */
     noCopy?: boolean;
 }
 export interface ServiceTaskSpecContainerSpecMountVolumeOptionsLabel {
+    /**
+     * Name of the label
+     */
     label: string;
+    /**
+     * Value of the label
+     */
     value: string;
 }
 export interface ServiceTaskSpecContainerSpecPrivileges {
+    /**
+     * CredentialSpec for managed service account (Windows only)
+     */
     credentialSpec?: outputs.ServiceTaskSpecContainerSpecPrivilegesCredentialSpec;
+    /**
+     * SELinux labels of the container
+     */
     seLinuxContext?: outputs.ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext;
 }
 export interface ServiceTaskSpecContainerSpecPrivilegesCredentialSpec {
+    /**
+     * Load credential spec from this file
+     */
     file?: string;
+    /**
+     * Load credential spec from this value in the Windows registry
+     */
     registry?: string;
 }
 export interface ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext {
+    /**
+     * Disable SELinux
+     */
     disable?: boolean;
+    /**
+     * SELinux level label
+     */
     level?: string;
+    /**
+     * SELinux role label
+     */
     role?: string;
+    /**
+     * SELinux type label
+     */
     type?: string;
+    /**
+     * SELinux user label
+     */
     user?: string;
 }
 export interface ServiceTaskSpecContainerSpecSecret {
+    /**
+     * Represents the file GID. Defaults to `0`
+     */
     fileGid?: string;
+    /**
+     * Represents represents the FileMode of the file. Defaults to `0o444`
+     */
     fileMode?: number;
+    /**
+     * Represents the final filename in the filesystem
+     */
     fileName: string;
+    /**
+     * Represents the file UID. Defaults to `0`
+     */
     fileUid?: string;
+    /**
+     * ID of the specific secret that we're referencing
+     */
     secretId: 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
+     */
     secretName?: string;
 }
 export interface ServiceTaskSpecLogDriver {
+    /**
+     * The logging driver to use
+     */
     name: string;
+    /**
+     * The options for the logging driver
+     */
     options?: {
         [key: string]: string;
     };
 }
 export interface ServiceTaskSpecNetworksAdvanced {
+    /**
+     * The network aliases of the container in the specific network.
+     */
     aliases?: string[];
+    /**
+     * An array of driver options for the network, e.g. `opts1=value`
+     */
     driverOpts?: string[];
+    /**
+     * The name/id of the network.
+     */
     name: string;
 }
 export interface ServiceTaskSpecPlacement {
+    /**
+     * An array of constraints. e.g.: `node.role==manager`
+     */
     constraints?: string[];
+    /**
+     * Maximum number of replicas for per node (default value is `0`, which is unlimited)
+     */
     maxReplicas?: number;
+    /**
+     * Platforms stores all the platforms that the service's image can run on
+     */
     platforms?: outputs.ServiceTaskSpecPlacementPlatform[];
+    /**
+     * 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`
+     */
     prefs?: string[];
 }
 export interface ServiceTaskSpecPlacementPlatform {
+    /**
+     * The architecture, e.g. `amd64`
+     */
     architecture: string;
+    /**
+     * The operation system, e.g. `linux`
+     */
     os: string;
 }
 export interface ServiceTaskSpecResources {
+    /**
+     * Describes the resources which can be advertised by a node and requested by a task
+     */
     limits?: outputs.ServiceTaskSpecResourcesLimits;
+    /**
+     * An object describing the resources which can be advertised by a node and requested by a task
+     */
     reservation?: outputs.ServiceTaskSpecResourcesReservation;
 }
 export interface ServiceTaskSpecResourcesLimits {
+    /**
+     * The amounf of memory in bytes the container allocates
+     */
     memoryBytes?: number;
+    /**
+     * CPU shares in units of `1/1e9` (or `10^-9`) of the CPU. Should be at least `1000000`
+     */
     nanoCpus?: number;
 }
 export interface ServiceTaskSpecResourcesReservation {
+    /**
+     * User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, GPU=UUID1)
+     */
     genericResources?: outputs.ServiceTaskSpecResourcesReservationGenericResources;
+    /**
+     * The amounf of memory in bytes the container allocates
+     */
     memoryBytes?: number;
+    /**
+     * CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least `1000000`
+     */
     nanoCpus?: number;
 }
 export interface ServiceTaskSpecResourcesReservationGenericResources {
+    /**
+     * The Integer resources
+     */
     discreteResourcesSpecs?: string[];
+    /**
+     * The String resources
+     */
     namedResourcesSpecs?: string[];
 }
 export interface ServiceTaskSpecRestartPolicy {
+    /**
+     * Condition for restart
+     */
     condition?: string;
+    /**
+     * Delay between restart attempts (ms|s|m|h)
+     */
     delay?: string;
+    /**
+     * Maximum attempts to restart a given container before giving up (default value is `0`, which is ignored)
+     */
     maxAttempts?: number;
+    /**
+     * The time window used to evaluate the restart policy (default value is `0`, which is unbounded) (ms|s|m|h)
+     */
     window?: string;
 }
 export interface ServiceUpdateConfig {
+    /**
+     * Delay between task updates `(ns|us|ms|s|m|h)`. Defaults to `0s`.
+     */
     delay?: string;
+    /**
+     * Action on update failure: `pause`, `continue` or `rollback`. Defaults to `pause`.
+     */
     failureAction?: string;
+    /**
+     * Failure rate to tolerate during an update. Defaults to `0.0`.
+     */
     maxFailureRatio?: string;
+    /**
+     * Duration after each task update to monitor for failure (ns|us|ms|s|m|h). Defaults to `5s`.
+     */
     monitor?: string;
+    /**
+     * Update order: either 'stop-first' or 'start-first'. Defaults to `stop-first`.
+     */
     order?: string;
+    /**
+     * Maximum number of tasks to be updated in one iteration. Defaults to `1`
+     */
     parallelism?: number;
 }
 export interface VolumeLabel {
@@ -724,11 +1153,26 @@ export interface VolumeLabel {
 }
 export declare namespace config {
     interface RegistryAuth {
+        /**
+         * Address of the registry
+         */
         address: string;
         authDisabled?: boolean;
+        /**
+         * Path to docker json file for registry auth. Defaults to `~/.docker/config.json`. If `DOCKER_CONFIG` is set, the value of `DOCKER_CONFIG` is used as the path. `configFile` has predencen over all other options.
+         */
         configFile?: string;
+        /**
+         * Plain content of the docker json file for registry auth. `configFileContent` has precedence over username/password.
+         */
         configFileContent?: string;
+        /**
+         * Password for the registry. Defaults to `DOCKER_REGISTRY_PASS` env variable if set.
+         */
         password?: string;
+        /**
+         * Username for the registry. Defaults to `DOCKER_REGISTRY_USER` env variable if set.
+         */
         username?: string;
     }
 }