Podman Integration Reference 25.1.x

CI Reference

Configuration Item Overview

Deployables

CI	Description
podman.ContainerSpec	Specification for a Podman container.
podman.File	Deployed File used for deployment in Podman (deployable)
podman.Folder	Deployed Folder used for deployment in Podman (deployable)
podman.NetworkSpec	Specification for a Podman network. The name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]
podman.PodSpec	Specification for a Podman Pod.
podman.SecretSpec	Specification for a Podman Secret Spec. The name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]
podman.VolumeSpec	Specification for a Podman volume. The name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]

Deployeds

CI	Description
podman.Container	A Podman container.
podman.DeployedFile	Deployed File used for deployment in Podman
podman.DeployedFolder	Deployed Folder used for deployment in Podman
podman.Network	A Podman network.
podman.Pod	A Podman Pod.
podman.Secret	A Podman Secrets Spec.
podman.Volume	A Podman volume.

Containers

CI	Description
podman.Engine	Podman engine
podman.PodmanCliClient	This task let you to config Podman client

Other Configuration Items

CI	Description
podman.ConfigSpec	Specification for a Podman Config Spec for Networks
podman.ContainerImageVolumeSpec	A Podman Mounted Volume. (deployable)
podman.ContainerVolumesSpec	A Podman container Volumes. (deployable)
podman.Engine_copyImage	Generated type for method copyImage.
podman.NetworkPodMappingSpec	Specification for a Podman Network.
podman.PodPortMappingSpec	Specification for a Podman port binding.
podman.PodVolumeMappingSpec	Specification for a Podman Volume mapping.
podman.Port	Port binding.
podman.PortSpec	Specification for a Podman port binding.
podman.Registry	A Podman registry.
podman.config	Config Spec
podman.containerImageVolume	A Podman Mounted Volume.
podman.containerVolumes	A Podman container Volumes.
podman.podnetwork	Network Properties.
podman.portmappings	Port Mapping.
podman.volumemappings	Volume Mapping.

Configuration Item Details

podman.ConfigSpec

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

Specification for a Podman Config Spec for Networks

		Public properties
		auxiliaryAddresses: MAP_STRING_STRING
		Auxiliary Addresses options as a key-value pair. (map_string_string)
		gateway: STRING
		gateway. (string)
		iPRange: STRING
		iPRange. (string)
		subnet: STRING
		Subnet for this Network in CIDR form. (string)

---

podman.Container

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

A Podman container.

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

		Children
		containerImageVolume: SET_OF_CI<podman.containerImageVolume>
		Image volumes bind-mount a container-image mount into the pod's infra container.
		containerVolumes: SET_OF_CI<podman.containerVolumes>
		Volumes are named volumes that will be added to the container. These will supersede Image Volumes and VolumesFrom volumes where there are conflicts.
		portBindings: SET_OF_CI<podman.Port>
		Port bindings.

		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 Podman 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.
		init: STRING
		Init specifies that an init binary will be mounted into the container, and will be used as PID1
		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 Podman 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.
		timeZone: STRING
		Timezone is the timezone inside the container. Local means it has the same timezone as the host machine Optional.
		tty: BOOLEAN
		Allocate a pseudo-TTY.
		workDir: STRING
		Path to the working directory.

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

---

podman.ContainerImageVolumeSpec

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

A Podman Mounted Volume. (deployable)

		Public properties
		Destination: STRING
		Destination is the absolute path of the mount in the container. (string)
		ReadWrite: STRING
		ReadWrite sets the volume writable. (boolean)
		Source: STRING
		Source is the source of the image volume. The image can be referred to by name and by ID. (string)

---

podman.ContainerSpec

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

Specification for a Podman container.

		Children
		containerImageVolume: LIST_OF_CI<podman.ContainerImageVolumeSpec>
		The list of data image volume bindings.
		containerVolumes: LIST_OF_CI<podman.ContainerVolumesSpec>
		The list of data volume bindings.
		portBindings: LIST_OF_CI<podman.PortSpec>
		The list of port 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 Podman 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)
		init: STRING
		Init specifies that an init binary will be mounted into the container, and will be used as PID1 (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 Podman 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.
		timeZone: STRING
		Timezone is the timezone inside the container. Local means it has the same timezone as the host machine Optional. (string)
		tty: STRING
		Allocate a pseudo-TTY. (boolean)
		workDir: 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)

