Docker Plugin Reference 23.3.x

CI Reference

Configuration Item Overview

Deployables

CI	Description
docker.ContainerSpec	Specification for a Docker container.
docker.File	Deployed File used for deployment in Docker (deployable)
docker.Folder	Deployed Folder used for deployment in Docker (deployable)
docker.NetworkSpec	Specification for a Docker network. The name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]
docker.ServiceSpec	Specification for a Docker service.
docker.VolumeSpec	Specification for a Docker volume. The name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]

Deployeds

CI	Description
docker.Container	A Docker container.
docker.DeployedFile	Deployed File used for deployment in Docker
docker.DeployedFolder	Deployed Folder used for deployment in Docker
docker.Network	A Docker network.
docker.Service	A Docker service.
docker.Volume	A Docker volume.

Containers

CI	Description
docker.Engine	Docker engine

Other Configuration Items

CI	Description
docker.Engine_copyImage	Generated type for method copyImage.
docker.MountedVolume	A Docker Mounted Volume.
docker.MountedVolumeSpec	A Docker Mounted Volume. (deployable)
docker.Port	Port binding.
docker.PortSpec	Specification for a Docker port binding.
docker.Registry	A Docker registry.
docker.ServicePort	Port binding.
docker.ServicePortSpec	Specification for a Docker port binding.

Configuration Item Details

docker.Container

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

A Docker container.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		portBindings: SET_OF_CI<docker.Port>
		Port bindings.
		volumeBindings: SET_OF_CI<docker.MountedVolume>
		List of volumes to be mounted on container.

		Public properties
		image: STRING
		Image to use. For example, ubuntu:14.04
		showLogsAfter: INTEGER = 30
		If set to a non-zero value, check that the container is running and show the logs after N seconds.
		command: STRING
		Command to be run in the container.
		containerId: STRING
		ID of the container.
		containerName: STRING
		The container name; if not specified, the CI name will be used. The Docker container name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		dnsOptions: LIST_OF_STRING
		Additional options to be added to the container’s resolv.conf file.
		domainname: STRING
		Custom DNS search domains.
		entrypoint: STRING
		Overwrite the default ENTRYPOINT of the image.
		environment: MAP_STRING_STRING
		A map of environment variable names and their values.
		hostname: STRING
		Hostname for the container.
		labels: MAP_STRING_STRING
		Metadata for the container.
		links: MAP_STRING_STRING
		A map of deployable name and alias if the deployable is present in same application package; otherwise, provide a container name and alias. The alias name should be unique for each pair.
		memoryLimit: STRING
		Memory limit.
		networks: LIST_OF_STRING
		Names of Docker networks to which this container can connect.
		pidMode: STRING
		If set to host, use the host PID namespace inside the container.
		privileged: BOOLEAN
		Give extended privileges to this container.
		publishAllPorts: BOOLEAN
		Publish all exposed ports to random ports.
		restartPolicyMaximumRetryCount: INTEGER
		Number of times to restart the container on failure.
		restartPolicyName: ENUM [none, on-failure, always]
		Restart the container when it exits.
		tty: BOOLEAN
		Allocate a pseudo-TTY.
		workingDir: STRING
		Path to the working directory.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

