CRD reference

management.project-flotta.io/v1alpha1

Resource Types:

EdgeConfig
EdgeDevice
EdgeDeviceSet
EdgeDeviceSignedRequest
EdgeWorkload
PlaybookExecution

EdgeConfig

EdgeConfig is the Schema for the edgeconfigs API

Name	Type	Description	Required
apiVersion	string	management.project-flotta.io/v1alpha1	true
kind	string	EdgeConfig	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	EdgeConfigSpec defines the desired state of EdgeConfig	false
status	object	EdgeConfigStatus defines the observed state of EdgeConfig	false

EdgeConfig.spec

^{^{↩ Parent}}

EdgeConfigSpec defines the desired state of EdgeConfig

Name	Type	Description	Required
edgePlaybook	object	Definition of the custom playbook workload to execute	false

EdgeConfig.spec.edgePlaybook

^{^{↩ Parent}}

Definition of the custom playbook workload to execute

Name	Type	Description	Required
playbooks	[]object	The ansible's playbooks list. The first element is the playbook with the highest priority.	false
user	string	username who execute the playbook	false

EdgeConfig.spec.edgePlaybook.playbooks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
content	string	Playbook content Format: byte	true
ansibleOptions	object	the ansible's playbook options for the playbook	false
executionStrategy	string	Execution strategy for the playbook	false
privilegeEscalationOptions	object	the ansible's playbook privilege escalation options for the playbook	false
requiredPrivilegeLevel	object	The required privelege level necessary to execute the playbook	false
timeoutSeconds	integer	The connection timeout on ansible-playbook Format: int64	false

EdgeConfig.spec.edgePlaybook.playbooks[index].ansibleOptions

^{^{↩ Parent}}

the ansible's playbook options for the playbook

Name	Type	Description	Required
check	boolean	don't make any changes; instead, try to predict some of the changes that may occur	false

EdgeConfig.spec.edgePlaybook.playbooks[index].privilegeEscalationOptions

^{^{↩ Parent}}

the ansible's playbook privilege escalation options for the playbook

Name	Type	Description	Required
become	boolean		false
becomeMethod	enum	Enum: sudo, su	false
becomeUser	string		false

EdgeConfig.spec.edgePlaybook.playbooks[index].requiredPrivilegeLevel

^{^{↩ Parent}}

The required privelege level necessary to execute the playbook

Name	Type	Description	Required
capAdd	[]integer	See https://man7.org/linux/man-pages/man7/capabilities.7.html	false
capDrop	[]integer		false

EdgeConfig.status

^{^{↩ Parent}}

EdgeConfigStatus defines the observed state of EdgeConfig

Name	Type	Description	Required
edgePlaybookStatus	object	EdgePlaybookStatus defines the observed state of EdgePlaybook	false

EdgeConfig.status.edgePlaybookStatus

^{^{↩ Parent}}

EdgePlaybookStatus defines the observed state of EdgePlaybook

Name	Type	Description	Required
conditions	[]object		false

EdgeConfig.status.edgePlaybookStatus.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
status	string	Indicates whether that condition is applicable, with possible values "True", "False", or "Unknown" The absence of a condition should be interpreted the same as Unknown	true
type	string		true
lastTransitionTime	string	Format: date-time	false
message	string		false
reason	string		false

EdgeDevice

^{^{↩ Parent}}

EdgeDevice is the Schema for the edgedevices API

Name	Type	Description	Required
apiVersion	string	management.project-flotta.io/v1alpha1	true
kind	string	EdgeDevice	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	EdgeDeviceSpec defines the desired state of EdgeDevice	false
status	object	EdgeDeviceStatus defines the observed state of EdgeDevice	false

EdgeDevice.spec

^{^{↩ Parent}}

EdgeDeviceSpec defines the desired state of EdgeDevice

Name	Type	Description	Required
heartbeat	object		false
logCollection	map[string]object		false
metrics	object		false
osInformation	object	OsInformation carries information about commit ID of the OS Image deployed to the device	false
requestTime	string	RequestTime is the time of device registration request Format: date-time	false
storage	object		false

EdgeDevice.spec.heartbeat

^{^{↩ Parent}}

Name	Type	Description	Required
hardwareProfile	object	hardware profile	false
periodSeconds	integer	period seconds Format: int64 Minimum: 1	false

EdgeDevice.spec.heartbeat.hardwareProfile

^{^{↩ Parent}}

hardware profile

Name	Type	Description	Required
include	boolean	include	false
scope	string	scope Enum: [full delta]	false

EdgeDevice.spec.logCollection[key]

^{^{↩ Parent}}

Name	Type	Description	Required
bufferSize	integer	Format: int32 Default: 12 Minimum: 1	false
kind	enum	Kind is the type of log collection to be used Enum: syslog	false
syslogConfig	object	SyslogConfig is the pointer to the configMap to be used to load the config	false

EdgeDevice.spec.logCollection[key].syslogConfig

^{^{↩ Parent}}

SyslogConfig is the pointer to the configMap to be used to load the config

Name	Type	Description	Required
name	string		true

EdgeDevice.spec.metrics

^{^{↩ Parent}}

Name	Type	Required
receiverConfiguration	object	false
retention	object	false
system	object	false

EdgeDevice.spec.metrics.receiverConfiguration

^{^{↩ Parent}}

Name	Type	Description	Required
caSecretName	string		false
requestNumSamples	integer	Format: int64	false
timeoutSeconds	integer	Format: int64	false
url	string		false

EdgeDevice.spec.metrics.retention

^{^{↩ Parent}}

Name	Type	Description	Required
maxHours	integer	MaxHours specifies how long should persisted metrics be stored on the device disk Format: int32 Minimum: 0	false
maxMiB	integer	MaxMiB specifies how much disk space should be used for storing persisted metrics on the device Format: int32 Minimum: 0	false

EdgeDevice.spec.metrics.system

^{^{↩ Parent}}

Name	Type	Description	Required
allowList	object	AllowList defines name of a ConfigMap containing list of system metrics that should be scraped	false
disabled	boolean	Disabled when set to true instructs the device to turn off system metrics collection	false
interval	integer	Interval(in seconds) to scrape system metrics. Format: int32 Default: 60 Minimum: 0	false

EdgeDevice.spec.metrics.system.allowList

^{^{↩ Parent}}

AllowList defines name of a ConfigMap containing list of system metrics that should be scraped

Name	Type	Description	Required
name	string		true

EdgeDevice.spec.osInformation

^{^{↩ Parent}}

OsInformation carries information about commit ID of the OS Image deployed to the device

Name	Type	Description	Required
automaticallyUpgrade	boolean	Automatically upgrade the OS image	false
commitID	string	CommitID carries information about commit of the OS Image	false
hostedObjectsURL	string	HostedObjectsURL carries the URL of the hosted commits web server	false

EdgeDevice.spec.storage

^{^{↩ Parent}}

Name	Type	Description	Required
s3	object		false

EdgeDevice.spec.storage.s3

^{^{↩ Parent}}

Name	Type	Description	Required
configMapName	string	configMap name	false
createOBC	boolean	createOBC. if the configuration above is empty and this bool is true then create OBC	false
secretName	string	secret name	false

EdgeDevice.status

^{^{↩ Parent}}

EdgeDeviceStatus defines the observed state of EdgeDevice

Name	Type	Required
dataObc	string	false
hardware	object	false
lastSyncedResourceVersion	string	false
phase	string	false
upgradeInformation	object	false
workloads	[]object	false

EdgeDevice.status.hardware

^{^{↩ Parent}}

Name	Type	Description	Required
disks	[]object	disks	true
gpus	[]object	gpus	true
interfaces	[]object	interfaces	true
boot	object	boot	false
cpu	object	cpu	false
hostname	string	hostname	false
memory	object	memory	false
systemVendor	object	system vendor	false