---

podman.ContainerVolumesSpec

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

A Podman container Volumes. (deployable)

		Public properties
		Dest: STRING
		Mount point of the volume. (string)
		Name: STRING
		The name of the volume. (string)
		Options: LIST_OF_STRING
		Options are options that the named volume will be mounted with. (list_of_string)

---

podman.DeployedFile

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

Deployed File used for deployment in Podman

		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.

---

podman.DeployedFolder

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

Deployed Folder used for deployment in Podman

		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.

---

podman.Engine

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

Podman engine

		Public properties
		podmanHost: STRING
		The protocol, host name, and port where the Podman server is hosted. For example: https://Podman-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 Podman host in a safe manner. If enabled, you must provide certificate details.
		isSwarmManager: BOOLEAN
		Enable this option if Podman host is also a swarm manager
		keyPem: STRING
		Content of the client key file (key.pem).
		podmanVersion: STRING
		The versions of Podman Client. Default Value is v4.0.0
		registries: SET_OF_CI<podman.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		delegate = jythonScript, script = xldpodman/check_connection.py	Verify the connection to the Podman daemon.
copyImage	podman.Engine_copyImage	delegate = jythonScript, script = xldpodman/copy_image.py	Copy the image from one repository to another repository.

---

podman.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.podman.com/
		targetRepoUrl: STRING
		The hostname and port name where target repository server is located.For example: http(s)://registry.hub.podman.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.

---

podman.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 Podman (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
		excludeFileNamesRegexToTranscode: STRING
		A regex of file type that needs to be ignored for transcode
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
		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)
		textFileNamesRegexToTranscode: 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 to transcode to EBCDIC

		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

---

podman.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 Podman (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
		excludeFileNamesRegexToTranscode: STRING
		A regex of file type that needs to be ignored for transcode
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
		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)
		textFileNamesRegexToTranscode: 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 to transcode to EBCDIC

		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

---

podman.Network

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

A Podman network.

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

		Children
		configBindings: SET_OF_CI<podman.ConfigSpec>
		List of Config for network.

		Public properties
		attachable: BOOLEAN
		Attachable is whether this is an Attachable Network.
		checkDuplicate: BOOLEAN = true
		checkDuplicate checks whether Network has a duplicate or not.
		configFromNetwork: STRING
		The Config From Network
		configOnly: BOOLEAN
		configOnly checks whether Network is a config only.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		driver: STRING = bridge
		Name of the driver used to create the network.
		ingress: BOOLEAN
		configOnly checks whether Network is a config only.
		internal: BOOLEAN
		Internal is whether the Network should not have external routes to public or other Networks.
		ipamDriver: STRING
		The Ipad Driver
		ipamOptions: MAP_STRING_STRING
		Driver options as a key-value pair.
		ipv6Enabled: BOOLEAN
		IPv6Enabled if set to true an ipv6 subnet should be created for this net.
		labels: MAP_STRING_STRING
		Labels to set on the Network.
		networkId: STRING
		Network Id
		networkName: STRING
		The network name; if not specified, the CI name will be used. The Podman network name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]
		options: MAP_STRING_STRING
		Options is a set of key-value options that have been applied to the Network.
		scope: STRING
		The scope of network

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

---

podman.NetworkPodMappingSpec

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

Specification for a Podman Network.

		Public properties
		aliases: LIST_OF_STRING
		Aliases of Podman Network. (list_of_string)
		propertyName: STRING
		Property Name of Network. (string)
		staticIps: LIST_OF_STRING
		Static Ips Address. (list_of_string)
		staticMac: LIST_OF_STRING
		Static Mac Address. (list_of_string)

---