docker.ContainerSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specification for a Docker container.

		Children
		portBindings: LIST_OF_CI<docker.PortSpec>
		The list of port bindings.
		volumeBindings: SET_OF_CI<docker.MountedVolumeSpec>
		The list of data volume bindings.

		Public properties
		command: STRING
		Command to be run in the container. (string)
		containerName: STRING
		The container name; if not specified, the CI name will be used. The Docker container name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-] (string)
		dnsOptions: LIST_OF_STRING
		Additional options to be added to the container’s resolv.conf file. (list_of_string)
		domainname: STRING
		Custom DNS search domains. (string)
		entrypoint: STRING
		Overwrite the default ENTRYPOINT of the image. (string)
		environment: MAP_STRING_STRING
		A map of environment variable names and their values. (map_string_string)
		hostname: STRING
		Hostname for the container. (string)
		image: STRING
		Image to use. For example, ubuntu:14.04 (string)
		labels: MAP_STRING_STRING
		Metadata for the container. (map_string_string)
		links: MAP_STRING_STRING
		A map of deployable name and alias if the deployable is present in same application package; otherwise, provide a container name and alias. The alias name should be unique for each pair. (map_string_string)
		memoryLimit: STRING
		Memory limit. (string)
		networks: LIST_OF_STRING
		Names of Docker networks to which this container can connect. (list_of_string)
		pidMode: STRING
		If set to host, use the host PID namespace inside the container. (string)
		privileged: STRING
		Give extended privileges to this container. (boolean)
		publishAllPorts: STRING
		Publish all exposed ports to random ports. (boolean)
		restartPolicyMaximumRetryCount: STRING
		Number of times to restart the container on failure. (integer)
		restartPolicyName: STRING
		Restart the container when it exits. (enum) values(none, on-failure, always)
		showLogsAfter: STRING
		If set to a non-zero value, check that the container is running and show the logs after N seconds. (integer) default(30)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		tty: STRING
		Allocate a pseudo-TTY. (boolean)
		workingDir: STRING
		Path to the working directory. (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		containerId: STRING
		ID of the container. (string)

---

docker.DeployedFile

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Deployed File used for deployment in Docker

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		targetContainer: STRING
		Name of the container on which the file should be deployed.
		targetPath: STRING
		Path where the file should be deployed.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>

		Hidden properties
		createTargetPath: STRING = false
		Create Target Path
		targetPathShared: STRING = true
		Target Path Shared
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

docker.DeployedFolder

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Deployed Folder used for deployment in Docker

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		targetContainer: STRING
		Name of the container on which the folder should be deployed.
		targetPath: STRING
		Path where the folder should be deployed.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>

		Hidden properties
		createTargetPath: STRING = false
		Create Target Path
		targetPathShared: STRING = true
		Target Path Shared
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

docker.Engine

Type Hierarchy	udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Container, udm.Taggable

Docker engine

		Public properties
		dockerHost: STRING
		The protocol, host name, and port where the Docker server is hosted. For example: https://docker-host:2376
		caPem: STRING
		Content of the Certification Authority certificate file (ca.pem).
		certPem: STRING
		Content of the signed public key file (cert.pem).
		enableTLS: BOOLEAN
		Enable this option to connect to the Docker host in a safe manner. If enabled, you must provide certificate details.
		isSwarmManager: BOOLEAN
		Enable this option if docker host is also a swarm manager
		keyPem: STRING
		Content of the client key file (key.pem).
		registries: SET_OF_CI<docker.Registry>
		Registries
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.

Control task	Parameter CI	Attributes	Description
checkConnection		script = xlddocker/check_connection.py	Verify the connection to the Docker daemon.
copyImage	docker.Engine_copyImage	script = xlddocker/copy_image.py	Copy the image from one repository to another repository.

---

docker.Engine_copyImage

Type Hierarchy	udm.Parameters >> udm.BaseConfigurationItem

Generated type for method copyImage.

		Public properties
		sourceImageNameAndTag: STRING
		[The name of the image]:[Tag of the image]. For ex: alpine:latest
		sourceRepoUrl: STRING
		The hostname and port name where source repository server is located.For example: http(s)://registry.hub.docker.com/
		targetRepoUrl: STRING
		The hostname and port name where target repository server is located.For example: http(s)://registry.hub.docker.com/
		sourcePassword: STRING
		Password.
		sourceUserName: STRING
		User Name.
		targetImageNameAndTag: STRING
		[The name of the image]:[Tag to the image]. For ex: alpine:latest
		targetPassword: STRING
		Password.
		targetUserName: STRING
		User Name.

---

docker.File

Type Hierarchy	udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Deployed File used for deployment in Docker (deployable)

		Public properties
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact to replace placeholders when it is imported
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		targetContainer: STRING
		Name of the container on which the file should be deployed. (string)
		targetPath: STRING
		Path where the file should be deployed. (string)

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

Control task	Parameter CI	Attributes	Description
rescanArtifacts			No description.

---

docker.Folder

Type Hierarchy	udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FolderArtifact, udm.SourceArtifact, udm.Taggable

Deployed Folder used for deployment in Docker (deployable)

		Public properties
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact to replace placeholders when it is imported
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		targetContainer: STRING
		Name of the container on which the folder should be deployed. (string)
		targetPath: STRING
		Path where the folder should be deployed. (string)

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

Control task	Parameter CI	Attributes	Description
rescanArtifacts			No description.

---

docker.MountedVolume

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

A Docker Mounted Volume.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		mountpoint: STRING
		Mount point of the volume.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		readOnly: BOOLEAN
		If set to true, volume will be mounted as read-only.
		volumeName: STRING
		The name of the volume.

---

docker.MountedVolumeSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

A Docker Mounted Volume. (deployable)

		Public properties
		mountpoint: STRING
		Mount point of the volume. (string)
		readOnly: STRING
		If set to true, volume will be mounted as read-only. (boolean) default(false)
		volumeName: STRING
		The name of the volume. (string)

---

docker.Network

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

A Docker network.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		driver: STRING = bridge
		Name of the driver used to create the network.
		networkId: STRING
		Network Id
		networkName: STRING
		The network name; if not specified, the CI name will be used. The Docker network name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]
		networkOptions: MAP_STRING_STRING
		Driver options as a key-value pair.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