EdgeDevice.status.hardware.disks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
bootable	boolean	bootable	false
byId	string	by-id is the World Wide Number of the device which guaranteed to be unique for every storage device	false
byPath	string	by-path is the shortest physical path to the device	false
driveType	string	drive type	false
hctl	string	hctl	false
id	string	Determine the disk's unique identifier which is the by-id field if it exists and fallback to the by-path field otherwise	false
ioPerf	object	io perf	false
isInstallationMedia	boolean	Whether the disk appears to be an installation media or not	false
model	string	model	false
name	string	name	false
path	string	path	false
serial	string	serial	false
sizeBytes	integer	size bytes Format: int64	false
smart	string	smart	false
vendor	string	vendor	false
wwn	string	wwn	false

EdgeDevice.status.hardware.disks[index].ioPerf

^{^{↩ Parent}}

io perf

Name	Type	Description	Required
syncDuration	integer	99th percentile of fsync duration in milliseconds Format: int64	false

EdgeDevice.status.hardware.gpus[index]

^{^{↩ Parent}}

Name	Type	Description	Required
address	string	Device address (for example "0000:00:02.0")	false
deviceId	string	ID of the device (for example "3ea0")	false
name	string	Product name of the device (for example "UHD Graphics 620 (Whiskey Lake)")	false
vendor	string	The name of the device vendor (for example "Intel Corporation")	false
vendorId	string	ID of the vendor (for example "8086")	false

EdgeDevice.status.hardware.interfaces[index]

^{^{↩ Parent}}

Name	Type	Description	Required
flags	[]string	flags	true
biosdevname	string	biosdevname	false
clientId	string	client id	false
hasCarrier	boolean	has carrier	false
ipv4Addresses	[]string	ipv4 addresses	false
ipv6Addresses	[]string	ipv6 addresses	false
macAddress	string	mac address	false
mtu	integer	mtu Format: int64	false
name	string	name	false
product	string	product	false
speedMbps	integer	speed mbps Format: int64	false
vendor	string	vendor	false

EdgeDevice.status.hardware.boot

^{^{↩ Parent}}

boot

Name	Type	Description	Required
currentBootMode	string	current boot mode	false
pxeInterface	string	pxe interface	false

EdgeDevice.status.hardware.cpu

^{^{↩ Parent}}

cpu

Name	Type	Description	Required
flags	[]string	flags	true
architecture	string	architecture	false
count	integer	count Format: int64	false
frequency	string	frequency	false
modelName	string	model name	false

EdgeDevice.status.hardware.memory

^{^{↩ Parent}}

memory

Name	Type	Description	Required
physicalBytes	integer	physical bytes Format: int64	false
usableBytes	integer	usable bytes Format: int64	false

EdgeDevice.status.hardware.systemVendor

^{^{↩ Parent}}

system vendor

Name	Type	Description	Required
manufacturer	string	manufacturer	false
productName	string	product name	false
serialNumber	string	serial number	false
virtual	boolean	Whether the machine appears to be a virtual machine or not	false

EdgeDevice.status.upgradeInformation

^{^{↩ Parent}}

Name	Type	Description	Required
currentCommitID	string	Current commit	true
lastUpgradeStatus	string	last upgrade status	false
lastUpgradeTime	string	last upgrade time	false