podman.NetworkSpec

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

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

		Children
		configBindings: SET_OF_CI<podman.ConfigSpec>
		List of Config for network.

		Public properties
		attachable: STRING
		Attachable is whether this is an Attachable Network. (boolean) default(false)
		checkDuplicate: STRING
		checkDuplicate checks whether Network has a duplicate or not. (boolean) default(true)
		configFromNetwork: STRING
		The Config From Network (string)
		configOnly: STRING
		configOnly checks whether Network is a config only. (boolean)
		driver: STRING
		Name of the driver used to create the network. (string) default(bridge)
		ingress: STRING
		configOnly checks whether Network is a config only. (boolean)
		internal: STRING
		Internal is whether the Network should not have external routes to public or other Networks. (boolean) default(false)
		ipamDriver: STRING
		The Ipad Driver (string)
		ipamOptions: MAP_STRING_STRING
		Driver options as a key-value pair. (map_string_string)
		ipv6Enabled: STRING
		IPv6Enabled if set to true an ipv6 subnet should be created for this net. (boolean) default(false)
		labels: MAP_STRING_STRING
		Labels to set on the Network. (map_string_string)
		networkName: STRING
		The network name; if not specified, the CI name will be used. The Podman network name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-] (string)
		options: MAP_STRING_STRING
		Options is a set of key-value options that have been applied to the Network. (map_string_string)
		scope: STRING
		The scope of network (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)

---

podman.Pod

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

A Podman Pod.

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

		Children
		podnetwork: LIST_OF_CI<podman.podnetwork>
		Pod Network Mappings.
		portmappings: LIST_OF_CI<podman.portmappings>
		Pod Port Mappings.
		volumemappings: LIST_OF_CI<podman.volumemappings>
		Pod Volume Mappings.

		Public properties
		PodId: STRING
		ID of the Pod.
		PodName: STRING
		Name of the Pod. If not specified, the CI name will be used.
		cgroupParent: STRING
		cgroup parent.
		cpu_period: INTEGER = 1
		CPU Period.
		cpu_quota: INTEGER = 1
		CPU Quota.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		hostname: STRING
		Hostname.
		infra_command: LIST_OF_STRING
		Command to be run in the Pod Infra.
		infra_image: STRING
		Infra Image to be used in the Pod.
		labels: MAP_STRING_STRING
		Metadata for the Pod.
		netnsNsmode: STRING
		Net NS Mode.
		netnsValue: STRING
		Net NS Value.
		networkOptions: MAP_STRING_STRING
		Driver specific options as a key-value dictionary.
		no_infra: BOOLEAN
		If No Infra is Required.
		no_manage_hosts: BOOLEAN
		If No Manage Host.
		pod_create_command: LIST_OF_STRING
		Pod Create Command.
		pod_devices: LIST_OF_STRING
		Pod Devices
		start_pod: BOOLEAN = true
		Start Pod Once Created.
		usernsNsmode: STRING
		User NS Mode.
		usernsValue: STRING
		User NS Value.

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

---

podman.PodPortMappingSpec

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

Specification for a Podman port binding.

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

---

podman.PodSpec

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

Specification for a Podman Pod.

		Children
		podnetwork: LIST_OF_CI<podman.NetworkPodMappingSpec>
		Pod Network Mappings.
		portmappings: LIST_OF_CI<podman.PodPortMappingSpec>
		The list of port bindings.
		volumemappings: LIST_OF_CI<podman.PodVolumeMappingSpec>
		Pod Volume Mappings.

		Public properties
		PodName: STRING
		Name of the Pod. If not specified, the CI name will be used. (string)
		cgroupParent: STRING
		cgroup parent. (string)
		cpu_period: STRING
		CPU Period. (integer) default(1)
		cpu_quota: STRING
		CPU Quota. (integer) default(1)
		hostname: STRING
		Hostname. (string)
		infra_command: LIST_OF_STRING
		Command to be run in the Pod Infra. (list_of_string)
		infra_image: STRING
		Infra Image to be used in the Pod. (string)
		labels: MAP_STRING_STRING
		Metadata for the Pod. (map_string_string)
		netnsNsmode: STRING
		Net NS Mode. (string)
		netnsValue: STRING
		Net NS Value. (string)
		networkOptions: MAP_STRING_STRING
		Driver specific options as a key-value dictionary. (map_string_string)
		no_infra: STRING
		If No Infra is Required. (boolean)
		no_manage_hosts: STRING
		If No Manage Host. (boolean)
		pod_create_command: LIST_OF_STRING
		Pod Create Command. (list_of_string)
		pod_devices: LIST_OF_STRING
		Pod Devices (list_of_string)
		start_pod: STRING
		Start Pod Once Created. (boolean) default(true)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		usernsNsmode: STRING
		User NS Mode. (string)
		usernsValue: STRING
		User NS Value. (string)

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

---

podman.PodVolumeMappingSpec

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