docker.NetworkSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specification for a Docker network. The name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]

		Public properties
		driver: STRING
		Name of the driver used to create the network. (string) default(bridge)
		networkName: STRING
		The network name; if not specified, the CI name will be used. The Docker network name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-] (string)
		networkOptions: MAP_STRING_STRING
		Driver options as a key-value pair. (map_string_string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		networkId: STRING
		Network Id (string)

---

docker.Port

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Port binding.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		containerPort: INTEGER
		Port number of Docker container.
		hostPort: INTEGER
		Port number of Docker host.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		protocol: STRING = tcp
		Protocol used by the specified port binding. For example: udp or tcp

---

docker.PortSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for a Docker port binding.

		Public properties
		containerPort: STRING
		Port number of Docker container. (integer)
		hostPort: STRING
		Port number of Docker host. (integer)
		protocol: STRING
		Protocol used by the specified port binding. For example: udp or tcp (string) default(tcp)

---

docker.Registry

Type Hierarchy	udm.Configuration >> udm.BaseConfigurationItem

A Docker registry.

		Public properties
		password: STRING
		Password to use when authenticating with the registry.
		url: STRING
		URL of the registry. For example: https://index.docker.io/v1/
		username: STRING
		User name to use when authenticating with the registry.

---

docker.Service

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

A Docker service.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		portBindings: SET_OF_CI<docker.ServicePort>
		Service Port bindings.

		Public properties
		image: STRING
		Image to use. For example: ubuntu:14.04
		mode: ENUM [replicated, global] = replicated
		Scheduling mode for the service.
		replicas: INTEGER = 1
		Number of replicas.
		restartPolicyName: ENUM [none, on-failure, any] = none
		Restart the container when it exits.
		updateDelay: INTEGER
		Amount of time between updates.
		updateFailureAction: ENUM [pause, continue] = pause
		Update Failure Action
		updateParallelism: INTEGER
		Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism).
		waitForReplicasMaxRetries: INTEGER = 12
		Maximum number of retries to wait for the required number of replicas to come up.
		waitForReplicasNr: INTEGER = 1
		Minimum number of replicas that should come up for this service to be considered successfully deployed.
		command: STRING
		Command to be run in the container.
		constraints: LIST_OF_STRING
		Placement constraints.
		containerLabels: MAP_STRING_STRING
		Metadata for the containers started for this service.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		endpointResolution: STRING = vip
		Mode of resolution to use for internal load balancing between tasks ('vip' or 'dnsrr').
		environment: MAP_STRING_STRING
		A map of environment variable names and their values.
		labels: MAP_STRING_STRING
		Metadata for the service.
		networks: LIST_OF_STRING
		Names of Docker networks to which this container can connect.
		restartPolicyMaximumRetryCount: INTEGER
		Number of times to restart the container on failure.
		serviceId: STRING
		ID of the service.
		serviceName: STRING
		Name of the service. If not specified, the CI name will be used.
		workingDir: STRING
		Path to the working directory.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