EdgeDevice.status.workloads[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string		true
lastDataUpload	string	Format: date-time	false
lastTransitionTime	string	Format: date-time	false
phase	string		false

EdgeDeviceSet

^{^{↩ Parent}}

EdgeDeviceSet is the Schema for the edgedevicesets API

Name	Type	Description	Required
apiVersion	string	management.project-flotta.io/v1alpha1	true
kind	string	EdgeDeviceSet	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	EdgeDeviceSetSpec defines the desired state of EdgeDeviceSet	false
status	object	EdgeDeviceSetStatus defines the observed state of EdgeDeviceSet	false

EdgeDeviceSet.spec

^{^{↩ Parent}}

EdgeDeviceSetSpec defines the desired state of EdgeDeviceSet

Name	Type	Description	Required
heartbeat	object	Heartbeat contains heartbeat messages configuration	false
logCollection	map[string]object	LogCollection contains configuration for device log collection	false
metrics	object	Metrics contain metric collection and upload configuration	false
osInformation	object	OsInformation carries information about commit ID of the OS Image deployed to the device	false
storage	object	Storage contains data upload configuration	false

EdgeDeviceSet.spec.heartbeat

^{^{↩ Parent}}

Heartbeat contains heartbeat messages configuration

Name	Type	Description	Required
hardwareProfile	object	hardware profile	false
periodSeconds	integer	period seconds Format: int64 Minimum: 1	false

EdgeDeviceSet.spec.heartbeat.hardwareProfile

^{^{↩ Parent}}

hardware profile

Name	Type	Description	Required
include	boolean	include	false
scope	string	scope Enum: [full delta]	false

EdgeDeviceSet.spec.logCollection[key]

^{^{↩ Parent}}

Name	Type	Description	Required
bufferSize	integer	Format: int32 Default: 12 Minimum: 1	false
kind	enum	Kind is the type of log collection to be used Enum: syslog	false
syslogConfig	object	SyslogConfig is the pointer to the configMap to be used to load the config	false

EdgeDeviceSet.spec.logCollection[key].syslogConfig

^{^{↩ Parent}}

SyslogConfig is the pointer to the configMap to be used to load the config

Name	Type	Description	Required
name	string		true

EdgeDeviceSet.spec.metrics

^{^{↩ Parent}}

Metrics contain metric collection and upload configuration

Name	Type	Required
receiverConfiguration	object	false
retention	object	false
system	object	false

EdgeDeviceSet.spec.metrics.receiverConfiguration

^{^{↩ Parent}}

Name	Type	Description	Required
caSecretName	string		false
requestNumSamples	integer	Format: int64	false
timeoutSeconds	integer	Format: int64	false
url	string		false

EdgeDeviceSet.spec.metrics.retention

^{^{↩ Parent}}

Name	Type	Description	Required
maxHours	integer	MaxHours specifies how long should persisted metrics be stored on the device disk Format: int32 Minimum: 0	false
maxMiB	integer	MaxMiB specifies how much disk space should be used for storing persisted metrics on the device Format: int32 Minimum: 0	false

EdgeDeviceSet.spec.metrics.system

^{^{↩ Parent}}

Name	Type	Description	Required
allowList	object	AllowList defines name of a ConfigMap containing list of system metrics that should be scraped	false
disabled	boolean	Disabled when set to true instructs the device to turn off system metrics collection	false
interval	integer	Interval(in seconds) to scrape system metrics. Format: int32 Default: 60 Minimum: 0	false

EdgeDeviceSet.spec.metrics.system.allowList

^{^{↩ Parent}}

AllowList defines name of a ConfigMap containing list of system metrics that should be scraped

Name	Type	Description	Required
name	string		true

EdgeDeviceSet.spec.osInformation

^{^{↩ Parent}}

OsInformation carries information about commit ID of the OS Image deployed to the device

Name	Type	Description	Required
automaticallyUpgrade	boolean	Automatically upgrade the OS image	false
commitID	string	CommitID carries information about commit of the OS Image	false
hostedObjectsURL	string	HostedObjectsURL carries the URL of the hosted commits web server	false

EdgeDeviceSet.spec.storage

^{^{↩ Parent}}

Storage contains data upload configuration

Name	Type	Description	Required
s3	object		false

EdgeDeviceSet.spec.storage.s3

^{^{↩ Parent}}

Name	Type	Description	Required
configMapName	string	configMap name	false
createOBC	boolean	createOBC. if the configuration above is empty and this bool is true then create OBC	false
secretName	string	secret name	false

EdgeDeviceSignedRequest

^{^{↩ Parent}}

EdgeDeviceSignedRequest is the Schema for the edgedevice enrolment options

Name	Type	Description	Required
apiVersion	string	management.project-flotta.io/v1alpha1	true
kind	string	EdgeDeviceSignedRequest	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		false
status	object		false

EdgeDeviceSignedRequest.spec

^{^{↩ Parent}}

Name	Type	Description	Required
targetNamespace	string	TargetNamespace is the namespace where device will land	true
approved	boolean	Approved is set to true if the device should be approved to register Default: false	false
features	object	Features lists features that the registering edge device has	false
targetSet	string	TargetSet is set that edgedevice will use.	false

EdgeDeviceSignedRequest.spec.features

^{^{↩ Parent}}

Features lists features that the registering edge device has

Name	Type	Description	Required
hardware	object	Hardware defines the hardware that devices has	false
modelName	string	ModelName is the model name from the OS. The output of: cat /sys/firmware/devicetree/base/model	false

EdgeDeviceSignedRequest.spec.features.hardware

^{^{↩ Parent}}

Hardware defines the hardware that devices has

Name	Type	Description	Required
disks	[]object	disks	true
gpus	[]object	gpus	true
interfaces	[]object	interfaces	true
boot	object	boot	false
cpu	object	cpu	false
hostname	string	hostname	false
memory	object	memory	false
systemVendor	object	system vendor	false

EdgeDeviceSignedRequest.spec.features.hardware.disks[index]

^{^{↩ Parent}}

Name	Type	Description	Required
bootable	boolean	bootable	false
byId	string	by-id is the World Wide Number of the device which guaranteed to be unique for every storage device	false
byPath	string	by-path is the shortest physical path to the device	false
driveType	string	drive type	false
hctl	string	hctl	false
id	string	Determine the disk's unique identifier which is the by-id field if it exists and fallback to the by-path field otherwise	false
ioPerf	object	io perf	false
isInstallationMedia	boolean	Whether the disk appears to be an installation media or not	false
model	string	model	false
name	string	name	false
path	string	path	false
serial	string	serial	false
sizeBytes	integer	size bytes Format: int64	false
smart	string	smart	false
vendor	string	vendor	false
wwn	string	wwn	false

EdgeDeviceSignedRequest.spec.features.hardware.disks[index].ioPerf

^{^{↩ Parent}}

io perf

Name	Type	Description	Required
syncDuration	integer	99th percentile of fsync duration in milliseconds Format: int64	false

EdgeDeviceSignedRequest.spec.features.hardware.gpus[index]

^{^{↩ Parent}}

Name	Type	Description	Required
address	string	Device address (for example "0000:00:02.0")	false
deviceId	string	ID of the device (for example "3ea0")	false
name	string	Product name of the device (for example "UHD Graphics 620 (Whiskey Lake)")	false
vendor	string	The name of the device vendor (for example "Intel Corporation")	false
vendorId	string	ID of the vendor (for example "8086")	false

EdgeDeviceSignedRequest.spec.features.hardware.interfaces[index]

^{^{↩ Parent}}

Name	Type	Description	Required
flags	[]string	flags	true
biosdevname	string	biosdevname	false
clientId	string	client id	false
hasCarrier	boolean	has carrier	false
ipv4Addresses	[]string	ipv4 addresses	false
ipv6Addresses	[]string	ipv6 addresses	false
macAddress	string	mac address	false
mtu	integer	mtu Format: int64	false
name	string	name	false
product	string	product	false
speedMbps	integer	speed mbps Format: int64	false
vendor	string	vendor	false

EdgeDeviceSignedRequest.spec.features.hardware.boot

^{^{↩ Parent}}

boot

Name	Type	Description	Required
currentBootMode	string	current boot mode	false
pxeInterface	string	pxe interface	false

EdgeDeviceSignedRequest.spec.features.hardware.cpu

^{^{↩ Parent}}

cpu

Name	Type	Description	Required
flags	[]string	flags	true
architecture	string	architecture	false
count	integer	count Format: int64	false
frequency	string	frequency	false
modelName	string	model name	false

EdgeDeviceSignedRequest.spec.features.hardware.memory

^{^{↩ Parent}}

memory

Name	Type	Description	Required
physicalBytes	integer	physical bytes Format: int64	false
usableBytes	integer	usable bytes Format: int64	false

EdgeDeviceSignedRequest.spec.features.hardware.systemVendor

^{^{↩ Parent}}

system vendor

Name	Type	Description	Required
manufacturer	string	manufacturer	false
productName	string	product name	false
serialNumber	string	serial number	false
virtual	boolean	Whether the machine appears to be a virtual machine or not	false

EdgeDeviceSignedRequest.status

^{^{↩ Parent}}

Name	Type	Description	Required
conditions	[]object		true

EdgeDeviceSignedRequest.status.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
status	string	Status of the condition, one of True, False, Unknown	true
type	enum	Type of status Enum: declined, approved, pending Default: pending	true
lastTransitionTime	string	The last time the condition transit from one status to another Format: date-time	false
message	string	A human-readable message indicating details about last transition	false

EdgeWorkload

^{^{↩ Parent}}

EdgeWorkload is the Schema for the EdgeWorkloads API

Name	Type	Description	Required
apiVersion	string	management.project-flotta.io/v1alpha1	true
kind	string	EdgeWorkload	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	EdgeWorkloadSpec defines the desired state of EdgeWorkload	false
status	object	EdgeWorkloadStatus defines the observed state of EdgeWorkload	false

EdgeWorkload.spec

^{^{↩ Parent}}

EdgeWorkloadSpec defines the desired state of EdgeWorkload

Name	Type	Description	Required
type	string		true
data	object		false
device	string		false
deviceSelector	object	A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.	false
imageRegistries	object		false
logCollection	string	LogCollection is the logCollection property to be used to collect logs from this endpoint. This key is what is defined on the edgedevice logCollection property	false
metrics	object		false
pod	object		false

EdgeWorkload.spec.data

^{^{↩ Parent}}

Name	Type	Description	Required
paths	[]object		false

EdgeWorkload.spec.data.paths[index]

^{^{↩ Parent}}

Name	Type	Description	Required
source	string		true
target	string		true

EdgeWorkload.spec.deviceSelector

^{^{↩ Parent}}

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.deviceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.imageRegistries

^{^{↩ Parent}}

Name	Type	Description	Required
secretRef	object		false

EdgeWorkload.spec.imageRegistries.secretRef

^{^{↩ Parent}}

Name	Type	Description	Required
name	string		true

EdgeWorkload.spec.metrics

^{^{↩ Parent}}

Name	Type	Description	Required
allowList	object	Specification of workload metrics to be collected	false
containers	map[string]object		false
interval	integer	Interval(in seconds) to scrape metrics endpoint. Format: int32 Default: 60 Minimum: 0	false
path	string	Path to use when retrieving metrics Default: /	false
port	integer	Port to use when retrieve the metrics Format: int32 Minimum: 0 Maximum: 65535	false

EdgeWorkload.spec.metrics.allowList

^{^{↩ Parent}}

Specification of workload metrics to be collected

Name	Type	Description	Required
name	string		true

EdgeWorkload.spec.metrics.containers[key]

^{^{↩ Parent}}

Name	Type	Description	Required
disabled	boolean		false
path	string	Path to use when retrieving metrics Default: /	false
port	integer	Port to use when retrieve the metrics Format: int32 Minimum: 0 Maximum: 65535	false

EdgeWorkload.spec.pod

^{^{↩ Parent}}

Name	Type	Description	Required
spec	object	PodSpec is a description of a pod.	true

EdgeWorkload.spec.pod.spec

^{^{↩ Parent}}

PodSpec is a description of a pod.

Name	Type	Description	Required
containers	[]object	List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.	true
activeDeadlineSeconds	integer	Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. Format: int64	false
affinity	object	If specified, the pod's scheduling constraints	false
automountServiceAccountToken	boolean	AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.	false
dnsConfig	object	Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.	false
dnsPolicy	string	Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.	false
enableServiceLinks	boolean	EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.	false
ephemeralContainers	[]object	List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is beta-level and available on clusters that haven't disabled the EphemeralContainers feature gate.	false
hostAliases	[]object	HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.	false
hostIPC	boolean	Use the host's ipc namespace. Optional: Default to false.	false
hostNetwork	boolean	Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.	false
hostPID	boolean	Use the host's pid namespace. Optional: Default to false.	false
hostname	string	Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.	false
imagePullSecrets	[]object	ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod	false
initContainers	[]object	List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/	false
nodeName	string	NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.	false
nodeSelector	map[string]string	NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/	false
os	object	Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup This is an alpha field and requires the IdentifyPodOS feature	false
overhead	map[string]int or string	Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md This field is beta-level as of Kubernetes v1.18, and is only honored by servers that enable the PodOverhead feature.	false
preemptionPolicy	string	PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.	false
priority	integer	The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. Format: int32	false
priorityClassName	string	If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.	false
readinessGates	[]object	If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates	false
restartPolicy	string	Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy	false
runtimeClassName	string	RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class This is a beta feature as of Kubernetes v1.14.	false
schedulerName	string	If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.	false
securityContext	object	SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.	false
serviceAccount	string	DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.	false
serviceAccountName	string	ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/	false
setHostnameAsFQDN	boolean	If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.	false
shareProcessNamespace	boolean	Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.	false
subdomain	string	If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. Format: int64	false
tolerations	[]object	If specified, the pod's tolerations.	false
topologySpreadConstraints	[]object	TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.	false
volumes	[]object	List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes	false

EdgeWorkload.spec.pod.spec.containers[index]

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

EdgeWorkload.spec.pod.spec.containers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

EdgeWorkload.spec.pod.spec.containers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable's value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

EdgeWorkload.spec.pod.spec.containers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

EdgeWorkload.spec.pod.spec.containers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

EdgeWorkload.spec.pod.spec.containers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

EdgeWorkload.spec.pod.spec.containers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod's namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

EdgeWorkload.spec.pod.spec.containers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

EdgeWorkload.spec.pod.spec.containers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

EdgeWorkload.spec.pod.spec.containers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

EdgeWorkload.spec.pod.spec.containers[index].lifecycle

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.postStart

^{^{↩ Parent}}

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.preStop

^{^{↩ Parent}}

PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.containers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.containers[index].livenessProbe

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

EdgeWorkload.spec.pod.spec.containers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.containers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

EdgeWorkload.spec.pod.spec.containers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.containers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.containers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.containers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

EdgeWorkload.spec.pod.spec.containers[index].readinessProbe

^{^{↩ Parent}}

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

EdgeWorkload.spec.pod.spec.containers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.containers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

EdgeWorkload.spec.pod.spec.containers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.containers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.containers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.containers[index].resources

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

EdgeWorkload.spec.pod.spec.containers[index].securityContext

^{^{↩ Parent}}

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

EdgeWorkload.spec.pod.spec.containers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

EdgeWorkload.spec.pod.spec.containers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

EdgeWorkload.spec.pod.spec.containers[index].securityContext.seccompProfile

^{^{↩ Parent}}

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".	false

EdgeWorkload.spec.pod.spec.containers[index].securityContext.windowsOptions

^{^{↩ Parent}}

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

EdgeWorkload.spec.pod.spec.containers[index].startupProbe

^{^{↩ Parent}}

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

EdgeWorkload.spec.pod.spec.containers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.containers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

EdgeWorkload.spec.pod.spec.containers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.containers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.containers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.containers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

EdgeWorkload.spec.pod.spec.containers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

EdgeWorkload.spec.pod.spec.affinity

^{^{↩ Parent}}

If specified, the pod's scheduling constraints

Name	Type	Description	Required
nodeAffinity	object	Describes node affinity scheduling rules for the pod.	false
podAffinity	object	Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).	false
podAntiAffinity	object	Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).	false

