Docker section

The Docker section of the application profile contains the configuration settings for Docker or (7.3.2 Fix)Podman containers. Note that IBM® Spectrum Symphony supports the Docker or (7.3.2 Fix)Podman containers on Linux® 64-bit platforms. If you want to update the application profile manually, ensure that the <Docker/> section is inserted after the <Consumer/> section; otherwise, application profile registration will fail.

Docker

Description: Defines containers used with IBM Spectrum Symphony: Docker or (7.3.2 Fix)Podman .

Docker > ContainerDefinition

Description: Defines containers for service instances.

containerUser

Description: Specifies the name of the user who will execute workload and own files created within the container. The maximum length is 4096 characters.

Where used: Docker > ContainerDefinition

Required or optional: Optional

Valid values: Any alphanumeric characters from 0 to 9, A to Z, a to z, and the _ and - characters.

Default value: The consumer OS execution user.

imageName

Description: The name of the container image. The maximum length is 4096 characters.

Where used: Docker > ContainerDefinition

Required or optional: Required

Valid values: Any alphanumeric characters from 0 to 9, A to Z, a to z, and the _ and - characters.

name

Description: Name of the container used to associate a service with a container definition. The maximum length is 128 characters.

Where used: Docker > ContainerDefinition

Required or optional: Required

Valid values: Any alphanumeric characters from 0 to 9, A to Z, a to z, and the _ and - characters.

(7.3.2 Fix)podmanKeepId

Description: When enablePodmanForServiceInstance is set to true in the <Consumer> section, use this to configure the Podman container definition. Set this value to true, if you want the Podman container user to use the same uid and gid inside the container as on the host.

Where used: Docker > ContainerDefinition

Required or optional: Optional

Valid values: true or false

Default value: false

registryUrl

Description: Specifies the registry URL of the container image.

Where used: Docker > ContainerDefinition

Required or optional: Optional

Default value: " " (empty)

Docker > ContainerDefinition > imagePull

Description: Defines behavior for pulling container images for service instances.

retryInterval

Description: The number of seconds to wait before the container client attempts to re-pull the container image, if the previous pull failed.

Where used: Docker > ContainerDefinition > imagePull

Required or optional: Optional

Valid values: Any positive integer from 0 to 2147483647. If you specify an unsupported value for this attribute in the application profile, registering the application will be rejected. If you do not specify a value, the default will be used instead.

Default value: 3 seconds

retryLimit

Description: The number of times the container client will retry pulling a container image, if it cannot pull the image. If the number of attempts exceeds the value of this attribute, the system will stop starting the container.

Where used: Docker > ContainerDefinition > imagePull

Required or optional: Optional

Valid values: Any positive integer from 0 to 2147483647. If you specify an unsupported value for this attribute in the application profile, registering the application will be rejected. If you do not specify a value, the default will be used instead.

Default value: 0, meaning that the container client only pulls once, and does not retry if it is unsuccessful.

Description: Define behavior for pulling container images for service instances.

Docker > ContainerDefinition > mount

Description: Binds host directories to directories accessible within the container, or defines internal data volumes for a container.

containerDir

Description: Specifies a mounted directory in the container.

Where used: Docker > ContainerDefinition > mount

Required or optional: Required

hostDir

Description: Specifies a mounted directory available on each of the hosts on which the container can run. The directory must be specified with an absolute path.

Where used: Docker > ContainerDefinition > mount

Required or optional: Required

permission

Description: Specifies the access permission for the data volumes.

Where used: Docker > ContainerDefinition > mount

Required or optional: Optional

Valid values: rw or ro (read-write or read-only)

Default value: rw