Specification for a Podman Volume mapping.

		Public properties
		dest: STRING
		Destination to mount the named volume within the container. Must be an absolute path. Path will be created if it does not exist. (string)
		options: LIST_OF_STRING
		Options are options that the named volume will be mounted with. (list_of_string)
		volumename: STRING
		Name is the name of the named volume to be mounted. May be empty. If empty, a new named volume with a pseudorandomly generated name will be mounted at the given destination. (string)

---

podman.PodmanCliClient

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

This task let you to config Podman client

		Parent
		host: CI<overthere.Host>
		Host

		Public properties
		path: STRING = /usr/local/bin
		Podman client installation path.
		registries: SET_OF_CI<podman.Registry>
		Registries
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.

---

podman.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 Podman container.
		hostIp: STRING
		Port IP of Podman host.
		hostPort: INTEGER
		Port number of Podman host.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		protocol: STRING = tcp
		Protocol used by the specified port mapping. For example: udp or tcp
		range: INTEGER
		Range of Podman container ports.

---

podman.PortSpec

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

Specification for a Podman port binding.

		Public properties
		containerPort: STRING
		Port number of Podman container. (integer)
		hostIp: STRING
		Port IP of Podman host. (string)
		hostPort: STRING
		Port number of Podman host. (integer)
		protocol: STRING
		Protocol used by the specified port mapping. For example: udp or tcp (string) default(tcp)
		range: STRING
		Range of Podman container ports. (integer)

---

podman.Registry

Type Hierarchy	udm.Configuration >> udm.BaseConfigurationItem

A Podman registry.

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

---

podman.Secret

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

A Podman Secrets Spec.

		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 = file
		Name of the driver used to create the secret: Default value is 'file'.
		secret: STRING
		The secret value
		secretName: STRING
		The secret name; if not specified, the CI name will be used. The Podman secret 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.

---

podman.SecretSpec

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

Specification for a Podman Secret Spec. 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 secret: Default value is 'file'. (string) default(file)
		secret: STRING
		The secret value (string)
		secretName: STRING
		The secret name; if not specified, the CI name will be used. The Podman secret name must match the regular expression [a-zA-Z0-9][a-zA-Z0-9_.-]. (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.

---

podman.Volume

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

A Podman 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 Podman 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.

---

podman.VolumeSpec

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

Specification for a Podman 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 Podman 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.

---

podman.config

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

Config Spec

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

		Public properties
		auxiliaryAddresses: MAP_STRING_STRING
		Auxiliary Addresses options as a key-value pair.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		gateway: STRING
		gateway.
		iPRange: STRING
		iPRange.
		subnet: STRING
		Subnet for this Network in CIDR form.

---

podman.containerImageVolume

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

A Podman Mounted Volume.

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

		Public properties
		Destination: STRING
		Destination is the absolute path of the mount in the container.
		Source: STRING
		Source is the source of the image volume. The image can be referred to by name and by ID.
		ReadWrite: BOOLEAN
		ReadWrite sets the volume writable.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

podman.containerVolumes

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

A Podman container Volumes.

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

		Public properties
		Dest: STRING
		Mount point of the volume.
		Name: STRING
		The name of the volume.
		Options: LIST_OF_STRING
		Options are options that the named volume will be mounted with.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

podman.podnetwork

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

Network Properties.

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

		Public properties
		aliases: LIST_OF_STRING
		Aliases of Podman Network.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		propertyName: STRING
		Property Name of Network.
		staticIps: LIST_OF_STRING
		Static Ips Address.
		staticMac: LIST_OF_STRING
		Static Mac Address.

---

podman.portmappings

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

Port Mapping.

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

		Public properties
		containerPort: INTEGER
		Port number of Podman container.
		hostIp: STRING
		Port number of Podman host.
		hostPort: INTEGER
		Port number of Podman 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
		range: INTEGER
		Port number of Podman container.

---

podman.volumemappings

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

Volume Mapping.

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

		Public properties
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		dest: STRING
		Destination to mount the named volume within the container. Must be an absolute path. Path will be created if it does not exist.
		options: LIST_OF_STRING
		Options are options that the named volume will be mounted with.
		volumename: STRING
		Name is the name of the named volume to be mounted. May be empty. If empty, a new named volume with a pseudorandomly generated name will be mounted at the given destination.

---