EdgeWorkload.spec.pod.spec.affinity.nodeAffinity

^{^{↩ Parent}}

Describes node affinity scheduling rules for the pod.

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.	false

EdgeWorkload.spec.pod.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Name	Type	Description	Required
preference	object	A node selector term, associated with the corresponding weight.	true
weight	integer	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. Format: int32	true

EdgeWorkload.spec.pod.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference

^{^{↩ Parent}}

A node selector term, associated with the corresponding weight.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

EdgeWorkload.spec.pod.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

^{^{↩ Parent}}

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.

Name	Type	Description	Required
nodeSelectorTerms	[]object	Required. A list of node selector terms. The terms are ORed.	true

EdgeWorkload.spec.pod.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index]

^{^{↩ Parent}}

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Name	Type	Description	Required
matchExpressions	[]object	A list of node selector requirements by node's labels.	false
matchFields	[]object	A list of node selector requirements by node's fields.	false

EdgeWorkload.spec.pod.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index]

^{^{↩ Parent}}

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	The label key that the selector applies to.	true
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.	true
values	[]string	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity

^{^{↩ Parent}}

Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

EdgeWorkload.spec.pod.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity

^{^{↩ Parent}}

Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

Name	Type	Description	Required
preferredDuringSchedulingIgnoredDuringExecution	[]object	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.	false
requiredDuringSchedulingIgnoredDuringExecution	[]object	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Name	Type	Description	Required
podAffinityTerm	object	Required. A pod affinity term, associated with the corresponding weight.	true
weight	integer	weight associated with matching the corresponding podAffinityTerm, in the range 1-100. Format: int32	true

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm

^{^{↩ Parent}}

Required. A pod affinity term, associated with the corresponding weight.

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index]

^{^{↩ Parent}}

Name	Type	Description	Required
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.	true
labelSelector	object	A label query over a set of resources, in this case pods.	false
namespaceSelector	object	A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.	false
namespaces	[]string	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace"	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector

^{^{↩ Parent}}

A label query over a set of resources, in this case pods.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector

^{^{↩ Parent}}

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.dnsConfig

^{^{↩ Parent}}

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

Name	Type	Description	Required
nameservers	[]string	A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.	false
options	[]object	A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.	false
searches	[]string	A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.	false

EdgeWorkload.spec.pod.spec.dnsConfig.options[index]

^{^{↩ Parent}}

PodDNSConfigOption defines DNS resolver options of a pod.

Name	Type	Description	Required
name	string	Required.	false
value	string		false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index]

^{^{↩ Parent}}

An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation. To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted. This is a beta feature available on clusters that haven't disabled the EphemeralContainers feature gate.

Name	Type	Description	Required
name	string	Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.	true
args	[]string	Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Lifecycle is not allowed for ephemeral containers.	false
livenessProbe	object	Probes are not allowed for ephemeral containers.	false
ports	[]object	Ports are not allowed for ephemeral containers.	false
readinessProbe	object	Probes are not allowed for ephemeral containers.	false
resources	object	Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.	false
securityContext	object	Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.	false
startupProbe	object	Probes are not allowed for ephemeral containers.	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
targetContainerName	string	If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable's value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod's namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle

^{^{↩ Parent}}

Lifecycle is not allowed for ephemeral containers.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.postStart

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.preStop

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].livenessProbe

^{^{↩ Parent}}

Probes are not allowed for ephemeral containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].readinessProbe

^{^{↩ Parent}}

Probes are not allowed for ephemeral containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].resources

^{^{↩ Parent}}

Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].securityContext

^{^{↩ Parent}}

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].startupProbe

^{^{↩ Parent}}

Probes are not allowed for ephemeral containers.

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

EdgeWorkload.spec.pod.spec.ephemeralContainers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

EdgeWorkload.spec.pod.spec.hostAliases[index]

^{^{↩ Parent}}

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

Name	Type	Description	Required
hostnames	[]string	Hostnames for the above IP address.	false
ip	string	IP address of the host file entry.	false

EdgeWorkload.spec.pod.spec.imagePullSecrets[index]

^{^{↩ Parent}}

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

EdgeWorkload.spec.pod.spec.initContainers[index]

^{^{↩ Parent}}

A single application container that you want to run within a pod.

Name	Type	Description	Required
name	string	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.	true
args	[]string	Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
command	[]string	Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
image	string	Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.	false
imagePullPolicy	string	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images	false
lifecycle	object	Actions that the management system should take in response to container lifecycle events. Cannot be updated.	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
ports	[]object	List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
resources	object	Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
securityContext	object	SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
stdin	boolean	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.	false
stdinOnce	boolean	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false	false
terminationMessagePath	string	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.	false
terminationMessagePolicy	string	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.	false
tty	boolean	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.	false
volumeDevices	[]object	volumeDevices is the list of block devices to be used by the container.	false
volumeMounts	[]object	Pod volumes to mount into the container's filesystem. Cannot be updated.	false
workingDir	string	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.	false

