Skip to main content

Interface: PodCreateOptions

Properties

Networks?

optional Networks: object

Map of networks names to ids the container should join to. You can request additional settings for each network, you can set network aliases, If the map is empty and the bridge network mode is set the container will be joined to the default network.

Index signature

[key: string]: object

Source

packages/extension-api/src/extension-api.d.ts:397


exit_policy?

optional exit_policy: string

ExitPolicy determines the pod's exit and stop behaviour.

Examples

"continue": the pod continues running. This is the default policy
when creating a pod.
"stop": stop the pod when the last container exits. This is the
default behaviour for play kube.

Source

packages/extension-api/src/extension-api.d.ts:413


labels?

optional labels: object

Labels are key-value pairs that are used to add metadata to pods. Optional.

Index signature

[key: string]: string

Source

packages/extension-api/src/extension-api.d.ts:389


name?

optional name: string

Name is the name of the pod. If not provided, a name will be generated when the pod is created. Optional.

Source

packages/extension-api/src/extension-api.d.ts:379


portmappings?

optional portmappings: PodCreatePortOptions[]

PortMappings is a set of ports to map into the infra container. As, by default, containers share their network with the infra container, this will forward the ports to the entire pod. Only available if NetNS is set to Bridge, Slirp, or Pasta.

Source

packages/extension-api/src/extension-api.d.ts:385


provider?

optional provider: ContainerProviderConnection

Source

packages/extension-api/src/extension-api.d.ts:391