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,

Index Signature

[key: string]: object

Remarks

PodCreateOptions.netns.nsmode need to be set to bridge to join a network

Defined in

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


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.

Defined in

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


labels?

optional labels: object

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

Index Signature

[key: string]: string

Defined in

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.

Defined in

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


netns?

optional netns: object

Network namespace

nsmode

nsmode: string

NamespaceMode

Examples
`bridge` indicates that the network backend (CNI/netavark) should be used.
`pasta` indicates that a pasta network stack should be used.

Defined in

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


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.

Defined in

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


provider?

optional provider: ContainerProviderConnection

Defined in

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