EdgeWorkload.spec.pod.spec.initContainers[index].env[index]

^{^{↩ Parent}}

EnvVar represents an environment variable present in a Container.

Name	Type	Description	Required
name	string	Name of the environment variable. Must be a C_IDENTIFIER.	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".	false
valueFrom	object	Source for the environment variable's value. Cannot be used if value is not empty.	false

EdgeWorkload.spec.pod.spec.initContainers[index].env[index].valueFrom

^{^{↩ Parent}}

Source for the environment variable's value. Cannot be used if value is not empty.

Name	Type	Description	Required
configMapKeyRef	object	Selects a key of a ConfigMap.	false
fieldRef	object	Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.	false
secretKeyRef	object	Selects a key of a secret in the pod's namespace	false

EdgeWorkload.spec.pod.spec.initContainers[index].env[index].valueFrom.configMapKeyRef

^{^{↩ Parent}}

Selects a key of a ConfigMap.

Name	Type	Description	Required
key	string	The key to select.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its key must be defined	false

EdgeWorkload.spec.pod.spec.initContainers[index].env[index].valueFrom.fieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

EdgeWorkload.spec.pod.spec.initContainers[index].env[index].valueFrom.resourceFieldRef

^{^{↩ Parent}}

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

EdgeWorkload.spec.pod.spec.initContainers[index].env[index].valueFrom.secretKeyRef

^{^{↩ Parent}}

Selects a key of a secret in the pod's namespace

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	true
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

EdgeWorkload.spec.pod.spec.initContainers[index].envFrom[index]

^{^{↩ Parent}}

EnvFromSource represents the source of a set of ConfigMaps

Name	Type	Description	Required
configMapRef	object	The ConfigMap to select from	false
prefix	string	An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.	false
secretRef	object	The Secret to select from	false

EdgeWorkload.spec.pod.spec.initContainers[index].envFrom[index].configMapRef

^{^{↩ Parent}}

The ConfigMap to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap must be defined	false

EdgeWorkload.spec.pod.spec.initContainers[index].envFrom[index].secretRef

^{^{↩ Parent}}

The Secret to select from

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret must be defined	false

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle

^{^{↩ Parent}}

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

Name	Type	Description	Required
postStart	object	PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false
preStop	object	PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks	false

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.postStart

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.postStart.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.postStart.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.postStart.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.preStop

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
tcpSocket	object	Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.	false

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.preStop.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.preStop.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.initContainers[index].lifecycle.preStop.tcpSocket

^{^{↩ Parent}}

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].livenessProbe

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

EdgeWorkload.spec.pod.spec.initContainers[index].livenessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.initContainers[index].livenessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

EdgeWorkload.spec.pod.spec.initContainers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.initContainers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].ports[index]

^{^{↩ Parent}}

ContainerPort represents a network port in a single container.

Name	Type	Description	Required
containerPort	integer	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. Format: int32	true
hostIP	string	What host IP to bind the external port to.	false
hostPort	integer	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. Format: int32	false
name	string	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	false
protocol	string	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". Default: TCP	false

EdgeWorkload.spec.pod.spec.initContainers[index].readinessProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

EdgeWorkload.spec.pod.spec.initContainers[index].readinessProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.initContainers[index].readinessProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

EdgeWorkload.spec.pod.spec.initContainers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.initContainers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].resources

^{^{↩ Parent}}

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

EdgeWorkload.spec.pod.spec.initContainers[index].securityContext

^{^{↩ Parent}}

Name	Type	Description	Required
allowPrivilegeEscalation	boolean	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.	false
capabilities	object	The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.	false
privileged	boolean	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.	false
procMount	string	procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.	false
readOnlyRootFilesystem	boolean	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

EdgeWorkload.spec.pod.spec.initContainers[index].securityContext.capabilities

^{^{↩ Parent}}

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
add	[]string	Added capabilities	false
drop	[]string	Removed capabilities	false

EdgeWorkload.spec.pod.spec.initContainers[index].securityContext.seLinuxOptions

^{^{↩ Parent}}

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

EdgeWorkload.spec.pod.spec.initContainers[index].securityContext.seccompProfile

^{^{↩ Parent}}

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".	false

EdgeWorkload.spec.pod.spec.initContainers[index].securityContext.windowsOptions

^{^{↩ Parent}}

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

EdgeWorkload.spec.pod.spec.initContainers[index].startupProbe

^{^{↩ Parent}}

Name	Type	Description	Required
exec	object	Exec specifies the action to take.	false
failureThreshold	integer	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Format: int32	false
grpc	object	GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false
terminationGracePeriodSeconds	integer	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. Format: int64	false
timeoutSeconds	integer	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32	false

EdgeWorkload.spec.pod.spec.initContainers[index].startupProbe.exec

^{^{↩ Parent}}

Exec specifies the action to take.

Name	Type	Description	Required
command	[]string	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.	false

EdgeWorkload.spec.pod.spec.initContainers[index].startupProbe.grpc

^{^{↩ Parent}}

GRPC specifies an action involving a GRPC port. This is an alpha field and requires enabling GRPCContainerProbe feature gate.

Name	Type	Description	Required
port	integer	Port number of the gRPC service. Number must be in the range 1 to 65535. Format: int32	true
service	string	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.	false

EdgeWorkload.spec.pod.spec.initContainers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
port	int or string	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.	false
httpHeaders	[]object	Custom headers to set in the request. HTTP allows repeated headers.	false
path	string	Path to access on the HTTP server.	false
scheme	string	Scheme to use for connecting to the host. Defaults to HTTP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index]

^{^{↩ Parent}}

HTTPHeader describes a custom header to be used in HTTP probes

Name	Type	Description	Required
name	string	The header field name	true
value	string	The header field value	true

EdgeWorkload.spec.pod.spec.initContainers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	int or string	Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.	true
host	string	Optional: Host name to connect to, defaults to the pod IP.	false

EdgeWorkload.spec.pod.spec.initContainers[index].volumeDevices[index]

^{^{↩ Parent}}

volumeDevice describes a mapping of a raw block device within a container.

Name	Type	Description	Required
devicePath	string	devicePath is the path inside of the container that the device will be mapped to.	true
name	string	name must match the name of a persistentVolumeClaim in the pod	true

EdgeWorkload.spec.pod.spec.initContainers[index].volumeMounts[index]

^{^{↩ Parent}}

VolumeMount describes a mounting of a Volume within a container.

Name	Type	Description	Required
mountPath	string	Path within the container at which the volume should be mounted. Must not contain ':'.	true
name	string	This must match the Name of a Volume.	true
mountPropagation	string	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.	false
readOnly	boolean	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.	false
subPath	string	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).	false
subPathExpr	string	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.	false

EdgeWorkload.spec.pod.spec.os

^{^{↩ Parent}}

Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup This is an alpha field and requires the IdentifyPodOS feature

Name	Type	Description	Required
name	string	Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null	true

EdgeWorkload.spec.pod.spec.readinessGates[index]

^{^{↩ Parent}}

PodReadinessGate contains the reference to a pod condition

Name	Type	Description	Required
conditionType	string	ConditionType refers to a condition in the pod's condition list with matching type.	true

EdgeWorkload.spec.pod.spec.securityContext

^{^{↩ Parent}}

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

Name	Type	Description	Required
fsGroup	integer	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
fsGroupChangePolicy	string	fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows.	false
runAsGroup	integer	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false
runAsUser	integer	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. Format: int64	false
seLinuxOptions	object	The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.	false
seccompProfile	object	The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.	false
supplementalGroups	[]integer	A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows.	false
sysctls	[]object	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.	false
windowsOptions	object	The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.	false

EdgeWorkload.spec.pod.spec.securityContext.seLinuxOptions