docker.ServicePort

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Port binding.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		published_port: INTEGER
		Port number of Docker container.
		target_port: INTEGER
		Port number of Docker host.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		protocol: STRING = tcp
		Protocol used by the specified port binding. For example: udp or tcp

---

docker.ServicePortSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for a Docker port binding.

		Public properties
		protocol: STRING
		Protocol used by the specified port binding. For example: udp or tcp (string) default(tcp)
		published_port: STRING
		Port number of Docker container. (integer)
		target_port: STRING
		Port number of Docker host. (integer)

---

docker.ServiceSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specification for a Docker service.

		Children
		portBindings: LIST_OF_CI<docker.ServicePortSpec>
		The list of port bindings.

		Public properties
		command: STRING
		Command to be run in the container. (string)
		constraints: LIST_OF_STRING
		Placement constraints. (list_of_string)
		containerLabels: MAP_STRING_STRING
		Metadata for the containers started for this service. (map_string_string)
		endpointResolution: STRING
		Mode of resolution to use for internal load balancing between tasks ('vip' or 'dnsrr'). (string) default(vip)
		environment: MAP_STRING_STRING
		A map of environment variable names and their values. (map_string_string)
		image: STRING
		Image to use. For example: ubuntu:14.04 (string)
		labels: MAP_STRING_STRING
		Metadata for the service. (map_string_string)
		mode: STRING
		Scheduling mode for the service. (enum) values(replicated, global) default(replicated)
		networks: LIST_OF_STRING
		Names of Docker networks to which this container can connect. (list_of_string)
		replicas: STRING
		Number of replicas. (integer) default(1)
		restartPolicyMaximumRetryCount: STRING
		Number of times to restart the container on failure. (integer)
		restartPolicyName: STRING
		Restart the container when it exits. (enum) values(none, on-failure, any) default(none)
		serviceName: STRING
		Name of the service. If not specified, the CI name will be used. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		updateDelay: STRING
		Amount of time between updates. (integer) default(0)
		updateFailureAction: STRING
		Update Failure Action (enum) values(pause, continue) default(pause)
		updateParallelism: STRING
		Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). (integer) default(0)
		waitForReplicasMaxRetries: STRING
		Maximum number of retries to wait for the required number of replicas to come up. (integer) default(12)
		waitForReplicasNr: STRING
		Minimum number of replicas that should come up for this service to be considered successfully deployed. (integer) default(1)
		workingDir: STRING
		Path to the working directory. (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		serviceId: STRING
		ID of the service. (string)

---

docker.Volume

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

A Docker volume.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		driver: STRING = local
		Name of the driver used to create the volume.
		driverOptions: MAP_STRING_STRING
		Driver specific options as a key-value dictionary.
		labels: MAP_STRING_STRING
		Labels to set on the volume.
		volumeName: STRING
		The volume name; if not specified, the CI name will be used. The Docker volume name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-].

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

docker.VolumeSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specification for a Docker volume. The name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]

		Public properties
		driver: STRING
		Name of the driver used to create the volume. (string) default(local)
		driverOptions: MAP_STRING_STRING
		Driver specific options as a key-value dictionary. (map_string_string)
		labels: MAP_STRING_STRING
		Labels to set on the volume. (map_string_string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		volumeName: STRING
		The volume name; if not specified, the CI name will be used. The Docker volume name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]. (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---