DockerRunOptions

Docker run options.

Initializer

import ros_cdk_core
ros_cdk_core.DockerRunOptions(
  command: typing.List[str] = None,
  entrypoint: typing.List[str] = None,
  environment: typing.Mapping[str] = None,
  network: str = None,
  platform: str = None,
  security_opt: str = None,
  user: str = None,
  volumes: typing.List[DockerVolume] = None,
  volumes_from: typing.List[str] = None,
  working_directory: str = None
)

Properties

Name	Type	Description
command	typing.List[str]	The command to run in the container.
entrypoint	typing.List[str]	The entrypoint to run in the container.
environment	typing.Mapping[str]	The environment variables to pass to the container.
network	str	Docker Networking options.
platform	str	Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+.
security_opt	str	Security configuration when running the docker container.
user	str	The user to use when running the container.
volumes	typing.List[DockerVolume]	Docker volumes to mount.
volumes_from	typing.List[str]	Where to mount the specified volumes from.
working_directory	str	Working directory inside the container.

---

command^Optional

command: typing.List[str]

• Type: typing.List[str]
• Default: run the command defined in the image

The command to run in the container.

---

entrypoint^Optional

entrypoint: typing.List[str]

• Type: typing.List[str]
• Default: run the entrypoint defined in the image

The entrypoint to run in the container.

---

environment^Optional

environment: typing.Mapping[str]

• Type: typing.Mapping[str]
• Default: no environment variables.

The environment variables to pass to the container.

---

network^Optional

network: str

• Type: str
• Default: no networking options

Docker Networking options.

---

platform^Optional

platform: str

• Type: str
• Default: no platform specified

Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+.

Example value: linux/amd64

---

security_opt^Optional

security_opt: str

• Type: str
• Default: no security options

Security configuration when running the docker container.

---

user^Optional

user: str

• Type: str
• Default: root or image default

The user to use when running the container.

---

volumes^Optional

volumes: typing.List[DockerVolume]

• Type: typing.List[DockerVolume]
• Default: no volumes are mounted

Docker volumes to mount.

---

volumes_from^Optional

volumes_from: typing.List[str]

• Type: typing.List[str]
• Default: no containers are specified to mount volumes from

Where to mount the specified volumes from.

https://docs.docker.com/engine/reference/commandline/run/#mount-volumes-from-container---volumes-from

---

working_directory^Optional

working_directory: str

• Type: str
• Default: image default

Working directory inside the container.

---