^{^{↩ Parent}}

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
level	string	Level is SELinux level label that applies to the container.	false
role	string	Role is a SELinux role label that applies to the container.	false
type	string	Type is a SELinux type label that applies to the container.	false
user	string	User is a SELinux user label that applies to the container.	false

EdgeWorkload.spec.pod.spec.securityContext.seccompProfile

^{^{↩ Parent}}

The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.

Name	Type	Description	Required
type	string	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.	true
localhostProfile	string	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".	false

EdgeWorkload.spec.pod.spec.securityContext.sysctls[index]

^{^{↩ Parent}}

Sysctl defines a kernel parameter to be set

Name	Type	Description	Required
name	string	Name of a property to set	true
value	string	Value of a property to set	true

EdgeWorkload.spec.pod.spec.securityContext.windowsOptions

^{^{↩ Parent}}

The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.

Name	Type	Description	Required
gmsaCredentialSpec	string	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.	false
gmsaCredentialSpecName	string	GMSACredentialSpecName is the name of the GMSA credential spec to use.	false
hostProcess	boolean	HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.	false
runAsUserName	string	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.	false

EdgeWorkload.spec.pod.spec.tolerations[index]

^{^{↩ Parent}}

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

Name	Type	Description	Required
effect	string	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.	false
key	string	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.	false
operator	string	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.	false
tolerationSeconds	integer	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. Format: int64	false
value	string	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.	false

EdgeWorkload.spec.pod.spec.topologySpreadConstraints[index]

^{^{↩ Parent}}

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Name	Type	Description	Required
maxSkew	integer	MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: \| zone1 \| zone2 \| zone3 \| \| P \| P \| \| - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. Format: int32	true
topologyKey	string	TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to put balanced number of pods into each bucket. It's a required field.	true
whenUnsatisfiable	string	WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: \| zone1 \| zone2 \| zone3 \| \| P P P \| P \| P \| If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it more imbalanced. It's a required field.	true
labelSelector	object	LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.	false

EdgeWorkload.spec.pod.spec.topologySpreadConstraints[index].labelSelector

^{^{↩ Parent}}

LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.volumes[index]

^{^{↩ Parent}}

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Name	Type	Description	Required
name	string	Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true
awsElasticBlockStore	object	AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false
azureDisk	object	AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.	false
azureFile	object	AzureFile represents an Azure File Service mount on the host and bind mount to the pod.	false
cephfs	object	CephFS represents a Ceph FS mount on the host that shares a pod's lifetime	false
cinder	object	Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
configMap	object	ConfigMap represents a configMap that should populate this volume	false
csi	object	CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).	false
downwardAPI	object	DownwardAPI represents downward API about the pod that should populate this volume	false
emptyDir	object	EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
ephemeral	object	Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.	false
fc	object	FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.	false
flexVolume	object	FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.	false
flocker	object	Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running	false
gcePersistentDisk	object	GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false
gitRepo	object	GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.	false
glusterfs	object	Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md	false
hostPath	object	HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.	false
iscsi	object	ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md	false
nfs	object	NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false
persistentVolumeClaim	object	PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	false
photonPersistentDisk	object	PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine	false
portworxVolume	object	PortworxVolume represents a portworx volume attached and mounted on kubelets host machine	false
projected	object	Items for all in one resources secrets, configmaps, and downward API	false
quobyte	object	Quobyte represents a Quobyte mount on the host that shares a pod's lifetime	false
rbd	object	RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md	false
scaleIO	object	ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.	false
secret	object	Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false
storageos	object	StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.	false
vsphereVolume	object	VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine	false

EdgeWorkload.spec.pod.spec.volumes[index].awsElasticBlockStore

^{^{↩ Parent}}

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Name	Type	Description	Required
volumeID	string	Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	true
fsType	string	Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). Format: int32	false
readOnly	boolean	Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore	false

EdgeWorkload.spec.pod.spec.volumes[index].azureDisk

^{^{↩ Parent}}

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Name	Type	Description	Required
diskName	string	The Name of the data disk in the blob storage	true
diskURI	string	The URI the data disk in the blob storage	true
cachingMode	string	Host Caching mode: None, Read Only, Read Write.	false
fsType	string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
kind	string	Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared	false
readOnly	boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

EdgeWorkload.spec.pod.spec.volumes[index].azureFile

^{^{↩ Parent}}

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Name	Type	Description	Required
secretName	string	the name of secret that contains Azure Storage Account Name and Key	true
shareName	string	Share Name	true
readOnly	boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

EdgeWorkload.spec.pod.spec.volumes[index].cephfs

^{^{↩ Parent}}

CephFS represents a Ceph FS mount on the host that shares a pod's lifetime

Name	Type	Description	Required
monitors	[]string	Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	true
path	string	Optional: Used as the mounted root, rather than the full Ceph tree, default is /	false
readOnly	boolean	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretFile	string	Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
secretRef	object	Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false
user	string	Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it	false

EdgeWorkload.spec.pod.spec.volumes[index].cephfs.secretRef

^{^{↩ Parent}}

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

EdgeWorkload.spec.pod.spec.volumes[index].cinder

^{^{↩ Parent}}

Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

Name	Type	Description	Required
volumeID	string	volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	true
fsType	string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
readOnly	boolean	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md	false
secretRef	object	Optional: points to a secret object containing parameters used to connect to OpenStack.	false

EdgeWorkload.spec.pod.spec.volumes[index].cinder.secretRef

^{^{↩ Parent}}

Optional: points to a secret object containing parameters used to connect to OpenStack.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

EdgeWorkload.spec.pod.spec.volumes[index].configMap

^{^{↩ Parent}}

ConfigMap represents a configMap that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its keys must be defined	false

