Interface: PodCreateOptions
Defined in: packages/extension-api/src/extension-api.d.ts:414
Properties
exit_policy?
optionalexit_policy:string
Defined in: packages/extension-api/src/extension-api.d.ts:467
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.
labels?
optionallabels:object
Defined in: packages/extension-api/src/extension-api.d.ts:428
Labels are key-value pairs that are used to add metadata to pods. Optional.
Index Signature
[key: string]: string
name?
optionalname:string
Defined in: packages/extension-api/src/extension-api.d.ts:418
Name is the name of the pod. If not provided, a name will be generated when the pod is created. Optional.
netns?
optionalnetns:object
Defined in: packages/extension-api/src/extension-api.d.ts:447
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.
Networks?
optionalNetworks:object
Defined in: packages/extension-api/src/extension-api.d.ts:438
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
portmappings?
optionalportmappings:PodCreatePortOptions[]
Defined in: packages/extension-api/src/extension-api.d.ts:424
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.
provider?
optionalprovider:ContainerProviderConnection
Defined in: packages/extension-api/src/extension-api.d.ts:430