Skip to content

Type Alias: ContainerdImageConfig ​

ContainerdImageConfig = object

The configuration an image gives its containers (ContainerdImage.config), read from the OCI image configuration of the platform the image object describes. A ContainerCreateOptions overrides its fields.

Properties ​

cmd ​

cmd: string[]

Its default command (CMD), [] when it has none.


entrypoint ​

entrypoint: string[]

Its entry point (ENTRYPOINT), [] when it has none.


env ​

env: Record<string, string>

Its environment variables by name ({PATH: '/usr/local/sbin:…'}).


exposedPorts ​

exposedPorts: object[]

The ports it declares (EXPOSE), the protocol 'tcp' when the image gives none. They are not published by themselves: see ContainerCreateOptions.ports.

port ​

port: number

type ​

type: "tcp" | "udp" | "sctp"


labels ​

labels: Record<string, string>

The labels of its configuration (LABEL), copied to its containers.


stopSignal? ​

optional stopSignal?: string

The signal stopping its containers (STOPSIGNAL: 'SIGQUIT'), undefined when it has none (SIGTERM is used).


user ​

user: string

The user of its process (USER: user, user:group, uid, uid:gid), '' when it has none (root).


volumes ​

volumes: string[]

The paths it declares as volumes (VOLUME). The component mounts no volume for them by itself.


workingDir ​

workingDir: string

The working directory of its process (WORKDIR), '' when it has none (/ is used).

Released under the MIT License.