EdgeWorkload.spec.pod.spec.volumes[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	The key to project.	true
path	string	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

EdgeWorkload.spec.pod.spec.volumes[index].csi

^{^{↩ Parent}}

CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

Name	Type	Description	Required
driver	string	Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.	true
fsType	string	Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.	false
nodePublishSecretRef	object	NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.	false
readOnly	boolean	Specifies a read-only configuration for the volume. Defaults to false (read/write).	false
volumeAttributes	map[string]string	VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.	false

EdgeWorkload.spec.pod.spec.volumes[index].csi.nodePublishSecretRef

^{^{↩ Parent}}

NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

EdgeWorkload.spec.pod.spec.volumes[index].downwardAPI

^{^{↩ Parent}}

DownwardAPI represents downward API about the pod that should populate this volume

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	Items is a list of downward API volume file	false

EdgeWorkload.spec.pod.spec.volumes[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

EdgeWorkload.spec.pod.spec.volumes[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

EdgeWorkload.spec.pod.spec.volumes[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

EdgeWorkload.spec.pod.spec.volumes[index].emptyDir

^{^{↩ Parent}}

EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

Name	Type	Description	Required
medium	string	What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir	false
sizeLimit	int or string	Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir	false

EdgeWorkload.spec.pod.spec.volumes[index].ephemeral

^{^{↩ Parent}}

Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time.

Name	Type	Description	Required
volumeClaimTemplate	object	Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `<pod name>-<volume name>` where `<volume name>` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.	false

EdgeWorkload.spec.pod.spec.volumes[index].ephemeral.volumeClaimTemplate

^{^{↩ Parent}}

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. Required, must not be nil.

Name	Type	Description	Required
spec	object	The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.	true
metadata	object	May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.	false

EdgeWorkload.spec.pod.spec.volumes[index].ephemeral.volumeClaimTemplate.spec

^{^{↩ Parent}}

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

Name	Type	Description	Required
accessModes	[]string	AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1	false
dataSource	object	This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.	false
dataSourceRef	object	Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.	false
resources	object	Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources	false
selector	object	A label query over volumes to consider for binding.	false
storageClassName	string	Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1	false
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.	false
volumeName	string	VolumeName is the binding reference to the PersistentVolume backing this claim.	false

EdgeWorkload.spec.pod.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

^{^{↩ Parent}}

This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

EdgeWorkload.spec.pod.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

^{^{↩ Parent}}

Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

Name	Type	Description	Required
kind	string	Kind is the type of resource being referenced	true
name	string	Name is the name of resource being referenced	true
apiGroup	string	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.	false

EdgeWorkload.spec.pod.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

^{^{↩ Parent}}

Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Name	Type	Description	Required
limits	map[string]int or string	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
requests	map[string]int or string	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false

EdgeWorkload.spec.pod.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

^{^{↩ Parent}}

A label query over volumes to consider for binding.

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

EdgeWorkload.spec.pod.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

EdgeWorkload.spec.pod.spec.volumes[index].fc

^{^{↩ Parent}}

FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

Name	Type	Description	Required
fsType	string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine	false
lun	integer	Optional: FC target lun number Format: int32	false
readOnly	boolean	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
targetWWNs	[]string	Optional: FC target worldwide names (WWNs)	false
wwids	[]string	Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.	false

EdgeWorkload.spec.pod.spec.volumes[index].flexVolume

^{^{↩ Parent}}

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Name	Type	Description	Required
driver	string	Driver is the name of the driver to use for this volume.	true
fsType	string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.	false
options	map[string]string	Optional: Extra command options if any.	false
readOnly	boolean	Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.	false

EdgeWorkload.spec.pod.spec.volumes[index].flexVolume.secretRef

^{^{↩ Parent}}

Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

EdgeWorkload.spec.pod.spec.volumes[index].flocker

^{^{↩ Parent}}

Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

Name	Type	Description	Required
datasetName	string	Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated	false
datasetUUID	string	UUID of the dataset. This is unique identifier of a Flocker dataset	false

EdgeWorkload.spec.pod.spec.volumes[index].gcePersistentDisk

^{^{↩ Parent}}

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Name	Type	Description	Required
pdName	string	Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	true
fsType	string	Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine	false
partition	integer	The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk Format: int32	false
readOnly	boolean	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk	false

EdgeWorkload.spec.pod.spec.volumes[index].gitRepo

^{^{↩ Parent}}

GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Name	Type	Description	Required
repository	string	Repository URL	true
directory	string	Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.	false
revision	string	Commit hash for the specified revision.	false

EdgeWorkload.spec.pod.spec.volumes[index].glusterfs

^{^{↩ Parent}}

Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

Name	Type	Description	Required
endpoints	string	EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
path	string	Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	true
readOnly	boolean	ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod	false

EdgeWorkload.spec.pod.spec.volumes[index].hostPath

^{^{↩ Parent}}

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath — TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

Name	Type	Description	Required
path	string	Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	true
type	string	Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath	false

EdgeWorkload.spec.pod.spec.volumes[index].iscsi

^{^{↩ Parent}}

ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

Name	Type	Description	Required
iqn	string	Target iSCSI Qualified Name.	true
lun	integer	iSCSI Target Lun number. Format: int32	true
targetPortal	string	iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	true
chapAuthDiscovery	boolean	whether support iSCSI Discovery CHAP authentication	false
chapAuthSession	boolean	whether support iSCSI Session CHAP authentication	false
fsType	string	Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine	false
initiatorName	string	Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.	false
iscsiInterface	string	iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).	false
portals	[]string	iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).	false
readOnly	boolean	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.	false
secretRef	object	CHAP Secret for iSCSI target and initiator authentication	false

EdgeWorkload.spec.pod.spec.volumes[index].iscsi.secretRef

^{^{↩ Parent}}

CHAP Secret for iSCSI target and initiator authentication

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

EdgeWorkload.spec.pod.spec.volumes[index].nfs

^{^{↩ Parent}}

NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

Name	Type	Description	Required
path	string	Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
server	string	Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	true
readOnly	boolean	ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs	false

EdgeWorkload.spec.pod.spec.volumes[index].persistentVolumeClaim

^{^{↩ Parent}}

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name	Type	Description	Required
claimName	string	ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims	true
readOnly	boolean	Will force the ReadOnly setting in VolumeMounts. Default false.	false

EdgeWorkload.spec.pod.spec.volumes[index].photonPersistentDisk

^{^{↩ Parent}}

PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

Name	Type	Description	Required
pdID	string	ID that identifies Photon Controller persistent disk	true
fsType	string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false

EdgeWorkload.spec.pod.spec.volumes[index].portworxVolume

^{^{↩ Parent}}

PortworxVolume represents a portworx volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumeID	string	VolumeID uniquely identifies a Portworx volume	true
fsType	string	FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false

EdgeWorkload.spec.pod.spec.volumes[index].projected

^{^{↩ Parent}}

Items for all in one resources secrets, configmaps, and downward API

Name	Type	Description	Required
defaultMode	integer	Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
sources	[]object	list of volume projections	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index]

^{^{↩ Parent}}

Projection that may be projected along with other supported volume types

Name	Type	Description	Required
configMap	object	information about the configMap data to project	false
downwardAPI	object	information about the downwardAPI data to project	false
secret	object	information about the secret data to project	false
serviceAccountToken	object	information about the serviceAccountToken data to project	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index].configMap

^{^{↩ Parent}}

information about the configMap data to project

Name	Type	Description	Required
items	[]object	If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the ConfigMap or its keys must be defined	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index].configMap.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	The key to project.	true
path	string	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index].downwardAPI

^{^{↩ Parent}}

information about the downwardAPI data to project

Name	Type	Description	Required
items	[]object	Items is a list of DownwardAPIVolume file	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index].downwardAPI.items[index]

^{^{↩ Parent}}

DownwardAPIVolumeFile represents information to create the file containing the pod field

Name	Type	Description	Required
path	string	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'	true
fieldRef	object	Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.	false
mode	integer	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
resourceFieldRef	object	Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

^{^{↩ Parent}}

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

Name	Type	Description	Required
fieldPath	string	Path of the field to select in the specified API version.	true
apiVersion	string	Version of the schema the FieldPath is written in terms of, defaults to "v1".	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

^{^{↩ Parent}}

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

Name	Type	Description	Required
resource	string	Required: resource to select	true
containerName	string	Container name: required for volumes, optional for env vars	false
divisor	int or string	Specifies the output format of the exposed resources, defaults to "1"	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index].secret

^{^{↩ Parent}}

information about the secret data to project

Name	Type	Description	Required
items	[]object	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false
optional	boolean	Specify whether the Secret or its key must be defined	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	The key to project.	true
path	string	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

EdgeWorkload.spec.pod.spec.volumes[index].projected.sources[index].serviceAccountToken

^{^{↩ Parent}}

information about the serviceAccountToken data to project

Name	Type	Description	Required
path	string	Path is the path relative to the mount point of the file to project the token into.	true
audience	string	Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.	false
expirationSeconds	integer	ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. Format: int64	false

EdgeWorkload.spec.pod.spec.volumes[index].quobyte

^{^{↩ Parent}}

Quobyte represents a Quobyte mount on the host that shares a pod's lifetime

Name	Type	Description	Required
registry	string	Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes	true
volume	string	Volume is a string that references an already created Quobyte volume by name.	true
group	string	Group to map volume access to Default is no group	false
readOnly	boolean	ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.	false
tenant	string	Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin	false
user	string	User to map volume access to Defaults to serivceaccount user	false

EdgeWorkload.spec.pod.spec.volumes[index].rbd

^{^{↩ Parent}}

RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md

Name	Type	Description	Required
image	string	The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
monitors	[]string	A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	true
fsType	string	Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine	false
keyring	string	Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
pool	string	The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
readOnly	boolean	ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
secretRef	object	SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false
user	string	The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it	false

EdgeWorkload.spec.pod.spec.volumes[index].rbd.secretRef

^{^{↩ Parent}}

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

EdgeWorkload.spec.pod.spec.volumes[index].scaleIO

^{^{↩ Parent}}

ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
gateway	string	The host address of the ScaleIO API Gateway.	true
secretRef	object	SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.	true
system	string	The name of the storage system as configured in ScaleIO.	true
fsType	string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".	false
protectionDomain	string	The name of the ScaleIO Protection Domain for the configured storage.	false
readOnly	boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
sslEnabled	boolean	Flag to enable/disable SSL communication with Gateway, default false	false
storageMode	string	Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.	false
storagePool	string	The ScaleIO Storage Pool associated with the protection domain.	false
volumeName	string	The name of a volume already created in the ScaleIO system that is associated with this volume source.	false

EdgeWorkload.spec.pod.spec.volumes[index].scaleIO.secretRef

^{^{↩ Parent}}

SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

EdgeWorkload.spec.pod.spec.volumes[index].secret

^{^{↩ Parent}}

Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

Name	Type	Description	Required
defaultMode	integer	Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false
items	[]object	If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.	false
optional	boolean	Specify whether the Secret or its keys must be defined	false
secretName	string	Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret	false

EdgeWorkload.spec.pod.spec.volumes[index].secret.items[index]

^{^{↩ Parent}}

Maps a string key to a path within a volume.

Name	Type	Description	Required
key	string	The key to project.	true
path	string	The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.	true
mode	integer	Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. Format: int32	false

EdgeWorkload.spec.pod.spec.volumes[index].storageos

^{^{↩ Parent}}

StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

Name	Type	Description	Required
fsType	string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
readOnly	boolean	Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.	false
secretRef	object	SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.	false
volumeName	string	VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.	false
volumeNamespace	string	VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.	false

EdgeWorkload.spec.pod.spec.volumes[index].storageos.secretRef

^{^{↩ Parent}}

SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

Name	Type	Description	Required
name	string	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?	false

EdgeWorkload.spec.pod.spec.volumes[index].vsphereVolume

^{^{↩ Parent}}

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

Name	Type	Description	Required
volumePath	string	Path that identifies vSphere volume vmdk	true
fsType	string	Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.	false
storagePolicyID	string	Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.	false
storagePolicyName	string	Storage Policy Based Management (SPBM) profile name.	false

PlaybookExecution

^{^{↩ Parent}}

PlaybookExecution is the Schema for the playbookexecutions API

Name	Type	Description	Required
apiVersion	string	management.project-flotta.io/v1alpha1	true
kind	string	PlaybookExecution	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	PlaybookExecutionSpec defines the desired state of PlaybookExecution	false
status	object	PlaybookExecutionStatus defines the observed state of PlaybookExecution	false

PlaybookExecution.spec

^{^{↩ Parent}}

PlaybookExecutionSpec defines the desired state of PlaybookExecution

Name	Type	Description	Required
executionAttempt	integer	Minimum: 0	false
playbook	object		false

PlaybookExecution.spec.playbook

^{^{↩ Parent}}

Name	Type	Description	Required
content	string	Playbook content Format: byte	true
ansibleOptions	object	the ansible's playbook options for the playbook	false
executionStrategy	string	Execution strategy for the playbook	false
privilegeEscalationOptions	object	the ansible's playbook privilege escalation options for the playbook	false
requiredPrivilegeLevel	object	The required privelege level necessary to execute the playbook	false
timeoutSeconds	integer	The connection timeout on ansible-playbook Format: int64	false

PlaybookExecution.spec.playbook.ansibleOptions

^{^{↩ Parent}}

the ansible's playbook options for the playbook

Name	Type	Description	Required
check	boolean	don't make any changes; instead, try to predict some of the changes that may occur	false

PlaybookExecution.spec.playbook.privilegeEscalationOptions

^{^{↩ Parent}}

the ansible's playbook privilege escalation options for the playbook

Name	Type	Description	Required
become	boolean		false
becomeMethod	enum	Enum: sudo, su	false
becomeUser	string		false

PlaybookExecution.spec.playbook.requiredPrivilegeLevel

^{^{↩ Parent}}

The required privelege level necessary to execute the playbook

Name	Type	Description	Required
capAdd	[]integer	See https://man7.org/linux/man-pages/man7/capabilities.7.html	false
capDrop	[]integer		false

PlaybookExecution.status

^{^{↩ Parent}}

PlaybookExecutionStatus defines the observed state of PlaybookExecution

Name	Type	Description	Required
conditions	[]object		false

PlaybookExecution.status.conditions[index]

^{^{↩ Parent}}

Name	Type	Description	Required
status	string	Indicates whether that condition is applicable, with possible values "True", "False", or "Unknown" The absence of a condition should be interpreted the same as Unknown	true
type	string		true
lastTransitionTime	string	Format: date-time	false
message	string		false
reason	string		false

Intro

Getting started

Operations

For developers

Other versions

CRD reference

management.project-flotta.io/v1alpha1

EdgeConfig

EdgeConfig.spec

EdgeConfig.spec.edgePlaybook

EdgeConfig.spec.edgePlaybook.playbooks[index]

EdgeConfig.spec.edgePlaybook.playbooks[index].ansibleOptions

EdgeConfig.spec.edgePlaybook.playbooks[index].privilegeEscalationOptions

EdgeConfig.spec.edgePlaybook.playbooks[index].requiredPrivilegeLevel

EdgeConfig.status

EdgeConfig.status.edgePlaybookStatus

EdgeConfig.status.edgePlaybookStatus.conditions[index]

EdgeDevice

EdgeDevice.spec

EdgeDevice.spec.heartbeat

EdgeDevice.spec.heartbeat.hardwareProfile

EdgeDevice.spec.logCollection[key]

EdgeDevice.spec.logCollection[key].syslogConfig

EdgeDevice.spec.metrics

EdgeDevice.spec.metrics.receiverConfiguration

EdgeDevice.spec.metrics.retention

EdgeDevice.spec.metrics.system

EdgeDevice.spec.metrics.system.allowList

EdgeDevice.spec.osInformation

EdgeDevice.spec.storage

EdgeDevice.spec.storage.s3

EdgeDevice.status

EdgeDevice.status.hardware

EdgeDevice.status.hardware.disks[index]

EdgeDevice.status.hardware.disks[index].ioPerf

EdgeDevice.status.hardware.gpus[index]

EdgeDevice.status.hardware.interfaces[index]

EdgeDevice.status.hardware.boot

EdgeDevice.status.hardware.cpu

EdgeDevice.status.hardware.memory

EdgeDevice.status.hardware.systemVendor

EdgeDevice.status.upgradeInformation

EdgeDevice.status.workloads[index]

EdgeDeviceSet

EdgeDeviceSet.spec

EdgeDeviceSet.spec.heartbeat

EdgeDeviceSet.spec.heartbeat.hardwareProfile

EdgeDeviceSet.spec.logCollection[key]

EdgeDeviceSet.spec.logCollection[key].syslogConfig

EdgeDeviceSet.spec.metrics

EdgeDeviceSet.spec.metrics.receiverConfiguration

EdgeDeviceSet.spec.metrics.retention

EdgeDeviceSet.spec.metrics.system

EdgeDeviceSet.spec.metrics.system.allowList

EdgeDeviceSet.spec.osInformation

EdgeDeviceSet.spec.storage

EdgeDeviceSet.spec.storage.s3

EdgeDeviceSignedRequest

EdgeDeviceSignedRequest.spec

EdgeDeviceSignedRequest.spec.features

EdgeDeviceSignedRequest.spec.features.hardware

EdgeDeviceSignedRequest.spec.features.hardware.disks[index]

EdgeDeviceSignedRequest.spec.features.hardware.disks[index].ioPerf

EdgeDeviceSignedRequest.spec.features.hardware.gpus[index]

EdgeDeviceSignedRequest.spec.features.hardware.interfaces[index]

EdgeDeviceSignedRequest.spec.features.hardware.boot

EdgeDeviceSignedRequest.spec.features.hardware.cpu

EdgeDeviceSignedRequest.spec.features.hardware.memory

EdgeDeviceSignedRequest.spec.features.hardware.systemVendor

EdgeDeviceSignedRequest.status

EdgeDeviceSignedRequest.status.conditions[index]

EdgeWorkload

EdgeWorkload.spec

EdgeWorkload.spec.data

EdgeWorkload.spec.data.paths[index]

EdgeWorkload.spec.deviceSelector

EdgeWorkload.spec.deviceSelector.matchExpressions[index]

EdgeWorkload.spec.imageRegistries

EdgeWorkload.spec.imageRegistries.secretRef

EdgeWorkload.spec.metrics