From 8d14579c6a67d71ea7e03aa5f9c2574a336caf9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miko=C5=82aj=20=C5=9Awi=C4=85tek?= Date: Wed, 5 Feb 2025 21:36:11 +0100 Subject: [PATCH] Split CRD documentation into separate files The CRD API doc became unmanagably large with the addition of TargetAllocators, and can't even be rendered by Github's markdown viewer . Split it into separate files per CRD. --- Makefile | 9 +- docs/api.md | 68657 +------------------------- docs/api/README.md | 6 + docs/api/instrumentations.md | 7461 +++ docs/api/opampbridges.md | 7492 +++ docs/api/opentelemetrycollectors.md | 39263 +++++++++++++++ docs/api/targetallocators.md | 14478 ++++++ 7 files changed, 68708 insertions(+), 68658 deletions(-) create mode 100644 docs/api/README.md create mode 100644 docs/api/instrumentations.md create mode 100644 docs/api/opampbridges.md create mode 100644 docs/api/opentelemetrycollectors.md create mode 100644 docs/api/targetallocators.md diff --git a/Makefile b/Makefile index 1c1bb6daf8..af1f9ec26c 100644 --- a/Makefile +++ b/Makefile @@ -625,8 +625,13 @@ api-docs: crdoc kustomize cp -r config/crd/* $$TMP_MANIFEST_DIR; \ $(MAKE) CRD_OPTIONS=$(CRD_OPTIONS),maxDescLen=1200 MANIFEST_DIR=$$TMP_MANIFEST_DIR/bases manifests ;\ TMP_DIR=$$(mktemp -d) ; \ - $(KUSTOMIZE) build $$TMP_MANIFEST_DIR -o $$TMP_DIR/crd-output.yaml ;\ - $(CRDOC) --resources $$TMP_DIR/crd-output.yaml --output docs/api.md ;\ + $(KUSTOMIZE) build $$TMP_MANIFEST_DIR -o $$TMP_DIR ;\ + mkdir -p docs/api ;\ + for crdmanifest in $$TMP_DIR/*; do \ + filename="$$(basename -s .opentelemetry.io.yaml $$crdmanifest)" ;\ + filename="$${filename#apiextensions.k8s.io_v1_customresourcedefinition_}" ;\ + $(CRDOC) --resources $$crdmanifest --output docs/api/$$filename.md ;\ + done;\ } diff --git a/docs/api.md b/docs/api.md index 9092af0a2a..3e898546b2 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,68658 +1,3 @@ # API Reference -Packages: - -- [opentelemetry.io/v1alpha1](#opentelemetryiov1alpha1) -- [opentelemetry.io/v1beta1](#opentelemetryiov1beta1) - -# opentelemetry.io/v1alpha1 - -Resource Types: - -- [Instrumentation](#instrumentation) - -- [OpAMPBridge](#opampbridge) - -- [OpenTelemetryCollector](#opentelemetrycollector) - -- [TargetAllocator](#targetallocator) - - - - -## Instrumentation -[↩ Parent](#opentelemetryiov1alpha1 ) - - - - - - -Instrumentation is the spec for OpenTelemetry instrumentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringInstrumentationtrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject - InstrumentationSpec defines the desired state of OpenTelemetry SDK and instrumentation.
- 		false
statusobject - InstrumentationStatus defines status of the instrumentation.
- 		false
- - -### Instrumentation.spec -[↩ Parent](#instrumentation) - - - -InstrumentationSpec defines the desired state of OpenTelemetry SDK and instrumentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
apacheHttpdobject - ApacheHttpd defines configuration for Apache HTTPD auto-instrumentation.
- 		false
defaultsobject - Defaults defines default values for the instrumentation.
- 		false
dotnetobject - DotNet defines configuration for DotNet auto-instrumentation.
- 		false
env[]object - Env defines common env vars. There are four layers for env vars' definitions and -the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. -If the former var had been defined, then the other vars would be ignored.
- 		false
exporterobject - Exporter defines exporter configuration.
- 		false
goobject - Go defines configuration for Go auto-instrumentation. -When using Go auto-instrumentation you must provide a value for the OTEL_GO_AUTO_TARGET_EXE env var via the -Instrumentation env vars or via the instrumentation.opentelemetry.io/otel-go-auto-target-exe pod annotation. -Failure to set this value causes instrumentation injection to abort, leaving the original pod unchanged.
- 		false
javaobject - Java defines configuration for java auto-instrumentation.
- 		false
nginxobject - Nginx defines configuration for Nginx auto-instrumentation.
- 		false
nodejsobject - NodeJS defines configuration for nodejs auto-instrumentation.
- 		false
propagators[]enum - Propagators defines inter-process context propagation configuration. -Values in this list will be set in the OTEL_PROPAGATORS env var. -Enum=tracecontext;baggage;b3;b3multi;jaeger;xray;ottrace;none
- 		false
pythonobject - Python defines configuration for python auto-instrumentation.
- 		false
resourceobject - Resource defines the configuration for the resource attributes, as defined by the OpenTelemetry specification.
- 		false
samplerobject - Sampler defines sampling configuration.
- 		false
- - -### Instrumentation.spec.apacheHttpd -[↩ Parent](#instrumentationspec) - - - -ApacheHttpd defines configuration for Apache HTTPD auto-instrumentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
attrs[]object - Attrs defines Apache HTTPD agent specific attributes. The precedence is: -`agent default attributes` > `instrument spec attributes` . -Attributes are documented at https://github.com/open-telemetry/opentelemetry-cpp-contrib/tree/main/instrumentation/otel-webserver-module
- 		false
configPathstring - Location of Apache HTTPD server configuration. -Needed only if different from default "/usr/local/apache2/conf"
- 		false
env[]object - Env defines Apache HTTPD specific env vars. There are four layers for env vars' definitions and -the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. -If the former var had been defined, then the other vars would be ignored.
- 		false
imagestring - Image is a container image with Apache SDK and auto-instrumentation.
- 		false
resourceRequirementsobject - Resources describes the compute resource requirements.
- 		false
versionstring - Apache HTTPD server version. One of 2.4 or 2.2. Default is 2.4
- 		false
volumeClaimTemplateobject - VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit
- 		false
volumeLimitSizeint or string - VolumeSizeLimit defines size limit for volume used for auto-instrumentation. -The default size is 200Mi.
- 		false
- - -### Instrumentation.spec.apacheHttpd.attrs[index] -[↩ Parent](#instrumentationspecapachehttpd) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom -[↩ Parent](#instrumentationspecapachehttpdattrsindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecapachehttpdattrsindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecapachehttpdattrsindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecapachehttpdattrsindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecapachehttpdattrsindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.apacheHttpd.env[index] -[↩ Parent](#instrumentationspecapachehttpd) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.apacheHttpd.env[index].valueFrom -[↩ Parent](#instrumentationspecapachehttpdenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.apacheHttpd.env[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecapachehttpdenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.apacheHttpd.env[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecapachehttpdenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.apacheHttpd.env[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecapachehttpdenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.apacheHttpd.env[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecapachehttpdenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.apacheHttpd.resourceRequirements -[↩ Parent](#instrumentationspecapachehttpd) - - - -Resources describes the compute resource requirements. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.apacheHttpd.resourceRequirements.claims[index] -[↩ Parent](#instrumentationspecapachehttpdresourcerequirements) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### Instrumentation.spec.apacheHttpd.volumeClaimTemplate -[↩ Parent](#instrumentationspecapachehttpd) - - - -VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec -[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.dataSource -[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.resources -[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.selector -[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.metadata -[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### Instrumentation.spec.defaults -[↩ Parent](#instrumentationspec) - - - -Defaults defines default values for the instrumentation. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
useLabelsForResourceAttributesboolean - UseLabelsForResourceAttributes defines whether to use common labels for resource attributes: - - `app.kubernetes.io/name` becomes `service.name` - - `app.kubernetes.io/version` becomes `service.version` - - `app.kubernetes.io/part-of` becomes `service.namespace`
- 		false
- - -### Instrumentation.spec.dotnet -[↩ Parent](#instrumentationspec) - - - -DotNet defines configuration for DotNet auto-instrumentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
env[]object - Env defines DotNet specific env vars. There are four layers for env vars' definitions and -the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. -If the former var had been defined, then the other vars would be ignored.
- 		false
imagestring - Image is a container image with DotNet SDK and auto-instrumentation.
- 		false
resourceRequirementsobject - Resources describes the compute resource requirements.
- 		false
volumeClaimTemplateobject - VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit
- 		false
volumeLimitSizeint or string - VolumeSizeLimit defines size limit for volume used for auto-instrumentation. -The default size is 200Mi.
- 		false
- - -### Instrumentation.spec.dotnet.env[index] -[↩ Parent](#instrumentationspecdotnet) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.dotnet.env[index].valueFrom -[↩ Parent](#instrumentationspecdotnetenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.dotnet.env[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecdotnetenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.dotnet.env[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecdotnetenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.dotnet.env[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecdotnetenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.dotnet.env[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecdotnetenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.dotnet.resourceRequirements -[↩ Parent](#instrumentationspecdotnet) - - - -Resources describes the compute resource requirements. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.dotnet.resourceRequirements.claims[index] -[↩ Parent](#instrumentationspecdotnetresourcerequirements) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### Instrumentation.spec.dotnet.volumeClaimTemplate -[↩ Parent](#instrumentationspecdotnet) - - - -VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### Instrumentation.spec.dotnet.volumeClaimTemplate.spec -[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.dataSource -[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.resources -[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.selector -[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### Instrumentation.spec.dotnet.volumeClaimTemplate.metadata -[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### Instrumentation.spec.env[index] -[↩ Parent](#instrumentationspec) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.env[index].valueFrom -[↩ Parent](#instrumentationspecenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.env[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.env[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.env[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.env[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.exporter -[↩ Parent](#instrumentationspec) - - - -Exporter defines exporter configuration. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
endpointstring - Endpoint is address of the collector with OTLP endpoint. -If the endpoint defines https:// scheme TLS has to be specified.
- 		false
tlsobject - TLS defines certificates for TLS. -TLS needs to be enabled by specifying https:// scheme in the Endpoint.
- 		false
- - -### Instrumentation.spec.exporter.tls -[↩ Parent](#instrumentationspecexporter) - - - -TLS defines certificates for TLS. -TLS needs to be enabled by specifying https:// scheme in the Endpoint. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
ca_filestring - CA defines the key of certificate (e.g. ca.crt) in the configmap map, secret or absolute path to a certificate. -The absolute path can be used when certificate is already present on the workload filesystem e.g. -/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt
- 		false
cert_filestring - Cert defines the key (e.g. tls.crt) of the client certificate in the secret or absolute path to a certificate. -The absolute path can be used when certificate is already present on the workload filesystem.
- 		false
configMapNamestring - ConfigMapName defines configmap name with CA certificate. If it is not defined CA certificate will be -used from the secret defined in SecretName.
- 		false
key_filestring - Key defines a key (e.g. tls.key) of the private key in the secret or absolute path to a certificate. -The absolute path can be used when certificate is already present on the workload filesystem.
- 		false
secretNamestring - SecretName defines secret name that will be used to configure TLS on the exporter. -It is user responsibility to create the secret in the namespace of the workload. -The secret must contain client certificate (Cert) and private key (Key). -The CA certificate might be defined in the secret or in the config map.
- 		false
- - -### Instrumentation.spec.go -[↩ Parent](#instrumentationspec) - - - -Go defines configuration for Go auto-instrumentation. -When using Go auto-instrumentation you must provide a value for the OTEL_GO_AUTO_TARGET_EXE env var via the -Instrumentation env vars or via the instrumentation.opentelemetry.io/otel-go-auto-target-exe pod annotation. -Failure to set this value causes instrumentation injection to abort, leaving the original pod unchanged. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
env[]object - Env defines Go specific env vars. There are four layers for env vars' definitions and -the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. -If the former var had been defined, then the other vars would be ignored.
- 		false
imagestring - Image is a container image with Go SDK and auto-instrumentation.
- 		false
resourceRequirementsobject - Resources describes the compute resource requirements.
- 		false
volumeClaimTemplateobject - VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit
- 		false
volumeLimitSizeint or string - VolumeSizeLimit defines size limit for volume used for auto-instrumentation. -The default size is 200Mi.
- 		false
- - -### Instrumentation.spec.go.env[index] -[↩ Parent](#instrumentationspecgo) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.go.env[index].valueFrom -[↩ Parent](#instrumentationspecgoenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.go.env[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecgoenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.go.env[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecgoenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.go.env[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecgoenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.go.env[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecgoenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.go.resourceRequirements -[↩ Parent](#instrumentationspecgo) - - - -Resources describes the compute resource requirements. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.go.resourceRequirements.claims[index] -[↩ Parent](#instrumentationspecgoresourcerequirements) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### Instrumentation.spec.go.volumeClaimTemplate -[↩ Parent](#instrumentationspecgo) - - - -VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### Instrumentation.spec.go.volumeClaimTemplate.spec -[↩ Parent](#instrumentationspecgovolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### Instrumentation.spec.go.volumeClaimTemplate.spec.dataSource -[↩ Parent](#instrumentationspecgovolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### Instrumentation.spec.go.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#instrumentationspecgovolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### Instrumentation.spec.go.volumeClaimTemplate.spec.resources -[↩ Parent](#instrumentationspecgovolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.go.volumeClaimTemplate.spec.selector -[↩ Parent](#instrumentationspecgovolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### Instrumentation.spec.go.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#instrumentationspecgovolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### Instrumentation.spec.go.volumeClaimTemplate.metadata -[↩ Parent](#instrumentationspecgovolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### Instrumentation.spec.java -[↩ Parent](#instrumentationspec) - - - -Java defines configuration for java auto-instrumentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
env[]object - Env defines java specific env vars. There are four layers for env vars' definitions and -the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. -If the former var had been defined, then the other vars would be ignored.
- 		false
extensions[]object - Extensions defines java specific extensions. -All extensions are copied to a single directory; if a JAR with the same name exists, it will be overwritten.
- 		false
imagestring - Image is a container image with javaagent auto-instrumentation JAR.
- 		false
resourcesobject - Resources describes the compute resource requirements.
- 		false
volumeClaimTemplateobject - VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit
- 		false
volumeLimitSizeint or string - VolumeSizeLimit defines size limit for volume used for auto-instrumentation. -The default size is 200Mi.
- 		false
- - -### Instrumentation.spec.java.env[index] -[↩ Parent](#instrumentationspecjava) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.java.env[index].valueFrom -[↩ Parent](#instrumentationspecjavaenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.java.env[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecjavaenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.java.env[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecjavaenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.java.env[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecjavaenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.java.env[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecjavaenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.java.extensions[index] -[↩ Parent](#instrumentationspecjava) - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
dirstring - Dir is a directory with extensions auto-instrumentation JAR.
- 		true
imagestring - Image is a container image with extensions auto-instrumentation JAR.
- 		true
- - -### Instrumentation.spec.java.resources -[↩ Parent](#instrumentationspecjava) - - - -Resources describes the compute resource requirements. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.java.resources.claims[index] -[↩ Parent](#instrumentationspecjavaresources) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### Instrumentation.spec.java.volumeClaimTemplate -[↩ Parent](#instrumentationspecjava) - - - -VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### Instrumentation.spec.java.volumeClaimTemplate.spec -[↩ Parent](#instrumentationspecjavavolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### Instrumentation.spec.java.volumeClaimTemplate.spec.dataSource -[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### Instrumentation.spec.java.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### Instrumentation.spec.java.volumeClaimTemplate.spec.resources -[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.java.volumeClaimTemplate.spec.selector -[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### Instrumentation.spec.java.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### Instrumentation.spec.java.volumeClaimTemplate.metadata -[↩ Parent](#instrumentationspecjavavolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### Instrumentation.spec.nginx -[↩ Parent](#instrumentationspec) - - - -Nginx defines configuration for Nginx auto-instrumentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
attrs[]object - Attrs defines Nginx agent specific attributes. The precedence order is: -`agent default attributes` > `instrument spec attributes` . -Attributes are documented at https://github.com/open-telemetry/opentelemetry-cpp-contrib/tree/main/instrumentation/otel-webserver-module
- 		false
configFilestring - Location of Nginx configuration file. -Needed only if different from default "/etx/nginx/nginx.conf"
- 		false
env[]object - Env defines Nginx specific env vars. There are four layers for env vars' definitions and -the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. -If the former var had been defined, then the other vars would be ignored.
- 		false
imagestring - Image is a container image with Nginx SDK and auto-instrumentation.
- 		false
resourceRequirementsobject - Resources describes the compute resource requirements.
- 		false
volumeClaimTemplateobject - VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit
- 		false
volumeLimitSizeint or string - VolumeSizeLimit defines size limit for volume used for auto-instrumentation. -The default size is 200Mi.
- 		false
- - -### Instrumentation.spec.nginx.attrs[index] -[↩ Parent](#instrumentationspecnginx) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.nginx.attrs[index].valueFrom -[↩ Parent](#instrumentationspecnginxattrsindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.nginx.attrs[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecnginxattrsindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.nginx.attrs[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecnginxattrsindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.nginx.attrs[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecnginxattrsindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.nginx.attrs[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecnginxattrsindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.nginx.env[index] -[↩ Parent](#instrumentationspecnginx) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.nginx.env[index].valueFrom -[↩ Parent](#instrumentationspecnginxenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.nginx.env[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecnginxenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.nginx.env[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecnginxenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.nginx.env[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecnginxenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.nginx.env[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecnginxenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.nginx.resourceRequirements -[↩ Parent](#instrumentationspecnginx) - - - -Resources describes the compute resource requirements. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.nginx.resourceRequirements.claims[index] -[↩ Parent](#instrumentationspecnginxresourcerequirements) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### Instrumentation.spec.nginx.volumeClaimTemplate -[↩ Parent](#instrumentationspecnginx) - - - -VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### Instrumentation.spec.nginx.volumeClaimTemplate.spec -[↩ Parent](#instrumentationspecnginxvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### Instrumentation.spec.nginx.volumeClaimTemplate.spec.dataSource -[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### Instrumentation.spec.nginx.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### Instrumentation.spec.nginx.volumeClaimTemplate.spec.resources -[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.nginx.volumeClaimTemplate.spec.selector -[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### Instrumentation.spec.nginx.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### Instrumentation.spec.nginx.volumeClaimTemplate.metadata -[↩ Parent](#instrumentationspecnginxvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### Instrumentation.spec.nodejs -[↩ Parent](#instrumentationspec) - - - -NodeJS defines configuration for nodejs auto-instrumentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
env[]object - Env defines nodejs specific env vars. There are four layers for env vars' definitions and -the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. -If the former var had been defined, then the other vars would be ignored.
- 		false
imagestring - Image is a container image with NodeJS SDK and auto-instrumentation.
- 		false
resourceRequirementsobject - Resources describes the compute resource requirements.
- 		false
volumeClaimTemplateobject - VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit
- 		false
volumeLimitSizeint or string - VolumeSizeLimit defines size limit for volume used for auto-instrumentation. -The default size is 200Mi.
- 		false
- - -### Instrumentation.spec.nodejs.env[index] -[↩ Parent](#instrumentationspecnodejs) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.nodejs.env[index].valueFrom -[↩ Parent](#instrumentationspecnodejsenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.nodejs.env[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecnodejsenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.nodejs.env[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecnodejsenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.nodejs.env[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecnodejsenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.nodejs.env[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecnodejsenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.nodejs.resourceRequirements -[↩ Parent](#instrumentationspecnodejs) - - - -Resources describes the compute resource requirements. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.nodejs.resourceRequirements.claims[index] -[↩ Parent](#instrumentationspecnodejsresourcerequirements) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### Instrumentation.spec.nodejs.volumeClaimTemplate -[↩ Parent](#instrumentationspecnodejs) - - - -VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### Instrumentation.spec.nodejs.volumeClaimTemplate.spec -[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.dataSource -[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.resources -[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.selector -[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### Instrumentation.spec.nodejs.volumeClaimTemplate.metadata -[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### Instrumentation.spec.python -[↩ Parent](#instrumentationspec) - - - -Python defines configuration for python auto-instrumentation. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
env[]object - Env defines python specific env vars. There are four layers for env vars' definitions and -the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. -If the former var had been defined, then the other vars would be ignored.
- 		false
imagestring - Image is a container image with Python SDK and auto-instrumentation.
- 		false
resourceRequirementsobject - Resources describes the compute resource requirements.
- 		false
volumeClaimTemplateobject - VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit
- 		false
volumeLimitSizeint or string - VolumeSizeLimit defines size limit for volume used for auto-instrumentation. -The default size is 200Mi.
- 		false
- - -### Instrumentation.spec.python.env[index] -[↩ Parent](#instrumentationspecpython) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### Instrumentation.spec.python.env[index].valueFrom -[↩ Parent](#instrumentationspecpythonenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### Instrumentation.spec.python.env[index].valueFrom.configMapKeyRef -[↩ Parent](#instrumentationspecpythonenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### Instrumentation.spec.python.env[index].valueFrom.fieldRef -[↩ Parent](#instrumentationspecpythonenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### Instrumentation.spec.python.env[index].valueFrom.resourceFieldRef -[↩ Parent](#instrumentationspecpythonenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### Instrumentation.spec.python.env[index].valueFrom.secretKeyRef -[↩ Parent](#instrumentationspecpythonenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### Instrumentation.spec.python.resourceRequirements -[↩ Parent](#instrumentationspecpython) - - - -Resources describes the compute resource requirements. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.python.resourceRequirements.claims[index] -[↩ Parent](#instrumentationspecpythonresourcerequirements) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### Instrumentation.spec.python.volumeClaimTemplate -[↩ Parent](#instrumentationspecpython) - - - -VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. -If omitted, an emptyDir is used with size limit VolumeSizeLimit - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### Instrumentation.spec.python.volumeClaimTemplate.spec -[↩ Parent](#instrumentationspecpythonvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### Instrumentation.spec.python.volumeClaimTemplate.spec.dataSource -[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### Instrumentation.spec.python.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### Instrumentation.spec.python.volumeClaimTemplate.spec.resources -[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### Instrumentation.spec.python.volumeClaimTemplate.spec.selector -[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### Instrumentation.spec.python.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### Instrumentation.spec.python.volumeClaimTemplate.metadata -[↩ Parent](#instrumentationspecpythonvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### Instrumentation.spec.resource -[↩ Parent](#instrumentationspec) - - - -Resource defines the configuration for the resource attributes, as defined by the OpenTelemetry specification. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
addK8sUIDAttributesboolean - AddK8sUIDAttributes defines whether K8s UID attributes should be collected (e.g. k8s.deployment.uid).
- 		false
resourceAttributesmap[string]string - Attributes defines attributes that are added to the resource. -For example environment: dev
- 		false
- - -### Instrumentation.spec.sampler -[↩ Parent](#instrumentationspec) - - - -Sampler defines sampling configuration. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
argumentstring - Argument defines sampler argument. -The value depends on the sampler type. -For instance for parentbased_traceidratio sampler type it is a number in range [0..1] e.g. 0.25. -The value will be set in the OTEL_TRACES_SAMPLER_ARG env var.
- 		false
typeenum - Type defines sampler type. -The value will be set in the OTEL_TRACES_SAMPLER env var. -The value can be for instance parentbased_always_on, parentbased_always_off, parentbased_traceidratio...
-
- Enum: always_on, always_off, traceidratio, parentbased_always_on, parentbased_always_off, parentbased_traceidratio, jaeger_remote, xray
- 		false
- -## OpAMPBridge -[↩ Parent](#opentelemetryiov1alpha1 ) - - - - - - -OpAMPBridge is the Schema for the opampbridges API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringOpAMPBridgetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject - OpAMPBridgeSpec defines the desired state of OpAMPBridge.
- 		false
statusobject - OpAMPBridgeStatus defines the observed state of OpAMPBridge.
- 		false
- - -### OpAMPBridge.spec -[↩ Parent](#opampbridge) - - - -OpAMPBridgeSpec defines the desired state of OpAMPBridge. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
capabilitiesmap[string]boolean - Capabilities supported by the OpAMP Bridge
- 		true
endpointstring - OpAMP backend Server endpoint
- 		true
affinityobject - If specified, indicates the pod's scheduling constraints
- 		false
componentsAllowedmap[string][]string - ComponentsAllowed is a list of allowed OpenTelemetry components for each pipeline type (receiver, processor, etc.)
- 		false
env[]object - ENV vars to set on the OpAMPBridge Pods.
- 		false
envFrom[]object - List of sources to populate environment variables on the OpAMPBridge Pods.
- 		false
headersmap[string]string - Headers is an optional map of headers to use when connecting to the OpAMP Server, -typically used to set access tokens or other authorization headers.
- 		false
hostNetworkboolean - HostNetwork indicates if the pod should run in the host networking namespace.
- 		false
imagestring - Image indicates the container image to use for the OpAMPBridge.
- 		false
imagePullPolicystring - ImagePullPolicy indicates the pull policy to be used for retrieving the container image (Always, Never, IfNotPresent)
- 		false
ipFamilies[]string - IPFamily represents the IP Family (IPv4 or IPv6). This type is used -to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
- 		false
ipFamilyPolicystring - IPFamilyPolicy represents the dual-stack-ness requested or required by a Service
- 		false
nodeSelectormap[string]string - NodeSelector to schedule OpAMPBridge pods.
- 		false
podAnnotationsmap[string]string - PodAnnotations is the set of annotations that will be attached to -OpAMPBridge pods.
- 		false
podDnsConfigobject - PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
- 		false
podSecurityContextobject - PodSecurityContext will be set as the pod security context.
- 		false
ports[]object - Ports allows a set of ports to be exposed by the underlying v1.Service.
- 		false
priorityClassNamestring - If specified, indicates the pod's priority. -If not specified, the pod priority will be default or zero if there is no -default.
- 		false
replicasinteger - Replicas is the number of pod instances for the OpAMPBridge.
-
- Format: int32
- Maximum: 1
- 		false
resourcesobject - Resources to set on the OpAMPBridge pods.
- 		false
securityContextobject - SecurityContext will be set as the container security context.
- 		false
serviceAccountstring - ServiceAccount indicates the name of an existing service account to use with this instance. When set, -the operator will not automatically create a ServiceAccount for the OpAMPBridge.
- 		false
tolerations[]object - Toleration to schedule OpAMPBridge pods.
- 		false
topologySpreadConstraints[]object - TopologySpreadConstraints embedded kubernetes pod configuration option, -controls how pods are spread across your cluster among failure-domains -such as regions, zones, nodes, and other user-defined topology domains -https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
- 		false
upgradeStrategyenum - UpgradeStrategy represents how the operator will handle upgrades to the CR when a newer version of the operator is deployed
-
- Enum: automatic, none
- 		false
volumeMounts[]object - VolumeMounts represents the mount points to use in the underlying OpAMPBridge deployment(s)
- 		false
volumes[]object - Volumes represents which volumes to use in the underlying OpAMPBridge deployment(s).
- 		false
- - -### OpAMPBridge.spec.affinity -[↩ Parent](#opampbridgespec) - - - -If specified, indicates the pod's scheduling constraints - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeAffinityobject - Describes node affinity scheduling rules for the pod.
- 		false
podAffinityobject - Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- 		false
podAntiAffinityobject - Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- 		false
- - -### OpAMPBridge.spec.affinity.nodeAffinity -[↩ Parent](#opampbridgespecaffinity) - - - -Describes node affinity scheduling rules for the pod. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject - 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
- - -### OpAMPBridge.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opampbridgespecaffinitynodeaffinity) - - - -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). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
preferenceobject - A node selector term, associated with the corresponding weight.
- 		true
weightinteger - Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
-
- Format: int32
- 		true
- - -### OpAMPBridge.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference -[↩ Parent](#opampbridgespecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -A node selector term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpAMPBridge.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] -[↩ Parent](#opampbridgespecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution -[↩ Parent](#opampbridgespecaffinitynodeaffinity) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeSelectorTerms[]object - Required. A list of node selector terms. The terms are ORed.
- 		true
- - -### OpAMPBridge.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] -[↩ Parent](#opampbridgespecaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpAMPBridge.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] -[↩ Parent](#opampbridgespecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.podAffinity -[↩ Parent](#opampbridgespecaffinity) - - - -Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opampbridgespecaffinitypodaffinity) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opampbridgespecaffinitypodaffinity) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opampbridgespecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opampbridgespecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity -[↩ Parent](#opampbridgespecaffinity) - - - -Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opampbridgespecaffinitypodantiaffinity) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opampbridgespecaffinitypodantiaffinity) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opampbridgespecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opampbridgespecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opampbridgespecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.env[index] -[↩ Parent](#opampbridgespec) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### OpAMPBridge.spec.env[index].valueFrom -[↩ Parent](#opampbridgespecenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### OpAMPBridge.spec.env[index].valueFrom.configMapKeyRef -[↩ Parent](#opampbridgespecenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### OpAMPBridge.spec.env[index].valueFrom.fieldRef -[↩ Parent](#opampbridgespecenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpAMPBridge.spec.env[index].valueFrom.resourceFieldRef -[↩ Parent](#opampbridgespecenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpAMPBridge.spec.env[index].valueFrom.secretKeyRef -[↩ Parent](#opampbridgespecenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### OpAMPBridge.spec.envFrom[index] -[↩ Parent](#opampbridgespec) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### OpAMPBridge.spec.envFrom[index].configMapRef -[↩ Parent](#opampbridgespecenvfromindex) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### OpAMPBridge.spec.envFrom[index].secretRef -[↩ Parent](#opampbridgespecenvfromindex) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### OpAMPBridge.spec.podDnsConfig -[↩ Parent](#opampbridgespec) - - - -PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpAMPBridge.spec.podDnsConfig.options[index] -[↩ Parent](#opampbridgespecpoddnsconfig) - - - -PodDNSConfigOption defines DNS resolver options of a pod. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Required.
- 		false
valuestring -
- 		false
- - -### OpAMPBridge.spec.podSecurityContext -[↩ Parent](#opampbridgespec) - - - -PodSecurityContext will be set as the pod security context. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
appArmorProfileobject - appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows.
- 		false
fsGroupinteger - 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
fsGroupChangePolicystring - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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 and fsGroup (if specified). If -the SupplementalGroupsPolicy feature is enabled, the -supplementalGroupsPolicy field determines whether these are in addition -to or instead of any group memberships defined in the container image. -If unspecified, no additional groups are added, though group memberships -defined in the container image may still be used, depending on the -supplementalGroupsPolicy field. -Note that this field cannot be set when spec.os.name is windows.
- 		false
supplementalGroupsPolicystring - Defines how supplemental groups of the first container processes are calculated. -Valid values are "Merge" and "Strict". If not specified, "Merge" is used. -(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled -and the container runtime must implement support for this feature. -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
windowsOptionsobject - 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
- - -### OpAMPBridge.spec.podSecurityContext.appArmorProfile -[↩ Parent](#opampbridgespecpodsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpAMPBridge.spec.podSecurityContext.seLinuxOptions -[↩ Parent](#opampbridgespecpodsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpAMPBridge.spec.podSecurityContext.seccompProfile -[↩ Parent](#opampbridgespecpodsecuritycontext) - - - -The seccomp options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpAMPBridge.spec.podSecurityContext.sysctls[index] -[↩ Parent](#opampbridgespecpodsecuritycontext) - - - -Sysctl defines a kernel parameter to be set - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of a property to set
- 		true
valuestring - Value of a property to set
- 		true
- - -### OpAMPBridge.spec.podSecurityContext.windowsOptions -[↩ Parent](#opampbridgespecpodsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpAMPBridge.spec.ports[index] -[↩ Parent](#opampbridgespec) - - - -ServicePort contains information on service's port. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - The port that will be exposed by this service.
-
- Format: int32
- 		true
appProtocolstring - The application protocol for this port. -This is used as a hint for implementations to offer richer behavior for protocols that they understand. -This field follows standard Kubernetes label syntax. -Valid values are either: - -* Un-prefixed protocol names - reserved for IANA standard service names (as per -RFC-6335 and https://www.iana.org/assignments/service-names). - -* Kubernetes-defined prefixed names: - * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- - * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 - * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 - -* Other protocols should use implementation-defined prefixed names such as -mycompany.com/my-custom-protocol.
- 		false
namestring - The name of this port within the service. This must be a DNS_LABEL. -All ports within a ServiceSpec must have unique names. When considering -the endpoints for a Service, this must match the 'name' field in the -EndpointPort. -Optional if only one ServicePort is defined on this service.
- 		false
nodePortinteger - The port on each node on which this service is exposed when type is -NodePort or LoadBalancer. Usually assigned by the system. If a value is -specified, in-range, and not in use it will be used, otherwise the -operation will fail. If not specified, a port will be allocated if this -Service requires one. If this field is specified when creating a -Service which does not need it, creation will fail. This field will be -wiped when updating a Service to no longer need it (e.g. changing type -from NodePort to ClusterIP). -More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
-
- Format: int32
- 		false
protocolstring - The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". -Default is TCP.
-
- Default: TCP
- 		false
targetPortint or string - Number or name of the port to access on the pods targeted by the service. -Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. -If this is a string, it will be looked up as a named port in the -target Pod's container ports. If this is not specified, the value -of the 'port' field is used (an identity map). -This field is ignored for services with clusterIP=None, and should be -omitted or set equal to the 'port' field. -More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
- 		false
- - -### OpAMPBridge.spec.resources -[↩ Parent](#opampbridgespec) - - - -Resources to set on the OpAMPBridge pods. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpAMPBridge.spec.resources.claims[index] -[↩ Parent](#opampbridgespecresources) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### OpAMPBridge.spec.securityContext -[↩ Parent](#opampbridgespec) - - - -SecurityContext will be set as the container security context. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### OpAMPBridge.spec.securityContext.appArmorProfile -[↩ Parent](#opampbridgespecsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpAMPBridge.spec.securityContext.capabilities -[↩ Parent](#opampbridgespecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### OpAMPBridge.spec.securityContext.seLinuxOptions -[↩ Parent](#opampbridgespecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpAMPBridge.spec.securityContext.seccompProfile -[↩ Parent](#opampbridgespecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpAMPBridge.spec.securityContext.windowsOptions -[↩ Parent](#opampbridgespecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpAMPBridge.spec.tolerations[index] -[↩ Parent](#opampbridgespec) - - - -The pod this Toleration is attached to tolerates any taint that matches -the triple using the matching operator . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
effectstring - Effect indicates the taint effect to match. Empty means match all taint effects. -When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- 		false
keystring - 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
operatorstring - 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
tolerationSecondsinteger - 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
valuestring - 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
- - -### OpAMPBridge.spec.topologySpreadConstraints[index] -[↩ Parent](#opampbridgespec) - - - -TopologySpreadConstraint specifies how to spread matching pods among the given topology. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSkewinteger - 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. -The global minimum is the minimum number of matching pods in an eligible domain -or zero if the number of eligible domains is less than MinDomains. -For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same -labelSelector spread as 2/2/1: -In this case, the global minimum is 1. -| zone1 | zone2 | zone3 | -| P P | P P | P | -- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; -scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring - 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 as a "bucket", and try to put balanced number -of pods into each bucket. -We define a domain as a particular instance of a topology. -Also, we define an eligible domain as a domain whose nodes meet the requirements of -nodeAffinityPolicy and nodeTaintsPolicy. -e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. -And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. -It's a required field.
- 		true
whenUnsatisfiablestring - 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
labelSelectorobject - 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
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select the pods over which -spreading will be calculated. The keys are used to lookup values from the -incoming pod labels, those key-value labels are ANDed with labelSelector -to select the group of existing pods over which spreading will be calculated -for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. -MatchLabelKeys cannot be set when LabelSelector isn't set. -Keys that don't exist in the incoming pod labels will -be ignored. A null or empty list means only match against labelSelector. - -This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- 		false
minDomainsinteger - MinDomains indicates a minimum number of eligible domains. -When the number of eligible domains with matching topology keys is less than minDomains, -Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. -And when the number of eligible domains with matching topology keys equals or greater than minDomains, -this value has no effect on scheduling. -As a result, when the number of eligible domains is less than minDomains, -scheduler won't schedule more than maxSkew Pods to those domains. -If value is nil, the constraint behaves as if MinDomains is equal to 1. -Valid values are integers greater than 0. -When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - -For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same -labelSelector spread as 2/2/2: -| zone1 | zone2 | zone3 | -| P P | P P | P P | -The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. -In this situation, new pod with the same labelSelector cannot be scheduled, -because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, -it will violate MaxSkew.
-
- Format: int32
- 		false
nodeAffinityPolicystring - NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector -when calculating pod topology spread skew. Options are: -- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. -- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. - -If this value is nil, the behavior is equivalent to the Honor policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
nodeTaintsPolicystring - NodeTaintsPolicy indicates how we will treat node taints when calculating -pod topology spread skew. Options are: -- Honor: nodes without taints, along with tainted nodes for which the incoming pod -has a toleration, are included. -- Ignore: node taints are ignored. All nodes are included. - -If this value is nil, the behavior is equivalent to the Ignore policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
- - -### OpAMPBridge.spec.topologySpreadConstraints[index].labelSelector -[↩ Parent](#opampbridgespectopologyspreadconstraintsindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index] -[↩ Parent](#opampbridgespectopologyspreadconstraintsindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.volumeMounts[index] -[↩ Parent](#opampbridgespec) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### OpAMPBridge.spec.volumes[index] -[↩ Parent](#opampbridgespec) - - - -Volume represents a named volume in a pod that may be accessed by any container in the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - name of the volume. -Must be a DNS_LABEL and unique within the pod. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- 		true
awsElasticBlockStoreobject - 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
azureDiskobject - azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- 		false
azureFileobject - azureFile represents an Azure File Service mount on the host and bind mount to the pod.
- 		false
cephfsobject - cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
- 		false
cinderobject - cinder represents a cinder volume attached and mounted on kubelets host machine. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- 		false
configMapobject - configMap represents a configMap that should populate this volume
- 		false
csiobject - csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
- 		false
downwardAPIobject - downwardAPI represents downward API about the pod that should populate this volume
- 		false
emptyDirobject - emptyDir represents a temporary directory that shares a pod's lifetime. -More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 		false
ephemeralobject - 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
fcobject - fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
- 		false
flexVolumeobject - flexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin.
- 		false
flockerobject - flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
- 		false
gcePersistentDiskobject - 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
gitRepoobject - 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
glusterfsobject - 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
hostPathobject - 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
- 		false
imageobject - image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. -The volume is resolved at pod startup depending on which PullPolicy value is provided: - -- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. - -The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. -A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
- 		false
iscsiobject - 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
nfsobject - 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
persistentVolumeClaimobject - persistentVolumeClaimVolumeSource represents a reference to a -PersistentVolumeClaim in the same namespace. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 		false
photonPersistentDiskobject - photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
- 		false
portworxVolumeobject - portworxVolume represents a portworx volume attached and mounted on kubelets host machine
- 		false
projectedobject - projected items for all in one resources secrets, configmaps, and downward API
- 		false
quobyteobject - quobyte represents a Quobyte mount on the host that shares a pod's lifetime
- 		false
rbdobject - 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
scaleIOobject - scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
- 		false
secretobject - secret represents a secret that should populate this volume. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- 		false
storageosobject - storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
- 		false
vsphereVolumeobject - vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
- 		false
- - -### OpAMPBridge.spec.volumes[index].awsElasticBlockStore -[↩ Parent](#opampbridgespecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). -More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 		true
fsTypestring - fsType is the 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
- 		false
partitioninteger - partition is 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
readOnlyboolean - readOnly value true will force the readOnly setting in VolumeMounts. -More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 		false
- - -### OpAMPBridge.spec.volumes[index].azureDisk -[↩ Parent](#opampbridgespecvolumesindex) - - - -azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
diskNamestring - diskName is the Name of the data disk in the blob storage
- 		true
diskURIstring - diskURI is the URI of data disk in the blob storage
- 		true
cachingModestring - cachingMode is the Host Caching mode: None, Read Only, Read Write.
- 		false
fsTypestring - fsType is 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.
-
- Default: ext4
- 		false
kindstring - kind expected values are 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
readOnlyboolean - readOnly Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
-
- Default: false
- 		false
- - -### OpAMPBridge.spec.volumes[index].azureFile -[↩ Parent](#opampbridgespecvolumesindex) - - - -azureFile represents an Azure File Service mount on the host and bind mount to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secretNamestring - secretName is the name of secret that contains Azure Storage Account Name and Key
- 		true
shareNamestring - shareName is the azure share Name
- 		true
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
- - -### OpAMPBridge.spec.volumes[index].cephfs -[↩ Parent](#opampbridgespecvolumesindex) - - - -cephFS represents a Ceph FS mount on the host that shares a pod's lifetime - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
monitors[]string - monitors is Required: Monitors is a collection of Ceph monitors -More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- 		true
pathstring - path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- 		false
readOnlyboolean - readOnly is 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
secretFilestring - secretFile is 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
secretRefobject - secretRef is 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
userstring - user is 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
- - -### OpAMPBridge.spec.volumes[index].cephfs.secretRef -[↩ Parent](#opampbridgespecvolumesindexcephfs) - - - -secretRef is 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 - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpAMPBridge.spec.volumes[index].cinder -[↩ Parent](#opampbridgespecvolumesindex) - - - -cinder represents a cinder volume attached and mounted on kubelets host machine. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID used to identify the volume in cinder. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- 		true
fsTypestring - fsType is the 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
readOnlyboolean - readOnly 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
secretRefobject - secretRef is optional: points to a secret object containing parameters used to connect -to OpenStack.
- 		false
- - -### OpAMPBridge.spec.volumes[index].cinder.secretRef -[↩ Parent](#opampbridgespecvolumesindexcinder) - - - -secretRef is optional: points to a secret object containing parameters used to connect -to OpenStack. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpAMPBridge.spec.volumes[index].configMap -[↩ Parent](#opampbridgespecvolumesindex) - - - -configMap represents a configMap that should populate this volume - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode is 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 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional specify whether the ConfigMap or its keys must be defined
- 		false
- - -### OpAMPBridge.spec.volumes[index].configMap.items[index] -[↩ Parent](#opampbridgespecvolumesindexconfigmap) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpAMPBridge.spec.volumes[index].csi -[↩ Parent](#opampbridgespecvolumesindex) - - - -csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
driverstring - 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
fsTypestring - fsType 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
nodePublishSecretRefobject - 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
readOnlyboolean - readOnly specifies a read-only configuration for the volume. -Defaults to false (read/write).
- 		false
volumeAttributesmap[string]string - volumeAttributes stores driver-specific properties that are passed to the CSI -driver. Consult your driver's documentation for supported values.
- 		false
- - -### OpAMPBridge.spec.volumes[index].csi.nodePublishSecretRef -[↩ Parent](#opampbridgespecvolumesindexcsi) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpAMPBridge.spec.volumes[index].downwardAPI -[↩ Parent](#opampbridgespecvolumesindex) - - - -downwardAPI represents downward API about the pod that should populate this volume - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - 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
- - -### OpAMPBridge.spec.volumes[index].downwardAPI.items[index] -[↩ Parent](#opampbridgespecvolumesindexdownwardapi) - - - -DownwardAPIVolumeFile represents information to create the file containing the pod field - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
fieldRefobject - Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- 		false
modeinteger - 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
resourceFieldRefobject - Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- 		false
- - -### OpAMPBridge.spec.volumes[index].downwardAPI.items[index].fieldRef -[↩ Parent](#opampbridgespecvolumesindexdownwardapiitemsindex) - - - -Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpAMPBridge.spec.volumes[index].downwardAPI.items[index].resourceFieldRef -[↩ Parent](#opampbridgespecvolumesindexdownwardapiitemsindex) - - - -Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpAMPBridge.spec.volumes[index].emptyDir -[↩ Parent](#opampbridgespecvolumesindex) - - - -emptyDir represents a temporary directory that shares a pod's lifetime. -More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mediumstring - medium represents 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
sizeLimitint or string - sizeLimit is the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 		false
- - -### OpAMPBridge.spec.volumes[index].ephemeral -[↩ Parent](#opampbridgespecvolumesindex) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeClaimTemplateobject - 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 `-` where -`` 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
- - -### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate -[↩ Parent](#opampbridgespecvolumesindexephemeral) - - - -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 `-` where -`` 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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec -[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource -[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources -[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector -[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata -[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### OpAMPBridge.spec.volumes[index].fc -[↩ Parent](#opampbridgespecvolumesindex) - - - -fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fsTypestring - fsType is the 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
luninteger - lun is Optional: FC target lun number
-
- Format: int32
- 		false
readOnlyboolean - readOnly is Optional: Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
targetWWNs[]string - targetWWNs is Optional: FC target worldwide names (WWNs)
- 		false
wwids[]string - wwids Optional: FC volume world wide identifiers (wwids) -Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- 		false
- - -### OpAMPBridge.spec.volumes[index].flexVolume -[↩ Parent](#opampbridgespecvolumesindex) - - - -flexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
driverstring - driver is the name of the driver to use for this volume.
- 		true
fsTypestring - fsType is the 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
optionsmap[string]string - options is Optional: this field holds extra command options if any.
- 		false
readOnlyboolean - readOnly is Optional: defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
secretRefobject - secretRef is 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
- - -### OpAMPBridge.spec.volumes[index].flexVolume.secretRef -[↩ Parent](#opampbridgespecvolumesindexflexvolume) - - - -secretRef is 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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpAMPBridge.spec.volumes[index].flocker -[↩ Parent](#opampbridgespecvolumesindex) - - - -flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
datasetNamestring - datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker -should be considered as deprecated
- 		false
datasetUUIDstring - datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
- 		false
- - -### OpAMPBridge.spec.volumes[index].gcePersistentDisk -[↩ Parent](#opampbridgespecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pdNamestring - pdName is 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
fsTypestring - fsType is 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
- 		false
partitioninteger - partition is 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
readOnlyboolean - readOnly here will force the ReadOnly setting in VolumeMounts. -Defaults to false. -More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- 		false
- - -### OpAMPBridge.spec.volumes[index].gitRepo -[↩ Parent](#opampbridgespecvolumesindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
repositorystring - repository is the URL
- 		true
directorystring - directory is the 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
revisionstring - revision is the commit hash for the specified revision.
- 		false
- - -### OpAMPBridge.spec.volumes[index].glusterfs -[↩ Parent](#opampbridgespecvolumesindex) - - - -glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. -More info: https://examples.k8s.io/volumes/glusterfs/README.md - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
endpointsstring - endpoints is the endpoint name that details Glusterfs topology. -More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- 		true
pathstring - path is the Glusterfs volume path. -More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- 		true
readOnlyboolean - 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
- - -### OpAMPBridge.spec.volumes[index].hostPath -[↩ Parent](#opampbridgespecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
typestring - type for HostPath Volume -Defaults to "" -More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- 		false
- - -### OpAMPBridge.spec.volumes[index].image -[↩ Parent](#opampbridgespecvolumesindex) - - - -image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. -The volume is resolved at pod startup depending on which PullPolicy value is provided: - -- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. - -The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. -A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pullPolicystring - Policy for pulling OCI objects. Possible values are: -Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. -Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- 		false
referencestring - Required: Image or artifact reference to be used. -Behaves in the same way as pod.spec.containers[*].image. -Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. -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
- - -### OpAMPBridge.spec.volumes[index].iscsi -[↩ Parent](#opampbridgespecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
iqnstring - iqn is the target iSCSI Qualified Name.
- 		true
luninteger - lun represents iSCSI Target Lun number.
-
- Format: int32
- 		true
targetPortalstring - targetPortal is 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
chapAuthDiscoveryboolean - chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
- 		false
chapAuthSessionboolean - chapAuthSession defines whether support iSCSI Session CHAP authentication
- 		false
fsTypestring - fsType is the 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
- 		false
initiatorNamestring - initiatorName is the custom iSCSI Initiator Name. -If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface -: will be created for the connection.
- 		false
iscsiInterfacestring - iscsiInterface is the interface Name that uses an iSCSI transport. -Defaults to 'default' (tcp).
-
- Default: default
- 		false
portals[]string - portals is the 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
readOnlyboolean - readOnly here will force the ReadOnly setting in VolumeMounts. -Defaults to false.
- 		false
secretRefobject - secretRef is the CHAP Secret for iSCSI target and initiator authentication
- 		false
- - -### OpAMPBridge.spec.volumes[index].iscsi.secretRef -[↩ Parent](#opampbridgespecvolumesindexiscsi) - - - -secretRef is the CHAP Secret for iSCSI target and initiator authentication - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpAMPBridge.spec.volumes[index].nfs -[↩ Parent](#opampbridgespecvolumesindex) - - - -nfs represents an NFS mount on the host that shares a pod's lifetime -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - path that is exported by the NFS server. -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 		true
serverstring - server is the hostname or IP address of the NFS server. -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 		true
readOnlyboolean - 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
- - -### OpAMPBridge.spec.volumes[index].persistentVolumeClaim -[↩ Parent](#opampbridgespecvolumesindex) - - - -persistentVolumeClaimVolumeSource represents a reference to a -PersistentVolumeClaim in the same namespace. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claimNamestring - 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
readOnlyboolean - readOnly Will force the ReadOnly setting in VolumeMounts. -Default false.
- 		false
- - -### OpAMPBridge.spec.volumes[index].photonPersistentDisk -[↩ Parent](#opampbridgespecvolumesindex) - - - -photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pdIDstring - pdID is the ID that identifies Photon Controller persistent disk
- 		true
fsTypestring - fsType is the 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
- - -### OpAMPBridge.spec.volumes[index].portworxVolume -[↩ Parent](#opampbridgespecvolumesindex) - - - -portworxVolume represents a portworx volume attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID uniquely identifies a Portworx volume
- 		true
fsTypestring - 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
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected -[↩ Parent](#opampbridgespecvolumesindex) - - - -projected items for all in one resources secrets, configmaps, and downward API - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode are the 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 - sources is the list of volume projections. Each entry in this list -handles one source.
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index] -[↩ Parent](#opampbridgespecvolumesindexprojected) - - - -Projection that may be projected along with other supported volume types. -Exactly one of these fields must be set. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
clusterTrustBundleobject - ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field -of ClusterTrustBundle objects in an auto-updating file. - -Alpha, gated by the ClusterTrustBundleProjection feature gate. - -ClusterTrustBundle objects can either be selected by name, or by the -combination of signer name and a label selector. - -Kubelet performs aggressive normalization of the PEM contents written -into the pod filesystem. Esoteric PEM features such as inter-block -comments and block headers are stripped. Certificates are deduplicated. -The ordering of certificates within the file is arbitrary, and Kubelet -may change the order over time.
- 		false
configMapobject - configMap information about the configMap data to project
- 		false
downwardAPIobject - downwardAPI information about the downwardAPI data to project
- 		false
secretobject - secret information about the secret data to project
- 		false
serviceAccountTokenobject - serviceAccountToken is information about the serviceAccountToken data to project
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].clusterTrustBundle -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) - - - -ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field -of ClusterTrustBundle objects in an auto-updating file. - -Alpha, gated by the ClusterTrustBundleProjection feature gate. - -ClusterTrustBundle objects can either be selected by name, or by the -combination of signer name and a label selector. - -Kubelet performs aggressive normalization of the PEM contents written -into the pod filesystem. Esoteric PEM features such as inter-block -comments and block headers are stripped. Certificates are deduplicated. -The ordering of certificates within the file is arbitrary, and Kubelet -may change the order over time. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - Relative path from the volume root to write the bundle.
- 		true
labelSelectorobject - Select all ClusterTrustBundles that match this label selector. Only has -effect if signerName is set. Mutually-exclusive with name. If unset, -interpreted as "match nothing". If set but empty, interpreted as "match -everything".
- 		false
namestring - Select a single ClusterTrustBundle by object name. Mutually-exclusive -with signerName and labelSelector.
- 		false
optionalboolean - If true, don't block pod startup if the referenced ClusterTrustBundle(s) -aren't available. If using name, then the named ClusterTrustBundle is -allowed not to exist. If using signerName, then the combination of -signerName and labelSelector is allowed to match zero -ClusterTrustBundles.
- 		false
signerNamestring - Select all ClusterTrustBundles that match this signer name. -Mutually-exclusive with name. The contents of all selected -ClusterTrustBundles will be unified and deduplicated.
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexclustertrustbundle) - - - -Select all ClusterTrustBundles that match this label selector. Only has -effect if signerName is set. Mutually-exclusive with name. If unset, -interpreted as "match nothing". If set but empty, interpreted as "match -everything". - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index] -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexclustertrustbundlelabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].configMap -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) - - - -configMap information about the configMap data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - items 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional specify whether the ConfigMap or its keys must be defined
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].configMap.items[index] -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexconfigmap) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].downwardAPI -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) - - - -downwardAPI information about the downwardAPI data to project - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - Items is a list of DownwardAPIVolume file
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].downwardAPI.items[index] -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexdownwardapi) - - - -DownwardAPIVolumeFile represents information to create the file containing the pod field - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
fieldRefobject - Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- 		false
modeinteger - 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
resourceFieldRefobject - Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexdownwardapiitemsindex) - - - -Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexdownwardapiitemsindex) - - - -Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].secret -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) - - - -secret information about the secret data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - items 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional field specify whether the Secret or its key must be defined
- 		false
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].secret.items[index] -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexsecret) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpAMPBridge.spec.volumes[index].projected.sources[index].serviceAccountToken -[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) - - - -serviceAccountToken is information about the serviceAccountToken data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - path is the path relative to the mount point of the file to project the -token into.
- 		true
audiencestring - 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
expirationSecondsinteger - 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
- - -### OpAMPBridge.spec.volumes[index].quobyte -[↩ Parent](#opampbridgespecvolumesindex) - - - -quobyte represents a Quobyte mount on the host that shares a pod's lifetime - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
registrystring - 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
volumestring - volume is a string that references an already created Quobyte volume by name.
- 		true
groupstring - group to map volume access to -Default is no group
- 		false
readOnlyboolean - readOnly here will force the Quobyte volume to be mounted with read-only permissions. -Defaults to false.
- 		false
tenantstring - tenant owning the given Quobyte volume in the Backend -Used with dynamically provisioned Quobyte volumes, value is set by the plugin
- 		false
userstring - user to map volume access to -Defaults to serivceaccount user
- 		false
- - -### OpAMPBridge.spec.volumes[index].rbd -[↩ Parent](#opampbridgespecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
imagestring - image is the rados image name. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 		true
monitors[]string - monitors is a collection of Ceph monitors. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 		true
fsTypestring - fsType is the 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
- 		false
keyringstring - 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
-
- Default: /etc/ceph/keyring
- 		false
poolstring - pool is the rados pool name. -Default is rbd. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
-
- Default: rbd
- 		false
readOnlyboolean - 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
secretRefobject - 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
userstring - user is the rados user name. -Default is admin. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
-
- Default: admin
- 		false
- - -### OpAMPBridge.spec.volumes[index].rbd.secretRef -[↩ Parent](#opampbridgespecvolumesindexrbd) - - - -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 - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpAMPBridge.spec.volumes[index].scaleIO -[↩ Parent](#opampbridgespecvolumesindex) - - - -scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gatewaystring - gateway is the host address of the ScaleIO API Gateway.
- 		true
secretRefobject - secretRef references to the secret for ScaleIO user and other -sensitive information. If this is not provided, Login operation will fail.
- 		true
systemstring - system is the name of the storage system as configured in ScaleIO.
- 		true
fsTypestring - fsType is the filesystem type to mount. -Must be a filesystem type supported by the host operating system. -Ex. "ext4", "xfs", "ntfs". -Default is "xfs".
-
- Default: xfs
- 		false
protectionDomainstring - protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
- 		false
readOnlyboolean - readOnly Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
sslEnabledboolean - sslEnabled Flag enable/disable SSL communication with Gateway, default false
- 		false
storageModestring - storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. -Default is ThinProvisioned.
-
- Default: ThinProvisioned
- 		false
storagePoolstring - storagePool is the ScaleIO Storage Pool associated with the protection domain.
- 		false
volumeNamestring - volumeName is the name of a volume already created in the ScaleIO system -that is associated with this volume source.
- 		false
- - -### OpAMPBridge.spec.volumes[index].scaleIO.secretRef -[↩ Parent](#opampbridgespecvolumesindexscaleio) - - - -secretRef references to the secret for ScaleIO user and other -sensitive information. If this is not provided, Login operation will fail. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpAMPBridge.spec.volumes[index].secret -[↩ Parent](#opampbridgespecvolumesindex) - - - -secret represents a secret that should populate this volume. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode is 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 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
optionalboolean - optional field specify whether the Secret or its keys must be defined
- 		false
secretNamestring - secretName is the name of the secret in the pod's namespace to use. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- 		false
- - -### OpAMPBridge.spec.volumes[index].secret.items[index] -[↩ Parent](#opampbridgespecvolumesindexsecret) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpAMPBridge.spec.volumes[index].storageos -[↩ Parent](#opampbridgespecvolumesindex) - - - -storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fsTypestring - fsType is the 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
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
secretRefobject - secretRef specifies the secret to use for obtaining the StorageOS API -credentials. If not specified, default values will be attempted.
- 		false
volumeNamestring - volumeName is the human-readable name of the StorageOS volume. Volume -names are only unique within a namespace.
- 		false
volumeNamespacestring - 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
- - -### OpAMPBridge.spec.volumes[index].storageos.secretRef -[↩ Parent](#opampbridgespecvolumesindexstorageos) - - - -secretRef specifies the secret to use for obtaining the StorageOS API -credentials. If not specified, default values will be attempted. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpAMPBridge.spec.volumes[index].vsphereVolume -[↩ Parent](#opampbridgespecvolumesindex) - - - -vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumePathstring - volumePath is the path that identifies vSphere volume vmdk
- 		true
fsTypestring - fsType is 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
storagePolicyIDstring - storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- 		false
storagePolicyNamestring - storagePolicyName is the storage Policy Based Management (SPBM) profile name.
- 		false
- - -### OpAMPBridge.status -[↩ Parent](#opampbridge) - - - -OpAMPBridgeStatus defines the observed state of OpAMPBridge. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
versionstring - Version of the managed OpAMP Bridge (operand)
- 		false
- -## OpenTelemetryCollector -[↩ Parent](#opentelemetryiov1alpha1 ) - - - - - - -OpenTelemetryCollector is the Schema for the opentelemetrycollectors API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringOpenTelemetryCollectortrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject - OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.
- 		false
statusobject - OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector.
- 		false
- - -### OpenTelemetryCollector.spec -[↩ Parent](#opentelemetrycollector) - - - -OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configstring - Config is the raw YAML to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.
- 		true
managementStateenum - ManagementState defines if the CR should be managed by the operator or not. -Default is managed.
-
- Enum: managed, unmanaged
- Default: managed
- 		true
additionalContainers[]object - AdditionalContainers allows injecting additional containers into the Collector's pod definition. -These sidecar containers can be used for authentication proxies, log shipping sidecars, agents for shipping -metrics to their cloud, or in general sidecars that do not support automatic injection. This option only -applies to Deployment, DaemonSet, and StatefulSet deployment modes of the collector. It does not apply to the sidecar -deployment mode. More info about sidecars: -https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/ - -Container names managed by the operator: -* `otc-container` - -Overriding containers managed by the operator is outside the scope of what the maintainers will support and by -doing so, you wil accept the risk of it breaking things.
- 		false
affinityobject - If specified, indicates the pod's scheduling constraints
- 		false
argsmap[string]string - Args is the set of arguments to pass to the OpenTelemetry Collector binary
- 		false
autoscalerobject - Autoscaler specifies the pod autoscaling configuration to use -for the OpenTelemetryCollector workload.
- 		false
configmaps[]object - ConfigMaps is a list of ConfigMaps in the same namespace as the OpenTelemetryCollector -object, which shall be mounted into the Collector Pods. -Each ConfigMap will be added to the Collector's Deployments as a volume named `configmap-`.
- 		false
deploymentUpdateStrategyobject - UpdateStrategy represents the strategy the operator will take replacing existing Deployment pods with new pods -https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/#DeploymentSpec -This is only applicable to Deployment mode.
- 		false
env[]object - ENV vars to set on the OpenTelemetry Collector's Pods. These can then in certain cases be -consumed in the config file for the Collector.
- 		false
envFrom[]object - List of sources to populate environment variables on the OpenTelemetry Collector's Pods. -These can then in certain cases be consumed in the config file for the Collector.
- 		false
hostNetworkboolean - HostNetwork indicates if the pod should run in the host networking namespace.
- 		false
imagestring - Image indicates the container image to use for the OpenTelemetry Collector.
- 		false
imagePullPolicystring - ImagePullPolicy indicates the pull policy to be used for retrieving the container image (Always, Never, IfNotPresent)
- 		false
ingressobject - Ingress is used to specify how OpenTelemetry Collector is exposed. This -functionality is only available if one of the valid modes is set. -Valid modes are: deployment, daemonset and statefulset.
- 		false
initContainers[]object - InitContainers allows injecting initContainers to the Collector's pod definition. -These init containers can be used to fetch secrets for injection into the -configuration from external sources, run added checks, etc. Any errors during the execution of -an initContainer will lead to a restart of the Pod. More info: -https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
- 		false
lifecycleobject - Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- 		false
livenessProbeobject - Liveness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. -It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline.
- 		false
maxReplicasinteger - MaxReplicas sets an upper bound to the autoscaling feature. If MaxReplicas is set autoscaling is enabled. -Deprecated: use "OpenTelemetryCollector.Spec.Autoscaler.MaxReplicas" instead.
-
- Format: int32
- 		false
minReplicasinteger - MinReplicas sets a lower bound to the autoscaling feature. Set this if you are using autoscaling. It must be at least 1 -Deprecated: use "OpenTelemetryCollector.Spec.Autoscaler.MinReplicas" instead.
-
- Format: int32
- 		false
modeenum - Mode represents how the collector should be deployed (deployment, daemonset, statefulset or sidecar)
-
- Enum: daemonset, deployment, sidecar, statefulset
- 		false
nodeSelectormap[string]string - NodeSelector to schedule OpenTelemetry Collector pods. -This is only relevant to daemonset, statefulset, and deployment mode
- 		false
observabilityobject - ObservabilitySpec defines how telemetry data gets handled.
- 		false
podAnnotationsmap[string]string - PodAnnotations is the set of annotations that will be attached to -Collector and Target Allocator pods.
- 		false
podDisruptionBudgetobject - PodDisruptionBudget specifies the pod disruption budget configuration to use -for the OpenTelemetryCollector workload.
- 		false
podSecurityContextobject - PodSecurityContext configures the pod security context for the -opentelemetry-collector pod, when running as a deployment, daemonset, -or statefulset. - -In sidecar mode, the opentelemetry-operator will ignore this setting.
- 		false
ports[]object - Ports allows a set of ports to be exposed by the underlying v1.Service. By default, the operator -will attempt to infer the required ports by parsing the .Spec.Config property but this property can be -used to open additional ports that can't be inferred by the operator, like for custom receivers.
- 		false
priorityClassNamestring - If specified, indicates the pod's priority. -If not specified, the pod priority will be default or zero if there is no -default.
- 		false
replicasinteger - Replicas is the number of pod instances for the underlying OpenTelemetry Collector. Set this if your are not using autoscaling
-
- Format: int32
- 		false
resourcesobject - Resources to set on the OpenTelemetry Collector pods.
- 		false
securityContextobject - SecurityContext configures the container security context for -the opentelemetry-collector container. - -In deployment, daemonset, or statefulset mode, this controls -the security context settings for the primary application -container. - -In sidecar mode, this controls the security context for the -injected sidecar container.
- 		false
serviceAccountstring - ServiceAccount indicates the name of an existing service account to use with this instance. When set, -the operator will not automatically create a ServiceAccount for the collector.
- 		false
shareProcessNamespaceboolean - ShareProcessNamespace indicates if the pod's containers should share process namespace.
- 		false
targetAllocatorobject - TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not.
- 		false
terminationGracePeriodSecondsinteger - Duration in seconds the pod needs to terminate gracefully upon probe failure.
-
- Format: int64
- 		false
tolerations[]object - Toleration to schedule OpenTelemetry Collector pods. -This is only relevant to daemonset, statefulset, and deployment mode
- 		false
topologySpreadConstraints[]object - TopologySpreadConstraints embedded kubernetes pod configuration option, -controls how pods are spread across your cluster among failure-domains -such as regions, zones, nodes, and other user-defined topology domains -https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ -This is only relevant to statefulset, and deployment mode
- 		false
updateStrategyobject - UpdateStrategy represents the strategy the operator will take replacing existing DaemonSet pods with new pods -https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/daemon-set-v1/#DaemonSetSpec -This is only applicable to Daemonset mode.
- 		false
upgradeStrategyenum - UpgradeStrategy represents how the operator will handle upgrades to the CR when a newer version of the operator is deployed
-
- Enum: automatic, none
- 		false
volumeClaimTemplates[]object - VolumeClaimTemplates will provide stable storage using PersistentVolumes. Only available when the mode=statefulset.
- 		false
volumeMounts[]object - VolumeMounts represents the mount points to use in the underlying collector deployment(s)
- 		false
volumes[]object - Volumes represents which volumes to use in the underlying collector deployment(s).
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -A single application container that you want to run within a pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - 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 container 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 container 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
imagestring - Container 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
imagePullPolicystring - 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
lifecycleobject - Actions that the management system should take in response to container lifecycle events. -Cannot be updated.
- 		false
livenessProbeobject - 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. 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. -Modifying this array with strategic merge patch may corrupt the data. -For more information See https://github.com/kubernetes/kubernetes/issues/108255. -Cannot be updated.
- 		false
readinessProbeobject - 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
resizePolicy[]object - Resources resize policy for the container.
- 		false
resourcesobject - Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
restartPolicystring - RestartPolicy defines the restart behavior of individual containers in a pod. -This field may only be set for init containers, and the only allowed value is "Always". -For non-init containers or when this field is not specified, -the restart behavior is defined by the Pod's restart policy and the container type. -Setting the RestartPolicy as "Always" for the init container will have the following effect: -this init container will be continually restarted on -exit until all regular containers have terminated. Once all regular -containers have completed, all init containers with restartPolicy "Always" -will be shut down. This lifecycle differs from normal init containers and -is often referred to as a "sidecar" container. Although this init -container still starts in the init container sequence, it does not wait -for the container to complete before proceeding to the next init -container. Instead, the next init container starts immediately after this -init container is started, or after any startupProbe has successfully -completed.
- 		false
securityContextobject - 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
startupProbeobject - 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
stdinboolean - 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
stdinOnceboolean - 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
terminationMessagePathstring - 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
terminationMessagePolicystring - 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
ttyboolean - 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
workingDirstring - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.configMapKeyRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.fieldRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.secretKeyRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index].configMapRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvfromindex) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index].secretRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvfromindex) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -Actions that the management system should take in response to container lifecycle events. -Cannot be updated. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
postStartobject - 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
preStopobject - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststarthttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.sleep -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestophttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.sleep -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.grpc -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].ports[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -ContainerPort represents a network port in a single container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
containerPortinteger - Number of port to expose on the pod's IP address. -This must be a valid port number, 0 < x < 65536.
-
- Format: int32
- 		true
hostIPstring - What host IP to bind the external port to.
- 		false
hostPortinteger - 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
namestring - 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
protocolstring - Protocol for port. Must be UDP, TCP, or SCTP. -Defaults to "TCP".
-
- Default: TCP
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.grpc -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].resizePolicy[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -ContainerResizePolicy represents resource resize policy for the container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourceNamestring - Name of the resource to which this resource resize policy applies. -Supported values: cpu, memory.
- 		true
restartPolicystring - Restart policy to apply when specified resource is resized. -If not specified, it defaults to NotRequired.
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].resources -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].resources.claims[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexresources) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -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/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.capabilities -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.grpc -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].volumeDevices[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -volumeDevice describes a mapping of a raw block device within a container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
devicePathstring - devicePath is the path inside of the container that the device will be mapped to.
- 		true
namestring - name must match the name of a persistentVolumeClaim in the pod
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].volumeMounts[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### OpenTelemetryCollector.spec.affinity -[↩ Parent](#opentelemetrycollectorspec) - - - -If specified, indicates the pod's scheduling constraints - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeAffinityobject - Describes node affinity scheduling rules for the pod.
- 		false
podAffinityobject - Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- 		false
podAntiAffinityobject - Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- 		false
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity -[↩ Parent](#opentelemetrycollectorspecaffinity) - - - -Describes node affinity scheduling rules for the pod. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject - 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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinity) - - - -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). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
preferenceobject - A node selector term, associated with the corresponding weight.
- 		true
weightinteger - Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -A node selector term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinity) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeSelectorTerms[]object - Required. A list of node selector terms. The terms are ORed.
- 		true
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity -[↩ Parent](#opentelemetrycollectorspecaffinity) - - - -Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinity) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinity) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity -[↩ Parent](#opentelemetrycollectorspecaffinity) - - - -Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinity) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinity) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.autoscaler -[↩ Parent](#opentelemetrycollectorspec) - - - -Autoscaler specifies the pod autoscaling configuration to use -for the OpenTelemetryCollector workload. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
behaviorobject - HorizontalPodAutoscalerBehavior configures the scaling behavior of the target -in both Up and Down directions (scaleUp and scaleDown fields respectively).
- 		false
maxReplicasinteger - MaxReplicas sets an upper bound to the autoscaling feature. If MaxReplicas is set autoscaling is enabled.
-
- Format: int32
- 		false
metrics[]object - Metrics is meant to provide a customizable way to configure HPA metrics. -currently the only supported custom metrics is type=Pod. -Use TargetCPUUtilization or TargetMemoryUtilization instead if scaling on these common resource metrics.
- 		false
minReplicasinteger - MinReplicas sets a lower bound to the autoscaling feature. Set this if your are using autoscaling. It must be at least 1
-
- Format: int32
- 		false
targetCPUUtilizationinteger - TargetCPUUtilization sets the target average CPU used across all replicas. -If average CPU exceeds this value, the HPA will scale up. Defaults to 90 percent.
-
- Format: int32
- 		false
targetMemoryUtilizationinteger - TargetMemoryUtilization sets the target average memory utilization across all replicas
-
- Format: int32
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.behavior -[↩ Parent](#opentelemetrycollectorspecautoscaler) - - - -HorizontalPodAutoscalerBehavior configures the scaling behavior of the target -in both Up and Down directions (scaleUp and scaleDown fields respectively). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
scaleDownobject - scaleDown is scaling policy for scaling Down. -If not set, the default value is to allow to scale down to minReplicas pods, with a -300 second stabilization window (i.e., the highest recommendation for -the last 300sec is used).
- 		false
scaleUpobject - scaleUp is scaling policy for scaling Up. -If not set, the default value is the higher of: - * increase no more than 4 pods per 60 seconds - * double the number of pods per 60 seconds -No stabilization is used.
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.behavior.scaleDown -[↩ Parent](#opentelemetrycollectorspecautoscalerbehavior) - - - -scaleDown is scaling policy for scaling Down. -If not set, the default value is to allow to scale down to minReplicas pods, with a -300 second stabilization window (i.e., the highest recommendation for -the last 300sec is used). - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
policies[]object - policies is a list of potential scaling polices which can be used during scaling. -At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- 		false
selectPolicystring - selectPolicy is used to specify which policy should be used. -If not set, the default value Max is used.
- 		false
stabilizationWindowSecondsinteger - stabilizationWindowSeconds is the number of seconds for which past recommendations should be -considered while scaling up or scaling down. -StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). -If not set, use the default values: -- For scale up: 0 (i.e. no stabilization is done). -- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
-
- Format: int32
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.behavior.scaleDown.policies[index] -[↩ Parent](#opentelemetrycollectorspecautoscalerbehaviorscaledown) - - - -HPAScalingPolicy is a single policy which must hold true for a specified past interval. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
periodSecondsinteger - periodSeconds specifies the window of time for which the policy should hold true. -PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
-
- Format: int32
- 		true
typestring - type is used to specify the scaling policy.
- 		true
valueinteger - value contains the amount of change which is permitted by the policy. -It must be greater than zero
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.autoscaler.behavior.scaleUp -[↩ Parent](#opentelemetrycollectorspecautoscalerbehavior) - - - -scaleUp is scaling policy for scaling Up. -If not set, the default value is the higher of: - * increase no more than 4 pods per 60 seconds - * double the number of pods per 60 seconds -No stabilization is used. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
policies[]object - policies is a list of potential scaling polices which can be used during scaling. -At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- 		false
selectPolicystring - selectPolicy is used to specify which policy should be used. -If not set, the default value Max is used.
- 		false
stabilizationWindowSecondsinteger - stabilizationWindowSeconds is the number of seconds for which past recommendations should be -considered while scaling up or scaling down. -StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). -If not set, use the default values: -- For scale up: 0 (i.e. no stabilization is done). -- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
-
- Format: int32
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.behavior.scaleUp.policies[index] -[↩ Parent](#opentelemetrycollectorspecautoscalerbehaviorscaleup) - - - -HPAScalingPolicy is a single policy which must hold true for a specified past interval. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
periodSecondsinteger - periodSeconds specifies the window of time for which the policy should hold true. -PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
-
- Format: int32
- 		true
typestring - type is used to specify the scaling policy.
- 		true
valueinteger - value contains the amount of change which is permitted by the policy. -It must be greater than zero
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index] -[↩ Parent](#opentelemetrycollectorspecautoscaler) - - - -MetricSpec defines a subset of metrics to be defined for the HPA's metric array -more metric type can be supported as needed. -See https://pkg.go.dev/k8s.io/api/autoscaling/v2#MetricSpec for reference. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - MetricSourceType indicates the type of metric.
- 		true
podsobject - PodsMetricSource indicates how to scale on a metric describing each pod in -the current scale target (for example, transactions-processed-per-second). -The values will be averaged together before being compared to the target -value.
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindex) - - - -PodsMetricSource indicates how to scale on a metric describing each pod in -the current scale target (for example, transactions-processed-per-second). -The values will be averaged together before being compared to the target -value. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
metricobject - metric identifies the target metric by name and selector
- 		true
targetobject - target specifies the target value for the given metric
- 		true
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpods) - - - -metric identifies the target metric by name and selector - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - name is the name of the given metric
- 		true
selectorobject - selector is the string-encoded form of a standard kubernetes label selector for the given metric -When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. -When unset, just the metricName will be used to gather metrics.
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric.selector -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpodsmetric) - - - -selector is the string-encoded form of a standard kubernetes label selector for the given metric -When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. -When unset, just the metricName will be used to gather metrics. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric.selector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpodsmetricselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.target -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpods) - - - -target specifies the target value for the given metric - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type represents whether the metric type is Utilization, Value, or AverageValue
- 		true
averageUtilizationinteger - averageUtilization is the target value of the average of the -resource metric across all relevant pods, represented as a percentage of -the requested value of the resource for the pods. -Currently only valid for Resource metric source type
-
- Format: int32
- 		false
averageValueint or string - averageValue is the target value of the average of the -metric across all relevant pods (as a quantity)
- 		false
valueint or string - value is the target value of the metric (as a quantity).
- 		false
- - -### OpenTelemetryCollector.spec.configmaps[index] -[↩ Parent](#opentelemetrycollectorspec) - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountpathstring -
- 		true
namestring - Configmap defines name and path where the configMaps should be mounted.
- 		true
- - -### OpenTelemetryCollector.spec.deploymentUpdateStrategy -[↩ Parent](#opentelemetrycollectorspec) - - - -UpdateStrategy represents the strategy the operator will take replacing existing Deployment pods with new pods -https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/#DeploymentSpec -This is only applicable to Deployment mode. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
rollingUpdateobject - Rolling update config params. Present only if DeploymentStrategyType = -RollingUpdate.
- 		false
typestring - Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
- 		false
- - -### OpenTelemetryCollector.spec.deploymentUpdateStrategy.rollingUpdate -[↩ Parent](#opentelemetrycollectorspecdeploymentupdatestrategy) - - - -Rolling update config params. Present only if DeploymentStrategyType = -RollingUpdate. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSurgeint or string - The maximum number of pods that can be scheduled above the desired number of -pods. -Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). -This can not be 0 if MaxUnavailable is 0. -Absolute number is calculated from percentage by rounding up. -Defaults to 25%. -Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when -the rolling update starts, such that the total number of old and new pods do not exceed -130% of desired pods. Once old pods have been killed, -new ReplicaSet can be scaled up further, ensuring that total number of pods running -at any time during the update is at most 130% of desired pods.
- 		false
maxUnavailableint or string - The maximum number of pods that can be unavailable during the update. -Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). -Absolute number is calculated from percentage by rounding down. -This can not be 0 if MaxSurge is 0. -Defaults to 25%. -Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods -immediately when the rolling update starts. Once new pods are ready, old ReplicaSet -can be scaled down further, followed by scaling up the new ReplicaSet, ensuring -that the total number of pods available at all times during the update is at -least 70% of desired pods.
- 		false
- - -### OpenTelemetryCollector.spec.env[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom -[↩ Parent](#opentelemetrycollectorspecenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom.configMapKeyRef -[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom.fieldRef -[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom.resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom.secretKeyRef -[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.envFrom[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### OpenTelemetryCollector.spec.envFrom[index].configMapRef -[↩ Parent](#opentelemetrycollectorspecenvfromindex) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### OpenTelemetryCollector.spec.envFrom[index].secretRef -[↩ Parent](#opentelemetrycollectorspecenvfromindex) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### OpenTelemetryCollector.spec.ingress -[↩ Parent](#opentelemetrycollectorspec) - - - -Ingress is used to specify how OpenTelemetry Collector is exposed. This -functionality is only available if one of the valid modes is set. -Valid modes are: deployment, daemonset and statefulset. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string - Annotations to add to ingress. -e.g. 'cert-manager.io/cluster-issuer: "letsencrypt"'
- 		false
hostnamestring - Hostname by which the ingress proxy can be reached.
- 		false
ingressClassNamestring - IngressClassName is the name of an IngressClass cluster resource. Ingress -controller implementations use this field to know whether they should be -serving this Ingress resource.
- 		false
routeobject - Route is an OpenShift specific section that is only considered when -type "route" is used.
- 		false
ruleTypeenum - RuleType defines how Ingress exposes collector receivers. -IngressRuleTypePath ("path") exposes each receiver port on a unique path on single domain defined in Hostname. -IngressRuleTypeSubdomain ("subdomain") exposes each receiver port on a unique subdomain of Hostname. -Default is IngressRuleTypePath ("path").
-
- Enum: path, subdomain
- 		false
tls[]object - TLS configuration.
- 		false
typeenum - Type default value is: "" -Supported types are: ingress, route
-
- Enum: ingress, route
- 		false
- - -### OpenTelemetryCollector.spec.ingress.route -[↩ Parent](#opentelemetrycollectorspecingress) - - - -Route is an OpenShift specific section that is only considered when -type "route" is used. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
terminationenum - Termination indicates termination type. By default "edge" is used.
-
- Enum: insecure, edge, passthrough, reencrypt
- 		false
- - -### OpenTelemetryCollector.spec.ingress.tls[index] -[↩ Parent](#opentelemetrycollectorspecingress) - - - -IngressTLS describes the transport layer security associated with an ingress. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
hosts[]string - hosts is a list of hosts included in the TLS certificate. The values in -this list must match the name/s used in the tlsSecret. Defaults to the -wildcard host setting for the loadbalancer controller fulfilling this -Ingress, if left unspecified.
- 		false
secretNamestring - secretName is the name of the secret used to terminate TLS traffic on -port 443. Field is left optional to allow TLS routing based on SNI -hostname alone. If the SNI host in a listener conflicts with the "Host" -header field used by an IngressRule, the SNI host is used for termination -and value of the "Host" header is used for routing.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -A single application container that you want to run within a pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - 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 container 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 container 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
imagestring - Container 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
imagePullPolicystring - 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
lifecycleobject - Actions that the management system should take in response to container lifecycle events. -Cannot be updated.
- 		false
livenessProbeobject - 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. 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. -Modifying this array with strategic merge patch may corrupt the data. -For more information See https://github.com/kubernetes/kubernetes/issues/108255. -Cannot be updated.
- 		false
readinessProbeobject - 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
resizePolicy[]object - Resources resize policy for the container.
- 		false
resourcesobject - Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
restartPolicystring - RestartPolicy defines the restart behavior of individual containers in a pod. -This field may only be set for init containers, and the only allowed value is "Always". -For non-init containers or when this field is not specified, -the restart behavior is defined by the Pod's restart policy and the container type. -Setting the RestartPolicy as "Always" for the init container will have the following effect: -this init container will be continually restarted on -exit until all regular containers have terminated. Once all regular -containers have completed, all init containers with restartPolicy "Always" -will be shut down. This lifecycle differs from normal init containers and -is often referred to as a "sidecar" container. Although this init -container still starts in the init container sequence, it does not wait -for the container to complete before proceeding to the next init -container. Instead, the next init container starts immediately after this -init container is started, or after any startupProbe has successfully -completed.
- 		false
securityContextobject - 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
startupProbeobject - 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
stdinboolean - 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
stdinOnceboolean - 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
terminationMessagePathstring - 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
terminationMessagePolicystring - 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
ttyboolean - 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
workingDirstring - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.configMapKeyRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.fieldRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.secretKeyRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].envFrom[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].envFrom[index].configMapRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvfromindex) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].envFrom[index].secretRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvfromindex) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -Actions that the management system should take in response to container lifecycle events. -Cannot be updated. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
postStartobject - 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
preStopobject - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststarthttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.sleep -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestophttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.sleep -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.grpc -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].ports[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -ContainerPort represents a network port in a single container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
containerPortinteger - Number of port to expose on the pod's IP address. -This must be a valid port number, 0 < x < 65536.
-
- Format: int32
- 		true
hostIPstring - What host IP to bind the external port to.
- 		false
hostPortinteger - 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
namestring - 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
protocolstring - Protocol for port. Must be UDP, TCP, or SCTP. -Defaults to "TCP".
-
- Default: TCP
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.grpc -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].resizePolicy[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -ContainerResizePolicy represents resource resize policy for the container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourceNamestring - Name of the resource to which this resource resize policy applies. -Supported values: cpu, memory.
- 		true
restartPolicystring - Restart policy to apply when specified resource is resized. -If not specified, it defaults to NotRequired.
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].resources -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].resources.claims[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexresources) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -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/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.capabilities -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.grpc -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].volumeDevices[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -volumeDevice describes a mapping of a raw block device within a container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
devicePathstring - devicePath is the path inside of the container that the device will be mapped to.
- 		true
namestring - name must match the name of a persistentVolumeClaim in the pod
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].volumeMounts[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### OpenTelemetryCollector.spec.lifecycle -[↩ Parent](#opentelemetrycollectorspec) - - - -Actions that the management system should take in response to container lifecycle events. Cannot be updated. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
postStartobject - 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
preStopobject - 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
- - -### OpenTelemetryCollector.spec.lifecycle.postStart -[↩ Parent](#opentelemetrycollectorspeclifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.exec -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.httpGet -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststarthttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.sleep -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.tcpSocket -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.lifecycle.preStop -[↩ Parent](#opentelemetrycollectorspeclifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.exec -[↩ Parent](#opentelemetrycollectorspeclifecycleprestop) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.httpGet -[↩ Parent](#opentelemetrycollectorspeclifecycleprestop) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspeclifecycleprestophttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.sleep -[↩ Parent](#opentelemetrycollectorspeclifecycleprestop) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.tcpSocket -[↩ Parent](#opentelemetrycollectorspeclifecycleprestop) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.livenessProbe -[↩ Parent](#opentelemetrycollectorspec) - - - -Liveness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. -It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
initialDelaySecondsinteger - Number of seconds after the container has started before liveness probes are initiated. -Defaults to 0 seconds. Minimum value is 0. -More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
-
- Format: int32
- 		false
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.observability -[↩ Parent](#opentelemetrycollectorspec) - - - -ObservabilitySpec defines how telemetry data gets handled. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
metricsobject - Metrics defines the metrics configuration for operands.
- 		false
- - -### OpenTelemetryCollector.spec.observability.metrics -[↩ Parent](#opentelemetrycollectorspecobservability) - - - -Metrics defines the metrics configuration for operands. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
DisablePrometheusAnnotationsboolean - DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations -('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
- 		false
enableMetricsboolean - EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. -The operator.observability.prometheus feature gate must be enabled to use this feature.
- 		false
- - -### OpenTelemetryCollector.spec.podDisruptionBudget -[↩ Parent](#opentelemetrycollectorspec) - - - -PodDisruptionBudget specifies the pod disruption budget configuration to use -for the OpenTelemetryCollector workload. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxUnavailableint or string - An eviction is allowed if at most "maxUnavailable" pods selected by -"selector" are unavailable after the eviction, i.e. even in absence of -the evicted pod. For example, one can prevent all voluntary evictions -by specifying 0. This is a mutually exclusive setting with "minAvailable".
- 		false
minAvailableint or string - An eviction is allowed if at least "minAvailable" pods selected by -"selector" will still be available after the eviction, i.e. even in the -absence of the evicted pod. So for example you can prevent all voluntary -evictions by specifying "100%".
- 		false
- - -### OpenTelemetryCollector.spec.podSecurityContext -[↩ Parent](#opentelemetrycollectorspec) - - - -PodSecurityContext configures the pod security context for the -opentelemetry-collector pod, when running as a deployment, daemonset, -or statefulset. - -In sidecar mode, the opentelemetry-operator will ignore this setting. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
appArmorProfileobject - appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows.
- 		false
fsGroupinteger - 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
fsGroupChangePolicystring - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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 and fsGroup (if specified). If -the SupplementalGroupsPolicy feature is enabled, the -supplementalGroupsPolicy field determines whether these are in addition -to or instead of any group memberships defined in the container image. -If unspecified, no additional groups are added, though group memberships -defined in the container image may still be used, depending on the -supplementalGroupsPolicy field. -Note that this field cannot be set when spec.os.name is windows.
- 		false
supplementalGroupsPolicystring - Defines how supplemental groups of the first container processes are calculated. -Valid values are "Merge" and "Strict". If not specified, "Merge" is used. -(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled -and the container runtime must implement support for this feature. -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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.podSecurityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.podSecurityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.podSecurityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) - - - -The seccomp options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.podSecurityContext.sysctls[index] -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) - - - -Sysctl defines a kernel parameter to be set - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of a property to set
- 		true
valuestring - Value of a property to set
- 		true
- - -### OpenTelemetryCollector.spec.podSecurityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.ports[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -PortsSpec defines the OpenTelemetryCollector's container/service ports additional specifications. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - The port that will be exposed by this service.
-
- Format: int32
- 		true
appProtocolstring - The application protocol for this port. -This is used as a hint for implementations to offer richer behavior for protocols that they understand. -This field follows standard Kubernetes label syntax. -Valid values are either: - -* Un-prefixed protocol names - reserved for IANA standard service names (as per -RFC-6335 and https://www.iana.org/assignments/service-names). - -* Kubernetes-defined prefixed names: - * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- - * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 - * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 - -* Other protocols should use implementation-defined prefixed names such as -mycompany.com/my-custom-protocol.
- 		false
hostPortinteger - Allows defining which port to bind to the host in the Container.
-
- Format: int32
- 		false
namestring - The name of this port within the service. This must be a DNS_LABEL. -All ports within a ServiceSpec must have unique names. When considering -the endpoints for a Service, this must match the 'name' field in the -EndpointPort. -Optional if only one ServicePort is defined on this service.
- 		false
nodePortinteger - The port on each node on which this service is exposed when type is -NodePort or LoadBalancer. Usually assigned by the system. If a value is -specified, in-range, and not in use it will be used, otherwise the -operation will fail. If not specified, a port will be allocated if this -Service requires one. If this field is specified when creating a -Service which does not need it, creation will fail. This field will be -wiped when updating a Service to no longer need it (e.g. changing type -from NodePort to ClusterIP). -More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
-
- Format: int32
- 		false
protocolstring - The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". -Default is TCP.
-
- Default: TCP
- 		false
targetPortint or string - Number or name of the port to access on the pods targeted by the service. -Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. -If this is a string, it will be looked up as a named port in the -target Pod's container ports. If this is not specified, the value -of the 'port' field is used (an identity map). -This field is ignored for services with clusterIP=None, and should be -omitted or set equal to the 'port' field. -More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
- 		false
- - -### OpenTelemetryCollector.spec.resources -[↩ Parent](#opentelemetrycollectorspec) - - - -Resources to set on the OpenTelemetry Collector pods. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.resources.claims[index] -[↩ Parent](#opentelemetrycollectorspecresources) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### OpenTelemetryCollector.spec.securityContext -[↩ Parent](#opentelemetrycollectorspec) - - - -SecurityContext configures the container security context for -the opentelemetry-collector container. - -In deployment, daemonset, or statefulset mode, this controls -the security context settings for the primary application -container. - -In sidecar mode, this controls the security context for the -injected sidecar container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.securityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspecsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.securityContext.capabilities -[↩ Parent](#opentelemetrycollectorspecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### OpenTelemetryCollector.spec.securityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.securityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.securityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator -[↩ Parent](#opentelemetrycollectorspec) - - - -TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
affinityobject - If specified, indicates the pod's scheduling constraints
- 		false
allocationStrategyenum - AllocationStrategy determines which strategy the target allocator should use for allocation. -The current options are least-weighted, consistent-hashing and per-node. The default is -consistent-hashing. -WARNING: The per-node strategy currently ignores targets without a Node, like control plane components.
-
- Enum: least-weighted, consistent-hashing, per-node
- Default: consistent-hashing
- 		false
enabledboolean - Enabled indicates whether to use a target allocation mechanism for Prometheus targets or not.
- 		false
env[]object - ENV vars to set on the OpenTelemetry TargetAllocator's Pods. These can then in certain cases be -consumed in the config file for the TargetAllocator.
- 		false
filterStrategystring - FilterStrategy determines how to filter targets before allocating them among the collectors. -The only current option is relabel-config (drops targets based on prom relabel_config). -The default is relabel-config.
-
- Default: relabel-config
- 		false
imagestring - Image indicates the container image to use for the OpenTelemetry TargetAllocator.
- 		false
nodeSelectormap[string]string - NodeSelector to schedule OpenTelemetry TargetAllocator pods.
- 		false
observabilityobject - ObservabilitySpec defines how telemetry data gets handled.
- 		false
podDisruptionBudgetobject - PodDisruptionBudget specifies the pod disruption budget configuration to use -for the target allocator workload.
- 		false
podSecurityContextobject - PodSecurityContext configures the pod security context for the -targetallocator.
- 		false
prometheusCRobject - PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ) retrieval. -All CR instances which the ServiceAccount has access to will be retrieved. This includes other namespaces.
- 		false
replicasinteger - Replicas is the number of pod instances for the underlying TargetAllocator. This should only be set to a value -other than 1 if a strategy that allows for high availability is chosen. Currently, the only allocation strategy -that can be run in a high availability mode is consistent-hashing.
-
- Format: int32
- 		false
resourcesobject - Resources to set on the OpenTelemetryTargetAllocator containers.
- 		false
securityContextobject - SecurityContext configures the container security context for -the targetallocator.
- 		false
serviceAccountstring - ServiceAccount indicates the name of an existing service account to use with this instance. When set, -the operator will not automatically create a ServiceAccount for the TargetAllocator.
- 		false
tolerations[]object - Toleration embedded kubernetes pod configuration option, -controls how pods can be scheduled with matching taints
- 		false
topologySpreadConstraints[]object - TopologySpreadConstraints embedded kubernetes pod configuration option, -controls how pods are spread across your cluster among failure-domains -such as regions, zones, nodes, and other user-defined topology domains -https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -If specified, indicates the pod's scheduling constraints - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeAffinityobject - Describes node affinity scheduling rules for the pod.
- 		false
podAffinityobject - Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- 		false
podAntiAffinityobject - Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity) - - - -Describes node affinity scheduling rules for the pod. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinity) - - - -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). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
preferenceobject - A node selector term, associated with the corresponding weight.
- 		true
weightinteger - Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -A node selector term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinity) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeSelectorTerms[]object - Required. A list of node selector terms. The terms are ORed.
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecution) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity) - - - -Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinity) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinity) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity) - - - -Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinity) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinity) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index] -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.configMapKeyRef -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.fieldRef -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.resourceFieldRef -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.secretKeyRef -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.observability -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -ObservabilitySpec defines how telemetry data gets handled. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
metricsobject - Metrics defines the metrics configuration for operands.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.observability.metrics -[↩ Parent](#opentelemetrycollectorspectargetallocatorobservability) - - - -Metrics defines the metrics configuration for operands. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
DisablePrometheusAnnotationsboolean - DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations -('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
- 		false
enableMetricsboolean - EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. -The operator.observability.prometheus feature gate must be enabled to use this feature.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podDisruptionBudget -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -PodDisruptionBudget specifies the pod disruption budget configuration to use -for the target allocator workload. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxUnavailableint or string - An eviction is allowed if at most "maxUnavailable" pods selected by -"selector" are unavailable after the eviction, i.e. even in absence of -the evicted pod. For example, one can prevent all voluntary evictions -by specifying 0. This is a mutually exclusive setting with "minAvailable".
- 		false
minAvailableint or string - An eviction is allowed if at least "minAvailable" pods selected by -"selector" will still be available after the eviction, i.e. even in the -absence of the evicted pod. So for example you can prevent all voluntary -evictions by specifying "100%".
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -PodSecurityContext configures the pod security context for the -targetallocator. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
appArmorProfileobject - appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows.
- 		false
fsGroupinteger - 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
fsGroupChangePolicystring - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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 and fsGroup (if specified). If -the SupplementalGroupsPolicy feature is enabled, the -supplementalGroupsPolicy field determines whether these are in addition -to or instead of any group memberships defined in the container image. -If unspecified, no additional groups are added, though group memberships -defined in the container image may still be used, depending on the -supplementalGroupsPolicy field. -Note that this field cannot be set when spec.os.name is windows.
- 		false
supplementalGroupsPolicystring - Defines how supplemental groups of the first container processes are calculated. -Valid values are "Merge" and "Strict". If not specified, "Merge" is used. -(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled -and the container runtime must implement support for this feature. -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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) - - - -The seccomp options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.sysctls[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) - - - -Sysctl defines a kernel parameter to be set - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of a property to set
- 		true
valuestring - Value of a property to set
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ) retrieval. -All CR instances which the ServiceAccount has access to will be retrieved. This includes other namespaces. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
enabledboolean - Enabled indicates whether to use a PrometheusOperator custom resources as targets or not.
- 		false
podMonitorSelectormap[string]string - PodMonitors to be selected for target discovery. -This is a map of {key,value} pairs. Each {key,value} in the map is going to exactly match a label in a -PodMonitor's meta labels. The requirements are ANDed. -Empty or nil map matches all pod monitors.
- 		false
scrapeIntervalstring - Interval between consecutive scrapes. Equivalent to the same setting on the Prometheus CRD. - -Default: "30s"
-
- Format: duration
- Default: 30s
- 		false
serviceMonitorSelectormap[string]string - ServiceMonitors to be selected for target discovery. -This is a map of {key,value} pairs. Each {key,value} in the map is going to exactly match a label in a -ServiceMonitor's meta labels. The requirements are ANDed. -Empty or nil map matches all service monitors.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.resources -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -Resources to set on the OpenTelemetryTargetAllocator containers. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.resources.claims[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatorresources) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -SecurityContext configures the container security context for -the targetallocator. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.capabilities -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.tolerations[index] -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -The pod this Toleration is attached to tolerates any taint that matches -the triple using the matching operator . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
effectstring - Effect indicates the taint effect to match. Empty means match all taint effects. -When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- 		false
keystring - 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
operatorstring - 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
tolerationSecondsinteger - 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
valuestring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index] -[↩ Parent](#opentelemetrycollectorspectargetallocator) - - - -TopologySpreadConstraint specifies how to spread matching pods among the given topology. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSkewinteger - 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. -The global minimum is the minimum number of matching pods in an eligible domain -or zero if the number of eligible domains is less than MinDomains. -For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same -labelSelector spread as 2/2/1: -In this case, the global minimum is 1. -| zone1 | zone2 | zone3 | -| P P | P P | P | -- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; -scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring - 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 as a "bucket", and try to put balanced number -of pods into each bucket. -We define a domain as a particular instance of a topology. -Also, we define an eligible domain as a domain whose nodes meet the requirements of -nodeAffinityPolicy and nodeTaintsPolicy. -e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. -And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. -It's a required field.
- 		true
whenUnsatisfiablestring - 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
labelSelectorobject - 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
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select the pods over which -spreading will be calculated. The keys are used to lookup values from the -incoming pod labels, those key-value labels are ANDed with labelSelector -to select the group of existing pods over which spreading will be calculated -for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. -MatchLabelKeys cannot be set when LabelSelector isn't set. -Keys that don't exist in the incoming pod labels will -be ignored. A null or empty list means only match against labelSelector. - -This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- 		false
minDomainsinteger - MinDomains indicates a minimum number of eligible domains. -When the number of eligible domains with matching topology keys is less than minDomains, -Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. -And when the number of eligible domains with matching topology keys equals or greater than minDomains, -this value has no effect on scheduling. -As a result, when the number of eligible domains is less than minDomains, -scheduler won't schedule more than maxSkew Pods to those domains. -If value is nil, the constraint behaves as if MinDomains is equal to 1. -Valid values are integers greater than 0. -When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - -For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same -labelSelector spread as 2/2/2: -| zone1 | zone2 | zone3 | -| P P | P P | P P | -The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. -In this situation, new pod with the same labelSelector cannot be scheduled, -because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, -it will violate MaxSkew.
-
- Format: int32
- 		false
nodeAffinityPolicystring - NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector -when calculating pod topology spread skew. Options are: -- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. -- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. - -If this value is nil, the behavior is equivalent to the Honor policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
nodeTaintsPolicystring - NodeTaintsPolicy indicates how we will treat node taints when calculating -pod topology spread skew. Options are: -- Honor: nodes without taints, along with tainted nodes for which the incoming pod -has a toleration, are included. -- Ignore: node taints are ignored. All nodes are included. - -If this value is nil, the behavior is equivalent to the Ignore policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index].labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatortopologyspreadconstraintsindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatortopologyspreadconstraintsindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.tolerations[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -The pod this Toleration is attached to tolerates any taint that matches -the triple using the matching operator . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
effectstring - Effect indicates the taint effect to match. Empty means match all taint effects. -When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- 		false
keystring - 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
operatorstring - 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
tolerationSecondsinteger - 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
valuestring - 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
- - -### OpenTelemetryCollector.spec.topologySpreadConstraints[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -TopologySpreadConstraint specifies how to spread matching pods among the given topology. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSkewinteger - 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. -The global minimum is the minimum number of matching pods in an eligible domain -or zero if the number of eligible domains is less than MinDomains. -For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same -labelSelector spread as 2/2/1: -In this case, the global minimum is 1. -| zone1 | zone2 | zone3 | -| P P | P P | P | -- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; -scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring - 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 as a "bucket", and try to put balanced number -of pods into each bucket. -We define a domain as a particular instance of a topology. -Also, we define an eligible domain as a domain whose nodes meet the requirements of -nodeAffinityPolicy and nodeTaintsPolicy. -e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. -And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. -It's a required field.
- 		true
whenUnsatisfiablestring - 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
labelSelectorobject - 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
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select the pods over which -spreading will be calculated. The keys are used to lookup values from the -incoming pod labels, those key-value labels are ANDed with labelSelector -to select the group of existing pods over which spreading will be calculated -for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. -MatchLabelKeys cannot be set when LabelSelector isn't set. -Keys that don't exist in the incoming pod labels will -be ignored. A null or empty list means only match against labelSelector. - -This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- 		false
minDomainsinteger - MinDomains indicates a minimum number of eligible domains. -When the number of eligible domains with matching topology keys is less than minDomains, -Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. -And when the number of eligible domains with matching topology keys equals or greater than minDomains, -this value has no effect on scheduling. -As a result, when the number of eligible domains is less than minDomains, -scheduler won't schedule more than maxSkew Pods to those domains. -If value is nil, the constraint behaves as if MinDomains is equal to 1. -Valid values are integers greater than 0. -When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - -For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same -labelSelector spread as 2/2/2: -| zone1 | zone2 | zone3 | -| P P | P P | P P | -The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. -In this situation, new pod with the same labelSelector cannot be scheduled, -because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, -it will violate MaxSkew.
-
- Format: int32
- 		false
nodeAffinityPolicystring - NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector -when calculating pod topology spread skew. Options are: -- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. -- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. - -If this value is nil, the behavior is equivalent to the Honor policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
nodeTaintsPolicystring - NodeTaintsPolicy indicates how we will treat node taints when calculating -pod topology spread skew. Options are: -- Honor: nodes without taints, along with tainted nodes for which the incoming pod -has a toleration, are included. -- Ignore: node taints are ignored. All nodes are included. - -If this value is nil, the behavior is equivalent to the Ignore policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
- - -### OpenTelemetryCollector.spec.topologySpreadConstraints[index].labelSelector -[↩ Parent](#opentelemetrycollectorspectopologyspreadconstraintsindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectopologyspreadconstraintsindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.updateStrategy -[↩ Parent](#opentelemetrycollectorspec) - - - -UpdateStrategy represents the strategy the operator will take replacing existing DaemonSet pods with new pods -https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/daemon-set-v1/#DaemonSetSpec -This is only applicable to Daemonset mode. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
rollingUpdateobject - Rolling update config params. Present only if type = "RollingUpdate".
- 		false
typestring - Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
- 		false
- - -### OpenTelemetryCollector.spec.updateStrategy.rollingUpdate -[↩ Parent](#opentelemetrycollectorspecupdatestrategy) - - - -Rolling update config params. Present only if type = "RollingUpdate". - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSurgeint or string - The maximum number of nodes with an existing available DaemonSet pod that -can have an updated DaemonSet pod during during an update. -Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). -This can not be 0 if MaxUnavailable is 0. -Absolute number is calculated from percentage by rounding up to a minimum of 1. -Default value is 0. -Example: when this is set to 30%, at most 30% of the total number of nodes -that should be running the daemon pod (i.e. status.desiredNumberScheduled) -can have their a new pod created before the old pod is marked as deleted. -The update starts by launching new pods on 30% of nodes. Once an updated -pod is available (Ready for at least minReadySeconds) the old DaemonSet pod -on that node is marked deleted. If the old pod becomes unavailable for any -reason (Ready transitions to false, is evicted, or is drained) an updated -pod is immediatedly created on that node without considering surge limits.
- 		false
maxUnavailableint or string - The maximum number of DaemonSet pods that can be unavailable during the -update. Value can be an absolute number (ex: 5) or a percentage of total -number of DaemonSet pods at the start of the update (ex: 10%). Absolute -number is calculated from percentage by rounding up. -This cannot be 0 if MaxSurge is 0 -Default value is 1. -Example: when this is set to 30%, at most 30% of the total number of nodes -that should be running the daemon pod (i.e. status.desiredNumberScheduled) -can have their pods stopped for an update at any given time. The update -starts by stopping at most 30% of those DaemonSet pods and then brings -up new DaemonSet pods in their place. Once the new pods are available, -it then proceeds onto other DaemonSet pods, thus ensuring that at least -70% of original number of DaemonSet pods are available at all times during -the update.
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -PersistentVolumeClaim is a user's request for and claim to a persistent volume - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
apiVersionstring - APIVersion defines the versioned schema of this representation of an object. -Servers should convert recognized schemas to the latest internal value, and -may reject unrecognized values. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- 		false
kindstring - Kind is a string value representing the REST resource this object represents. -Servers may infer this from the endpoint the client submits requests to. -Cannot be updated. -In CamelCase. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- 		false
metadataobject - Standard object's metadata. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- 		false
specobject - spec defines the desired characteristics of a volume requested by a pod author. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 		false
statusobject - status represents the current information/status of a persistent volume claim. -Read-only. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].metadata -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex) - - - -Standard object's metadata. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex) - - - -spec defines the desired characteristics of a volume requested by a pod author. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSource -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSourceRef -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.resources -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex) - - - -status represents the current information/status of a persistent volume claim. -Read-only. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
accessModes[]string - accessModes contains the actual access modes the volume backing the PVC has. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- 		false
allocatedResourceStatusesmap[string]string - allocatedResourceStatuses stores status of resource being resized for the given PVC. -Key names follow standard Kubernetes label syntax. Valid values are either: - * Un-prefixed keys: - - storage - the capacity of the volume. - * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" -Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered -reserved and hence may not be used. - -ClaimResourceStatus can be in any of following states: - - ControllerResizeInProgress: - State set when resize controller starts resizing the volume in control-plane. - - ControllerResizeFailed: - State set when resize has failed in resize controller with a terminal error. - - NodeResizePending: - State set when resize controller has finished resizing the volume but further resizing of - volume is needed on the node. - - NodeResizeInProgress: - State set when kubelet starts resizing the volume. - - NodeResizeFailed: - State set when resizing has failed in kubelet with a terminal error. Transient errors don't set - NodeResizeFailed.
- 		false
allocatedResourcesmap[string]int or string - allocatedResources tracks the resources allocated to a PVC including its capacity. -Key names follow standard Kubernetes label syntax. Valid values are either: - * Un-prefixed keys: - - storage - the capacity of the volume. - * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" -Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered -reserved and hence may not be used. - -Capacity reported here may be larger than the actual capacity when a volume expansion operation -is requested. -For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. -If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. -If a volume expansion capacity request is lowered, allocatedResources is only -lowered if there are no expansion operations in progress and if the actual volume capacity -is equal or lower than the requested capacity. - -A controller that receives PVC update with previously unknown resourceName -should ignore the update for the purpose it was designed.
- 		false
capacitymap[string]int or string - capacity represents the actual resources of the underlying volume.
- 		false
conditions[]object - conditions is the current Condition of persistent volume claim. If underlying persistent volume is being -resized then the Condition will be set to 'Resizing'.
- 		false
currentVolumeAttributesClassNamestring - currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. -When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim -This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
- 		false
modifyVolumeStatusobject - ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. -When this is unset, there is no ModifyVolume operation being attempted. -This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
- 		false
phasestring - phase represents the current phase of PersistentVolumeClaim.
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.conditions[index] -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexstatus) - - - -PersistentVolumeClaimCondition contains details about state of pvc - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
statusstring -
- 		true
typestring - PersistentVolumeClaimConditionType defines the condition of PV claim. -Valid values are: - - "Resizing", "FileSystemResizePending" - -If RecoverVolumeExpansionFailure feature gate is enabled, then following additional values can be expected: - - "ControllerResizeError", "NodeResizeError" - -If VolumeAttributesClass feature gate is enabled, then following additional values can be expected: - - "ModifyVolumeError", "ModifyingVolume"
- 		true
lastProbeTimestring - lastProbeTime is the time we probed the condition.
-
- Format: date-time
- 		false
lastTransitionTimestring - lastTransitionTime is the time the condition transitioned from one status to another.
-
- Format: date-time
- 		false
messagestring - message is the human-readable message indicating details about last transition.
- 		false
reasonstring - reason is a unique, this should be a short, machine understandable string that gives the reason -for condition's last transition. If it reports "Resizing" that means the underlying -persistent volume is being resized.
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.modifyVolumeStatus -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexstatus) - - - -ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. -When this is unset, there is no ModifyVolume operation being attempted. -This is a beta field and requires enabling VolumeAttributesClass feature (off by default). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
statusstring - status is the status of the ControllerModifyVolume operation. It can be in any of following states: - - Pending - Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as - the specified VolumeAttributesClass not existing. - - InProgress - InProgress indicates that the volume is being modified. - - Infeasible - Infeasible indicates that the request has been rejected as invalid by the CSI driver. To - resolve the error, a valid VolumeAttributesClass needs to be specified. -Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
- 		true
targetVolumeAttributesClassNamestring - targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
- 		false
- - -### OpenTelemetryCollector.spec.volumeMounts[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### OpenTelemetryCollector.spec.volumes[index] -[↩ Parent](#opentelemetrycollectorspec) - - - -Volume represents a named volume in a pod that may be accessed by any container in the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - name of the volume. -Must be a DNS_LABEL and unique within the pod. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- 		true
awsElasticBlockStoreobject - 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
azureDiskobject - azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- 		false
azureFileobject - azureFile represents an Azure File Service mount on the host and bind mount to the pod.
- 		false
cephfsobject - cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
- 		false
cinderobject - cinder represents a cinder volume attached and mounted on kubelets host machine. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- 		false
configMapobject - configMap represents a configMap that should populate this volume
- 		false
csiobject - csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
- 		false
downwardAPIobject - downwardAPI represents downward API about the pod that should populate this volume
- 		false
emptyDirobject - emptyDir represents a temporary directory that shares a pod's lifetime. -More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 		false
ephemeralobject - 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
fcobject - fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
- 		false
flexVolumeobject - flexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin.
- 		false
flockerobject - flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
- 		false
gcePersistentDiskobject - 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
gitRepoobject - 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
glusterfsobject - 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
hostPathobject - 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
- 		false
imageobject - image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. -The volume is resolved at pod startup depending on which PullPolicy value is provided: - -- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. - -The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. -A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
- 		false
iscsiobject - 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
nfsobject - 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
persistentVolumeClaimobject - persistentVolumeClaimVolumeSource represents a reference to a -PersistentVolumeClaim in the same namespace. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 		false
photonPersistentDiskobject - photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
- 		false
portworxVolumeobject - portworxVolume represents a portworx volume attached and mounted on kubelets host machine
- 		false
projectedobject - projected items for all in one resources secrets, configmaps, and downward API
- 		false
quobyteobject - quobyte represents a Quobyte mount on the host that shares a pod's lifetime
- 		false
rbdobject - 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
scaleIOobject - scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
- 		false
secretobject - secret represents a secret that should populate this volume. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- 		false
storageosobject - storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
- 		false
vsphereVolumeobject - vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].awsElasticBlockStore -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). -More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 		true
fsTypestring - fsType is the 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
- 		false
partitioninteger - partition is 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
readOnlyboolean - readOnly value true will force the readOnly setting in VolumeMounts. -More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].azureDisk -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
diskNamestring - diskName is the Name of the data disk in the blob storage
- 		true
diskURIstring - diskURI is the URI of data disk in the blob storage
- 		true
cachingModestring - cachingMode is the Host Caching mode: None, Read Only, Read Write.
- 		false
fsTypestring - fsType is 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.
-
- Default: ext4
- 		false
kindstring - kind expected values are 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
readOnlyboolean - readOnly Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
-
- Default: false
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].azureFile -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -azureFile represents an Azure File Service mount on the host and bind mount to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secretNamestring - secretName is the name of secret that contains Azure Storage Account Name and Key
- 		true
shareNamestring - shareName is the azure share Name
- 		true
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].cephfs -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -cephFS represents a Ceph FS mount on the host that shares a pod's lifetime - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
monitors[]string - monitors is Required: Monitors is a collection of Ceph monitors -More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- 		true
pathstring - path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- 		false
readOnlyboolean - readOnly is 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
secretFilestring - secretFile is 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
secretRefobject - secretRef is 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
userstring - user is 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
- - -### OpenTelemetryCollector.spec.volumes[index].cephfs.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexcephfs) - - - -secretRef is 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 - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].cinder -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -cinder represents a cinder volume attached and mounted on kubelets host machine. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID used to identify the volume in cinder. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- 		true
fsTypestring - fsType is the 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
readOnlyboolean - readOnly 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
secretRefobject - secretRef is optional: points to a secret object containing parameters used to connect -to OpenStack.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].cinder.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexcinder) - - - -secretRef is optional: points to a secret object containing parameters used to connect -to OpenStack. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].configMap -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -configMap represents a configMap that should populate this volume - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode is 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 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional specify whether the ConfigMap or its keys must be defined
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].configMap.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexconfigmap) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpenTelemetryCollector.spec.volumes[index].csi -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
driverstring - 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
fsTypestring - fsType 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
nodePublishSecretRefobject - 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
readOnlyboolean - readOnly specifies a read-only configuration for the volume. -Defaults to false (read/write).
- 		false
volumeAttributesmap[string]string - volumeAttributes stores driver-specific properties that are passed to the CSI -driver. Consult your driver's documentation for supported values.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].csi.nodePublishSecretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexcsi) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].downwardAPI -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -downwardAPI represents downward API about the pod that should populate this volume - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - 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
- - -### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapi) - - - -DownwardAPIVolumeFile represents information to create the file containing the pod field - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
fieldRefobject - Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- 		false
modeinteger - 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
resourceFieldRefobject - Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].fieldRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex) - - - -Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex) - - - -Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].emptyDir -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -emptyDir represents a temporary directory that shares a pod's lifetime. -More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mediumstring - medium represents 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
sizeLimitint or string - sizeLimit is the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeClaimTemplateobject - 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 `-` where -`` 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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeral) - - - -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 `-` where -`` 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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].fc -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fsTypestring - fsType is the 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
luninteger - lun is Optional: FC target lun number
-
- Format: int32
- 		false
readOnlyboolean - readOnly is Optional: Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
targetWWNs[]string - targetWWNs is Optional: FC target worldwide names (WWNs)
- 		false
wwids[]string - wwids Optional: FC volume world wide identifiers (wwids) -Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].flexVolume -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -flexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
driverstring - driver is the name of the driver to use for this volume.
- 		true
fsTypestring - fsType is the 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
optionsmap[string]string - options is Optional: this field holds extra command options if any.
- 		false
readOnlyboolean - readOnly is Optional: defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
secretRefobject - secretRef is 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
- - -### OpenTelemetryCollector.spec.volumes[index].flexVolume.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexflexvolume) - - - -secretRef is 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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].flocker -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
datasetNamestring - datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker -should be considered as deprecated
- 		false
datasetUUIDstring - datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].gcePersistentDisk -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pdNamestring - pdName is 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
fsTypestring - fsType is 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
- 		false
partitioninteger - partition is 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
readOnlyboolean - readOnly here will force the ReadOnly setting in VolumeMounts. -Defaults to false. -More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].gitRepo -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
repositorystring - repository is the URL
- 		true
directorystring - directory is the 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
revisionstring - revision is the commit hash for the specified revision.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].glusterfs -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. -More info: https://examples.k8s.io/volumes/glusterfs/README.md - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
endpointsstring - endpoints is the endpoint name that details Glusterfs topology. -More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- 		true
pathstring - path is the Glusterfs volume path. -More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- 		true
readOnlyboolean - 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
- - -### OpenTelemetryCollector.spec.volumes[index].hostPath -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
typestring - type for HostPath Volume -Defaults to "" -More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].image -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. -The volume is resolved at pod startup depending on which PullPolicy value is provided: - -- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. - -The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. -A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pullPolicystring - Policy for pulling OCI objects. Possible values are: -Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. -Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- 		false
referencestring - Required: Image or artifact reference to be used. -Behaves in the same way as pod.spec.containers[*].image. -Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. -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
- - -### OpenTelemetryCollector.spec.volumes[index].iscsi -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
iqnstring - iqn is the target iSCSI Qualified Name.
- 		true
luninteger - lun represents iSCSI Target Lun number.
-
- Format: int32
- 		true
targetPortalstring - targetPortal is 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
chapAuthDiscoveryboolean - chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
- 		false
chapAuthSessionboolean - chapAuthSession defines whether support iSCSI Session CHAP authentication
- 		false
fsTypestring - fsType is the 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
- 		false
initiatorNamestring - initiatorName is the custom iSCSI Initiator Name. -If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface -: will be created for the connection.
- 		false
iscsiInterfacestring - iscsiInterface is the interface Name that uses an iSCSI transport. -Defaults to 'default' (tcp).
-
- Default: default
- 		false
portals[]string - portals is the 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
readOnlyboolean - readOnly here will force the ReadOnly setting in VolumeMounts. -Defaults to false.
- 		false
secretRefobject - secretRef is the CHAP Secret for iSCSI target and initiator authentication
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].iscsi.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexiscsi) - - - -secretRef is the CHAP Secret for iSCSI target and initiator authentication - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].nfs -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -nfs represents an NFS mount on the host that shares a pod's lifetime -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - path that is exported by the NFS server. -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 		true
serverstring - server is the hostname or IP address of the NFS server. -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 		true
readOnlyboolean - 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
- - -### OpenTelemetryCollector.spec.volumes[index].persistentVolumeClaim -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -persistentVolumeClaimVolumeSource represents a reference to a -PersistentVolumeClaim in the same namespace. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claimNamestring - 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
readOnlyboolean - readOnly Will force the ReadOnly setting in VolumeMounts. -Default false.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].photonPersistentDisk -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pdIDstring - pdID is the ID that identifies Photon Controller persistent disk
- 		true
fsTypestring - fsType is the 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
- - -### OpenTelemetryCollector.spec.volumes[index].portworxVolume -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -portworxVolume represents a portworx volume attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID uniquely identifies a Portworx volume
- 		true
fsTypestring - 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
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -projected items for all in one resources secrets, configmaps, and downward API - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode are the 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 - sources is the list of volume projections. Each entry in this list -handles one source.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojected) - - - -Projection that may be projected along with other supported volume types. -Exactly one of these fields must be set. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
clusterTrustBundleobject - ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field -of ClusterTrustBundle objects in an auto-updating file. - -Alpha, gated by the ClusterTrustBundleProjection feature gate. - -ClusterTrustBundle objects can either be selected by name, or by the -combination of signer name and a label selector. - -Kubelet performs aggressive normalization of the PEM contents written -into the pod filesystem. Esoteric PEM features such as inter-block -comments and block headers are stripped. Certificates are deduplicated. -The ordering of certificates within the file is arbitrary, and Kubelet -may change the order over time.
- 		false
configMapobject - configMap information about the configMap data to project
- 		false
downwardAPIobject - downwardAPI information about the downwardAPI data to project
- 		false
secretobject - secret information about the secret data to project
- 		false
serviceAccountTokenobject - serviceAccountToken is information about the serviceAccountToken data to project
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) - - - -ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field -of ClusterTrustBundle objects in an auto-updating file. - -Alpha, gated by the ClusterTrustBundleProjection feature gate. - -ClusterTrustBundle objects can either be selected by name, or by the -combination of signer name and a label selector. - -Kubelet performs aggressive normalization of the PEM contents written -into the pod filesystem. Esoteric PEM features such as inter-block -comments and block headers are stripped. Certificates are deduplicated. -The ordering of certificates within the file is arbitrary, and Kubelet -may change the order over time. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - Relative path from the volume root to write the bundle.
- 		true
labelSelectorobject - Select all ClusterTrustBundles that match this label selector. Only has -effect if signerName is set. Mutually-exclusive with name. If unset, -interpreted as "match nothing". If set but empty, interpreted as "match -everything".
- 		false
namestring - Select a single ClusterTrustBundle by object name. Mutually-exclusive -with signerName and labelSelector.
- 		false
optionalboolean - If true, don't block pod startup if the referenced ClusterTrustBundle(s) -aren't available. If using name, then the named ClusterTrustBundle is -allowed not to exist. If using signerName, then the combination of -signerName and labelSelector is allowed to match zero -ClusterTrustBundles.
- 		false
signerNamestring - Select all ClusterTrustBundles that match this signer name. -Mutually-exclusive with name. The contents of all selected -ClusterTrustBundles will be unified and deduplicated.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexclustertrustbundle) - - - -Select all ClusterTrustBundles that match this label selector. Only has -effect if signerName is set. Mutually-exclusive with name. If unset, -interpreted as "match nothing". If set but empty, interpreted as "match -everything". - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexclustertrustbundlelabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) - - - -configMap information about the configMap data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - items 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional specify whether the ConfigMap or its keys must be defined
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexconfigmap) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) - - - -downwardAPI information about the downwardAPI data to project - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - Items is a list of DownwardAPIVolume file
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapi) - - - -DownwardAPIVolumeFile represents information to create the file containing the pod field - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
fieldRefobject - Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- 		false
modeinteger - 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
resourceFieldRefobject - Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) - - - -Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) - - - -Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) - - - -secret information about the secret data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - items 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional field specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexsecret) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].serviceAccountToken -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) - - - -serviceAccountToken is information about the serviceAccountToken data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - path is the path relative to the mount point of the file to project the -token into.
- 		true
audiencestring - 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
expirationSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.volumes[index].quobyte -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -quobyte represents a Quobyte mount on the host that shares a pod's lifetime - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
registrystring - 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
volumestring - volume is a string that references an already created Quobyte volume by name.
- 		true
groupstring - group to map volume access to -Default is no group
- 		false
readOnlyboolean - readOnly here will force the Quobyte volume to be mounted with read-only permissions. -Defaults to false.
- 		false
tenantstring - tenant owning the given Quobyte volume in the Backend -Used with dynamically provisioned Quobyte volumes, value is set by the plugin
- 		false
userstring - user to map volume access to -Defaults to serivceaccount user
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].rbd -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
imagestring - image is the rados image name. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 		true
monitors[]string - monitors is a collection of Ceph monitors. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 		true
fsTypestring - fsType is the 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
- 		false
keyringstring - 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
-
- Default: /etc/ceph/keyring
- 		false
poolstring - pool is the rados pool name. -Default is rbd. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
-
- Default: rbd
- 		false
readOnlyboolean - 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
secretRefobject - 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
userstring - user is the rados user name. -Default is admin. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
-
- Default: admin
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].rbd.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexrbd) - - - -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 - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].scaleIO -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gatewaystring - gateway is the host address of the ScaleIO API Gateway.
- 		true
secretRefobject - secretRef references to the secret for ScaleIO user and other -sensitive information. If this is not provided, Login operation will fail.
- 		true
systemstring - system is the name of the storage system as configured in ScaleIO.
- 		true
fsTypestring - fsType is the filesystem type to mount. -Must be a filesystem type supported by the host operating system. -Ex. "ext4", "xfs", "ntfs". -Default is "xfs".
-
- Default: xfs
- 		false
protectionDomainstring - protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
- 		false
readOnlyboolean - readOnly Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
sslEnabledboolean - sslEnabled Flag enable/disable SSL communication with Gateway, default false
- 		false
storageModestring - storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. -Default is ThinProvisioned.
-
- Default: ThinProvisioned
- 		false
storagePoolstring - storagePool is the ScaleIO Storage Pool associated with the protection domain.
- 		false
volumeNamestring - volumeName is the name of a volume already created in the ScaleIO system -that is associated with this volume source.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].scaleIO.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexscaleio) - - - -secretRef references to the secret for ScaleIO user and other -sensitive information. If this is not provided, Login operation will fail. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].secret -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -secret represents a secret that should populate this volume. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode is 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 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
optionalboolean - optional field specify whether the Secret or its keys must be defined
- 		false
secretNamestring - secretName is the name of the secret in the pod's namespace to use. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].secret.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexsecret) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpenTelemetryCollector.spec.volumes[index].storageos -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fsTypestring - fsType is the 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
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
secretRefobject - secretRef specifies the secret to use for obtaining the StorageOS API -credentials. If not specified, default values will be attempted.
- 		false
volumeNamestring - volumeName is the human-readable name of the StorageOS volume. Volume -names are only unique within a namespace.
- 		false
volumeNamespacestring - 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
- - -### OpenTelemetryCollector.spec.volumes[index].storageos.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexstorageos) - - - -secretRef specifies the secret to use for obtaining the StorageOS API -credentials. If not specified, default values will be attempted. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].vsphereVolume -[↩ Parent](#opentelemetrycollectorspecvolumesindex) - - - -vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumePathstring - volumePath is the path that identifies vSphere volume vmdk
- 		true
fsTypestring - fsType is 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
storagePolicyIDstring - storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- 		false
storagePolicyNamestring - storagePolicyName is the storage Policy Based Management (SPBM) profile name.
- 		false
- - -### OpenTelemetryCollector.status -[↩ Parent](#opentelemetrycollector) - - - -OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
imagestring - Image indicates the container image to use for the OpenTelemetry Collector.
- 		false
messages[]string - Messages about actions performed by the operator on this resource. -Deprecated: use Kubernetes events instead.
- 		false
replicasinteger - Replicas is currently not being set and might be removed in the next version. -Deprecated: use "OpenTelemetryCollector.Status.Scale.Replicas" instead.
-
- Format: int32
- 		false
scaleobject - Scale is the OpenTelemetryCollector's scale subresource status.
- 		false
versionstring - Version of the managed OpenTelemetry Collector (operand)
- 		false
- - -### OpenTelemetryCollector.status.scale -[↩ Parent](#opentelemetrycollectorstatus) - - - -Scale is the OpenTelemetryCollector's scale subresource status. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
replicasinteger - The total number non-terminated pods targeted by this -OpenTelemetryCollector's deployment or statefulSet.
-
- Format: int32
- 		false
selectorstring - The selector used to match the OpenTelemetryCollector's -deployment or statefulSet pods.
- 		false
statusReplicasstring - StatusReplicas is the number of pods targeted by this OpenTelemetryCollector's with a Ready Condition / -Total number of non-terminated pods targeted by this OpenTelemetryCollector's (their labels match the selector). -Deployment, Daemonset, StatefulSet.
- 		false
- -## TargetAllocator -[↩ Parent](#opentelemetryiov1alpha1 ) - - - - - - -TargetAllocator is the Schema for the targetallocators API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringTargetAllocatortrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject - TargetAllocatorSpec defines the desired state of TargetAllocator.
- 		false
statusobject - TargetAllocatorStatus defines the observed state of Target Allocator.
- 		false
- - -### TargetAllocator.spec -[↩ Parent](#targetallocator) - - - -TargetAllocatorSpec defines the desired state of TargetAllocator. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
managementStateenum - ManagementState defines if the CR should be managed by the operator or not. -Default is managed.
-
- Enum: managed, unmanaged
- Default: managed
- 		true
additionalContainers[]object - AdditionalContainers allows injecting additional containers into the generated pod definition. -These sidecar containers can be used for authentication proxies, log shipping sidecars, agents for shipping -metrics to their cloud, or in general sidecars that do not support automatic injection. -This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment. - -Container names managed by the operator: -* `otc-container` - -Overriding containers managed by the operator is outside the scope of what the maintainers will support and by -doing so, you wil accept the risk of it breaking things.
- 		false
affinityobject - If specified, indicates the pod's scheduling constraints
- 		false
allocationStrategyenum - AllocationStrategy determines which strategy the target allocator should use for allocation. -The current options are least-weighted, consistent-hashing and per-node. The default is -consistent-hashing. -WARNING: The per-node strategy currently ignores targets without a Node, like control plane components.
-
- Enum: least-weighted, consistent-hashing, per-node
- Default: consistent-hashing
- 		false
argsmap[string]string - Args is the set of arguments to pass to the main container's binary.
- 		false
env[]object - Environment variables to set on the generated pods.
- 		false
envFrom[]object - List of sources to populate environment variables on the generated pods.
- 		false
filterStrategyenum - FilterStrategy determines how to filter targets before allocating them among the collectors. -The only current option is relabel-config (drops targets based on prom relabel_config). -The default is relabel-config.
-
- Enum: , relabel-config
- Default: relabel-config
- 		false
globalobject - GlobalConfig configures the global configuration for Prometheus -For more info, see https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file.
- 		false
hostNetworkboolean - HostNetwork indicates if the pod should run in the host networking namespace.
- 		false
imagestring - Image indicates the container image to use for the generated pods.
- 		false
imagePullPolicystring - ImagePullPolicy indicates the pull policy to be used for retrieving the container image.
- 		false
initContainers[]object - InitContainers allows injecting initContainers to the generated pod definition. -These init containers can be used to fetch secrets for injection into the -configuration from external sources, run added checks, etc. Any errors during the execution of -an initContainer will lead to a restart of the Pod. More info: -https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
- 		false
ipFamilies[]string - IPFamily represents the IP Family (IPv4 or IPv6). This type is used -to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
- 		false
ipFamilyPolicystring - IPFamilyPolicy represents the dual-stack-ness requested or required by a Service
-
- Default: SingleStack
- 		false
lifecycleobject - Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- 		false
nodeSelectormap[string]string - NodeSelector to schedule generated pods. -This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment.
- 		false
observabilityobject - ObservabilitySpec defines how telemetry data gets handled.
- 		false
podAnnotationsmap[string]string - PodAnnotations is the set of annotations that will be attached to -the generated pods.
- 		false
podDisruptionBudgetobject - PodDisruptionBudget specifies the pod disruption budget configuration to use -for the generated workload. By default, a PDB with a MaxUnavailable of one is set.
- 		false
podDnsConfigobject - PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
- 		false
podSecurityContextobject - PodSecurityContext configures the pod security context for the -generated pod, when running as a deployment, daemonset, -or statefulset. - -In sidecar mode, the opentelemetry-operator will ignore this setting.
- 		false
ports[]object - Ports allows a set of ports to be exposed by the underlying v1.Service & v1.ContainerPort. By default, the operator -will attempt to infer the required ports by parsing the .Spec.Config property but this property can be -used to open additional ports that can't be inferred by the operator, like for custom receivers.
- 		false
priorityClassNamestring - If specified, indicates the pod's priority. -If not specified, the pod priority will be default or zero if there is no -default.
- 		false
prometheusCRobject - PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ).
- 		false
replicasinteger - Replicas is the number of pod instances for the underlying replicaset. Set this if you are not using autoscaling.
-
- Format: int32
- 		false
resourcesobject - Resources to set on generated pods.
- 		false
scrapeConfigs[]object - ScrapeConfigs define static Prometheus scrape configurations for the target allocator. -To use dynamic configurations from ServiceMonitors and PodMonitors, see the PrometheusCR section. -For the exact format, see https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.
- 		false
securityContextobject - SecurityContext configures the container security context for -the generated main container. - -In deployment, daemonset, or statefulset mode, this controls -the security context settings for the primary application -container. - -In sidecar mode, this controls the security context for the -injected sidecar container.
- 		false
serviceAccountstring - ServiceAccount indicates the name of an existing service account to use with this instance. When set, -the operator will not automatically create a ServiceAccount.
- 		false
shareProcessNamespaceboolean - ShareProcessNamespace indicates if the pod's containers should share process namespace.
- 		false
terminationGracePeriodSecondsinteger - Duration in seconds the pod needs to terminate gracefully upon probe failure.
-
- Format: int64
- 		false
tolerations[]object - Toleration to schedule the generated pods. -This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment.
- 		false
topologySpreadConstraints[]object - TopologySpreadConstraints embedded kubernetes pod configuration option, -controls how pods are spread across your cluster among failure-domains -such as regions, zones, nodes, and other user-defined topology domains -https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ -This only works with the following OpenTelemetryCollector mode's: statefulset, and deployment.
- 		false
volumeMounts[]object - VolumeMounts represents the mount points to use in the underlying deployment(s).
- 		false
volumes[]object - Volumes represents which volumes to use in the underlying deployment(s).
- 		false
- - -### TargetAllocator.spec.additionalContainers[index] -[↩ Parent](#targetallocatorspec) - - - -A single application container that you want to run within a pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - 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 container 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 container 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
imagestring - Container 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
imagePullPolicystring - 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
lifecycleobject - Actions that the management system should take in response to container lifecycle events. -Cannot be updated.
- 		false
livenessProbeobject - 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. 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. -Modifying this array with strategic merge patch may corrupt the data. -For more information See https://github.com/kubernetes/kubernetes/issues/108255. -Cannot be updated.
- 		false
readinessProbeobject - 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
resizePolicy[]object - Resources resize policy for the container.
- 		false
resourcesobject - Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
restartPolicystring - RestartPolicy defines the restart behavior of individual containers in a pod. -This field may only be set for init containers, and the only allowed value is "Always". -For non-init containers or when this field is not specified, -the restart behavior is defined by the Pod's restart policy and the container type. -Setting the RestartPolicy as "Always" for the init container will have the following effect: -this init container will be continually restarted on -exit until all regular containers have terminated. Once all regular -containers have completed, all init containers with restartPolicy "Always" -will be shut down. This lifecycle differs from normal init containers and -is often referred to as a "sidecar" container. Although this init -container still starts in the init container sequence, it does not wait -for the container to complete before proceeding to the next init -container. Instead, the next init container starts immediately after this -init container is started, or after any startupProbe has successfully -completed.
- 		false
securityContextobject - 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
startupProbeobject - 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
stdinboolean - 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
stdinOnceboolean - 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
terminationMessagePathstring - 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
terminationMessagePolicystring - 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
ttyboolean - 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
workingDirstring - 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
- - -### TargetAllocator.spec.additionalContainers[index].env[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom -[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom.configMapKeyRef -[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom.fieldRef -[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom.resourceFieldRef -[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom.secretKeyRef -[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].envFrom[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].envFrom[index].configMapRef -[↩ Parent](#targetallocatorspecadditionalcontainersindexenvfromindex) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].envFrom[index].secretRef -[↩ Parent](#targetallocatorspecadditionalcontainersindexenvfromindex) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -Actions that the management system should take in response to container lifecycle events. -Cannot be updated. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
postStartobject - 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
preStopobject - 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
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.exec -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststart) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.httpGet -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststart) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststarthttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.sleep -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststart) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.tcpSocket -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststart) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.exec -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestop) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.httpGet -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestop) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestophttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.sleep -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestop) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.tcpSocket -[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestop) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].livenessProbe -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### TargetAllocator.spec.additionalContainers[index].livenessProbe.exec -[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.additionalContainers[index].livenessProbe.grpc -[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].livenessProbe.httpGet -[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].livenessProbe.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.additionalContainers[index].livenessProbe.tcpSocket -[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].ports[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -ContainerPort represents a network port in a single container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
containerPortinteger - Number of port to expose on the pod's IP address. -This must be a valid port number, 0 < x < 65536.
-
- Format: int32
- 		true
hostIPstring - What host IP to bind the external port to.
- 		false
hostPortinteger - 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
namestring - 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
protocolstring - Protocol for port. Must be UDP, TCP, or SCTP. -Defaults to "TCP".
-
- Default: TCP
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].readinessProbe -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### TargetAllocator.spec.additionalContainers[index].readinessProbe.exec -[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.additionalContainers[index].readinessProbe.grpc -[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].readinessProbe.httpGet -[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].readinessProbe.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.additionalContainers[index].readinessProbe.tcpSocket -[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].resizePolicy[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -ContainerResizePolicy represents resource resize policy for the container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourceNamestring - Name of the resource to which this resource resize policy applies. -Supported values: cpu, memory.
- 		true
restartPolicystring - Restart policy to apply when specified resource is resized. -If not specified, it defaults to NotRequired.
- 		true
- - -### TargetAllocator.spec.additionalContainers[index].resources -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].resources.claims[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindexresources) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].securityContext -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -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/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### TargetAllocator.spec.additionalContainers[index].securityContext.appArmorProfile -[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].securityContext.capabilities -[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].securityContext.seLinuxOptions -[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].securityContext.seccompProfile -[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].securityContext.windowsOptions -[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### TargetAllocator.spec.additionalContainers[index].startupProbe -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### TargetAllocator.spec.additionalContainers[index].startupProbe.exec -[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.additionalContainers[index].startupProbe.grpc -[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].startupProbe.httpGet -[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].startupProbe.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.additionalContainers[index].startupProbe.tcpSocket -[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.additionalContainers[index].volumeDevices[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -volumeDevice describes a mapping of a raw block device within a container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
devicePathstring - devicePath is the path inside of the container that the device will be mapped to.
- 		true
namestring - name must match the name of a persistentVolumeClaim in the pod
- 		true
- - -### TargetAllocator.spec.additionalContainers[index].volumeMounts[index] -[↩ Parent](#targetallocatorspecadditionalcontainersindex) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### TargetAllocator.spec.affinity -[↩ Parent](#targetallocatorspec) - - - -If specified, indicates the pod's scheduling constraints - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeAffinityobject - Describes node affinity scheduling rules for the pod.
- 		false
podAffinityobject - Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- 		false
podAntiAffinityobject - Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- 		false
- - -### TargetAllocator.spec.affinity.nodeAffinity -[↩ Parent](#targetallocatorspecaffinity) - - - -Describes node affinity scheduling rules for the pod. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject - 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
- - -### TargetAllocator.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#targetallocatorspecaffinitynodeaffinity) - - - -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). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
preferenceobject - A node selector term, associated with the corresponding weight.
- 		true
weightinteger - Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
-
- Format: int32
- 		true
- - -### TargetAllocator.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference -[↩ Parent](#targetallocatorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -A node selector term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] -[↩ Parent](#targetallocatorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution -[↩ Parent](#targetallocatorspecaffinitynodeaffinity) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeSelectorTerms[]object - Required. A list of node selector terms. The terms are ORed.
- 		true
- - -### TargetAllocator.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] -[↩ Parent](#targetallocatorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] -[↩ Parent](#targetallocatorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.podAffinity -[↩ Parent](#targetallocatorspecaffinity) - - - -Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#targetallocatorspecaffinitypodaffinity) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#targetallocatorspecaffinitypodaffinity) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#targetallocatorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#targetallocatorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.podAntiAffinity -[↩ Parent](#targetallocatorspecaffinity) - - - -Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#targetallocatorspecaffinitypodantiaffinity) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#targetallocatorspecaffinitypodantiaffinity) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#targetallocatorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#targetallocatorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.env[index] -[↩ Parent](#targetallocatorspec) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### TargetAllocator.spec.env[index].valueFrom -[↩ Parent](#targetallocatorspecenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### TargetAllocator.spec.env[index].valueFrom.configMapKeyRef -[↩ Parent](#targetallocatorspecenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### TargetAllocator.spec.env[index].valueFrom.fieldRef -[↩ Parent](#targetallocatorspecenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### TargetAllocator.spec.env[index].valueFrom.resourceFieldRef -[↩ Parent](#targetallocatorspecenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### TargetAllocator.spec.env[index].valueFrom.secretKeyRef -[↩ Parent](#targetallocatorspecenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### TargetAllocator.spec.envFrom[index] -[↩ Parent](#targetallocatorspec) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### TargetAllocator.spec.envFrom[index].configMapRef -[↩ Parent](#targetallocatorspecenvfromindex) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### TargetAllocator.spec.envFrom[index].secretRef -[↩ Parent](#targetallocatorspecenvfromindex) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### TargetAllocator.spec.initContainers[index] -[↩ Parent](#targetallocatorspec) - - - -A single application container that you want to run within a pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - 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 container 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 container 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
imagestring - Container 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
imagePullPolicystring - 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
lifecycleobject - Actions that the management system should take in response to container lifecycle events. -Cannot be updated.
- 		false
livenessProbeobject - 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. 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. -Modifying this array with strategic merge patch may corrupt the data. -For more information See https://github.com/kubernetes/kubernetes/issues/108255. -Cannot be updated.
- 		false
readinessProbeobject - 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
resizePolicy[]object - Resources resize policy for the container.
- 		false
resourcesobject - Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
restartPolicystring - RestartPolicy defines the restart behavior of individual containers in a pod. -This field may only be set for init containers, and the only allowed value is "Always". -For non-init containers or when this field is not specified, -the restart behavior is defined by the Pod's restart policy and the container type. -Setting the RestartPolicy as "Always" for the init container will have the following effect: -this init container will be continually restarted on -exit until all regular containers have terminated. Once all regular -containers have completed, all init containers with restartPolicy "Always" -will be shut down. This lifecycle differs from normal init containers and -is often referred to as a "sidecar" container. Although this init -container still starts in the init container sequence, it does not wait -for the container to complete before proceeding to the next init -container. Instead, the next init container starts immediately after this -init container is started, or after any startupProbe has successfully -completed.
- 		false
securityContextobject - 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
startupProbeobject - 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
stdinboolean - 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
stdinOnceboolean - 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
terminationMessagePathstring - 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
terminationMessagePolicystring - 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
ttyboolean - 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
workingDirstring - 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
- - -### TargetAllocator.spec.initContainers[index].env[index] -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### TargetAllocator.spec.initContainers[index].env[index].valueFrom -[↩ Parent](#targetallocatorspecinitcontainersindexenvindex) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### TargetAllocator.spec.initContainers[index].env[index].valueFrom.configMapKeyRef -[↩ Parent](#targetallocatorspecinitcontainersindexenvindexvaluefrom) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### TargetAllocator.spec.initContainers[index].env[index].valueFrom.fieldRef -[↩ Parent](#targetallocatorspecinitcontainersindexenvindexvaluefrom) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### TargetAllocator.spec.initContainers[index].env[index].valueFrom.resourceFieldRef -[↩ Parent](#targetallocatorspecinitcontainersindexenvindexvaluefrom) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### TargetAllocator.spec.initContainers[index].env[index].valueFrom.secretKeyRef -[↩ Parent](#targetallocatorspecinitcontainersindexenvindexvaluefrom) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### TargetAllocator.spec.initContainers[index].envFrom[index] -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### TargetAllocator.spec.initContainers[index].envFrom[index].configMapRef -[↩ Parent](#targetallocatorspecinitcontainersindexenvfromindex) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### TargetAllocator.spec.initContainers[index].envFrom[index].secretRef -[↩ Parent](#targetallocatorspecinitcontainersindexenvfromindex) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### TargetAllocator.spec.initContainers[index].lifecycle -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -Actions that the management system should take in response to container lifecycle events. -Cannot be updated. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
postStartobject - 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
preStopobject - 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
- - -### TargetAllocator.spec.initContainers[index].lifecycle.postStart -[↩ Parent](#targetallocatorspecinitcontainersindexlifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### TargetAllocator.spec.initContainers[index].lifecycle.postStart.exec -[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststart) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.initContainers[index].lifecycle.postStart.httpGet -[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststart) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststarthttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.initContainers[index].lifecycle.postStart.sleep -[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststart) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### TargetAllocator.spec.initContainers[index].lifecycle.postStart.tcpSocket -[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststart) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].lifecycle.preStop -[↩ Parent](#targetallocatorspecinitcontainersindexlifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### TargetAllocator.spec.initContainers[index].lifecycle.preStop.exec -[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestop) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.initContainers[index].lifecycle.preStop.httpGet -[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestop) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestophttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.initContainers[index].lifecycle.preStop.sleep -[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestop) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### TargetAllocator.spec.initContainers[index].lifecycle.preStop.tcpSocket -[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestop) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].livenessProbe -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### TargetAllocator.spec.initContainers[index].livenessProbe.exec -[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.initContainers[index].livenessProbe.grpc -[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### TargetAllocator.spec.initContainers[index].livenessProbe.httpGet -[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.initContainers[index].livenessProbe.tcpSocket -[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].ports[index] -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -ContainerPort represents a network port in a single container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
containerPortinteger - Number of port to expose on the pod's IP address. -This must be a valid port number, 0 < x < 65536.
-
- Format: int32
- 		true
hostIPstring - What host IP to bind the external port to.
- 		false
hostPortinteger - 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
namestring - 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
protocolstring - Protocol for port. Must be UDP, TCP, or SCTP. -Defaults to "TCP".
-
- Default: TCP
- 		false
- - -### TargetAllocator.spec.initContainers[index].readinessProbe -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### TargetAllocator.spec.initContainers[index].readinessProbe.exec -[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.initContainers[index].readinessProbe.grpc -[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### TargetAllocator.spec.initContainers[index].readinessProbe.httpGet -[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.initContainers[index].readinessProbe.tcpSocket -[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].resizePolicy[index] -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -ContainerResizePolicy represents resource resize policy for the container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourceNamestring - Name of the resource to which this resource resize policy applies. -Supported values: cpu, memory.
- 		true
restartPolicystring - Restart policy to apply when specified resource is resized. -If not specified, it defaults to NotRequired.
- 		true
- - -### TargetAllocator.spec.initContainers[index].resources -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### TargetAllocator.spec.initContainers[index].resources.claims[index] -[↩ Parent](#targetallocatorspecinitcontainersindexresources) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### TargetAllocator.spec.initContainers[index].securityContext -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -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/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### TargetAllocator.spec.initContainers[index].securityContext.appArmorProfile -[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### TargetAllocator.spec.initContainers[index].securityContext.capabilities -[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### TargetAllocator.spec.initContainers[index].securityContext.seLinuxOptions -[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### TargetAllocator.spec.initContainers[index].securityContext.seccompProfile -[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### TargetAllocator.spec.initContainers[index].securityContext.windowsOptions -[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### TargetAllocator.spec.initContainers[index].startupProbe -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### TargetAllocator.spec.initContainers[index].startupProbe.exec -[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobe) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.initContainers[index].startupProbe.grpc -[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobe) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### TargetAllocator.spec.initContainers[index].startupProbe.httpGet -[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobe) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobehttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.initContainers[index].startupProbe.tcpSocket -[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobe) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.initContainers[index].volumeDevices[index] -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -volumeDevice describes a mapping of a raw block device within a container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
devicePathstring - devicePath is the path inside of the container that the device will be mapped to.
- 		true
namestring - name must match the name of a persistentVolumeClaim in the pod
- 		true
- - -### TargetAllocator.spec.initContainers[index].volumeMounts[index] -[↩ Parent](#targetallocatorspecinitcontainersindex) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### TargetAllocator.spec.lifecycle -[↩ Parent](#targetallocatorspec) - - - -Actions that the management system should take in response to container lifecycle events. Cannot be updated. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
postStartobject - 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
preStopobject - 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
- - -### TargetAllocator.spec.lifecycle.postStart -[↩ Parent](#targetallocatorspeclifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### TargetAllocator.spec.lifecycle.postStart.exec -[↩ Parent](#targetallocatorspeclifecyclepoststart) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.lifecycle.postStart.httpGet -[↩ Parent](#targetallocatorspeclifecyclepoststart) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.lifecycle.postStart.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspeclifecyclepoststarthttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.lifecycle.postStart.sleep -[↩ Parent](#targetallocatorspeclifecyclepoststart) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### TargetAllocator.spec.lifecycle.postStart.tcpSocket -[↩ Parent](#targetallocatorspeclifecyclepoststart) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.lifecycle.preStop -[↩ Parent](#targetallocatorspeclifecycle) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### TargetAllocator.spec.lifecycle.preStop.exec -[↩ Parent](#targetallocatorspeclifecycleprestop) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.lifecycle.preStop.httpGet -[↩ Parent](#targetallocatorspeclifecycleprestop) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### TargetAllocator.spec.lifecycle.preStop.httpGet.httpHeaders[index] -[↩ Parent](#targetallocatorspeclifecycleprestophttpget) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### TargetAllocator.spec.lifecycle.preStop.sleep -[↩ Parent](#targetallocatorspeclifecycleprestop) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### TargetAllocator.spec.lifecycle.preStop.tcpSocket -[↩ Parent](#targetallocatorspeclifecycleprestop) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### TargetAllocator.spec.observability -[↩ Parent](#targetallocatorspec) - - - -ObservabilitySpec defines how telemetry data gets handled. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
metricsobject - Metrics defines the metrics configuration for operands.
- 		false
- - -### TargetAllocator.spec.observability.metrics -[↩ Parent](#targetallocatorspecobservability) - - - -Metrics defines the metrics configuration for operands. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
disablePrometheusAnnotationsboolean - DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations -('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
- 		false
enableMetricsboolean - EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. -The operator.observability.prometheus feature gate must be enabled to use this feature.
- 		false
- - -### TargetAllocator.spec.podDisruptionBudget -[↩ Parent](#targetallocatorspec) - - - -PodDisruptionBudget specifies the pod disruption budget configuration to use -for the generated workload. By default, a PDB with a MaxUnavailable of one is set. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxUnavailableint or string - An eviction is allowed if at most "maxUnavailable" pods selected by -"selector" are unavailable after the eviction, i.e. even in absence of -the evicted pod. For example, one can prevent all voluntary evictions -by specifying 0. This is a mutually exclusive setting with "minAvailable".
- 		false
minAvailableint or string - An eviction is allowed if at least "minAvailable" pods selected by -"selector" will still be available after the eviction, i.e. even in the -absence of the evicted pod. So for example you can prevent all voluntary -evictions by specifying "100%".
- 		false
- - -### TargetAllocator.spec.podDnsConfig -[↩ Parent](#targetallocatorspec) - - - -PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### TargetAllocator.spec.podDnsConfig.options[index] -[↩ Parent](#targetallocatorspecpoddnsconfig) - - - -PodDNSConfigOption defines DNS resolver options of a pod. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Required.
- 		false
valuestring -
- 		false
- - -### TargetAllocator.spec.podSecurityContext -[↩ Parent](#targetallocatorspec) - - - -PodSecurityContext configures the pod security context for the -generated pod, when running as a deployment, daemonset, -or statefulset. - -In sidecar mode, the opentelemetry-operator will ignore this setting. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
appArmorProfileobject - appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows.
- 		false
fsGroupinteger - 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
fsGroupChangePolicystring - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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 and fsGroup (if specified). If -the SupplementalGroupsPolicy feature is enabled, the -supplementalGroupsPolicy field determines whether these are in addition -to or instead of any group memberships defined in the container image. -If unspecified, no additional groups are added, though group memberships -defined in the container image may still be used, depending on the -supplementalGroupsPolicy field. -Note that this field cannot be set when spec.os.name is windows.
- 		false
supplementalGroupsPolicystring - Defines how supplemental groups of the first container processes are calculated. -Valid values are "Merge" and "Strict". If not specified, "Merge" is used. -(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled -and the container runtime must implement support for this feature. -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
windowsOptionsobject - 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
- - -### TargetAllocator.spec.podSecurityContext.appArmorProfile -[↩ Parent](#targetallocatorspecpodsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### TargetAllocator.spec.podSecurityContext.seLinuxOptions -[↩ Parent](#targetallocatorspecpodsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### TargetAllocator.spec.podSecurityContext.seccompProfile -[↩ Parent](#targetallocatorspecpodsecuritycontext) - - - -The seccomp options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### TargetAllocator.spec.podSecurityContext.sysctls[index] -[↩ Parent](#targetallocatorspecpodsecuritycontext) - - - -Sysctl defines a kernel parameter to be set - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of a property to set
- 		true
valuestring - Value of a property to set
- 		true
- - -### TargetAllocator.spec.podSecurityContext.windowsOptions -[↩ Parent](#targetallocatorspecpodsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### TargetAllocator.spec.ports[index] -[↩ Parent](#targetallocatorspec) - - - -PortsSpec defines the OpenTelemetryCollector's container/service ports additional specifications. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - The port that will be exposed by this service.
-
- Format: int32
- 		true
appProtocolstring - The application protocol for this port. -This is used as a hint for implementations to offer richer behavior for protocols that they understand. -This field follows standard Kubernetes label syntax. -Valid values are either: - -* Un-prefixed protocol names - reserved for IANA standard service names (as per -RFC-6335 and https://www.iana.org/assignments/service-names). - -* Kubernetes-defined prefixed names: - * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- - * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 - * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 - -* Other protocols should use implementation-defined prefixed names such as -mycompany.com/my-custom-protocol.
- 		false
hostPortinteger - Allows defining which port to bind to the host in the Container.
-
- Format: int32
- 		false
namestring - The name of this port within the service. This must be a DNS_LABEL. -All ports within a ServiceSpec must have unique names. When considering -the endpoints for a Service, this must match the 'name' field in the -EndpointPort. -Optional if only one ServicePort is defined on this service.
- 		false
nodePortinteger - The port on each node on which this service is exposed when type is -NodePort or LoadBalancer. Usually assigned by the system. If a value is -specified, in-range, and not in use it will be used, otherwise the -operation will fail. If not specified, a port will be allocated if this -Service requires one. If this field is specified when creating a -Service which does not need it, creation will fail. This field will be -wiped when updating a Service to no longer need it (e.g. changing type -from NodePort to ClusterIP). -More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
-
- Format: int32
- 		false
protocolstring - The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". -Default is TCP.
-
- Default: TCP
- 		false
targetPortint or string - Number or name of the port to access on the pods targeted by the service. -Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. -If this is a string, it will be looked up as a named port in the -target Pod's container ports. If this is not specified, the value -of the 'port' field is used (an identity map). -This field is ignored for services with clusterIP=None, and should be -omitted or set equal to the 'port' field. -More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
- 		false
- - -### TargetAllocator.spec.prometheusCR -[↩ Parent](#targetallocatorspec) - - - -PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
enabledboolean - Enabled indicates whether to use a PrometheusOperator custom resources as targets or not.
- 		false
podMonitorSelectorobject - PodMonitors to be selected for target discovery. -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
probeSelectorobject - Probes to be selected for target discovery. -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
scrapeConfigSelectorobject - ScrapeConfigs to be selected for target discovery. -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
scrapeIntervalstring - Default interval between consecutive scrapes. Intervals set in ServiceMonitors and PodMonitors override it. -Equivalent to the same setting on the Prometheus CR. - -Default: "30s"
-
- Format: duration
- Default: 30s
- 		false
serviceMonitorSelectorobject - ServiceMonitors to be selected for target discovery. -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
- - -### TargetAllocator.spec.prometheusCR.podMonitorSelector -[↩ Parent](#targetallocatorspecprometheuscr) - - - -PodMonitors to be selected for target discovery. -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.prometheusCR.podMonitorSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecprometheuscrpodmonitorselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.prometheusCR.probeSelector -[↩ Parent](#targetallocatorspecprometheuscr) - - - -Probes to be selected for target discovery. -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.prometheusCR.probeSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecprometheuscrprobeselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.prometheusCR.scrapeConfigSelector -[↩ Parent](#targetallocatorspecprometheuscr) - - - -ScrapeConfigs to be selected for target discovery. -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.prometheusCR.scrapeConfigSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecprometheuscrscrapeconfigselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.prometheusCR.serviceMonitorSelector -[↩ Parent](#targetallocatorspecprometheuscr) - - - -ServiceMonitors to be selected for target discovery. -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.prometheusCR.serviceMonitorSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecprometheuscrservicemonitorselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.resources -[↩ Parent](#targetallocatorspec) - - - -Resources to set on generated pods. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### TargetAllocator.spec.resources.claims[index] -[↩ Parent](#targetallocatorspecresources) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### TargetAllocator.spec.securityContext -[↩ Parent](#targetallocatorspec) - - - -SecurityContext configures the container security context for -the generated main container. - -In deployment, daemonset, or statefulset mode, this controls -the security context settings for the primary application -container. - -In sidecar mode, this controls the security context for the -injected sidecar container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### TargetAllocator.spec.securityContext.appArmorProfile -[↩ Parent](#targetallocatorspecsecuritycontext) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### TargetAllocator.spec.securityContext.capabilities -[↩ Parent](#targetallocatorspecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### TargetAllocator.spec.securityContext.seLinuxOptions -[↩ Parent](#targetallocatorspecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### TargetAllocator.spec.securityContext.seccompProfile -[↩ Parent](#targetallocatorspecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### TargetAllocator.spec.securityContext.windowsOptions -[↩ Parent](#targetallocatorspecsecuritycontext) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### TargetAllocator.spec.tolerations[index] -[↩ Parent](#targetallocatorspec) - - - -The pod this Toleration is attached to tolerates any taint that matches -the triple using the matching operator . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
effectstring - Effect indicates the taint effect to match. Empty means match all taint effects. -When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- 		false
keystring - 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
operatorstring - 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
tolerationSecondsinteger - 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
valuestring - 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
- - -### TargetAllocator.spec.topologySpreadConstraints[index] -[↩ Parent](#targetallocatorspec) - - - -TopologySpreadConstraint specifies how to spread matching pods among the given topology. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSkewinteger - 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. -The global minimum is the minimum number of matching pods in an eligible domain -or zero if the number of eligible domains is less than MinDomains. -For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same -labelSelector spread as 2/2/1: -In this case, the global minimum is 1. -| zone1 | zone2 | zone3 | -| P P | P P | P | -- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; -scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring - 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 as a "bucket", and try to put balanced number -of pods into each bucket. -We define a domain as a particular instance of a topology. -Also, we define an eligible domain as a domain whose nodes meet the requirements of -nodeAffinityPolicy and nodeTaintsPolicy. -e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. -And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. -It's a required field.
- 		true
whenUnsatisfiablestring - 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
labelSelectorobject - 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
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select the pods over which -spreading will be calculated. The keys are used to lookup values from the -incoming pod labels, those key-value labels are ANDed with labelSelector -to select the group of existing pods over which spreading will be calculated -for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. -MatchLabelKeys cannot be set when LabelSelector isn't set. -Keys that don't exist in the incoming pod labels will -be ignored. A null or empty list means only match against labelSelector. - -This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- 		false
minDomainsinteger - MinDomains indicates a minimum number of eligible domains. -When the number of eligible domains with matching topology keys is less than minDomains, -Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. -And when the number of eligible domains with matching topology keys equals or greater than minDomains, -this value has no effect on scheduling. -As a result, when the number of eligible domains is less than minDomains, -scheduler won't schedule more than maxSkew Pods to those domains. -If value is nil, the constraint behaves as if MinDomains is equal to 1. -Valid values are integers greater than 0. -When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - -For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same -labelSelector spread as 2/2/2: -| zone1 | zone2 | zone3 | -| P P | P P | P P | -The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. -In this situation, new pod with the same labelSelector cannot be scheduled, -because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, -it will violate MaxSkew.
-
- Format: int32
- 		false
nodeAffinityPolicystring - NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector -when calculating pod topology spread skew. Options are: -- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. -- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. - -If this value is nil, the behavior is equivalent to the Honor policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
nodeTaintsPolicystring - NodeTaintsPolicy indicates how we will treat node taints when calculating -pod topology spread skew. Options are: -- Honor: nodes without taints, along with tainted nodes for which the incoming pod -has a toleration, are included. -- Ignore: node taints are ignored. All nodes are included. - -If this value is nil, the behavior is equivalent to the Ignore policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
- - -### TargetAllocator.spec.topologySpreadConstraints[index].labelSelector -[↩ Parent](#targetallocatorspectopologyspreadconstraintsindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspectopologyspreadconstraintsindexlabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.volumeMounts[index] -[↩ Parent](#targetallocatorspec) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### TargetAllocator.spec.volumes[index] -[↩ Parent](#targetallocatorspec) - - - -Volume represents a named volume in a pod that may be accessed by any container in the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - name of the volume. -Must be a DNS_LABEL and unique within the pod. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- 		true
awsElasticBlockStoreobject - 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
azureDiskobject - azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- 		false
azureFileobject - azureFile represents an Azure File Service mount on the host and bind mount to the pod.
- 		false
cephfsobject - cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
- 		false
cinderobject - cinder represents a cinder volume attached and mounted on kubelets host machine. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- 		false
configMapobject - configMap represents a configMap that should populate this volume
- 		false
csiobject - csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
- 		false
downwardAPIobject - downwardAPI represents downward API about the pod that should populate this volume
- 		false
emptyDirobject - emptyDir represents a temporary directory that shares a pod's lifetime. -More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 		false
ephemeralobject - 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
fcobject - fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
- 		false
flexVolumeobject - flexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin.
- 		false
flockerobject - flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
- 		false
gcePersistentDiskobject - 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
gitRepoobject - 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
glusterfsobject - 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
hostPathobject - 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
- 		false
imageobject - image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. -The volume is resolved at pod startup depending on which PullPolicy value is provided: - -- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. - -The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. -A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
- 		false
iscsiobject - 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
nfsobject - 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
persistentVolumeClaimobject - persistentVolumeClaimVolumeSource represents a reference to a -PersistentVolumeClaim in the same namespace. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 		false
photonPersistentDiskobject - photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
- 		false
portworxVolumeobject - portworxVolume represents a portworx volume attached and mounted on kubelets host machine
- 		false
projectedobject - projected items for all in one resources secrets, configmaps, and downward API
- 		false
quobyteobject - quobyte represents a Quobyte mount on the host that shares a pod's lifetime
- 		false
rbdobject - 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
scaleIOobject - scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
- 		false
secretobject - secret represents a secret that should populate this volume. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- 		false
storageosobject - storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
- 		false
vsphereVolumeobject - vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
- 		false
- - -### TargetAllocator.spec.volumes[index].awsElasticBlockStore -[↩ Parent](#targetallocatorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). -More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 		true
fsTypestring - fsType is the 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
- 		false
partitioninteger - partition is 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
readOnlyboolean - readOnly value true will force the readOnly setting in VolumeMounts. -More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 		false
- - -### TargetAllocator.spec.volumes[index].azureDisk -[↩ Parent](#targetallocatorspecvolumesindex) - - - -azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
diskNamestring - diskName is the Name of the data disk in the blob storage
- 		true
diskURIstring - diskURI is the URI of data disk in the blob storage
- 		true
cachingModestring - cachingMode is the Host Caching mode: None, Read Only, Read Write.
- 		false
fsTypestring - fsType is 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.
-
- Default: ext4
- 		false
kindstring - kind expected values are 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
readOnlyboolean - readOnly Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
-
- Default: false
- 		false
- - -### TargetAllocator.spec.volumes[index].azureFile -[↩ Parent](#targetallocatorspecvolumesindex) - - - -azureFile represents an Azure File Service mount on the host and bind mount to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secretNamestring - secretName is the name of secret that contains Azure Storage Account Name and Key
- 		true
shareNamestring - shareName is the azure share Name
- 		true
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
- - -### TargetAllocator.spec.volumes[index].cephfs -[↩ Parent](#targetallocatorspecvolumesindex) - - - -cephFS represents a Ceph FS mount on the host that shares a pod's lifetime - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
monitors[]string - monitors is Required: Monitors is a collection of Ceph monitors -More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- 		true
pathstring - path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- 		false
readOnlyboolean - readOnly is 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
secretFilestring - secretFile is 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
secretRefobject - secretRef is 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
userstring - user is 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
- - -### TargetAllocator.spec.volumes[index].cephfs.secretRef -[↩ Parent](#targetallocatorspecvolumesindexcephfs) - - - -secretRef is 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 - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### TargetAllocator.spec.volumes[index].cinder -[↩ Parent](#targetallocatorspecvolumesindex) - - - -cinder represents a cinder volume attached and mounted on kubelets host machine. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID used to identify the volume in cinder. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- 		true
fsTypestring - fsType is the 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
readOnlyboolean - readOnly 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
secretRefobject - secretRef is optional: points to a secret object containing parameters used to connect -to OpenStack.
- 		false
- - -### TargetAllocator.spec.volumes[index].cinder.secretRef -[↩ Parent](#targetallocatorspecvolumesindexcinder) - - - -secretRef is optional: points to a secret object containing parameters used to connect -to OpenStack. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### TargetAllocator.spec.volumes[index].configMap -[↩ Parent](#targetallocatorspecvolumesindex) - - - -configMap represents a configMap that should populate this volume - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode is 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 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional specify whether the ConfigMap or its keys must be defined
- 		false
- - -### TargetAllocator.spec.volumes[index].configMap.items[index] -[↩ Parent](#targetallocatorspecvolumesindexconfigmap) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### TargetAllocator.spec.volumes[index].csi -[↩ Parent](#targetallocatorspecvolumesindex) - - - -csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
driverstring - 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
fsTypestring - fsType 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
nodePublishSecretRefobject - 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
readOnlyboolean - readOnly specifies a read-only configuration for the volume. -Defaults to false (read/write).
- 		false
volumeAttributesmap[string]string - volumeAttributes stores driver-specific properties that are passed to the CSI -driver. Consult your driver's documentation for supported values.
- 		false
- - -### TargetAllocator.spec.volumes[index].csi.nodePublishSecretRef -[↩ Parent](#targetallocatorspecvolumesindexcsi) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### TargetAllocator.spec.volumes[index].downwardAPI -[↩ Parent](#targetallocatorspecvolumesindex) - - - -downwardAPI represents downward API about the pod that should populate this volume - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - 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
- - -### TargetAllocator.spec.volumes[index].downwardAPI.items[index] -[↩ Parent](#targetallocatorspecvolumesindexdownwardapi) - - - -DownwardAPIVolumeFile represents information to create the file containing the pod field - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
fieldRefobject - Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- 		false
modeinteger - 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
resourceFieldRefobject - Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- 		false
- - -### TargetAllocator.spec.volumes[index].downwardAPI.items[index].fieldRef -[↩ Parent](#targetallocatorspecvolumesindexdownwardapiitemsindex) - - - -Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### TargetAllocator.spec.volumes[index].downwardAPI.items[index].resourceFieldRef -[↩ Parent](#targetallocatorspecvolumesindexdownwardapiitemsindex) - - - -Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### TargetAllocator.spec.volumes[index].emptyDir -[↩ Parent](#targetallocatorspecvolumesindex) - - - -emptyDir represents a temporary directory that shares a pod's lifetime. -More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mediumstring - medium represents 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
sizeLimitint or string - sizeLimit is the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 		false
- - -### TargetAllocator.spec.volumes[index].ephemeral -[↩ Parent](#targetallocatorspecvolumesindex) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeClaimTemplateobject - 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 `-` where -`` 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
- - -### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate -[↩ Parent](#targetallocatorspecvolumesindexephemeral) - - - -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 `-` where -`` 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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec -[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource -[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespec) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespec) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources -[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespec) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector -[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespec) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespecselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata -[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplate) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### TargetAllocator.spec.volumes[index].fc -[↩ Parent](#targetallocatorspecvolumesindex) - - - -fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fsTypestring - fsType is the 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
luninteger - lun is Optional: FC target lun number
-
- Format: int32
- 		false
readOnlyboolean - readOnly is Optional: Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
targetWWNs[]string - targetWWNs is Optional: FC target worldwide names (WWNs)
- 		false
wwids[]string - wwids Optional: FC volume world wide identifiers (wwids) -Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- 		false
- - -### TargetAllocator.spec.volumes[index].flexVolume -[↩ Parent](#targetallocatorspecvolumesindex) - - - -flexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
driverstring - driver is the name of the driver to use for this volume.
- 		true
fsTypestring - fsType is the 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
optionsmap[string]string - options is Optional: this field holds extra command options if any.
- 		false
readOnlyboolean - readOnly is Optional: defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
secretRefobject - secretRef is 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
- - -### TargetAllocator.spec.volumes[index].flexVolume.secretRef -[↩ Parent](#targetallocatorspecvolumesindexflexvolume) - - - -secretRef is 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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### TargetAllocator.spec.volumes[index].flocker -[↩ Parent](#targetallocatorspecvolumesindex) - - - -flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
datasetNamestring - datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker -should be considered as deprecated
- 		false
datasetUUIDstring - datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
- 		false
- - -### TargetAllocator.spec.volumes[index].gcePersistentDisk -[↩ Parent](#targetallocatorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pdNamestring - pdName is 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
fsTypestring - fsType is 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
- 		false
partitioninteger - partition is 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
readOnlyboolean - readOnly here will force the ReadOnly setting in VolumeMounts. -Defaults to false. -More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- 		false
- - -### TargetAllocator.spec.volumes[index].gitRepo -[↩ Parent](#targetallocatorspecvolumesindex) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
repositorystring - repository is the URL
- 		true
directorystring - directory is the 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
revisionstring - revision is the commit hash for the specified revision.
- 		false
- - -### TargetAllocator.spec.volumes[index].glusterfs -[↩ Parent](#targetallocatorspecvolumesindex) - - - -glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. -More info: https://examples.k8s.io/volumes/glusterfs/README.md - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
endpointsstring - endpoints is the endpoint name that details Glusterfs topology. -More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- 		true
pathstring - path is the Glusterfs volume path. -More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- 		true
readOnlyboolean - 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
- - -### TargetAllocator.spec.volumes[index].hostPath -[↩ Parent](#targetallocatorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
typestring - type for HostPath Volume -Defaults to "" -More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- 		false
- - -### TargetAllocator.spec.volumes[index].image -[↩ Parent](#targetallocatorspecvolumesindex) - - - -image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. -The volume is resolved at pod startup depending on which PullPolicy value is provided: - -- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. - -The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. -A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pullPolicystring - Policy for pulling OCI objects. Possible values are: -Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. -Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- 		false
referencestring - Required: Image or artifact reference to be used. -Behaves in the same way as pod.spec.containers[*].image. -Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. -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
- - -### TargetAllocator.spec.volumes[index].iscsi -[↩ Parent](#targetallocatorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
iqnstring - iqn is the target iSCSI Qualified Name.
- 		true
luninteger - lun represents iSCSI Target Lun number.
-
- Format: int32
- 		true
targetPortalstring - targetPortal is 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
chapAuthDiscoveryboolean - chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
- 		false
chapAuthSessionboolean - chapAuthSession defines whether support iSCSI Session CHAP authentication
- 		false
fsTypestring - fsType is the 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
- 		false
initiatorNamestring - initiatorName is the custom iSCSI Initiator Name. -If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface -: will be created for the connection.
- 		false
iscsiInterfacestring - iscsiInterface is the interface Name that uses an iSCSI transport. -Defaults to 'default' (tcp).
-
- Default: default
- 		false
portals[]string - portals is the 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
readOnlyboolean - readOnly here will force the ReadOnly setting in VolumeMounts. -Defaults to false.
- 		false
secretRefobject - secretRef is the CHAP Secret for iSCSI target and initiator authentication
- 		false
- - -### TargetAllocator.spec.volumes[index].iscsi.secretRef -[↩ Parent](#targetallocatorspecvolumesindexiscsi) - - - -secretRef is the CHAP Secret for iSCSI target and initiator authentication - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### TargetAllocator.spec.volumes[index].nfs -[↩ Parent](#targetallocatorspecvolumesindex) - - - -nfs represents an NFS mount on the host that shares a pod's lifetime -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - path that is exported by the NFS server. -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 		true
serverstring - server is the hostname or IP address of the NFS server. -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 		true
readOnlyboolean - 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
- - -### TargetAllocator.spec.volumes[index].persistentVolumeClaim -[↩ Parent](#targetallocatorspecvolumesindex) - - - -persistentVolumeClaimVolumeSource represents a reference to a -PersistentVolumeClaim in the same namespace. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claimNamestring - 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
readOnlyboolean - readOnly Will force the ReadOnly setting in VolumeMounts. -Default false.
- 		false
- - -### TargetAllocator.spec.volumes[index].photonPersistentDisk -[↩ Parent](#targetallocatorspecvolumesindex) - - - -photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pdIDstring - pdID is the ID that identifies Photon Controller persistent disk
- 		true
fsTypestring - fsType is the 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
- - -### TargetAllocator.spec.volumes[index].portworxVolume -[↩ Parent](#targetallocatorspecvolumesindex) - - - -portworxVolume represents a portworx volume attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID uniquely identifies a Portworx volume
- 		true
fsTypestring - 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
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
- - -### TargetAllocator.spec.volumes[index].projected -[↩ Parent](#targetallocatorspecvolumesindex) - - - -projected items for all in one resources secrets, configmaps, and downward API - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode are the 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 - sources is the list of volume projections. Each entry in this list -handles one source.
- 		false
- - -### TargetAllocator.spec.volumes[index].projected.sources[index] -[↩ Parent](#targetallocatorspecvolumesindexprojected) - - - -Projection that may be projected along with other supported volume types. -Exactly one of these fields must be set. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
clusterTrustBundleobject - ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field -of ClusterTrustBundle objects in an auto-updating file. - -Alpha, gated by the ClusterTrustBundleProjection feature gate. - -ClusterTrustBundle objects can either be selected by name, or by the -combination of signer name and a label selector. - -Kubelet performs aggressive normalization of the PEM contents written -into the pod filesystem. Esoteric PEM features such as inter-block -comments and block headers are stripped. Certificates are deduplicated. -The ordering of certificates within the file is arbitrary, and Kubelet -may change the order over time.
- 		false
configMapobject - configMap information about the configMap data to project
- 		false
downwardAPIobject - downwardAPI information about the downwardAPI data to project
- 		false
secretobject - secret information about the secret data to project
- 		false
serviceAccountTokenobject - serviceAccountToken is information about the serviceAccountToken data to project
- 		false
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].clusterTrustBundle -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) - - - -ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field -of ClusterTrustBundle objects in an auto-updating file. - -Alpha, gated by the ClusterTrustBundleProjection feature gate. - -ClusterTrustBundle objects can either be selected by name, or by the -combination of signer name and a label selector. - -Kubelet performs aggressive normalization of the PEM contents written -into the pod filesystem. Esoteric PEM features such as inter-block -comments and block headers are stripped. Certificates are deduplicated. -The ordering of certificates within the file is arbitrary, and Kubelet -may change the order over time. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - Relative path from the volume root to write the bundle.
- 		true
labelSelectorobject - Select all ClusterTrustBundles that match this label selector. Only has -effect if signerName is set. Mutually-exclusive with name. If unset, -interpreted as "match nothing". If set but empty, interpreted as "match -everything".
- 		false
namestring - Select a single ClusterTrustBundle by object name. Mutually-exclusive -with signerName and labelSelector.
- 		false
optionalboolean - If true, don't block pod startup if the referenced ClusterTrustBundle(s) -aren't available. If using name, then the named ClusterTrustBundle is -allowed not to exist. If using signerName, then the combination of -signerName and labelSelector is allowed to match zero -ClusterTrustBundles.
- 		false
signerNamestring - Select all ClusterTrustBundles that match this signer name. -Mutually-exclusive with name. The contents of all selected -ClusterTrustBundles will be unified and deduplicated.
- 		false
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexclustertrustbundle) - - - -Select all ClusterTrustBundles that match this label selector. Only has -effect if signerName is set. Mutually-exclusive with name. If unset, -interpreted as "match nothing". If set but empty, interpreted as "match -everything". - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index] -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexclustertrustbundlelabelselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].configMap -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) - - - -configMap information about the configMap data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - items 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional specify whether the ConfigMap or its keys must be defined
- 		false
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].configMap.items[index] -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexconfigmap) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].downwardAPI -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) - - - -downwardAPI information about the downwardAPI data to project - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - Items is a list of DownwardAPIVolume file
- 		false
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].downwardAPI.items[index] -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexdownwardapi) - - - -DownwardAPIVolumeFile represents information to create the file containing the pod field - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
fieldRefobject - Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- 		false
modeinteger - 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
resourceFieldRefobject - Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- 		false
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) - - - -Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) - - - -Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].secret -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) - - - -secret information about the secret data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - items 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional field specify whether the Secret or its key must be defined
- 		false
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].secret.items[index] -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexsecret) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### TargetAllocator.spec.volumes[index].projected.sources[index].serviceAccountToken -[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) - - - -serviceAccountToken is information about the serviceAccountToken data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - path is the path relative to the mount point of the file to project the -token into.
- 		true
audiencestring - 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
expirationSecondsinteger - 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
- - -### TargetAllocator.spec.volumes[index].quobyte -[↩ Parent](#targetallocatorspecvolumesindex) - - - -quobyte represents a Quobyte mount on the host that shares a pod's lifetime - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
registrystring - 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
volumestring - volume is a string that references an already created Quobyte volume by name.
- 		true
groupstring - group to map volume access to -Default is no group
- 		false
readOnlyboolean - readOnly here will force the Quobyte volume to be mounted with read-only permissions. -Defaults to false.
- 		false
tenantstring - tenant owning the given Quobyte volume in the Backend -Used with dynamically provisioned Quobyte volumes, value is set by the plugin
- 		false
userstring - user to map volume access to -Defaults to serivceaccount user
- 		false
- - -### TargetAllocator.spec.volumes[index].rbd -[↩ Parent](#targetallocatorspecvolumesindex) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
imagestring - image is the rados image name. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 		true
monitors[]string - monitors is a collection of Ceph monitors. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 		true
fsTypestring - fsType is the 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
- 		false
keyringstring - 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
-
- Default: /etc/ceph/keyring
- 		false
poolstring - pool is the rados pool name. -Default is rbd. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
-
- Default: rbd
- 		false
readOnlyboolean - 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
secretRefobject - 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
userstring - user is the rados user name. -Default is admin. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
-
- Default: admin
- 		false
- - -### TargetAllocator.spec.volumes[index].rbd.secretRef -[↩ Parent](#targetallocatorspecvolumesindexrbd) - - - -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 - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### TargetAllocator.spec.volumes[index].scaleIO -[↩ Parent](#targetallocatorspecvolumesindex) - - - -scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gatewaystring - gateway is the host address of the ScaleIO API Gateway.
- 		true
secretRefobject - secretRef references to the secret for ScaleIO user and other -sensitive information. If this is not provided, Login operation will fail.
- 		true
systemstring - system is the name of the storage system as configured in ScaleIO.
- 		true
fsTypestring - fsType is the filesystem type to mount. -Must be a filesystem type supported by the host operating system. -Ex. "ext4", "xfs", "ntfs". -Default is "xfs".
-
- Default: xfs
- 		false
protectionDomainstring - protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
- 		false
readOnlyboolean - readOnly Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
sslEnabledboolean - sslEnabled Flag enable/disable SSL communication with Gateway, default false
- 		false
storageModestring - storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. -Default is ThinProvisioned.
-
- Default: ThinProvisioned
- 		false
storagePoolstring - storagePool is the ScaleIO Storage Pool associated with the protection domain.
- 		false
volumeNamestring - volumeName is the name of a volume already created in the ScaleIO system -that is associated with this volume source.
- 		false
- - -### TargetAllocator.spec.volumes[index].scaleIO.secretRef -[↩ Parent](#targetallocatorspecvolumesindexscaleio) - - - -secretRef references to the secret for ScaleIO user and other -sensitive information. If this is not provided, Login operation will fail. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### TargetAllocator.spec.volumes[index].secret -[↩ Parent](#targetallocatorspecvolumesindex) - - - -secret represents a secret that should populate this volume. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode is 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 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
optionalboolean - optional field specify whether the Secret or its keys must be defined
- 		false
secretNamestring - secretName is the name of the secret in the pod's namespace to use. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- 		false
- - -### TargetAllocator.spec.volumes[index].secret.items[index] -[↩ Parent](#targetallocatorspecvolumesindexsecret) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### TargetAllocator.spec.volumes[index].storageos -[↩ Parent](#targetallocatorspecvolumesindex) - - - -storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fsTypestring - fsType is the 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
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
secretRefobject - secretRef specifies the secret to use for obtaining the StorageOS API -credentials. If not specified, default values will be attempted.
- 		false
volumeNamestring - volumeName is the human-readable name of the StorageOS volume. Volume -names are only unique within a namespace.
- 		false
volumeNamespacestring - 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
- - -### TargetAllocator.spec.volumes[index].storageos.secretRef -[↩ Parent](#targetallocatorspecvolumesindexstorageos) - - - -secretRef specifies the secret to use for obtaining the StorageOS API -credentials. If not specified, default values will be attempted. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### TargetAllocator.spec.volumes[index].vsphereVolume -[↩ Parent](#targetallocatorspecvolumesindex) - - - -vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumePathstring - volumePath is the path that identifies vSphere volume vmdk
- 		true
fsTypestring - fsType is 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
storagePolicyIDstring - storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- 		false
storagePolicyNamestring - storagePolicyName is the storage Policy Based Management (SPBM) profile name.
- 		false
- - -### TargetAllocator.status -[↩ Parent](#targetallocator) - - - -TargetAllocatorStatus defines the observed state of Target Allocator. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
imagestring - Image indicates the container image to use for the Target Allocator.
- 		false
versionstring - Version of the managed Target Allocator (operand)
- 		false
- -# opentelemetry.io/v1beta1 - -Resource Types: - -- [OpenTelemetryCollector](#opentelemetrycollector) - - - - -## OpenTelemetryCollector -[↩ Parent](#opentelemetryiov1beta1 ) - - - - - - -OpenTelemetryCollector is the Schema for the opentelemetrycollectors API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1beta1true
kindstringOpenTelemetryCollectortrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject - OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.
- 		false
statusobject - OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector.
- 		false
- - -### OpenTelemetryCollector.spec -[↩ Parent](#opentelemetrycollector-1) - - - -OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configobject - Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details. -The empty objects e.g. batch: should be written as batch: {} otherwise they won't work with kustomize or kubectl edit.
- 		true
managementStateenum - ManagementState defines if the CR should be managed by the operator or not. -Default is managed.
-
- Enum: managed, unmanaged
- Default: managed
- 		true
additionalContainers[]object - AdditionalContainers allows injecting additional containers into the generated pod definition. -These sidecar containers can be used for authentication proxies, log shipping sidecars, agents for shipping -metrics to their cloud, or in general sidecars that do not support automatic injection. -This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment. - -Container names managed by the operator: -* `otc-container` - -Overriding containers managed by the operator is outside the scope of what the maintainers will support and by -doing so, you wil accept the risk of it breaking things.
- 		false
affinityobject - If specified, indicates the pod's scheduling constraints
- 		false
argsmap[string]string - Args is the set of arguments to pass to the main container's binary.
- 		false
autoscalerobject - Autoscaler specifies the pod autoscaling configuration to use -for the workload.
- 		false
configVersionsinteger - ConfigVersions defines the number versions to keep for the collector config. Each config version is stored in a separate ConfigMap. -Defaults to 3. The minimum value is 1.
-
- Default: 3
- Minimum: 1
- 		false
configmaps[]object - ConfigMaps is a list of ConfigMaps in the same namespace as the OpenTelemetryCollector -object, which shall be mounted into the Collector Pods. -Each ConfigMap will be added to the Collector's Deployments as a volume named `configmap-`.
- 		false
daemonSetUpdateStrategyobject - UpdateStrategy represents the strategy the operator will take replacing existing DaemonSet pods with new pods -https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/daemon-set-v1/#DaemonSetSpec -This is only applicable to Daemonset mode.
- 		false
deploymentUpdateStrategyobject - UpdateStrategy represents the strategy the operator will take replacing existing Deployment pods with new pods -https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/#DeploymentSpec -This is only applicable to Deployment mode.
- 		false
env[]object - Environment variables to set on the generated pods.
- 		false
envFrom[]object - List of sources to populate environment variables on the generated pods.
- 		false
hostNetworkboolean - HostNetwork indicates if the pod should run in the host networking namespace.
- 		false
imagestring - Image indicates the container image to use for the generated pods.
- 		false
imagePullPolicystring - ImagePullPolicy indicates the pull policy to be used for retrieving the container image.
- 		false
ingressobject - Ingress is used to specify how OpenTelemetry Collector is exposed. This -functionality is only available if one of the valid modes is set. -Valid modes are: deployment, daemonset and statefulset.
- 		false
initContainers[]object - InitContainers allows injecting initContainers to the generated pod definition. -These init containers can be used to fetch secrets for injection into the -configuration from external sources, run added checks, etc. Any errors during the execution of -an initContainer will lead to a restart of the Pod. More info: -https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
- 		false
ipFamilies[]string - IPFamily represents the IP Family (IPv4 or IPv6). This type is used -to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
- 		false
ipFamilyPolicystring - IPFamilyPolicy represents the dual-stack-ness requested or required by a Service
-
- Default: SingleStack
- 		false
lifecycleobject - Actions that the management system should take in response to container lifecycle events. Cannot be updated.
- 		false
livenessProbeobject - Liveness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. -It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline.
- 		false
modeenum - Mode represents how the collector should be deployed (deployment, daemonset, statefulset or sidecar)
-
- Enum: daemonset, deployment, sidecar, statefulset
- 		false
nodeSelectormap[string]string - NodeSelector to schedule generated pods. -This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment.
- 		false
observabilityobject - ObservabilitySpec defines how telemetry data gets handled.
- 		false
persistentVolumeClaimRetentionPolicyobject - PersistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims -created from volumeClaimTemplates. -This only works with the following OpenTelemetryCollector modes: statefulset.
- 		false
podAnnotationsmap[string]string - PodAnnotations is the set of annotations that will be attached to -the generated pods.
- 		false
podDisruptionBudgetobject - PodDisruptionBudget specifies the pod disruption budget configuration to use -for the generated workload. By default, a PDB with a MaxUnavailable of one is set.
- 		false
podDnsConfigobject - PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
- 		false
podSecurityContextobject - PodSecurityContext configures the pod security context for the -generated pod, when running as a deployment, daemonset, -or statefulset. - -In sidecar mode, the opentelemetry-operator will ignore this setting.
- 		false
ports[]object - Ports allows a set of ports to be exposed by the underlying v1.Service & v1.ContainerPort. By default, the operator -will attempt to infer the required ports by parsing the .Spec.Config property but this property can be -used to open additional ports that can't be inferred by the operator, like for custom receivers.
- 		false
priorityClassNamestring - If specified, indicates the pod's priority. -If not specified, the pod priority will be default or zero if there is no -default.
- 		false
readinessProbeobject - Readiness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. -It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline.
- 		false
replicasinteger - Replicas is the number of pod instances for the underlying replicaset. Set this if you are not using autoscaling.
-
- Format: int32
- 		false
resourcesobject - Resources to set on generated pods.
- 		false
securityContextobject - SecurityContext configures the container security context for -the generated main container. - -In deployment, daemonset, or statefulset mode, this controls -the security context settings for the primary application -container. - -In sidecar mode, this controls the security context for the -injected sidecar container.
- 		false
serviceAccountstring - ServiceAccount indicates the name of an existing service account to use with this instance. When set, -the operator will not automatically create a ServiceAccount.
- 		false
shareProcessNamespaceboolean - ShareProcessNamespace indicates if the pod's containers should share process namespace.
- 		false
targetAllocatorobject - TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not.
- 		false
terminationGracePeriodSecondsinteger - Duration in seconds the pod needs to terminate gracefully upon probe failure.
-
- Format: int64
- 		false
tolerations[]object - Toleration to schedule the generated pods. -This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment.
- 		false
topologySpreadConstraints[]object - TopologySpreadConstraints embedded kubernetes pod configuration option, -controls how pods are spread across your cluster among failure-domains -such as regions, zones, nodes, and other user-defined topology domains -https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ -This only works with the following OpenTelemetryCollector mode's: statefulset, and deployment.
- 		false
upgradeStrategyenum - UpgradeStrategy represents how the operator will handle upgrades to the CR when a newer version of the operator is deployed
-
- Enum: automatic, none
- 		false
volumeClaimTemplates[]object - VolumeClaimTemplates will provide stable storage using PersistentVolumes. -This only works with the following OpenTelemetryCollector mode's: statefulset.
- 		false
volumeMounts[]object - VolumeMounts represents the mount points to use in the underlying deployment(s).
- 		false
volumes[]object - Volumes represents which volumes to use in the underlying deployment(s).
- 		false
- - -### OpenTelemetryCollector.spec.config -[↩ Parent](#opentelemetrycollectorspec-1) - - - -Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details. -The empty objects e.g. batch: should be written as batch: {} otherwise they won't work with kustomize or kubectl edit. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
exportersobject - AnyConfig represent parts of the config.
- 		true
receiversobject - AnyConfig represent parts of the config.
- 		true
serviceobject -
- 		true
connectorsobject - AnyConfig represent parts of the config.
- 		false
extensionsobject - AnyConfig represent parts of the config.
- 		false
processorsobject - AnyConfig represent parts of the config.
- 		false
- - -### OpenTelemetryCollector.spec.config.service -[↩ Parent](#opentelemetrycollectorspecconfig) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pipelinesmap[string]object -
- 		true
extensions[]string -
- 		false
telemetryobject - AnyConfig represent parts of the config.
- 		false
- - -### OpenTelemetryCollector.spec.config.service.pipelines[key] -[↩ Parent](#opentelemetrycollectorspecconfigservice) - - - -Pipeline is a struct of component type to a list of component IDs. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
exporters[]string -
- 		true
receivers[]string -
- 		true
processors[]string -
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -A single application container that you want to run within a pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - 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 container 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 container 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
imagestring - Container 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
imagePullPolicystring - 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
lifecycleobject - Actions that the management system should take in response to container lifecycle events. -Cannot be updated.
- 		false
livenessProbeobject - 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. 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. -Modifying this array with strategic merge patch may corrupt the data. -For more information See https://github.com/kubernetes/kubernetes/issues/108255. -Cannot be updated.
- 		false
readinessProbeobject - 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
resizePolicy[]object - Resources resize policy for the container.
- 		false
resourcesobject - Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
restartPolicystring - RestartPolicy defines the restart behavior of individual containers in a pod. -This field may only be set for init containers, and the only allowed value is "Always". -For non-init containers or when this field is not specified, -the restart behavior is defined by the Pod's restart policy and the container type. -Setting the RestartPolicy as "Always" for the init container will have the following effect: -this init container will be continually restarted on -exit until all regular containers have terminated. Once all regular -containers have completed, all init containers with restartPolicy "Always" -will be shut down. This lifecycle differs from normal init containers and -is often referred to as a "sidecar" container. Although this init -container still starts in the init container sequence, it does not wait -for the container to complete before proceeding to the next init -container. Instead, the next init container starts immediately after this -init container is started, or after any startupProbe has successfully -completed.
- 		false
securityContextobject - 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
startupProbeobject - 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
stdinboolean - 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
stdinOnceboolean - 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
terminationMessagePathstring - 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
terminationMessagePolicystring - 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
ttyboolean - 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
workingDirstring - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindex-1) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.configMapKeyRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom-1) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.fieldRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom-1) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.secretKeyRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom-1) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index].configMapRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvfromindex-1) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index].secretRef -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvfromindex-1) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -Actions that the management system should take in response to container lifecycle events. -Cannot be updated. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
postStartobject - 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
preStopobject - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycle-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststarthttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.sleep -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart-1) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycle-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestophttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.sleep -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop-1) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.grpc -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe-1) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobehttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe-1) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].ports[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -ContainerPort represents a network port in a single container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
containerPortinteger - Number of port to expose on the pod's IP address. -This must be a valid port number, 0 < x < 65536.
-
- Format: int32
- 		true
hostIPstring - What host IP to bind the external port to.
- 		false
hostPortinteger - 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
namestring - 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
protocolstring - Protocol for port. Must be UDP, TCP, or SCTP. -Defaults to "TCP".
-
- Default: TCP
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.grpc -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe-1) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobehttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe-1) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].resizePolicy[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -ContainerResizePolicy represents resource resize policy for the container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourceNamestring - Name of the resource to which this resource resize policy applies. -Supported values: cpu, memory.
- 		true
restartPolicystring - Restart policy to apply when specified resource is resized. -If not specified, it defaults to NotRequired.
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].resources -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].resources.claims[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexresources-1) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -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/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.capabilities -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.exec -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.grpc -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe-1) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobehttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe-1) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.additionalContainers[index].volumeDevices[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -volumeDevice describes a mapping of a raw block device within a container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
devicePathstring - devicePath is the path inside of the container that the device will be mapped to.
- 		true
namestring - name must match the name of a persistentVolumeClaim in the pod
- 		true
- - -### OpenTelemetryCollector.spec.additionalContainers[index].volumeMounts[index] -[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### OpenTelemetryCollector.spec.affinity -[↩ Parent](#opentelemetrycollectorspec-1) - - - -If specified, indicates the pod's scheduling constraints - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeAffinityobject - Describes node affinity scheduling rules for the pod.
- 		false
podAffinityobject - Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- 		false
podAntiAffinityobject - Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- 		false
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity -[↩ Parent](#opentelemetrycollectorspecaffinity-1) - - - -Describes node affinity scheduling rules for the pod. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject - 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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinity-1) - - - -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). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
preferenceobject - A node selector term, associated with the corresponding weight.
- 		true
weightinteger - Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex-1) - - - -A node selector term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference-1) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference-1) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinity-1) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeSelectorTerms[]object - Required. A list of node selector terms. The terms are ORed.
- 		true
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecution-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex-1) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] -[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex-1) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity -[↩ Parent](#opentelemetrycollectorspecaffinity-1) - - - -Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinity-1) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex-1) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinity-1) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex-1) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity -[↩ Parent](#opentelemetrycollectorspecaffinity-1) - - - -Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinity-1) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex-1) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinity-1) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex-1) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.autoscaler -[↩ Parent](#opentelemetrycollectorspec-1) - - - -Autoscaler specifies the pod autoscaling configuration to use -for the workload. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
behaviorobject - HorizontalPodAutoscalerBehavior configures the scaling behavior of the target -in both Up and Down directions (scaleUp and scaleDown fields respectively).
- 		false
maxReplicasinteger - MaxReplicas sets an upper bound to the autoscaling feature. If MaxReplicas is set autoscaling is enabled.
-
- Format: int32
- 		false
metrics[]object - Metrics is meant to provide a customizable way to configure HPA metrics. -currently the only supported custom metrics is type=Pod. -Use TargetCPUUtilization or TargetMemoryUtilization instead if scaling on these common resource metrics.
- 		false
minReplicasinteger - MinReplicas sets a lower bound to the autoscaling feature. Set this if your are using autoscaling. It must be at least 1
-
- Format: int32
- 		false
targetCPUUtilizationinteger - TargetCPUUtilization sets the target average CPU used across all replicas. -If average CPU exceeds this value, the HPA will scale up. Defaults to 90 percent.
-
- Format: int32
- 		false
targetMemoryUtilizationinteger - TargetMemoryUtilization sets the target average memory utilization across all replicas
-
- Format: int32
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.behavior -[↩ Parent](#opentelemetrycollectorspecautoscaler-1) - - - -HorizontalPodAutoscalerBehavior configures the scaling behavior of the target -in both Up and Down directions (scaleUp and scaleDown fields respectively). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
scaleDownobject - scaleDown is scaling policy for scaling Down. -If not set, the default value is to allow to scale down to minReplicas pods, with a -300 second stabilization window (i.e., the highest recommendation for -the last 300sec is used).
- 		false
scaleUpobject - scaleUp is scaling policy for scaling Up. -If not set, the default value is the higher of: - * increase no more than 4 pods per 60 seconds - * double the number of pods per 60 seconds -No stabilization is used.
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.behavior.scaleDown -[↩ Parent](#opentelemetrycollectorspecautoscalerbehavior-1) - - - -scaleDown is scaling policy for scaling Down. -If not set, the default value is to allow to scale down to minReplicas pods, with a -300 second stabilization window (i.e., the highest recommendation for -the last 300sec is used). - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
policies[]object - policies is a list of potential scaling polices which can be used during scaling. -At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- 		false
selectPolicystring - selectPolicy is used to specify which policy should be used. -If not set, the default value Max is used.
- 		false
stabilizationWindowSecondsinteger - stabilizationWindowSeconds is the number of seconds for which past recommendations should be -considered while scaling up or scaling down. -StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). -If not set, use the default values: -- For scale up: 0 (i.e. no stabilization is done). -- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
-
- Format: int32
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.behavior.scaleDown.policies[index] -[↩ Parent](#opentelemetrycollectorspecautoscalerbehaviorscaledown-1) - - - -HPAScalingPolicy is a single policy which must hold true for a specified past interval. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
periodSecondsinteger - periodSeconds specifies the window of time for which the policy should hold true. -PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
-
- Format: int32
- 		true
typestring - type is used to specify the scaling policy.
- 		true
valueinteger - value contains the amount of change which is permitted by the policy. -It must be greater than zero
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.autoscaler.behavior.scaleUp -[↩ Parent](#opentelemetrycollectorspecautoscalerbehavior-1) - - - -scaleUp is scaling policy for scaling Up. -If not set, the default value is the higher of: - * increase no more than 4 pods per 60 seconds - * double the number of pods per 60 seconds -No stabilization is used. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
policies[]object - policies is a list of potential scaling polices which can be used during scaling. -At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
- 		false
selectPolicystring - selectPolicy is used to specify which policy should be used. -If not set, the default value Max is used.
- 		false
stabilizationWindowSecondsinteger - stabilizationWindowSeconds is the number of seconds for which past recommendations should be -considered while scaling up or scaling down. -StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). -If not set, use the default values: -- For scale up: 0 (i.e. no stabilization is done). -- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
-
- Format: int32
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.behavior.scaleUp.policies[index] -[↩ Parent](#opentelemetrycollectorspecautoscalerbehaviorscaleup-1) - - - -HPAScalingPolicy is a single policy which must hold true for a specified past interval. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
periodSecondsinteger - periodSeconds specifies the window of time for which the policy should hold true. -PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
-
- Format: int32
- 		true
typestring - type is used to specify the scaling policy.
- 		true
valueinteger - value contains the amount of change which is permitted by the policy. -It must be greater than zero
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index] -[↩ Parent](#opentelemetrycollectorspecautoscaler-1) - - - -MetricSpec defines a subset of metrics to be defined for the HPA's metric array -more metric type can be supported as needed. -See https://pkg.go.dev/k8s.io/api/autoscaling/v2#MetricSpec for reference. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - MetricSourceType indicates the type of metric.
- 		true
podsobject - PodsMetricSource indicates how to scale on a metric describing each pod in -the current scale target (for example, transactions-processed-per-second). -The values will be averaged together before being compared to the target -value.
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindex-1) - - - -PodsMetricSource indicates how to scale on a metric describing each pod in -the current scale target (for example, transactions-processed-per-second). -The values will be averaged together before being compared to the target -value. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
metricobject - metric identifies the target metric by name and selector
- 		true
targetobject - target specifies the target value for the given metric
- 		true
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpods-1) - - - -metric identifies the target metric by name and selector - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - name is the name of the given metric
- 		true
selectorobject - selector is the string-encoded form of a standard kubernetes label selector for the given metric -When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. -When unset, just the metricName will be used to gather metrics.
- 		false
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric.selector -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpodsmetric-1) - - - -selector is the string-encoded form of a standard kubernetes label selector for the given metric -When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. -When unset, just the metricName will be used to gather metrics. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric.selector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpodsmetricselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.target -[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpods-1) - - - -target specifies the target value for the given metric - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type represents whether the metric type is Utilization, Value, or AverageValue
- 		true
averageUtilizationinteger - averageUtilization is the target value of the average of the -resource metric across all relevant pods, represented as a percentage of -the requested value of the resource for the pods. -Currently only valid for Resource metric source type
-
- Format: int32
- 		false
averageValueint or string - averageValue is the target value of the average of the -metric across all relevant pods (as a quantity)
- 		false
valueint or string - value is the target value of the metric (as a quantity).
- 		false
- - -### OpenTelemetryCollector.spec.configmaps[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountpathstring -
- 		true
namestring - Configmap defines name and path where the configMaps should be mounted.
- 		true
- - -### OpenTelemetryCollector.spec.daemonSetUpdateStrategy -[↩ Parent](#opentelemetrycollectorspec-1) - - - -UpdateStrategy represents the strategy the operator will take replacing existing DaemonSet pods with new pods -https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/daemon-set-v1/#DaemonSetSpec -This is only applicable to Daemonset mode. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
rollingUpdateobject - Rolling update config params. Present only if type = "RollingUpdate".
- 		false
typestring - Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
- 		false
- - -### OpenTelemetryCollector.spec.daemonSetUpdateStrategy.rollingUpdate -[↩ Parent](#opentelemetrycollectorspecdaemonsetupdatestrategy) - - - -Rolling update config params. Present only if type = "RollingUpdate". - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSurgeint or string - The maximum number of nodes with an existing available DaemonSet pod that -can have an updated DaemonSet pod during during an update. -Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). -This can not be 0 if MaxUnavailable is 0. -Absolute number is calculated from percentage by rounding up to a minimum of 1. -Default value is 0. -Example: when this is set to 30%, at most 30% of the total number of nodes -that should be running the daemon pod (i.e. status.desiredNumberScheduled) -can have their a new pod created before the old pod is marked as deleted. -The update starts by launching new pods on 30% of nodes. Once an updated -pod is available (Ready for at least minReadySeconds) the old DaemonSet pod -on that node is marked deleted. If the old pod becomes unavailable for any -reason (Ready transitions to false, is evicted, or is drained) an updated -pod is immediatedly created on that node without considering surge limits.
- 		false
maxUnavailableint or string - The maximum number of DaemonSet pods that can be unavailable during the -update. Value can be an absolute number (ex: 5) or a percentage of total -number of DaemonSet pods at the start of the update (ex: 10%). Absolute -number is calculated from percentage by rounding up. -This cannot be 0 if MaxSurge is 0 -Default value is 1. -Example: when this is set to 30%, at most 30% of the total number of nodes -that should be running the daemon pod (i.e. status.desiredNumberScheduled) -can have their pods stopped for an update at any given time. The update -starts by stopping at most 30% of those DaemonSet pods and then brings -up new DaemonSet pods in their place. Once the new pods are available, -it then proceeds onto other DaemonSet pods, thus ensuring that at least -70% of original number of DaemonSet pods are available at all times during -the update.
- 		false
- - -### OpenTelemetryCollector.spec.deploymentUpdateStrategy -[↩ Parent](#opentelemetrycollectorspec-1) - - - -UpdateStrategy represents the strategy the operator will take replacing existing Deployment pods with new pods -https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/#DeploymentSpec -This is only applicable to Deployment mode. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
rollingUpdateobject - Rolling update config params. Present only if DeploymentStrategyType = -RollingUpdate.
- 		false
typestring - Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
- 		false
- - -### OpenTelemetryCollector.spec.deploymentUpdateStrategy.rollingUpdate -[↩ Parent](#opentelemetrycollectorspecdeploymentupdatestrategy-1) - - - -Rolling update config params. Present only if DeploymentStrategyType = -RollingUpdate. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSurgeint or string - The maximum number of pods that can be scheduled above the desired number of -pods. -Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). -This can not be 0 if MaxUnavailable is 0. -Absolute number is calculated from percentage by rounding up. -Defaults to 25%. -Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when -the rolling update starts, such that the total number of old and new pods do not exceed -130% of desired pods. Once old pods have been killed, -new ReplicaSet can be scaled up further, ensuring that total number of pods running -at any time during the update is at most 130% of desired pods.
- 		false
maxUnavailableint or string - The maximum number of pods that can be unavailable during the update. -Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). -Absolute number is calculated from percentage by rounding down. -This can not be 0 if MaxSurge is 0. -Defaults to 25%. -Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods -immediately when the rolling update starts. Once new pods are ready, old ReplicaSet -can be scaled down further, followed by scaling up the new ReplicaSet, ensuring -that the total number of pods available at all times during the update is at -least 70% of desired pods.
- 		false
- - -### OpenTelemetryCollector.spec.env[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom -[↩ Parent](#opentelemetrycollectorspecenvindex-1) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom.configMapKeyRef -[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom-1) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom.fieldRef -[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom-1) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom.resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.env[index].valueFrom.secretKeyRef -[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom-1) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.envFrom[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### OpenTelemetryCollector.spec.envFrom[index].configMapRef -[↩ Parent](#opentelemetrycollectorspecenvfromindex-1) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### OpenTelemetryCollector.spec.envFrom[index].secretRef -[↩ Parent](#opentelemetrycollectorspecenvfromindex-1) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### OpenTelemetryCollector.spec.ingress -[↩ Parent](#opentelemetrycollectorspec-1) - - - -Ingress is used to specify how OpenTelemetry Collector is exposed. This -functionality is only available if one of the valid modes is set. -Valid modes are: deployment, daemonset and statefulset. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string - Annotations to add to ingress. -e.g. 'cert-manager.io/cluster-issuer: "letsencrypt"'
- 		false
hostnamestring - Hostname by which the ingress proxy can be reached.
- 		false
ingressClassNamestring - IngressClassName is the name of an IngressClass cluster resource. Ingress -controller implementations use this field to know whether they should be -serving this Ingress resource.
- 		false
routeobject - Route is an OpenShift specific section that is only considered when -type "route" is used.
- 		false
ruleTypeenum - RuleType defines how Ingress exposes collector receivers. -IngressRuleTypePath ("path") exposes each receiver port on a unique path on single domain defined in Hostname. -IngressRuleTypeSubdomain ("subdomain") exposes each receiver port on a unique subdomain of Hostname. -Default is IngressRuleTypePath ("path").
-
- Enum: path, subdomain
- 		false
tls[]object - TLS configuration.
- 		false
typeenum - Type default value is: "" -Supported types are: ingress, route
-
- Enum: ingress, route
- 		false
- - -### OpenTelemetryCollector.spec.ingress.route -[↩ Parent](#opentelemetrycollectorspecingress-1) - - - -Route is an OpenShift specific section that is only considered when -type "route" is used. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
terminationenum - Termination indicates termination type. By default "edge" is used.
-
- Enum: insecure, edge, passthrough, reencrypt
- 		false
- - -### OpenTelemetryCollector.spec.ingress.tls[index] -[↩ Parent](#opentelemetrycollectorspecingress-1) - - - -IngressTLS describes the transport layer security associated with an ingress. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
hosts[]string - hosts is a list of hosts included in the TLS certificate. The values in -this list must match the name/s used in the tlsSecret. Defaults to the -wildcard host setting for the loadbalancer controller fulfilling this -Ingress, if left unspecified.
- 		false
secretNamestring - secretName is the name of the secret used to terminate TLS traffic on -port 443. Field is left optional to allow TLS routing based on SNI -hostname alone. If the SNI host in a listener conflicts with the "Host" -header field used by an IngressRule, the SNI host is used for termination -and value of the "Host" header is used for routing.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -A single application container that you want to run within a pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - 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 container 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 container 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
imagestring - Container 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
imagePullPolicystring - 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
lifecycleobject - Actions that the management system should take in response to container lifecycle events. -Cannot be updated.
- 		false
livenessProbeobject - 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. 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. -Modifying this array with strategic merge patch may corrupt the data. -For more information See https://github.com/kubernetes/kubernetes/issues/108255. -Cannot be updated.
- 		false
readinessProbeobject - 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
resizePolicy[]object - Resources resize policy for the container.
- 		false
resourcesobject - Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
restartPolicystring - RestartPolicy defines the restart behavior of individual containers in a pod. -This field may only be set for init containers, and the only allowed value is "Always". -For non-init containers or when this field is not specified, -the restart behavior is defined by the Pod's restart policy and the container type. -Setting the RestartPolicy as "Always" for the init container will have the following effect: -this init container will be continually restarted on -exit until all regular containers have terminated. Once all regular -containers have completed, all init containers with restartPolicy "Always" -will be shut down. This lifecycle differs from normal init containers and -is often referred to as a "sidecar" container. Although this init -container still starts in the init container sequence, it does not wait -for the container to complete before proceeding to the next init -container. Instead, the next init container starts immediately after this -init container is started, or after any startupProbe has successfully -completed.
- 		false
securityContextobject - 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
startupProbeobject - 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
stdinboolean - 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
stdinOnceboolean - 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
terminationMessagePathstring - 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
terminationMessagePolicystring - 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
ttyboolean - 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
workingDirstring - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindex-1) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.configMapKeyRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom-1) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.fieldRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom-1) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.secretKeyRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom-1) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].envFrom[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -EnvFromSource represents the source of a set of ConfigMaps - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapRefobject - The ConfigMap to select from
- 		false
prefixstring - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
- 		false
secretRefobject - The Secret to select from
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].envFrom[index].configMapRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvfromindex-1) - - - -The ConfigMap to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap must be defined
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].envFrom[index].secretRef -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvfromindex-1) - - - -The Secret to select from - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret must be defined
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -Actions that the management system should take in response to container lifecycle events. -Cannot be updated. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
postStartobject - 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
preStopobject - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycle-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststarthttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.sleep -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart-1) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycle-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestophttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.sleep -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop-1) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.grpc -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe-1) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobehttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe-1) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].ports[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -ContainerPort represents a network port in a single container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
containerPortinteger - Number of port to expose on the pod's IP address. -This must be a valid port number, 0 < x < 65536.
-
- Format: int32
- 		true
hostIPstring - What host IP to bind the external port to.
- 		false
hostPortinteger - 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
namestring - 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
protocolstring - Protocol for port. Must be UDP, TCP, or SCTP. -Defaults to "TCP".
-
- Default: TCP
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.grpc -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe-1) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobehttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe-1) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].resizePolicy[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -ContainerResizePolicy represents resource resize policy for the container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourceNamestring - Name of the resource to which this resource resize policy applies. -Supported values: cpu, memory.
- 		true
restartPolicystring - Restart policy to apply when specified resource is resized. -If not specified, it defaults to NotRequired.
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].resources -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -Compute Resources required by this container. -Cannot be updated. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].resources.claims[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexresources-1) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -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/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.capabilities -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].securityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
grpcobject - GRPC specifies an action involving a GRPC port.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
initialDelaySecondsinteger - 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
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
tcpSocketobject - TCPSocket specifies an action involving a TCP port.
- 		false
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.exec -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.grpc -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe-1) - - - -GRPC specifies an action involving a GRPC port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - Port number of the gRPC service. Number must be in the range 1 to 65535.
-
- Format: int32
- 		true
servicestring - 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.
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.httpGet -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobehttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].startupProbe.tcpSocket -[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe-1) - - - -TCPSocket specifies an action involving a TCP port. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.initContainers[index].volumeDevices[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -volumeDevice describes a mapping of a raw block device within a container. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
devicePathstring - devicePath is the path inside of the container that the device will be mapped to.
- 		true
namestring - name must match the name of a persistentVolumeClaim in the pod
- 		true
- - -### OpenTelemetryCollector.spec.initContainers[index].volumeMounts[index] -[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### OpenTelemetryCollector.spec.lifecycle -[↩ Parent](#opentelemetrycollectorspec-1) - - - -Actions that the management system should take in response to container lifecycle events. Cannot be updated. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
postStartobject - 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
preStopobject - 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
- - -### OpenTelemetryCollector.spec.lifecycle.postStart -[↩ Parent](#opentelemetrycollectorspeclifecycle-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.exec -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.httpGet -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststarthttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.sleep -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart-1) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.lifecycle.postStart.tcpSocket -[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.lifecycle.preStop -[↩ Parent](#opentelemetrycollectorspeclifecycle-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
execobject - Exec specifies the action to take.
- 		false
httpGetobject - HTTPGet specifies the http request to perform.
- 		false
sleepobject - Sleep represents the duration that the container should sleep before being terminated.
- 		false
tcpSocketobject - 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
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.exec -[↩ Parent](#opentelemetrycollectorspeclifecycleprestop-1) - - - -Exec specifies the action to take. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.httpGet -[↩ Parent](#opentelemetrycollectorspeclifecycleprestop-1) - - - -HTTPGet specifies the http request to perform. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - 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
pathstring - Path to access on the HTTP server.
- 		false
schemestring - Scheme to use for connecting to the host. -Defaults to HTTP.
- 		false
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.httpGet.httpHeaders[index] -[↩ Parent](#opentelemetrycollectorspeclifecycleprestophttpget-1) - - - -HTTPHeader describes a custom header to be used in HTTP probes - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - The header field name. -This will be canonicalized upon output, so case-variant names will be understood as the same header.
- 		true
valuestring - The header field value
- 		true
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.sleep -[↩ Parent](#opentelemetrycollectorspeclifecycleprestop-1) - - - -Sleep represents the duration that the container should sleep before being terminated. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secondsinteger - Seconds is the number of seconds to sleep.
-
- Format: int64
- 		true
- - -### OpenTelemetryCollector.spec.lifecycle.preStop.tcpSocket -[↩ Parent](#opentelemetrycollectorspeclifecycleprestop-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portint 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
hoststring - Optional: Host name to connect to, defaults to the pod IP.
- 		false
- - -### OpenTelemetryCollector.spec.livenessProbe -[↩ Parent](#opentelemetrycollectorspec-1) - - - -Liveness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. -It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
initialDelaySecondsinteger - Number of seconds after the container has started before liveness probes are initiated. -Defaults to 0 seconds. Minimum value is 0. -More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
-
- Format: int32
- 		false
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.observability -[↩ Parent](#opentelemetrycollectorspec-1) - - - -ObservabilitySpec defines how telemetry data gets handled. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
metricsobject - Metrics defines the metrics configuration for operands.
- 		false
- - -### OpenTelemetryCollector.spec.observability.metrics -[↩ Parent](#opentelemetrycollectorspecobservability-1) - - - -Metrics defines the metrics configuration for operands. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
disablePrometheusAnnotationsboolean - DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations -('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
- 		false
enableMetricsboolean - EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. -The operator.observability.prometheus feature gate must be enabled to use this feature.
- 		false
- - -### OpenTelemetryCollector.spec.persistentVolumeClaimRetentionPolicy -[↩ Parent](#opentelemetrycollectorspec-1) - - - -PersistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims -created from volumeClaimTemplates. -This only works with the following OpenTelemetryCollector modes: statefulset. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
whenDeletedstring - WhenDeleted specifies what happens to PVCs created from StatefulSet -VolumeClaimTemplates when the StatefulSet is deleted. The default policy -of `Retain` causes PVCs to not be affected by StatefulSet deletion. The -`Delete` policy causes those PVCs to be deleted.
- 		false
whenScaledstring - WhenScaled specifies what happens to PVCs created from StatefulSet -VolumeClaimTemplates when the StatefulSet is scaled down. The default -policy of `Retain` causes PVCs to not be affected by a scaledown. The -`Delete` policy causes the associated PVCs for any excess pods above -the replica count to be deleted.
- 		false
- - -### OpenTelemetryCollector.spec.podDisruptionBudget -[↩ Parent](#opentelemetrycollectorspec-1) - - - -PodDisruptionBudget specifies the pod disruption budget configuration to use -for the generated workload. By default, a PDB with a MaxUnavailable of one is set. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxUnavailableint or string - An eviction is allowed if at most "maxUnavailable" pods selected by -"selector" are unavailable after the eviction, i.e. even in absence of -the evicted pod. For example, one can prevent all voluntary evictions -by specifying 0. This is a mutually exclusive setting with "minAvailable".
- 		false
minAvailableint or string - An eviction is allowed if at least "minAvailable" pods selected by -"selector" will still be available after the eviction, i.e. even in the -absence of the evicted pod. So for example you can prevent all voluntary -evictions by specifying "100%".
- 		false
- - -### OpenTelemetryCollector.spec.podDnsConfig -[↩ Parent](#opentelemetrycollectorspec-1) - - - -PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.podDnsConfig.options[index] -[↩ Parent](#opentelemetrycollectorspecpoddnsconfig) - - - -PodDNSConfigOption defines DNS resolver options of a pod. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Required.
- 		false
valuestring -
- 		false
- - -### OpenTelemetryCollector.spec.podSecurityContext -[↩ Parent](#opentelemetrycollectorspec-1) - - - -PodSecurityContext configures the pod security context for the -generated pod, when running as a deployment, daemonset, -or statefulset. - -In sidecar mode, the opentelemetry-operator will ignore this setting. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
appArmorProfileobject - appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows.
- 		false
fsGroupinteger - 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
fsGroupChangePolicystring - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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 and fsGroup (if specified). If -the SupplementalGroupsPolicy feature is enabled, the -supplementalGroupsPolicy field determines whether these are in addition -to or instead of any group memberships defined in the container image. -If unspecified, no additional groups are added, though group memberships -defined in the container image may still be used, depending on the -supplementalGroupsPolicy field. -Note that this field cannot be set when spec.os.name is windows.
- 		false
supplementalGroupsPolicystring - Defines how supplemental groups of the first container processes are calculated. -Valid values are "Merge" and "Strict". If not specified, "Merge" is used. -(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled -and the container runtime must implement support for this feature. -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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.podSecurityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) - - - -appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.podSecurityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.podSecurityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) - - - -The seccomp options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.podSecurityContext.sysctls[index] -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) - - - -Sysctl defines a kernel parameter to be set - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of a property to set
- 		true
valuestring - Value of a property to set
- 		true
- - -### OpenTelemetryCollector.spec.podSecurityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.ports[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -PortsSpec defines the OpenTelemetryCollector's container/service ports additional specifications. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
portinteger - The port that will be exposed by this service.
-
- Format: int32
- 		true
appProtocolstring - The application protocol for this port. -This is used as a hint for implementations to offer richer behavior for protocols that they understand. -This field follows standard Kubernetes label syntax. -Valid values are either: - -* Un-prefixed protocol names - reserved for IANA standard service names (as per -RFC-6335 and https://www.iana.org/assignments/service-names). - -* Kubernetes-defined prefixed names: - * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- - * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 - * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 - -* Other protocols should use implementation-defined prefixed names such as -mycompany.com/my-custom-protocol.
- 		false
hostPortinteger - Allows defining which port to bind to the host in the Container.
-
- Format: int32
- 		false
namestring - The name of this port within the service. This must be a DNS_LABEL. -All ports within a ServiceSpec must have unique names. When considering -the endpoints for a Service, this must match the 'name' field in the -EndpointPort. -Optional if only one ServicePort is defined on this service.
- 		false
nodePortinteger - The port on each node on which this service is exposed when type is -NodePort or LoadBalancer. Usually assigned by the system. If a value is -specified, in-range, and not in use it will be used, otherwise the -operation will fail. If not specified, a port will be allocated if this -Service requires one. If this field is specified when creating a -Service which does not need it, creation will fail. This field will be -wiped when updating a Service to no longer need it (e.g. changing type -from NodePort to ClusterIP). -More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
-
- Format: int32
- 		false
protocolstring - The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". -Default is TCP.
-
- Default: TCP
- 		false
targetPortint or string - Number or name of the port to access on the pods targeted by the service. -Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. -If this is a string, it will be looked up as a named port in the -target Pod's container ports. If this is not specified, the value -of the 'port' field is used (an identity map). -This field is ignored for services with clusterIP=None, and should be -omitted or set equal to the 'port' field. -More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
- 		false
- - -### OpenTelemetryCollector.spec.readinessProbe -[↩ Parent](#opentelemetrycollectorspec-1) - - - -Readiness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. -It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
failureThresholdinteger - Minimum consecutive failures for the probe to be considered failed after having succeeded. -Defaults to 3. Minimum value is 1.
-
- Format: int32
- 		false
initialDelaySecondsinteger - Number of seconds after the container has started before liveness probes are initiated. -Defaults to 0 seconds. Minimum value is 0. -More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
-
- Format: int32
- 		false
periodSecondsinteger - How often (in seconds) to perform the probe. -Default to 10 seconds. Minimum value is 1.
-
- Format: int32
- 		false
successThresholdinteger - 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
terminationGracePeriodSecondsinteger - 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
timeoutSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.resources -[↩ Parent](#opentelemetrycollectorspec-1) - - - -Resources to set on generated pods. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.resources.claims[index] -[↩ Parent](#opentelemetrycollectorspecresources-1) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### OpenTelemetryCollector.spec.securityContext -[↩ Parent](#opentelemetrycollectorspec-1) - - - -SecurityContext configures the container security context for -the generated main container. - -In deployment, daemonset, or statefulset mode, this controls -the security context settings for the primary application -container. - -In sidecar mode, this controls the security context for the -injected sidecar container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.securityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.securityContext.capabilities -[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### OpenTelemetryCollector.spec.securityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.securityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.securityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator -[↩ Parent](#opentelemetrycollectorspec-1) - - - -TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
affinityobject - If specified, indicates the pod's scheduling constraints
- 		false
allocationStrategyenum - AllocationStrategy determines which strategy the target allocator should use for allocation. -The current options are least-weighted, consistent-hashing and per-node. The default is -consistent-hashing. -WARNING: The per-node strategy currently ignores targets without a Node, like control plane components.
-
- Enum: least-weighted, consistent-hashing, per-node
- Default: consistent-hashing
- 		false
enabledboolean - Enabled indicates whether to use a target allocation mechanism for Prometheus targets or not.
- 		false
env[]object - ENV vars to set on the OpenTelemetry TargetAllocator's Pods. These can then in certain cases be -consumed in the config file for the TargetAllocator.
- 		false
filterStrategyenum - FilterStrategy determines how to filter targets before allocating them among the collectors. -The only current option is relabel-config (drops targets based on prom relabel_config). -The default is relabel-config.
-
- Enum: , relabel-config
- Default: relabel-config
- 		false
imagestring - Image indicates the container image to use for the OpenTelemetry TargetAllocator.
- 		false
nodeSelectormap[string]string - NodeSelector to schedule OpenTelemetry TargetAllocator pods.
- 		false
observabilityobject - ObservabilitySpec defines how telemetry data gets handled.
- 		false
podDisruptionBudgetobject - PodDisruptionBudget specifies the pod disruption budget configuration to use -for the target allocator workload. By default, a PDB with a MaxUnavailable of one is set for a valid -allocation strategy.
- 		false
podSecurityContextobject - PodSecurityContext configures the pod security context for the -targetallocator.
- 		false
prometheusCRobject - PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ) retrieval. -All CR instances which the ServiceAccount has access to will be retrieved. This includes other namespaces.
- 		false
replicasinteger - Replicas is the number of pod instances for the underlying TargetAllocator. This should only be set to a value -other than 1 if a strategy that allows for high availability is chosen. Currently, the only allocation strategy -that can be run in a high availability mode is consistent-hashing.
-
- Format: int32
- 		false
resourcesobject - Resources to set on the OpenTelemetryTargetAllocator containers.
- 		false
securityContextobject - SecurityContext configures the container security context for -the targetallocator.
- 		false
serviceAccountstring - ServiceAccount indicates the name of an existing service account to use with this instance. When set, -the operator will not automatically create a ServiceAccount for the TargetAllocator.
- 		false
tolerations[]object - Toleration embedded kubernetes pod configuration option, -controls how pods can be scheduled with matching taints
- 		false
topologySpreadConstraints[]object - TopologySpreadConstraints embedded kubernetes pod configuration option, -controls how pods are spread across your cluster among failure-domains -such as regions, zones, nodes, and other user-defined topology domains -https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -If specified, indicates the pod's scheduling constraints - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeAffinityobject - Describes node affinity scheduling rules for the pod.
- 		false
podAffinityobject - Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
- 		false
podAntiAffinityobject - Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity-1) - - - -Describes node affinity scheduling rules for the pod. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinity-1) - - - -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). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
preferenceobject - A node selector term, associated with the corresponding weight.
- 		true
weightinteger - Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex-1) - - - -A node selector term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference-1) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference-1) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinity-1) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
nodeSelectorTerms[]object - Required. A list of node selector terms. The terms are ORed.
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecution-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex-1) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex-1) - - - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity-1) - - - -Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinity-1) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex-1) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinity-1) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex-1) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity-1) - - - -Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinity-1) - - - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
podAffinityTermobject - Required. A pod affinity term, associated with the corresponding weight.
- 		true
weightinteger - weight associated with matching the corresponding podAffinityTerm, -in the range 1-100.
-
- Format: int32
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex-1) - - - -Required. A pod affinity term, associated with the corresponding weight. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinity-1) - - - -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 matches that of any node on which -a pod of the set of pods is running - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
topologyKeystring - 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
labelSelectorobject - A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods.
- 		false
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both matchLabelKeys and labelSelector. -Also, matchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
mismatchLabelKeys[]string - MismatchLabelKeys is a set of pod label keys to select which pods will -be taken into consideration. The keys are used to lookup values from the -incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` -to select the group of existing pods which pods will be taken into consideration -for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming -pod labels will be ignored. The default value is empty. -The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. -Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
- 		false
namespaceSelectorobject - 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.
- 		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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex-1) - - - -A label query over a set of resources, in this case pods. -If it's null, this PodAffinityTerm matches with no Pods. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index] -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -EnvVar represents an environment variable present in a Container. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the environment variable. Must be a C_IDENTIFIER.
- 		true
valuestring - 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
valueFromobject - Source for the environment variable's value. Cannot be used if value is not empty.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindex-1) - - - -Source for the environment variable's value. Cannot be used if value is not empty. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
configMapKeyRefobject - Selects a key of a ConfigMap.
- 		false
fieldRefobject - Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
- 		false
resourceFieldRefobject - 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
secretKeyRefobject - Selects a key of a secret in the pod's namespace
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.configMapKeyRef -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom-1) - - - -Selects a key of a ConfigMap. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key to select.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the ConfigMap or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.fieldRef -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom-1) - - - -Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, -spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.resourceFieldRef -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.secretKeyRef -[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom-1) - - - -Selects a key of a secret in the pod's namespace - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - The key of the secret to select from. Must be a valid secret key.
- 		true
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - Specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.observability -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -ObservabilitySpec defines how telemetry data gets handled. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
metricsobject - Metrics defines the metrics configuration for operands.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.observability.metrics -[↩ Parent](#opentelemetrycollectorspectargetallocatorobservability-1) - - - -Metrics defines the metrics configuration for operands. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
disablePrometheusAnnotationsboolean - DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations -('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
- 		false
enableMetricsboolean - EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. -The operator.observability.prometheus feature gate must be enabled to use this feature.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podDisruptionBudget -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -PodDisruptionBudget specifies the pod disruption budget configuration to use -for the target allocator workload. By default, a PDB with a MaxUnavailable of one is set for a valid -allocation strategy. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxUnavailableint or string - An eviction is allowed if at most "maxUnavailable" pods selected by -"selector" are unavailable after the eviction, i.e. even in absence of -the evicted pod. For example, one can prevent all voluntary evictions -by specifying 0. This is a mutually exclusive setting with "minAvailable".
- 		false
minAvailableint or string - An eviction is allowed if at least "minAvailable" pods selected by -"selector" will still be available after the eviction, i.e. even in the -absence of the evicted pod. So for example you can prevent all voluntary -evictions by specifying "100%".
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -PodSecurityContext configures the pod security context for the -targetallocator. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
appArmorProfileobject - appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows.
- 		false
fsGroupinteger - 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
fsGroupChangePolicystring - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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 and fsGroup (if specified). If -the SupplementalGroupsPolicy feature is enabled, the -supplementalGroupsPolicy field determines whether these are in addition -to or instead of any group memberships defined in the container image. -If unspecified, no additional groups are added, though group memberships -defined in the container image may still be used, depending on the -supplementalGroupsPolicy field. -Note that this field cannot be set when spec.os.name is windows.
- 		false
supplementalGroupsPolicystring - Defines how supplemental groups of the first container processes are calculated. -Valid values are "Merge" and "Strict". If not specified, "Merge" is used. -(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled -and the container runtime must implement support for this feature. -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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) - - - -appArmorProfile is the AppArmor options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) - - - -The seccomp options to use by the containers in this pod. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.sysctls[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) - - - -Sysctl defines a kernel parameter to be set - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of a property to set
- 		true
valuestring - Value of a property to set
- 		true
- - -### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ) retrieval. -All CR instances which the ServiceAccount has access to will be retrieved. This includes other namespaces. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
enabledboolean - Enabled indicates whether to use a PrometheusOperator custom resources as targets or not.
- 		false
podMonitorSelectorobject - PodMonitors to be selected for target discovery. -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
probeSelectorobject - Probes to be selected for target discovery. -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
scrapeConfigSelectorobject - ScrapeConfigs to be selected for target discovery. -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
scrapeIntervalstring - Default interval between consecutive scrapes. Intervals set in ServiceMonitors and PodMonitors override it. -Equivalent to the same setting on the Prometheus CR. - -Default: "30s"
-
- Format: duration
- Default: 30s
- 		false
serviceMonitorSelectorobject - ServiceMonitors to be selected for target discovery. -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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.podMonitorSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscr-1) - - - -PodMonitors to be selected for target discovery. -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.podMonitorSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscrpodmonitorselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.probeSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscr-1) - - - -Probes to be selected for target discovery. -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.probeSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscrprobeselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.scrapeConfigSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscr-1) - - - -ScrapeConfigs to be selected for target discovery. -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.scrapeConfigSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscrscrapeconfigselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.serviceMonitorSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscr-1) - - - -ServiceMonitors to be selected for target discovery. -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.serviceMonitorSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscrservicemonitorselector) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.resources -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -Resources to set on the OpenTelemetryTargetAllocator containers. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claims[]object - Claims lists the names of resources, defined in spec.resourceClaims, -that are used by this container. - -This is an alpha field and requires enabling the -DynamicResourceAllocation feature gate. - -This field is immutable. It can only be set for containers.
- 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.resources.claims[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatorresources-1) - - - -ResourceClaim references one entry in PodSpec.ResourceClaims. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name must match the name of one entry in pod.spec.resourceClaims of -the Pod where this field is used. It makes that resource available -inside a container.
- 		true
requeststring - Request is the name chosen for a request in the referenced claim. -If empty, everything from the claim is made available, otherwise -only the result of this request.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -SecurityContext configures the container security context for -the targetallocator. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean - 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
appArmorProfileobject - appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows.
- 		false
capabilitiesobject - 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
privilegedboolean - 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
procMountstring - procMount denotes the type of proc mount to use for the containers. -The default value is Default 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
readOnlyRootFilesystemboolean - 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
runAsGroupinteger - 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
runAsNonRootboolean - 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
runAsUserinteger - 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
seLinuxOptionsobject - 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
seccompProfileobject - 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
windowsOptionsobject - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.appArmorProfile -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) - - - -appArmorProfile is the AppArmor options to use by this container. If set, this profile -overrides the pod's appArmorProfile. -Note that this field cannot be set when spec.os.name is windows. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - type indicates which kind of AppArmor profile will be applied. -Valid options are: - Localhost - a profile pre-loaded on the node. - RuntimeDefault - the container runtime's default profile. - Unconfined - no AppArmor enforcement.
- 		true
localhostProfilestring - localhostProfile indicates a profile loaded on the node that should be used. -The profile must be preconfigured on the node to work. -Must match the loaded name of the profile. -Must be set if and only if type is "Localhost".
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.capabilities -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
add[]string - Added capabilities
- 		false
drop[]string - Removed capabilities
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.seLinuxOptions -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
levelstring - Level is SELinux level label that applies to the container.
- 		false
rolestring - Role is a SELinux role label that applies to the container.
- 		false
typestring - Type is a SELinux type label that applies to the container.
- 		false
userstring - User is a SELinux user label that applies to the container.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.seccompProfile -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
typestring - 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
localhostProfilestring - 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 be set if type is "Localhost". Must NOT be set for any other type.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.securityContext.windowsOptions -[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gmsaCredentialSpecstring - 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
gmsaCredentialSpecNamestring - GMSACredentialSpecName is the name of the GMSA credential spec to use.
- 		false
hostProcessboolean - HostProcess determines if a container should be run as a 'Host Process' container. -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
runAsUserNamestring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.tolerations[index] -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -The pod this Toleration is attached to tolerates any taint that matches -the triple using the matching operator . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
effectstring - Effect indicates the taint effect to match. Empty means match all taint effects. -When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- 		false
keystring - 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
operatorstring - 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
tolerationSecondsinteger - 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
valuestring - 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
- - -### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index] -[↩ Parent](#opentelemetrycollectorspectargetallocator-1) - - - -TopologySpreadConstraint specifies how to spread matching pods among the given topology. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSkewinteger - 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. -The global minimum is the minimum number of matching pods in an eligible domain -or zero if the number of eligible domains is less than MinDomains. -For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same -labelSelector spread as 2/2/1: -In this case, the global minimum is 1. -| zone1 | zone2 | zone3 | -| P P | P P | P | -- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; -scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring - 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 as a "bucket", and try to put balanced number -of pods into each bucket. -We define a domain as a particular instance of a topology. -Also, we define an eligible domain as a domain whose nodes meet the requirements of -nodeAffinityPolicy and nodeTaintsPolicy. -e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. -And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. -It's a required field.
- 		true
whenUnsatisfiablestring - 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
labelSelectorobject - 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
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select the pods over which -spreading will be calculated. The keys are used to lookup values from the -incoming pod labels, those key-value labels are ANDed with labelSelector -to select the group of existing pods over which spreading will be calculated -for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. -MatchLabelKeys cannot be set when LabelSelector isn't set. -Keys that don't exist in the incoming pod labels will -be ignored. A null or empty list means only match against labelSelector. - -This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- 		false
minDomainsinteger - MinDomains indicates a minimum number of eligible domains. -When the number of eligible domains with matching topology keys is less than minDomains, -Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. -And when the number of eligible domains with matching topology keys equals or greater than minDomains, -this value has no effect on scheduling. -As a result, when the number of eligible domains is less than minDomains, -scheduler won't schedule more than maxSkew Pods to those domains. -If value is nil, the constraint behaves as if MinDomains is equal to 1. -Valid values are integers greater than 0. -When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - -For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same -labelSelector spread as 2/2/2: -| zone1 | zone2 | zone3 | -| P P | P P | P P | -The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. -In this situation, new pod with the same labelSelector cannot be scheduled, -because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, -it will violate MaxSkew.
-
- Format: int32
- 		false
nodeAffinityPolicystring - NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector -when calculating pod topology spread skew. Options are: -- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. -- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. - -If this value is nil, the behavior is equivalent to the Honor policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
nodeTaintsPolicystring - NodeTaintsPolicy indicates how we will treat node taints when calculating -pod topology spread skew. Options are: -- Honor: nodes without taints, along with tainted nodes for which the incoming pod -has a toleration, are included. -- Ignore: node taints are ignored. All nodes are included. - -If this value is nil, the behavior is equivalent to the Ignore policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
- - -### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index].labelSelector -[↩ Parent](#opentelemetrycollectorspectargetallocatortopologyspreadconstraintsindex-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectargetallocatortopologyspreadconstraintsindexlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.tolerations[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -The pod this Toleration is attached to tolerates any taint that matches -the triple using the matching operator . - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
effectstring - Effect indicates the taint effect to match. Empty means match all taint effects. -When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
- 		false
keystring - 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
operatorstring - 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
tolerationSecondsinteger - 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
valuestring - 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
- - -### OpenTelemetryCollector.spec.topologySpreadConstraints[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -TopologySpreadConstraint specifies how to spread matching pods among the given topology. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
maxSkewinteger - 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. -The global minimum is the minimum number of matching pods in an eligible domain -or zero if the number of eligible domains is less than MinDomains. -For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same -labelSelector spread as 2/2/1: -In this case, the global minimum is 1. -| zone1 | zone2 | zone3 | -| P P | P P | P | -- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; -scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring - 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 as a "bucket", and try to put balanced number -of pods into each bucket. -We define a domain as a particular instance of a topology. -Also, we define an eligible domain as a domain whose nodes meet the requirements of -nodeAffinityPolicy and nodeTaintsPolicy. -e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. -And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. -It's a required field.
- 		true
whenUnsatisfiablestring - 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
labelSelectorobject - 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
matchLabelKeys[]string - MatchLabelKeys is a set of pod label keys to select the pods over which -spreading will be calculated. The keys are used to lookup values from the -incoming pod labels, those key-value labels are ANDed with labelSelector -to select the group of existing pods over which spreading will be calculated -for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. -MatchLabelKeys cannot be set when LabelSelector isn't set. -Keys that don't exist in the incoming pod labels will -be ignored. A null or empty list means only match against labelSelector. - -This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- 		false
minDomainsinteger - MinDomains indicates a minimum number of eligible domains. -When the number of eligible domains with matching topology keys is less than minDomains, -Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. -And when the number of eligible domains with matching topology keys equals or greater than minDomains, -this value has no effect on scheduling. -As a result, when the number of eligible domains is less than minDomains, -scheduler won't schedule more than maxSkew Pods to those domains. -If value is nil, the constraint behaves as if MinDomains is equal to 1. -Valid values are integers greater than 0. -When value is not nil, WhenUnsatisfiable must be DoNotSchedule. - -For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same -labelSelector spread as 2/2/2: -| zone1 | zone2 | zone3 | -| P P | P P | P P | -The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. -In this situation, new pod with the same labelSelector cannot be scheduled, -because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, -it will violate MaxSkew.
-
- Format: int32
- 		false
nodeAffinityPolicystring - NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector -when calculating pod topology spread skew. Options are: -- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. -- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. - -If this value is nil, the behavior is equivalent to the Honor policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
nodeTaintsPolicystring - NodeTaintsPolicy indicates how we will treat node taints when calculating -pod topology spread skew. Options are: -- Honor: nodes without taints, along with tainted nodes for which the incoming pod -has a toleration, are included. -- Ignore: node taints are ignored. All nodes are included. - -If this value is nil, the behavior is equivalent to the Ignore policy. -This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- 		false
- - -### OpenTelemetryCollector.spec.topologySpreadConstraints[index].labelSelector -[↩ Parent](#opentelemetrycollectorspectopologyspreadconstraintsindex-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspectopologyspreadconstraintsindexlabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -PersistentVolumeClaim is a user's request for and claim to a persistent volume - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
apiVersionstring - APIVersion defines the versioned schema of this representation of an object. -Servers should convert recognized schemas to the latest internal value, and -may reject unrecognized values. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
- 		false
kindstring - Kind is a string value representing the REST resource this object represents. -Servers may infer this from the endpoint the client submits requests to. -Cannot be updated. -In CamelCase. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- 		false
metadataobject - Standard object's metadata. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- 		false
specobject - spec defines the desired characteristics of a volume requested by a pod author. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 		false
statusobject - status represents the current information/status of a persistent volume claim. -Read-only. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].metadata -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex-1) - - - -Standard object's metadata. -More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex-1) - - - -spec defines the desired characteristics of a volume requested by a pod author. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSource -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec-1) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSourceRef -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec-1) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.resources -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec-1) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspecselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex-1) - - - -status represents the current information/status of a persistent volume claim. -Read-only. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
accessModes[]string - accessModes contains the actual access modes the volume backing the PVC has. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
- 		false
allocatedResourceStatusesmap[string]string - allocatedResourceStatuses stores status of resource being resized for the given PVC. -Key names follow standard Kubernetes label syntax. Valid values are either: - * Un-prefixed keys: - - storage - the capacity of the volume. - * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" -Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered -reserved and hence may not be used. - -ClaimResourceStatus can be in any of following states: - - ControllerResizeInProgress: - State set when resize controller starts resizing the volume in control-plane. - - ControllerResizeFailed: - State set when resize has failed in resize controller with a terminal error. - - NodeResizePending: - State set when resize controller has finished resizing the volume but further resizing of - volume is needed on the node. - - NodeResizeInProgress: - State set when kubelet starts resizing the volume. - - NodeResizeFailed: - State set when resizing has failed in kubelet with a terminal error. Transient errors don't set - NodeResizeFailed.
- 		false
allocatedResourcesmap[string]int or string - allocatedResources tracks the resources allocated to a PVC including its capacity. -Key names follow standard Kubernetes label syntax. Valid values are either: - * Un-prefixed keys: - - storage - the capacity of the volume. - * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" -Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered -reserved and hence may not be used. - -Capacity reported here may be larger than the actual capacity when a volume expansion operation -is requested. -For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. -If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. -If a volume expansion capacity request is lowered, allocatedResources is only -lowered if there are no expansion operations in progress and if the actual volume capacity -is equal or lower than the requested capacity. - -A controller that receives PVC update with previously unknown resourceName -should ignore the update for the purpose it was designed.
- 		false
capacitymap[string]int or string - capacity represents the actual resources of the underlying volume.
- 		false
conditions[]object - conditions is the current Condition of persistent volume claim. If underlying persistent volume is being -resized then the Condition will be set to 'Resizing'.
- 		false
currentVolumeAttributesClassNamestring - currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. -When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim -This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
- 		false
modifyVolumeStatusobject - ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. -When this is unset, there is no ModifyVolume operation being attempted. -This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
- 		false
phasestring - phase represents the current phase of PersistentVolumeClaim.
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.conditions[index] -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexstatus-1) - - - -PersistentVolumeClaimCondition contains details about state of pvc - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
statusstring -
- 		true
typestring - PersistentVolumeClaimConditionType defines the condition of PV claim. -Valid values are: - - "Resizing", "FileSystemResizePending" - -If RecoverVolumeExpansionFailure feature gate is enabled, then following additional values can be expected: - - "ControllerResizeError", "NodeResizeError" - -If VolumeAttributesClass feature gate is enabled, then following additional values can be expected: - - "ModifyVolumeError", "ModifyingVolume"
- 		true
lastProbeTimestring - lastProbeTime is the time we probed the condition.
-
- Format: date-time
- 		false
lastTransitionTimestring - lastTransitionTime is the time the condition transitioned from one status to another.
-
- Format: date-time
- 		false
messagestring - message is the human-readable message indicating details about last transition.
- 		false
reasonstring - reason is a unique, this should be a short, machine understandable string that gives the reason -for condition's last transition. If it reports "Resizing" that means the underlying -persistent volume is being resized.
- 		false
- - -### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.modifyVolumeStatus -[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexstatus-1) - - - -ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. -When this is unset, there is no ModifyVolume operation being attempted. -This is a beta field and requires enabling VolumeAttributesClass feature (off by default). - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
statusstring - status is the status of the ControllerModifyVolume operation. It can be in any of following states: - - Pending - Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as - the specified VolumeAttributesClass not existing. - - InProgress - InProgress indicates that the volume is being modified. - - Infeasible - Infeasible indicates that the request has been rejected as invalid by the CSI driver. To - resolve the error, a valid VolumeAttributesClass needs to be specified. -Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
- 		true
targetVolumeAttributesClassNamestring - targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
- 		false
- - -### OpenTelemetryCollector.spec.volumeMounts[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -VolumeMount describes a mounting of a Volume within a container. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mountPathstring - Path within the container at which the volume should be mounted. Must -not contain ':'.
- 		true
namestring - This must match the Name of a Volume.
- 		true
mountPropagationstring - 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. -When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified -(which defaults to None).
- 		false
readOnlyboolean - Mounted read-only if true, read-write otherwise (false or unspecified). -Defaults to false.
- 		false
recursiveReadOnlystring - RecursiveReadOnly specifies whether read-only mounts should be handled -recursively. - -If ReadOnly is false, this field has no meaning and must be unspecified. - -If ReadOnly is true, and this field is set to Disabled, the mount is not made -recursively read-only. If this field is set to IfPossible, the mount is made -recursively read-only, if it is supported by the container runtime. If this -field is set to Enabled, the mount is made recursively read-only if it is -supported by the container runtime, otherwise the pod will not be started and -an error will be generated to indicate the reason. - -If this field is set to IfPossible or Enabled, MountPropagation must be set to -None (or be unspecified, which defaults to None). - -If this field is not specified, it is treated as an equivalent of Disabled.
- 		false
subPathstring - Path within the volume from which the container's volume should be mounted. -Defaults to "" (volume's root).
- 		false
subPathExprstring - 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
- - -### OpenTelemetryCollector.spec.volumes[index] -[↩ Parent](#opentelemetrycollectorspec-1) - - - -Volume represents a named volume in a pod that may be accessed by any container in the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - name of the volume. -Must be a DNS_LABEL and unique within the pod. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- 		true
awsElasticBlockStoreobject - 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
azureDiskobject - azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
- 		false
azureFileobject - azureFile represents an Azure File Service mount on the host and bind mount to the pod.
- 		false
cephfsobject - cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
- 		false
cinderobject - cinder represents a cinder volume attached and mounted on kubelets host machine. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- 		false
configMapobject - configMap represents a configMap that should populate this volume
- 		false
csiobject - csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
- 		false
downwardAPIobject - downwardAPI represents downward API about the pod that should populate this volume
- 		false
emptyDirobject - emptyDir represents a temporary directory that shares a pod's lifetime. -More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 		false
ephemeralobject - 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
fcobject - fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
- 		false
flexVolumeobject - flexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin.
- 		false
flockerobject - flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
- 		false
gcePersistentDiskobject - 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
gitRepoobject - 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
glusterfsobject - 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
hostPathobject - 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
- 		false
imageobject - image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. -The volume is resolved at pod startup depending on which PullPolicy value is provided: - -- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. - -The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. -A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
- 		false
iscsiobject - 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
nfsobject - 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
persistentVolumeClaimobject - persistentVolumeClaimVolumeSource represents a reference to a -PersistentVolumeClaim in the same namespace. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 		false
photonPersistentDiskobject - photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
- 		false
portworxVolumeobject - portworxVolume represents a portworx volume attached and mounted on kubelets host machine
- 		false
projectedobject - projected items for all in one resources secrets, configmaps, and downward API
- 		false
quobyteobject - quobyte represents a Quobyte mount on the host that shares a pod's lifetime
- 		false
rbdobject - 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
scaleIOobject - scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
- 		false
secretobject - secret represents a secret that should populate this volume. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- 		false
storageosobject - storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
- 		false
vsphereVolumeobject - vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].awsElasticBlockStore -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). -More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 		true
fsTypestring - fsType is the 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
- 		false
partitioninteger - partition is 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
readOnlyboolean - readOnly value true will force the readOnly setting in VolumeMounts. -More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].azureDisk -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
diskNamestring - diskName is the Name of the data disk in the blob storage
- 		true
diskURIstring - diskURI is the URI of data disk in the blob storage
- 		true
cachingModestring - cachingMode is the Host Caching mode: None, Read Only, Read Write.
- 		false
fsTypestring - fsType is 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.
-
- Default: ext4
- 		false
kindstring - kind expected values are 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
readOnlyboolean - readOnly Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
-
- Default: false
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].azureFile -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -azureFile represents an Azure File Service mount on the host and bind mount to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
secretNamestring - secretName is the name of secret that contains Azure Storage Account Name and Key
- 		true
shareNamestring - shareName is the azure share Name
- 		true
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].cephfs -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -cephFS represents a Ceph FS mount on the host that shares a pod's lifetime - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
monitors[]string - monitors is Required: Monitors is a collection of Ceph monitors -More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- 		true
pathstring - path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
- 		false
readOnlyboolean - readOnly is 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
secretFilestring - secretFile is 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
secretRefobject - secretRef is 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
userstring - user is 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
- - -### OpenTelemetryCollector.spec.volumes[index].cephfs.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexcephfs-1) - - - -secretRef is 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 - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].cinder -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -cinder represents a cinder volume attached and mounted on kubelets host machine. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID used to identify the volume in cinder. -More info: https://examples.k8s.io/mysql-cinder-pd/README.md
- 		true
fsTypestring - fsType is the 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
readOnlyboolean - readOnly 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
secretRefobject - secretRef is optional: points to a secret object containing parameters used to connect -to OpenStack.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].cinder.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexcinder-1) - - - -secretRef is optional: points to a secret object containing parameters used to connect -to OpenStack. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].configMap -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -configMap represents a configMap that should populate this volume - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode is 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 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional specify whether the ConfigMap or its keys must be defined
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].configMap.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexconfigmap-1) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpenTelemetryCollector.spec.volumes[index].csi -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
driverstring - 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
fsTypestring - fsType 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
nodePublishSecretRefobject - 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
readOnlyboolean - readOnly specifies a read-only configuration for the volume. -Defaults to false (read/write).
- 		false
volumeAttributesmap[string]string - volumeAttributes stores driver-specific properties that are passed to the CSI -driver. Consult your driver's documentation for supported values.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].csi.nodePublishSecretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexcsi-1) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].downwardAPI -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -downwardAPI represents downward API about the pod that should populate this volume - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - 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
- - -### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapi-1) - - - -DownwardAPIVolumeFile represents information to create the file containing the pod field - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
fieldRefobject - Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- 		false
modeinteger - 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
resourceFieldRefobject - Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].fieldRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex-1) - - - -Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex-1) - - - -Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].emptyDir -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -emptyDir represents a temporary directory that shares a pod's lifetime. -More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
mediumstring - medium represents 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
sizeLimitint or string - sizeLimit is the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeClaimTemplateobject - 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 `-` where -`` 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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeral-1) - - - -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 `-` where -`` 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. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
specobject - 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
metadataobject - 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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
dataSourceobject - dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource.
- 		false
dataSourceRefobject - dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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.
- 		false
resourcesobject - 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
selectorobject - selector is a label query over volumes to consider for binding.
- 		false
storageClassNamestring - storageClassName is the name of the StorageClass required by the claim. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
- 		false
volumeAttributesClassNamestring - volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. -If specified, the CSI driver will create or update the volume with the attributes defined -in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, -it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass -will be applied to the claim but it's not allowed to reset this field to empty string once it is set. -If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass -will be set by the persistentvolume controller if it exists. -If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be -set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource -exists. -More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ -(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
- 		false
volumeModestring - volumeMode defines what type of volume is required by the claim. -Value of Filesystem is implied when not included in claim spec.
- 		false
volumeNamestring - volumeName is the binding reference to the PersistentVolume backing this claim.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec-1) - - - -dataSource 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. -When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, -and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. -If the namespace is specified, then dataSourceRef will not be copied to dataSource. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec-1) - - - -dataSourceRef specifies the object from which to populate the volume with data, if a non-empty -volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, -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. -When namespace is specified in dataSourceRef, -dataSource isn't set to the same value and must be empty. -There are three 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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
kindstring - Kind is the type of resource being referenced
- 		true
namestring - Name is the name of resource being referenced
- 		true
apiGroupstring - 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
namespacestring - Namespace is the namespace of resource being referenced -Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. -(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec-1) - - - -selector is a label query over volumes to consider for binding. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespecselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata -[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
annotationsmap[string]string -
- 		false
finalizers[]string -
- 		false
labelsmap[string]string -
- 		false
namestring -
- 		false
namespacestring -
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].fc -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fsTypestring - fsType is the 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
luninteger - lun is Optional: FC target lun number
-
- Format: int32
- 		false
readOnlyboolean - readOnly is Optional: Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
targetWWNs[]string - targetWWNs is Optional: FC target worldwide names (WWNs)
- 		false
wwids[]string - wwids Optional: FC volume world wide identifiers (wwids) -Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].flexVolume -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -flexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
driverstring - driver is the name of the driver to use for this volume.
- 		true
fsTypestring - fsType is the 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
optionsmap[string]string - options is Optional: this field holds extra command options if any.
- 		false
readOnlyboolean - readOnly is Optional: defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
secretRefobject - secretRef is 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
- - -### OpenTelemetryCollector.spec.volumes[index].flexVolume.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexflexvolume-1) - - - -secretRef is 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. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].flocker -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
datasetNamestring - datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker -should be considered as deprecated
- 		false
datasetUUIDstring - datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].gcePersistentDisk -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pdNamestring - pdName is 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
fsTypestring - fsType is 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
- 		false
partitioninteger - partition is 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
readOnlyboolean - readOnly here will force the ReadOnly setting in VolumeMounts. -Defaults to false. -More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].gitRepo -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -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. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
repositorystring - repository is the URL
- 		true
directorystring - directory is the 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
revisionstring - revision is the commit hash for the specified revision.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].glusterfs -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. -More info: https://examples.k8s.io/volumes/glusterfs/README.md - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
endpointsstring - endpoints is the endpoint name that details Glusterfs topology. -More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- 		true
pathstring - path is the Glusterfs volume path. -More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
- 		true
readOnlyboolean - 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
- - -### OpenTelemetryCollector.spec.volumes[index].hostPath -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
typestring - type for HostPath Volume -Defaults to "" -More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].image -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. -The volume is resolved at pod startup depending on which PullPolicy value is provided: - -- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. - -The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. -A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pullPolicystring - Policy for pulling OCI objects. Possible values are: -Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. -Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. -IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. -Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
- 		false
referencestring - Required: Image or artifact reference to be used. -Behaves in the same way as pod.spec.containers[*].image. -Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. -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
- - -### OpenTelemetryCollector.spec.volumes[index].iscsi -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
iqnstring - iqn is the target iSCSI Qualified Name.
- 		true
luninteger - lun represents iSCSI Target Lun number.
-
- Format: int32
- 		true
targetPortalstring - targetPortal is 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
chapAuthDiscoveryboolean - chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
- 		false
chapAuthSessionboolean - chapAuthSession defines whether support iSCSI Session CHAP authentication
- 		false
fsTypestring - fsType is the 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
- 		false
initiatorNamestring - initiatorName is the custom iSCSI Initiator Name. -If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface -: will be created for the connection.
- 		false
iscsiInterfacestring - iscsiInterface is the interface Name that uses an iSCSI transport. -Defaults to 'default' (tcp).
-
- Default: default
- 		false
portals[]string - portals is the 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
readOnlyboolean - readOnly here will force the ReadOnly setting in VolumeMounts. -Defaults to false.
- 		false
secretRefobject - secretRef is the CHAP Secret for iSCSI target and initiator authentication
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].iscsi.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexiscsi-1) - - - -secretRef is the CHAP Secret for iSCSI target and initiator authentication - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].nfs -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -nfs represents an NFS mount on the host that shares a pod's lifetime -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - path that is exported by the NFS server. -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 		true
serverstring - server is the hostname or IP address of the NFS server. -More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 		true
readOnlyboolean - 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
- - -### OpenTelemetryCollector.spec.volumes[index].persistentVolumeClaim -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -persistentVolumeClaimVolumeSource represents a reference to a -PersistentVolumeClaim in the same namespace. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
claimNamestring - 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
readOnlyboolean - readOnly Will force the ReadOnly setting in VolumeMounts. -Default false.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].photonPersistentDisk -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pdIDstring - pdID is the ID that identifies Photon Controller persistent disk
- 		true
fsTypestring - fsType is the 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
- - -### OpenTelemetryCollector.spec.volumes[index].portworxVolume -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -portworxVolume represents a portworx volume attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumeIDstring - volumeID uniquely identifies a Portworx volume
- 		true
fsTypestring - 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
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -projected items for all in one resources secrets, configmaps, and downward API - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode are the 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 - sources is the list of volume projections. Each entry in this list -handles one source.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojected-1) - - - -Projection that may be projected along with other supported volume types. -Exactly one of these fields must be set. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
clusterTrustBundleobject - ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field -of ClusterTrustBundle objects in an auto-updating file. - -Alpha, gated by the ClusterTrustBundleProjection feature gate. - -ClusterTrustBundle objects can either be selected by name, or by the -combination of signer name and a label selector. - -Kubelet performs aggressive normalization of the PEM contents written -into the pod filesystem. Esoteric PEM features such as inter-block -comments and block headers are stripped. Certificates are deduplicated. -The ordering of certificates within the file is arbitrary, and Kubelet -may change the order over time.
- 		false
configMapobject - configMap information about the configMap data to project
- 		false
downwardAPIobject - downwardAPI information about the downwardAPI data to project
- 		false
secretobject - secret information about the secret data to project
- 		false
serviceAccountTokenobject - serviceAccountToken is information about the serviceAccountToken data to project
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) - - - -ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field -of ClusterTrustBundle objects in an auto-updating file. - -Alpha, gated by the ClusterTrustBundleProjection feature gate. - -ClusterTrustBundle objects can either be selected by name, or by the -combination of signer name and a label selector. - -Kubelet performs aggressive normalization of the PEM contents written -into the pod filesystem. Esoteric PEM features such as inter-block -comments and block headers are stripped. Certificates are deduplicated. -The ordering of certificates within the file is arbitrary, and Kubelet -may change the order over time. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - Relative path from the volume root to write the bundle.
- 		true
labelSelectorobject - Select all ClusterTrustBundles that match this label selector. Only has -effect if signerName is set. Mutually-exclusive with name. If unset, -interpreted as "match nothing". If set but empty, interpreted as "match -everything".
- 		false
namestring - Select a single ClusterTrustBundle by object name. Mutually-exclusive -with signerName and labelSelector.
- 		false
optionalboolean - If true, don't block pod startup if the referenced ClusterTrustBundle(s) -aren't available. If using name, then the named ClusterTrustBundle is -allowed not to exist. If using signerName, then the combination of -signerName and labelSelector is allowed to match zero -ClusterTrustBundles.
- 		false
signerNamestring - Select all ClusterTrustBundles that match this signer name. -Mutually-exclusive with name. The contents of all selected -ClusterTrustBundles will be unified and deduplicated.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexclustertrustbundle-1) - - - -Select all ClusterTrustBundles that match this label selector. Only has -effect if signerName is set. Mutually-exclusive with name. If unset, -interpreted as "match nothing". If set but empty, interpreted as "match -everything". - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
matchExpressions[]object - matchExpressions is a list of label selector requirements. The requirements are ANDed.
- 		false
matchLabelsmap[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
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexclustertrustbundlelabelselector-1) - - - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the label key that the selector applies to.
- 		true
operatorstring - 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
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) - - - -configMap information about the configMap data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - items 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional specify whether the ConfigMap or its keys must be defined
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexconfigmap-1) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) - - - -downwardAPI information about the downwardAPI data to project - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - Items is a list of DownwardAPIVolume file
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapi-1) - - - -DownwardAPIVolumeFile represents information to create the file containing the pod field - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - 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
fieldRefobject - Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
- 		false
modeinteger - 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
resourceFieldRefobject - Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex-1) - - - -Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fieldPathstring - Path of the field to select in the specified API version.
- 		true
apiVersionstring - Version of the schema the FieldPath is written in terms of, defaults to "v1".
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex-1) - - - -Selects a resource of the container: only resources limits and requests -(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
resourcestring - Required: resource to select
- 		true
containerNamestring - Container name: required for volumes, optional for env vars
- 		false
divisorint or string - Specifies the output format of the exposed resources, defaults to "1"
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) - - - -secret information about the secret data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
items[]object - items 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
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
optionalboolean - optional field specify whether the Secret or its key must be defined
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexsecret-1) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].serviceAccountToken -[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) - - - -serviceAccountToken is information about the serviceAccountToken data to project - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
pathstring - path is the path relative to the mount point of the file to project the -token into.
- 		true
audiencestring - 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
expirationSecondsinteger - 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
- - -### OpenTelemetryCollector.spec.volumes[index].quobyte -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -quobyte represents a Quobyte mount on the host that shares a pod's lifetime - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
registrystring - 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
volumestring - volume is a string that references an already created Quobyte volume by name.
- 		true
groupstring - group to map volume access to -Default is no group
- 		false
readOnlyboolean - readOnly here will force the Quobyte volume to be mounted with read-only permissions. -Defaults to false.
- 		false
tenantstring - tenant owning the given Quobyte volume in the Backend -Used with dynamically provisioned Quobyte volumes, value is set by the plugin
- 		false
userstring - user to map volume access to -Defaults to serivceaccount user
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].rbd -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
imagestring - image is the rados image name. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 		true
monitors[]string - monitors is a collection of Ceph monitors. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 		true
fsTypestring - fsType is the 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
- 		false
keyringstring - 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
-
- Default: /etc/ceph/keyring
- 		false
poolstring - pool is the rados pool name. -Default is rbd. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
-
- Default: rbd
- 		false
readOnlyboolean - 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
secretRefobject - 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
userstring - user is the rados user name. -Default is admin. -More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
-
- Default: admin
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].rbd.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexrbd-1) - - - -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 - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].scaleIO -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
gatewaystring - gateway is the host address of the ScaleIO API Gateway.
- 		true
secretRefobject - secretRef references to the secret for ScaleIO user and other -sensitive information. If this is not provided, Login operation will fail.
- 		true
systemstring - system is the name of the storage system as configured in ScaleIO.
- 		true
fsTypestring - fsType is the filesystem type to mount. -Must be a filesystem type supported by the host operating system. -Ex. "ext4", "xfs", "ntfs". -Default is "xfs".
-
- Default: xfs
- 		false
protectionDomainstring - protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
- 		false
readOnlyboolean - readOnly Defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
sslEnabledboolean - sslEnabled Flag enable/disable SSL communication with Gateway, default false
- 		false
storageModestring - storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. -Default is ThinProvisioned.
-
- Default: ThinProvisioned
- 		false
storagePoolstring - storagePool is the ScaleIO Storage Pool associated with the protection domain.
- 		false
volumeNamestring - volumeName is the name of a volume already created in the ScaleIO system -that is associated with this volume source.
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].scaleIO.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexscaleio-1) - - - -secretRef references to the secret for ScaleIO user and other -sensitive information. If this is not provided, Login operation will fail. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].secret -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -secret represents a secret that should populate this volume. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
defaultModeinteger - defaultMode is 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 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
optionalboolean - optional field specify whether the Secret or its keys must be defined
- 		false
secretNamestring - secretName is the name of the secret in the pod's namespace to use. -More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].secret.items[index] -[↩ Parent](#opentelemetrycollectorspecvolumesindexsecret-1) - - - -Maps a string key to a path within a volume. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
keystring - key is the key to project.
- 		true
pathstring - path is 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
modeinteger - mode is 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
- - -### OpenTelemetryCollector.spec.volumes[index].storageos -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
fsTypestring - fsType is the 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
readOnlyboolean - readOnly defaults to false (read/write). ReadOnly here will force -the ReadOnly setting in VolumeMounts.
- 		false
secretRefobject - secretRef specifies the secret to use for obtaining the StorageOS API -credentials. If not specified, default values will be attempted.
- 		false
volumeNamestring - volumeName is the human-readable name of the StorageOS volume. Volume -names are only unique within a namespace.
- 		false
volumeNamespacestring - 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
- - -### OpenTelemetryCollector.spec.volumes[index].storageos.secretRef -[↩ Parent](#opentelemetrycollectorspecvolumesindexstorageos-1) - - - -secretRef specifies the secret to use for obtaining the StorageOS API -credentials. If not specified, default values will be attempted. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name of the referent. -This field is effectively required, but due to backwards compatibility is -allowed to be empty. Instances of this type with an empty value here are -almost certainly wrong. -More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
-
- Default:
- 		false
- - -### OpenTelemetryCollector.spec.volumes[index].vsphereVolume -[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) - - - -vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
volumePathstring - volumePath is the path that identifies vSphere volume vmdk
- 		true
fsTypestring - fsType is 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
storagePolicyIDstring - storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
- 		false
storagePolicyNamestring - storagePolicyName is the storage Policy Based Management (SPBM) profile name.
- 		false
- - -### OpenTelemetryCollector.status -[↩ Parent](#opentelemetrycollector-1) - - - -OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
imagestring - Image indicates the container image to use for the OpenTelemetry Collector.
- 		false
scaleobject - Scale is the OpenTelemetryCollector's scale subresource status.
- 		false
versionstring - Version of the managed OpenTelemetry Collector (operand)
- 		false
- - -### OpenTelemetryCollector.status.scale -[↩ Parent](#opentelemetrycollectorstatus-1) - - - -Scale is the OpenTelemetryCollector's scale subresource status. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
replicasinteger - The total number non-terminated pods targeted by this -OpenTelemetryCollector's deployment or statefulSet.
-
- Format: int32
- 		false
selectorstring - The selector used to match the OpenTelemetryCollector's -deployment or statefulSet pods.
- 		false
statusReplicasstring - StatusReplicas is the number of pods targeted by this OpenTelemetryCollector's with a Ready Condition / -Total number of non-terminated pods targeted by this OpenTelemetryCollector's (their labels match the selector). -Deployment, Daemonset, StatefulSet.
- 		false
\ No newline at end of file +Moved to [here](/docs/api). \ No newline at end of file diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 0000000000..a285ca903a --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,6 @@ +# CRDs + +- [Instrumentation](instrumentations.md) +- [OpAMPBridge](opampbridges.md) +- [OpenTelemetryCollector](opentelemetrycollectors.md) +- [TargetAllocator](targetallocators.md) \ No newline at end of file diff --git a/docs/api/instrumentations.md b/docs/api/instrumentations.md new file mode 100644 index 0000000000..a7d8b72f9e --- /dev/null +++ b/docs/api/instrumentations.md @@ -0,0 +1,7461 @@ +# API Reference + +Packages: + +- [opentelemetry.io/v1alpha1](#opentelemetryiov1alpha1) + +# opentelemetry.io/v1alpha1 + +Resource Types: + +- [Instrumentation](#instrumentation) + + + + +## Instrumentation +[↩ Parent](#opentelemetryiov1alpha1 ) + + + + + + +Instrumentation is the spec for OpenTelemetry instrumentation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringInstrumentationtrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + InstrumentationSpec defines the desired state of OpenTelemetry SDK and instrumentation.
+ 		false
statusobject + InstrumentationStatus defines status of the instrumentation.
+ 		false
+ + +### Instrumentation.spec +[↩ Parent](#instrumentation) + + + +InstrumentationSpec defines the desired state of OpenTelemetry SDK and instrumentation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apacheHttpdobject + ApacheHttpd defines configuration for Apache HTTPD auto-instrumentation.
+ 		false
defaultsobject + Defaults defines default values for the instrumentation.
+ 		false
dotnetobject + DotNet defines configuration for DotNet auto-instrumentation.
+ 		false
env[]object + Env defines common env vars. There are four layers for env vars' definitions and +the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. +If the former var had been defined, then the other vars would be ignored.
+ 		false
exporterobject + Exporter defines exporter configuration.
+ 		false
goobject + Go defines configuration for Go auto-instrumentation. +When using Go auto-instrumentation you must provide a value for the OTEL_GO_AUTO_TARGET_EXE env var via the +Instrumentation env vars or via the instrumentation.opentelemetry.io/otel-go-auto-target-exe pod annotation. +Failure to set this value causes instrumentation injection to abort, leaving the original pod unchanged.
+ 		false
javaobject + Java defines configuration for java auto-instrumentation.
+ 		false
nginxobject + Nginx defines configuration for Nginx auto-instrumentation.
+ 		false
nodejsobject + NodeJS defines configuration for nodejs auto-instrumentation.
+ 		false
propagators[]enum + Propagators defines inter-process context propagation configuration. +Values in this list will be set in the OTEL_PROPAGATORS env var. +Enum=tracecontext;baggage;b3;b3multi;jaeger;xray;ottrace;none
+ 		false
pythonobject + Python defines configuration for python auto-instrumentation.
+ 		false
resourceobject + Resource defines the configuration for the resource attributes, as defined by the OpenTelemetry specification.
+ 		false
samplerobject + Sampler defines sampling configuration.
+ 		false
+ + +### Instrumentation.spec.apacheHttpd +[↩ Parent](#instrumentationspec) + + + +ApacheHttpd defines configuration for Apache HTTPD auto-instrumentation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
attrs[]object + Attrs defines Apache HTTPD agent specific attributes. The precedence is: +`agent default attributes` > `instrument spec attributes` . +Attributes are documented at https://github.com/open-telemetry/opentelemetry-cpp-contrib/tree/main/instrumentation/otel-webserver-module
+ 		false
configPathstring + Location of Apache HTTPD server configuration. +Needed only if different from default "/usr/local/apache2/conf"
+ 		false
env[]object + Env defines Apache HTTPD specific env vars. There are four layers for env vars' definitions and +the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. +If the former var had been defined, then the other vars would be ignored.
+ 		false
imagestring + Image is a container image with Apache SDK and auto-instrumentation.
+ 		false
resourceRequirementsobject + Resources describes the compute resource requirements.
+ 		false
versionstring + Apache HTTPD server version. One of 2.4 or 2.2. Default is 2.4
+ 		false
volumeClaimTemplateobject + VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit
+ 		false
volumeLimitSizeint or string + VolumeSizeLimit defines size limit for volume used for auto-instrumentation. +The default size is 200Mi.
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.attrs[index] +[↩ Parent](#instrumentationspecapachehttpd) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom +[↩ Parent](#instrumentationspecapachehttpdattrsindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecapachehttpdattrsindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecapachehttpdattrsindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecapachehttpdattrsindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.attrs[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecapachehttpdattrsindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.env[index] +[↩ Parent](#instrumentationspecapachehttpd) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.env[index].valueFrom +[↩ Parent](#instrumentationspecapachehttpdenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.env[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecapachehttpdenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.env[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecapachehttpdenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.env[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecapachehttpdenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.env[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecapachehttpdenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.resourceRequirements +[↩ Parent](#instrumentationspecapachehttpd) + + + +Resources describes the compute resource requirements. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.resourceRequirements.claims[index] +[↩ Parent](#instrumentationspecapachehttpdresourcerequirements) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.volumeClaimTemplate +[↩ Parent](#instrumentationspecapachehttpd) + + + +VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec +[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.dataSource +[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.resources +[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.selector +[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### Instrumentation.spec.apacheHttpd.volumeClaimTemplate.metadata +[↩ Parent](#instrumentationspecapachehttpdvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### Instrumentation.spec.defaults +[↩ Parent](#instrumentationspec) + + + +Defaults defines default values for the instrumentation. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
useLabelsForResourceAttributesboolean + UseLabelsForResourceAttributes defines whether to use common labels for resource attributes: + - `app.kubernetes.io/name` becomes `service.name` + - `app.kubernetes.io/version` becomes `service.version` + - `app.kubernetes.io/part-of` becomes `service.namespace`
+ 		false
+ + +### Instrumentation.spec.dotnet +[↩ Parent](#instrumentationspec) + + + +DotNet defines configuration for DotNet auto-instrumentation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
env[]object + Env defines DotNet specific env vars. There are four layers for env vars' definitions and +the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. +If the former var had been defined, then the other vars would be ignored.
+ 		false
imagestring + Image is a container image with DotNet SDK and auto-instrumentation.
+ 		false
resourceRequirementsobject + Resources describes the compute resource requirements.
+ 		false
volumeClaimTemplateobject + VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit
+ 		false
volumeLimitSizeint or string + VolumeSizeLimit defines size limit for volume used for auto-instrumentation. +The default size is 200Mi.
+ 		false
+ + +### Instrumentation.spec.dotnet.env[index] +[↩ Parent](#instrumentationspecdotnet) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.dotnet.env[index].valueFrom +[↩ Parent](#instrumentationspecdotnetenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.dotnet.env[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecdotnetenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.dotnet.env[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecdotnetenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.dotnet.env[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecdotnetenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.dotnet.env[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecdotnetenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.dotnet.resourceRequirements +[↩ Parent](#instrumentationspecdotnet) + + + +Resources describes the compute resource requirements. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.dotnet.resourceRequirements.claims[index] +[↩ Parent](#instrumentationspecdotnetresourcerequirements) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### Instrumentation.spec.dotnet.volumeClaimTemplate +[↩ Parent](#instrumentationspecdotnet) + + + +VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### Instrumentation.spec.dotnet.volumeClaimTemplate.spec +[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.dataSource +[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.resources +[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.selector +[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### Instrumentation.spec.dotnet.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### Instrumentation.spec.dotnet.volumeClaimTemplate.metadata +[↩ Parent](#instrumentationspecdotnetvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### Instrumentation.spec.env[index] +[↩ Parent](#instrumentationspec) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.env[index].valueFrom +[↩ Parent](#instrumentationspecenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.env[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.env[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.env[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.env[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.exporter +[↩ Parent](#instrumentationspec) + + + +Exporter defines exporter configuration. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
endpointstring + Endpoint is address of the collector with OTLP endpoint. +If the endpoint defines https:// scheme TLS has to be specified.
+ 		false
tlsobject + TLS defines certificates for TLS. +TLS needs to be enabled by specifying https:// scheme in the Endpoint.
+ 		false
+ + +### Instrumentation.spec.exporter.tls +[↩ Parent](#instrumentationspecexporter) + + + +TLS defines certificates for TLS. +TLS needs to be enabled by specifying https:// scheme in the Endpoint. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
ca_filestring + CA defines the key of certificate (e.g. ca.crt) in the configmap map, secret or absolute path to a certificate. +The absolute path can be used when certificate is already present on the workload filesystem e.g. +/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt
+ 		false
cert_filestring + Cert defines the key (e.g. tls.crt) of the client certificate in the secret or absolute path to a certificate. +The absolute path can be used when certificate is already present on the workload filesystem.
+ 		false
configMapNamestring + ConfigMapName defines configmap name with CA certificate. If it is not defined CA certificate will be +used from the secret defined in SecretName.
+ 		false
key_filestring + Key defines a key (e.g. tls.key) of the private key in the secret or absolute path to a certificate. +The absolute path can be used when certificate is already present on the workload filesystem.
+ 		false
secretNamestring + SecretName defines secret name that will be used to configure TLS on the exporter. +It is user responsibility to create the secret in the namespace of the workload. +The secret must contain client certificate (Cert) and private key (Key). +The CA certificate might be defined in the secret or in the config map.
+ 		false
+ + +### Instrumentation.spec.go +[↩ Parent](#instrumentationspec) + + + +Go defines configuration for Go auto-instrumentation. +When using Go auto-instrumentation you must provide a value for the OTEL_GO_AUTO_TARGET_EXE env var via the +Instrumentation env vars or via the instrumentation.opentelemetry.io/otel-go-auto-target-exe pod annotation. +Failure to set this value causes instrumentation injection to abort, leaving the original pod unchanged. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
env[]object + Env defines Go specific env vars. There are four layers for env vars' definitions and +the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. +If the former var had been defined, then the other vars would be ignored.
+ 		false
imagestring + Image is a container image with Go SDK and auto-instrumentation.
+ 		false
resourceRequirementsobject + Resources describes the compute resource requirements.
+ 		false
volumeClaimTemplateobject + VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit
+ 		false
volumeLimitSizeint or string + VolumeSizeLimit defines size limit for volume used for auto-instrumentation. +The default size is 200Mi.
+ 		false
+ + +### Instrumentation.spec.go.env[index] +[↩ Parent](#instrumentationspecgo) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.go.env[index].valueFrom +[↩ Parent](#instrumentationspecgoenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.go.env[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecgoenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.go.env[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecgoenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.go.env[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecgoenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.go.env[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecgoenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.go.resourceRequirements +[↩ Parent](#instrumentationspecgo) + + + +Resources describes the compute resource requirements. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.go.resourceRequirements.claims[index] +[↩ Parent](#instrumentationspecgoresourcerequirements) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### Instrumentation.spec.go.volumeClaimTemplate +[↩ Parent](#instrumentationspecgo) + + + +VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### Instrumentation.spec.go.volumeClaimTemplate.spec +[↩ Parent](#instrumentationspecgovolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### Instrumentation.spec.go.volumeClaimTemplate.spec.dataSource +[↩ Parent](#instrumentationspecgovolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### Instrumentation.spec.go.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#instrumentationspecgovolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### Instrumentation.spec.go.volumeClaimTemplate.spec.resources +[↩ Parent](#instrumentationspecgovolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.go.volumeClaimTemplate.spec.selector +[↩ Parent](#instrumentationspecgovolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### Instrumentation.spec.go.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#instrumentationspecgovolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### Instrumentation.spec.go.volumeClaimTemplate.metadata +[↩ Parent](#instrumentationspecgovolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### Instrumentation.spec.java +[↩ Parent](#instrumentationspec) + + + +Java defines configuration for java auto-instrumentation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
env[]object + Env defines java specific env vars. There are four layers for env vars' definitions and +the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. +If the former var had been defined, then the other vars would be ignored.
+ 		false
extensions[]object + Extensions defines java specific extensions. +All extensions are copied to a single directory; if a JAR with the same name exists, it will be overwritten.
+ 		false
imagestring + Image is a container image with javaagent auto-instrumentation JAR.
+ 		false
resourcesobject + Resources describes the compute resource requirements.
+ 		false
volumeClaimTemplateobject + VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit
+ 		false
volumeLimitSizeint or string + VolumeSizeLimit defines size limit for volume used for auto-instrumentation. +The default size is 200Mi.
+ 		false
+ + +### Instrumentation.spec.java.env[index] +[↩ Parent](#instrumentationspecjava) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.java.env[index].valueFrom +[↩ Parent](#instrumentationspecjavaenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.java.env[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecjavaenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.java.env[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecjavaenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.java.env[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecjavaenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.java.env[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecjavaenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.java.extensions[index] +[↩ Parent](#instrumentationspecjava) + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
dirstring + Dir is a directory with extensions auto-instrumentation JAR.
+ 		true
imagestring + Image is a container image with extensions auto-instrumentation JAR.
+ 		true
+ + +### Instrumentation.spec.java.resources +[↩ Parent](#instrumentationspecjava) + + + +Resources describes the compute resource requirements. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.java.resources.claims[index] +[↩ Parent](#instrumentationspecjavaresources) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### Instrumentation.spec.java.volumeClaimTemplate +[↩ Parent](#instrumentationspecjava) + + + +VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### Instrumentation.spec.java.volumeClaimTemplate.spec +[↩ Parent](#instrumentationspecjavavolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### Instrumentation.spec.java.volumeClaimTemplate.spec.dataSource +[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### Instrumentation.spec.java.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### Instrumentation.spec.java.volumeClaimTemplate.spec.resources +[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.java.volumeClaimTemplate.spec.selector +[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### Instrumentation.spec.java.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#instrumentationspecjavavolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### Instrumentation.spec.java.volumeClaimTemplate.metadata +[↩ Parent](#instrumentationspecjavavolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### Instrumentation.spec.nginx +[↩ Parent](#instrumentationspec) + + + +Nginx defines configuration for Nginx auto-instrumentation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
attrs[]object + Attrs defines Nginx agent specific attributes. The precedence order is: +`agent default attributes` > `instrument spec attributes` . +Attributes are documented at https://github.com/open-telemetry/opentelemetry-cpp-contrib/tree/main/instrumentation/otel-webserver-module
+ 		false
configFilestring + Location of Nginx configuration file. +Needed only if different from default "/etx/nginx/nginx.conf"
+ 		false
env[]object + Env defines Nginx specific env vars. There are four layers for env vars' definitions and +the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. +If the former var had been defined, then the other vars would be ignored.
+ 		false
imagestring + Image is a container image with Nginx SDK and auto-instrumentation.
+ 		false
resourceRequirementsobject + Resources describes the compute resource requirements.
+ 		false
volumeClaimTemplateobject + VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit
+ 		false
volumeLimitSizeint or string + VolumeSizeLimit defines size limit for volume used for auto-instrumentation. +The default size is 200Mi.
+ 		false
+ + +### Instrumentation.spec.nginx.attrs[index] +[↩ Parent](#instrumentationspecnginx) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.nginx.attrs[index].valueFrom +[↩ Parent](#instrumentationspecnginxattrsindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.nginx.attrs[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecnginxattrsindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.nginx.attrs[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecnginxattrsindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.nginx.attrs[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecnginxattrsindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.nginx.attrs[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecnginxattrsindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.nginx.env[index] +[↩ Parent](#instrumentationspecnginx) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.nginx.env[index].valueFrom +[↩ Parent](#instrumentationspecnginxenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.nginx.env[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecnginxenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.nginx.env[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecnginxenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.nginx.env[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecnginxenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.nginx.env[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecnginxenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.nginx.resourceRequirements +[↩ Parent](#instrumentationspecnginx) + + + +Resources describes the compute resource requirements. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.nginx.resourceRequirements.claims[index] +[↩ Parent](#instrumentationspecnginxresourcerequirements) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### Instrumentation.spec.nginx.volumeClaimTemplate +[↩ Parent](#instrumentationspecnginx) + + + +VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### Instrumentation.spec.nginx.volumeClaimTemplate.spec +[↩ Parent](#instrumentationspecnginxvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### Instrumentation.spec.nginx.volumeClaimTemplate.spec.dataSource +[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### Instrumentation.spec.nginx.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### Instrumentation.spec.nginx.volumeClaimTemplate.spec.resources +[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.nginx.volumeClaimTemplate.spec.selector +[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### Instrumentation.spec.nginx.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#instrumentationspecnginxvolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### Instrumentation.spec.nginx.volumeClaimTemplate.metadata +[↩ Parent](#instrumentationspecnginxvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### Instrumentation.spec.nodejs +[↩ Parent](#instrumentationspec) + + + +NodeJS defines configuration for nodejs auto-instrumentation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
env[]object + Env defines nodejs specific env vars. There are four layers for env vars' definitions and +the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. +If the former var had been defined, then the other vars would be ignored.
+ 		false
imagestring + Image is a container image with NodeJS SDK and auto-instrumentation.
+ 		false
resourceRequirementsobject + Resources describes the compute resource requirements.
+ 		false
volumeClaimTemplateobject + VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit
+ 		false
volumeLimitSizeint or string + VolumeSizeLimit defines size limit for volume used for auto-instrumentation. +The default size is 200Mi.
+ 		false
+ + +### Instrumentation.spec.nodejs.env[index] +[↩ Parent](#instrumentationspecnodejs) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.nodejs.env[index].valueFrom +[↩ Parent](#instrumentationspecnodejsenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.nodejs.env[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecnodejsenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.nodejs.env[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecnodejsenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.nodejs.env[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecnodejsenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.nodejs.env[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecnodejsenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.nodejs.resourceRequirements +[↩ Parent](#instrumentationspecnodejs) + + + +Resources describes the compute resource requirements. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.nodejs.resourceRequirements.claims[index] +[↩ Parent](#instrumentationspecnodejsresourcerequirements) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### Instrumentation.spec.nodejs.volumeClaimTemplate +[↩ Parent](#instrumentationspecnodejs) + + + +VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### Instrumentation.spec.nodejs.volumeClaimTemplate.spec +[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.dataSource +[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.resources +[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.selector +[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### Instrumentation.spec.nodejs.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### Instrumentation.spec.nodejs.volumeClaimTemplate.metadata +[↩ Parent](#instrumentationspecnodejsvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### Instrumentation.spec.python +[↩ Parent](#instrumentationspec) + + + +Python defines configuration for python auto-instrumentation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
env[]object + Env defines python specific env vars. There are four layers for env vars' definitions and +the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`. +If the former var had been defined, then the other vars would be ignored.
+ 		false
imagestring + Image is a container image with Python SDK and auto-instrumentation.
+ 		false
resourceRequirementsobject + Resources describes the compute resource requirements.
+ 		false
volumeClaimTemplateobject + VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit
+ 		false
volumeLimitSizeint or string + VolumeSizeLimit defines size limit for volume used for auto-instrumentation. +The default size is 200Mi.
+ 		false
+ + +### Instrumentation.spec.python.env[index] +[↩ Parent](#instrumentationspecpython) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### Instrumentation.spec.python.env[index].valueFrom +[↩ Parent](#instrumentationspecpythonenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### Instrumentation.spec.python.env[index].valueFrom.configMapKeyRef +[↩ Parent](#instrumentationspecpythonenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### Instrumentation.spec.python.env[index].valueFrom.fieldRef +[↩ Parent](#instrumentationspecpythonenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### Instrumentation.spec.python.env[index].valueFrom.resourceFieldRef +[↩ Parent](#instrumentationspecpythonenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### Instrumentation.spec.python.env[index].valueFrom.secretKeyRef +[↩ Parent](#instrumentationspecpythonenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### Instrumentation.spec.python.resourceRequirements +[↩ Parent](#instrumentationspecpython) + + + +Resources describes the compute resource requirements. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.python.resourceRequirements.claims[index] +[↩ Parent](#instrumentationspecpythonresourcerequirements) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### Instrumentation.spec.python.volumeClaimTemplate +[↩ Parent](#instrumentationspecpython) + + + +VolumeClaimTemplate defines a ephemeral volume used for auto-instrumentation. +If omitted, an emptyDir is used with size limit VolumeSizeLimit + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### Instrumentation.spec.python.volumeClaimTemplate.spec +[↩ Parent](#instrumentationspecpythonvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### Instrumentation.spec.python.volumeClaimTemplate.spec.dataSource +[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### Instrumentation.spec.python.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### Instrumentation.spec.python.volumeClaimTemplate.spec.resources +[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### Instrumentation.spec.python.volumeClaimTemplate.spec.selector +[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### Instrumentation.spec.python.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#instrumentationspecpythonvolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### Instrumentation.spec.python.volumeClaimTemplate.metadata +[↩ Parent](#instrumentationspecpythonvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### Instrumentation.spec.resource +[↩ Parent](#instrumentationspec) + + + +Resource defines the configuration for the resource attributes, as defined by the OpenTelemetry specification. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
addK8sUIDAttributesboolean + AddK8sUIDAttributes defines whether K8s UID attributes should be collected (e.g. k8s.deployment.uid).
+ 		false
resourceAttributesmap[string]string + Attributes defines attributes that are added to the resource. +For example environment: dev
+ 		false
+ + +### Instrumentation.spec.sampler +[↩ Parent](#instrumentationspec) + + + +Sampler defines sampling configuration. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
argumentstring + Argument defines sampler argument. +The value depends on the sampler type. +For instance for parentbased_traceidratio sampler type it is a number in range [0..1] e.g. 0.25. +The value will be set in the OTEL_TRACES_SAMPLER_ARG env var.
+ 		false
typeenum + Type defines sampler type. +The value will be set in the OTEL_TRACES_SAMPLER env var. +The value can be for instance parentbased_always_on, parentbased_always_off, parentbased_traceidratio...
+
+ Enum: always_on, always_off, traceidratio, parentbased_always_on, parentbased_always_off, parentbased_traceidratio, jaeger_remote, xray
+ 		false
\ No newline at end of file diff --git a/docs/api/opampbridges.md b/docs/api/opampbridges.md new file mode 100644 index 0000000000..8cfa08d43f --- /dev/null +++ b/docs/api/opampbridges.md @@ -0,0 +1,7492 @@ +# API Reference + +Packages: + +- [opentelemetry.io/v1alpha1](#opentelemetryiov1alpha1) + +# opentelemetry.io/v1alpha1 + +Resource Types: + +- [OpAMPBridge](#opampbridge) + + + + +## OpAMPBridge +[↩ Parent](#opentelemetryiov1alpha1 ) + + + + + + +OpAMPBridge is the Schema for the opampbridges API. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringOpAMPBridgetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + OpAMPBridgeSpec defines the desired state of OpAMPBridge.
+ 		false
statusobject + OpAMPBridgeStatus defines the observed state of OpAMPBridge.
+ 		false
+ + +### OpAMPBridge.spec +[↩ Parent](#opampbridge) + + + +OpAMPBridgeSpec defines the desired state of OpAMPBridge. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
capabilitiesmap[string]boolean + Capabilities supported by the OpAMP Bridge
+ 		true
endpointstring + OpAMP backend Server endpoint
+ 		true
affinityobject + If specified, indicates the pod's scheduling constraints
+ 		false
componentsAllowedmap[string][]string + ComponentsAllowed is a list of allowed OpenTelemetry components for each pipeline type (receiver, processor, etc.)
+ 		false
env[]object + ENV vars to set on the OpAMPBridge Pods.
+ 		false
envFrom[]object + List of sources to populate environment variables on the OpAMPBridge Pods.
+ 		false
headersmap[string]string + Headers is an optional map of headers to use when connecting to the OpAMP Server, +typically used to set access tokens or other authorization headers.
+ 		false
hostNetworkboolean + HostNetwork indicates if the pod should run in the host networking namespace.
+ 		false
imagestring + Image indicates the container image to use for the OpAMPBridge.
+ 		false
imagePullPolicystring + ImagePullPolicy indicates the pull policy to be used for retrieving the container image (Always, Never, IfNotPresent)
+ 		false
ipFamilies[]string + IPFamily represents the IP Family (IPv4 or IPv6). This type is used +to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
+ 		false
ipFamilyPolicystring + IPFamilyPolicy represents the dual-stack-ness requested or required by a Service
+ 		false
nodeSelectormap[string]string + NodeSelector to schedule OpAMPBridge pods.
+ 		false
podAnnotationsmap[string]string + PodAnnotations is the set of annotations that will be attached to +OpAMPBridge pods.
+ 		false
podDnsConfigobject + PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
+ 		false
podSecurityContextobject + PodSecurityContext will be set as the pod security context.
+ 		false
ports[]object + Ports allows a set of ports to be exposed by the underlying v1.Service.
+ 		false
priorityClassNamestring + If specified, indicates the pod's priority. +If not specified, the pod priority will be default or zero if there is no +default.
+ 		false
replicasinteger + Replicas is the number of pod instances for the OpAMPBridge.
+
+ Format: int32
+ Maximum: 1
+ 		false
resourcesobject + Resources to set on the OpAMPBridge pods.
+ 		false
securityContextobject + SecurityContext will be set as the container security context.
+ 		false
serviceAccountstring + ServiceAccount indicates the name of an existing service account to use with this instance. When set, +the operator will not automatically create a ServiceAccount for the OpAMPBridge.
+ 		false
tolerations[]object + Toleration to schedule OpAMPBridge pods.
+ 		false
topologySpreadConstraints[]object + TopologySpreadConstraints embedded kubernetes pod configuration option, +controls how pods are spread across your cluster among failure-domains +such as regions, zones, nodes, and other user-defined topology domains +https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
+ 		false
upgradeStrategyenum + UpgradeStrategy represents how the operator will handle upgrades to the CR when a newer version of the operator is deployed
+
+ Enum: automatic, none
+ 		false
volumeMounts[]object + VolumeMounts represents the mount points to use in the underlying OpAMPBridge deployment(s)
+ 		false
volumes[]object + Volumes represents which volumes to use in the underlying OpAMPBridge deployment(s).
+ 		false
+ + +### OpAMPBridge.spec.affinity +[↩ Parent](#opampbridgespec) + + + +If specified, indicates the pod's scheduling constraints + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeAffinityobject + Describes node affinity scheduling rules for the pod.
+ 		false
podAffinityobject + Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
podAntiAffinityobject + Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
+ + +### OpAMPBridge.spec.affinity.nodeAffinity +[↩ Parent](#opampbridgespecaffinity) + + + +Describes node affinity scheduling rules for the pod. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject + 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
+ + +### OpAMPBridge.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opampbridgespecaffinitynodeaffinity) + + + +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). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
preferenceobject + A node selector term, associated with the corresponding weight.
+ 		true
weightinteger + Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpAMPBridge.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference +[↩ Parent](#opampbridgespecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +A node selector term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpAMPBridge.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] +[↩ Parent](#opampbridgespecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +[↩ Parent](#opampbridgespecaffinitynodeaffinity) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeSelectorTerms[]object + Required. A list of node selector terms. The terms are ORed.
+ 		true
+ + +### OpAMPBridge.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] +[↩ Parent](#opampbridgespecaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpAMPBridge.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] +[↩ Parent](#opampbridgespecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.podAffinity +[↩ Parent](#opampbridgespecaffinity) + + + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opampbridgespecaffinitypodaffinity) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opampbridgespecaffinitypodaffinity) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opampbridgespecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opampbridgespecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity +[↩ Parent](#opampbridgespecaffinity) + + + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opampbridgespecaffinitypodantiaffinity) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opampbridgespecaffinitypodantiaffinity) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opampbridgespecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opampbridgespecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opampbridgespecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.env[index] +[↩ Parent](#opampbridgespec) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpAMPBridge.spec.env[index].valueFrom +[↩ Parent](#opampbridgespecenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpAMPBridge.spec.env[index].valueFrom.configMapKeyRef +[↩ Parent](#opampbridgespecenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpAMPBridge.spec.env[index].valueFrom.fieldRef +[↩ Parent](#opampbridgespecenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpAMPBridge.spec.env[index].valueFrom.resourceFieldRef +[↩ Parent](#opampbridgespecenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpAMPBridge.spec.env[index].valueFrom.secretKeyRef +[↩ Parent](#opampbridgespecenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpAMPBridge.spec.envFrom[index] +[↩ Parent](#opampbridgespec) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### OpAMPBridge.spec.envFrom[index].configMapRef +[↩ Parent](#opampbridgespecenvfromindex) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### OpAMPBridge.spec.envFrom[index].secretRef +[↩ Parent](#opampbridgespecenvfromindex) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### OpAMPBridge.spec.podDnsConfig +[↩ Parent](#opampbridgespec) + + + +PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpAMPBridge.spec.podDnsConfig.options[index] +[↩ Parent](#opampbridgespecpoddnsconfig) + + + +PodDNSConfigOption defines DNS resolver options of a pod. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Required.
+ 		false
valuestring +
+ 		false
+ + +### OpAMPBridge.spec.podSecurityContext +[↩ Parent](#opampbridgespec) + + + +PodSecurityContext will be set as the pod security context. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
appArmorProfileobject + appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
fsGroupinteger + 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
fsGroupChangePolicystring + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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 and fsGroup (if specified). If +the SupplementalGroupsPolicy feature is enabled, the +supplementalGroupsPolicy field determines whether these are in addition +to or instead of any group memberships defined in the container image. +If unspecified, no additional groups are added, though group memberships +defined in the container image may still be used, depending on the +supplementalGroupsPolicy field. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
supplementalGroupsPolicystring + Defines how supplemental groups of the first container processes are calculated. +Valid values are "Merge" and "Strict". If not specified, "Merge" is used. +(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled +and the container runtime must implement support for this feature. +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
windowsOptionsobject + 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
+ + +### OpAMPBridge.spec.podSecurityContext.appArmorProfile +[↩ Parent](#opampbridgespecpodsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpAMPBridge.spec.podSecurityContext.seLinuxOptions +[↩ Parent](#opampbridgespecpodsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpAMPBridge.spec.podSecurityContext.seccompProfile +[↩ Parent](#opampbridgespecpodsecuritycontext) + + + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpAMPBridge.spec.podSecurityContext.sysctls[index] +[↩ Parent](#opampbridgespecpodsecuritycontext) + + + +Sysctl defines a kernel parameter to be set + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of a property to set
+ 		true
valuestring + Value of a property to set
+ 		true
+ + +### OpAMPBridge.spec.podSecurityContext.windowsOptions +[↩ Parent](#opampbridgespecpodsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpAMPBridge.spec.ports[index] +[↩ Parent](#opampbridgespec) + + + +ServicePort contains information on service's port. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + The port that will be exposed by this service.
+
+ Format: int32
+ 		true
appProtocolstring + The application protocol for this port. +This is used as a hint for implementations to offer richer behavior for protocols that they understand. +This field follows standard Kubernetes label syntax. +Valid values are either: + +* Un-prefixed protocol names - reserved for IANA standard service names (as per +RFC-6335 and https://www.iana.org/assignments/service-names). + +* Kubernetes-defined prefixed names: + * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- + * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 + * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 + +* Other protocols should use implementation-defined prefixed names such as +mycompany.com/my-custom-protocol.
+ 		false
namestring + The name of this port within the service. This must be a DNS_LABEL. +All ports within a ServiceSpec must have unique names. When considering +the endpoints for a Service, this must match the 'name' field in the +EndpointPort. +Optional if only one ServicePort is defined on this service.
+ 		false
nodePortinteger + The port on each node on which this service is exposed when type is +NodePort or LoadBalancer. Usually assigned by the system. If a value is +specified, in-range, and not in use it will be used, otherwise the +operation will fail. If not specified, a port will be allocated if this +Service requires one. If this field is specified when creating a +Service which does not need it, creation will fail. This field will be +wiped when updating a Service to no longer need it (e.g. changing type +from NodePort to ClusterIP). +More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
+
+ Format: int32
+ 		false
protocolstring + The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". +Default is TCP.
+
+ Default: TCP
+ 		false
targetPortint or string + Number or name of the port to access on the pods targeted by the service. +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +If this is a string, it will be looked up as a named port in the +target Pod's container ports. If this is not specified, the value +of the 'port' field is used (an identity map). +This field is ignored for services with clusterIP=None, and should be +omitted or set equal to the 'port' field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
+ 		false
+ + +### OpAMPBridge.spec.resources +[↩ Parent](#opampbridgespec) + + + +Resources to set on the OpAMPBridge pods. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpAMPBridge.spec.resources.claims[index] +[↩ Parent](#opampbridgespecresources) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### OpAMPBridge.spec.securityContext +[↩ Parent](#opampbridgespec) + + + +SecurityContext will be set as the container security context. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### OpAMPBridge.spec.securityContext.appArmorProfile +[↩ Parent](#opampbridgespecsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpAMPBridge.spec.securityContext.capabilities +[↩ Parent](#opampbridgespecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpAMPBridge.spec.securityContext.seLinuxOptions +[↩ Parent](#opampbridgespecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpAMPBridge.spec.securityContext.seccompProfile +[↩ Parent](#opampbridgespecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpAMPBridge.spec.securityContext.windowsOptions +[↩ Parent](#opampbridgespecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpAMPBridge.spec.tolerations[index] +[↩ Parent](#opampbridgespec) + + + +The pod this Toleration is attached to tolerates any taint that matches +the triple using the matching operator . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
effectstring + Effect indicates the taint effect to match. Empty means match all taint effects. +When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ 		false
keystring + 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
operatorstring + 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
tolerationSecondsinteger + 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
valuestring + 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
+ + +### OpAMPBridge.spec.topologySpreadConstraints[index] +[↩ Parent](#opampbridgespec) + + + +TopologySpreadConstraint specifies how to spread matching pods among the given topology. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSkewinteger + 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. +The global minimum is the minimum number of matching pods in an eligible domain +or zero if the number of eligible domains is less than MinDomains. +For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same +labelSelector spread as 2/2/1: +In this case, the global minimum is 1. +| zone1 | zone2 | zone3 | +| P P | P P | P | +- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; +scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring + 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 as a "bucket", and try to put balanced number +of pods into each bucket. +We define a domain as a particular instance of a topology. +Also, we define an eligible domain as a domain whose nodes meet the requirements of +nodeAffinityPolicy and nodeTaintsPolicy. +e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. +And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. +It's a required field.
+ 		true
whenUnsatisfiablestring + 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
labelSelectorobject + 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
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select the pods over which +spreading will be calculated. The keys are used to lookup values from the +incoming pod labels, those key-value labels are ANDed with labelSelector +to select the group of existing pods over which spreading will be calculated +for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +MatchLabelKeys cannot be set when LabelSelector isn't set. +Keys that don't exist in the incoming pod labels will +be ignored. A null or empty list means only match against labelSelector. + +This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ 		false
minDomainsinteger + MinDomains indicates a minimum number of eligible domains. +When the number of eligible domains with matching topology keys is less than minDomains, +Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. +And when the number of eligible domains with matching topology keys equals or greater than minDomains, +this value has no effect on scheduling. +As a result, when the number of eligible domains is less than minDomains, +scheduler won't schedule more than maxSkew Pods to those domains. +If value is nil, the constraint behaves as if MinDomains is equal to 1. +Valid values are integers greater than 0. +When value is not nil, WhenUnsatisfiable must be DoNotSchedule. + +For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same +labelSelector spread as 2/2/2: +| zone1 | zone2 | zone3 | +| P P | P P | P P | +The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. +In this situation, new pod with the same labelSelector cannot be scheduled, +because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, +it will violate MaxSkew.
+
+ Format: int32
+ 		false
nodeAffinityPolicystring + NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector +when calculating pod topology spread skew. Options are: +- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. +- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. + +If this value is nil, the behavior is equivalent to the Honor policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
nodeTaintsPolicystring + NodeTaintsPolicy indicates how we will treat node taints when calculating +pod topology spread skew. Options are: +- Honor: nodes without taints, along with tainted nodes for which the incoming pod +has a toleration, are included. +- Ignore: node taints are ignored. All nodes are included. + +If this value is nil, the behavior is equivalent to the Ignore policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
+ + +### OpAMPBridge.spec.topologySpreadConstraints[index].labelSelector +[↩ Parent](#opampbridgespectopologyspreadconstraintsindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index] +[↩ Parent](#opampbridgespectopologyspreadconstraintsindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.volumeMounts[index] +[↩ Parent](#opampbridgespec) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### OpAMPBridge.spec.volumes[index] +[↩ Parent](#opampbridgespec) + + + +Volume represents a named volume in a pod that may be accessed by any container in the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + name of the volume. +Must be a DNS_LABEL and unique within the pod. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ 		true
awsElasticBlockStoreobject + 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
azureDiskobject + azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ 		false
azureFileobject + azureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ 		false
cephfsobject + cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ 		false
cinderobject + cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		false
configMapobject + configMap represents a configMap that should populate this volume
+ 		false
csiobject + csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ 		false
downwardAPIobject + downwardAPI represents downward API about the pod that should populate this volume
+ 		false
emptyDirobject + emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
ephemeralobject + 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
fcobject + fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ 		false
flexVolumeobject + flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin.
+ 		false
flockerobject + flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ 		false
gcePersistentDiskobject + 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
gitRepoobject + 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
glusterfsobject + 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
hostPathobject + 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
+ 		false
imageobject + image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. +The volume is resolved at pod startup depending on which PullPolicy value is provided: + +- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. + +The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. +A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
+ 		false
iscsiobject + 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
nfsobject + 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
persistentVolumeClaimobject + persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
photonPersistentDiskobject + photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ 		false
portworxVolumeobject + portworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ 		false
projectedobject + projected items for all in one resources secrets, configmaps, and downward API
+ 		false
quobyteobject + quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ 		false
rbdobject + 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
scaleIOobject + scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ 		false
secretobject + secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
storageosobject + storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ 		false
vsphereVolumeobject + vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].awsElasticBlockStore +[↩ Parent](#opampbridgespecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		true
fsTypestring + fsType is the 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
+ 		false
partitioninteger + partition is 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
readOnlyboolean + readOnly value true will force the readOnly setting in VolumeMounts. +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].azureDisk +[↩ Parent](#opampbridgespecvolumesindex) + + + +azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
diskNamestring + diskName is the Name of the data disk in the blob storage
+ 		true
diskURIstring + diskURI is the URI of data disk in the blob storage
+ 		true
cachingModestring + cachingMode is the Host Caching mode: None, Read Only, Read Write.
+ 		false
fsTypestring + fsType is 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.
+
+ Default: ext4
+ 		false
kindstring + kind expected values are 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
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+
+ Default: false
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].azureFile +[↩ Parent](#opampbridgespecvolumesindex) + + + +azureFile represents an Azure File Service mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secretNamestring + secretName is the name of secret that contains Azure Storage Account Name and Key
+ 		true
shareNamestring + shareName is the azure share Name
+ 		true
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].cephfs +[↩ Parent](#opampbridgespecvolumesindex) + + + +cephFS represents a Ceph FS mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
monitors[]string + monitors is Required: Monitors is a collection of Ceph monitors +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		true
pathstring + path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
+ 		false
readOnlyboolean + readOnly is 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
secretFilestring + secretFile is 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
secretRefobject + secretRef is 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
userstring + user is 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
+ + +### OpAMPBridge.spec.volumes[index].cephfs.secretRef +[↩ Parent](#opampbridgespecvolumesindexcephfs) + + + +secretRef is 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 + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].cinder +[↩ Parent](#opampbridgespecvolumesindex) + + + +cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID used to identify the volume in cinder. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		true
fsTypestring + fsType is the 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
readOnlyboolean + readOnly 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
secretRefobject + secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].cinder.secretRef +[↩ Parent](#opampbridgespecvolumesindexcinder) + + + +secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].configMap +[↩ Parent](#opampbridgespecvolumesindex) + + + +configMap represents a configMap that should populate this volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is 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 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].configMap.items[index] +[↩ Parent](#opampbridgespecvolumesindexconfigmap) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpAMPBridge.spec.volumes[index].csi +[↩ Parent](#opampbridgespecvolumesindex) + + + +csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + 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
fsTypestring + fsType 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
nodePublishSecretRefobject + 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
readOnlyboolean + readOnly specifies a read-only configuration for the volume. +Defaults to false (read/write).
+ 		false
volumeAttributesmap[string]string + volumeAttributes stores driver-specific properties that are passed to the CSI +driver. Consult your driver's documentation for supported values.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].csi.nodePublishSecretRef +[↩ Parent](#opampbridgespecvolumesindexcsi) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].downwardAPI +[↩ Parent](#opampbridgespecvolumesindex) + + + +downwardAPI represents downward API about the pod that should populate this volume + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + 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
+ + +### OpAMPBridge.spec.volumes[index].downwardAPI.items[index] +[↩ Parent](#opampbridgespecvolumesindexdownwardapi) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
+ 		false
modeinteger + 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
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].downwardAPI.items[index].fieldRef +[↩ Parent](#opampbridgespecvolumesindexdownwardapiitemsindex) + + + +Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#opampbridgespecvolumesindexdownwardapiitemsindex) + + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].emptyDir +[↩ Parent](#opampbridgespecvolumesindex) + + + +emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mediumstring + medium represents 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
sizeLimitint or string + sizeLimit is the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].ephemeral +[↩ Parent](#opampbridgespecvolumesindex) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeClaimTemplateobject + 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 `-` where +`` 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
+ + +### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate +[↩ Parent](#opampbridgespecvolumesindexephemeral) + + + +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 `-` where +`` 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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec +[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource +[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources +[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector +[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata +[↩ Parent](#opampbridgespecvolumesindexephemeralvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].fc +[↩ Parent](#opampbridgespecvolumesindex) + + + +fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the 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
luninteger + lun is Optional: FC target lun number
+
+ Format: int32
+ 		false
readOnlyboolean + readOnly is Optional: Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
targetWWNs[]string + targetWWNs is Optional: FC target worldwide names (WWNs)
+ 		false
wwids[]string + wwids Optional: FC volume world wide identifiers (wwids) +Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].flexVolume +[↩ Parent](#opampbridgespecvolumesindex) + + + +flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + driver is the name of the driver to use for this volume.
+ 		true
fsTypestring + fsType is the 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
optionsmap[string]string + options is Optional: this field holds extra command options if any.
+ 		false
readOnlyboolean + readOnly is Optional: defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef is 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
+ + +### OpAMPBridge.spec.volumes[index].flexVolume.secretRef +[↩ Parent](#opampbridgespecvolumesindexflexvolume) + + + +secretRef is 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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].flocker +[↩ Parent](#opampbridgespecvolumesindex) + + + +flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
datasetNamestring + datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker +should be considered as deprecated
+ 		false
datasetUUIDstring + datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].gcePersistentDisk +[↩ Parent](#opampbridgespecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdNamestring + pdName is 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
fsTypestring + fsType is 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
+ 		false
partitioninteger + partition is 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
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].gitRepo +[↩ Parent](#opampbridgespecvolumesindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
repositorystring + repository is the URL
+ 		true
directorystring + directory is the 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
revisionstring + revision is the commit hash for the specified revision.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].glusterfs +[↩ Parent](#opampbridgespecvolumesindex) + + + +glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/glusterfs/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
endpointsstring + endpoints is the endpoint name that details Glusterfs topology. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
pathstring + path is the Glusterfs volume path. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
readOnlyboolean + 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
+ + +### OpAMPBridge.spec.volumes[index].hostPath +[↩ Parent](#opampbridgespecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
typestring + type for HostPath Volume +Defaults to "" +More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].image +[↩ Parent](#opampbridgespecvolumesindex) + + + +image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. +The volume is resolved at pod startup depending on which PullPolicy value is provided: + +- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. + +The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. +A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pullPolicystring + Policy for pulling OCI objects. Possible values are: +Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. +Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
+ 		false
referencestring + Required: Image or artifact reference to be used. +Behaves in the same way as pod.spec.containers[*].image. +Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. +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
+ + +### OpAMPBridge.spec.volumes[index].iscsi +[↩ Parent](#opampbridgespecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
iqnstring + iqn is the target iSCSI Qualified Name.
+ 		true
luninteger + lun represents iSCSI Target Lun number.
+
+ Format: int32
+ 		true
targetPortalstring + targetPortal is 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
chapAuthDiscoveryboolean + chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
+ 		false
chapAuthSessionboolean + chapAuthSession defines whether support iSCSI Session CHAP authentication
+ 		false
fsTypestring + fsType is the 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
+ 		false
initiatorNamestring + initiatorName is the custom iSCSI Initiator Name. +If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface +: will be created for the connection.
+ 		false
iscsiInterfacestring + iscsiInterface is the interface Name that uses an iSCSI transport. +Defaults to 'default' (tcp).
+
+ Default: default
+ 		false
portals[]string + portals is the 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
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false.
+ 		false
secretRefobject + secretRef is the CHAP Secret for iSCSI target and initiator authentication
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].iscsi.secretRef +[↩ Parent](#opampbridgespecvolumesindexiscsi) + + + +secretRef is the CHAP Secret for iSCSI target and initiator authentication + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].nfs +[↩ Parent](#opampbridgespecvolumesindex) + + + +nfs represents an NFS mount on the host that shares a pod's lifetime +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path that is exported by the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
serverstring + server is the hostname or IP address of the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
readOnlyboolean + 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
+ + +### OpAMPBridge.spec.volumes[index].persistentVolumeClaim +[↩ Parent](#opampbridgespecvolumesindex) + + + +persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claimNamestring + 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
readOnlyboolean + readOnly Will force the ReadOnly setting in VolumeMounts. +Default false.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].photonPersistentDisk +[↩ Parent](#opampbridgespecvolumesindex) + + + +photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdIDstring + pdID is the ID that identifies Photon Controller persistent disk
+ 		true
fsTypestring + fsType is the 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
+ + +### OpAMPBridge.spec.volumes[index].portworxVolume +[↩ Parent](#opampbridgespecvolumesindex) + + + +portworxVolume represents a portworx volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID uniquely identifies a Portworx volume
+ 		true
fsTypestring + 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
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected +[↩ Parent](#opampbridgespecvolumesindex) + + + +projected items for all in one resources secrets, configmaps, and downward API + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode are the 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 + sources is the list of volume projections. Each entry in this list +handles one source.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index] +[↩ Parent](#opampbridgespecvolumesindexprojected) + + + +Projection that may be projected along with other supported volume types. +Exactly one of these fields must be set. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
clusterTrustBundleobject + ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time.
+ 		false
configMapobject + configMap information about the configMap data to project
+ 		false
downwardAPIobject + downwardAPI information about the downwardAPI data to project
+ 		false
secretobject + secret information about the secret data to project
+ 		false
serviceAccountTokenobject + serviceAccountToken is information about the serviceAccountToken data to project
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].clusterTrustBundle +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) + + + +ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Relative path from the volume root to write the bundle.
+ 		true
labelSelectorobject + Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything".
+ 		false
namestring + Select a single ClusterTrustBundle by object name. Mutually-exclusive +with signerName and labelSelector.
+ 		false
optionalboolean + If true, don't block pod startup if the referenced ClusterTrustBundle(s) +aren't available. If using name, then the named ClusterTrustBundle is +allowed not to exist. If using signerName, then the combination of +signerName and labelSelector is allowed to match zero +ClusterTrustBundles.
+ 		false
signerNamestring + Select all ClusterTrustBundles that match this signer name. +Mutually-exclusive with name. The contents of all selected +ClusterTrustBundles will be unified and deduplicated.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexclustertrustbundle) + + + +Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything". + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index] +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexclustertrustbundlelabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].configMap +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) + + + +configMap information about the configMap data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].configMap.items[index] +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexconfigmap) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].downwardAPI +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) + + + +downwardAPI information about the downwardAPI data to project + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + Items is a list of DownwardAPIVolume file
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].downwardAPI.items[index] +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexdownwardapi) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
+ 		false
modeinteger + 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
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + + +Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].secret +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) + + + +secret information about the secret data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional field specify whether the Secret or its key must be defined
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].secret.items[index] +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindexsecret) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpAMPBridge.spec.volumes[index].projected.sources[index].serviceAccountToken +[↩ Parent](#opampbridgespecvolumesindexprojectedsourcesindex) + + + +serviceAccountToken is information about the serviceAccountToken data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path is the path relative to the mount point of the file to project the +token into.
+ 		true
audiencestring + 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
expirationSecondsinteger + 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
+ + +### OpAMPBridge.spec.volumes[index].quobyte +[↩ Parent](#opampbridgespecvolumesindex) + + + +quobyte represents a Quobyte mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
registrystring + 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
volumestring + volume is a string that references an already created Quobyte volume by name.
+ 		true
groupstring + group to map volume access to +Default is no group
+ 		false
readOnlyboolean + readOnly here will force the Quobyte volume to be mounted with read-only permissions. +Defaults to false.
+ 		false
tenantstring + tenant owning the given Quobyte volume in the Backend +Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ 		false
userstring + user to map volume access to +Defaults to serivceaccount user
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].rbd +[↩ Parent](#opampbridgespecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + image is the rados image name. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
monitors[]string + monitors is a collection of Ceph monitors. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
fsTypestring + fsType is the 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
+ 		false
keyringstring + 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
+
+ Default: /etc/ceph/keyring
+ 		false
poolstring + pool is the rados pool name. +Default is rbd. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+
+ Default: rbd
+ 		false
readOnlyboolean + 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
secretRefobject + 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
userstring + user is the rados user name. +Default is admin. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+
+ Default: admin
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].rbd.secretRef +[↩ Parent](#opampbridgespecvolumesindexrbd) + + + +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 + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].scaleIO +[↩ Parent](#opampbridgespecvolumesindex) + + + +scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gatewaystring + gateway is the host address of the ScaleIO API Gateway.
+ 		true
secretRefobject + secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail.
+ 		true
systemstring + system is the name of the storage system as configured in ScaleIO.
+ 		true
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". +Default is "xfs".
+
+ Default: xfs
+ 		false
protectionDomainstring + protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
+ 		false
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
sslEnabledboolean + sslEnabled Flag enable/disable SSL communication with Gateway, default false
+ 		false
storageModestring + storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. +Default is ThinProvisioned.
+
+ Default: ThinProvisioned
+ 		false
storagePoolstring + storagePool is the ScaleIO Storage Pool associated with the protection domain.
+ 		false
volumeNamestring + volumeName is the name of a volume already created in the ScaleIO system +that is associated with this volume source.
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].scaleIO.secretRef +[↩ Parent](#opampbridgespecvolumesindexscaleio) + + + +secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].secret +[↩ Parent](#opampbridgespecvolumesindex) + + + +secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is 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 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
optionalboolean + optional field specify whether the Secret or its keys must be defined
+ 		false
secretNamestring + secretName is the name of the secret in the pod's namespace to use. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].secret.items[index] +[↩ Parent](#opampbridgespecvolumesindexsecret) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpAMPBridge.spec.volumes[index].storageos +[↩ Parent](#opampbridgespecvolumesindex) + + + +storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the 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
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted.
+ 		false
volumeNamestring + volumeName is the human-readable name of the StorageOS volume. Volume +names are only unique within a namespace.
+ 		false
volumeNamespacestring + 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
+ + +### OpAMPBridge.spec.volumes[index].storageos.secretRef +[↩ Parent](#opampbridgespecvolumesindexstorageos) + + + +secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpAMPBridge.spec.volumes[index].vsphereVolume +[↩ Parent](#opampbridgespecvolumesindex) + + + +vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumePathstring + volumePath is the path that identifies vSphere volume vmdk
+ 		true
fsTypestring + fsType is 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
storagePolicyIDstring + storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ 		false
storagePolicyNamestring + storagePolicyName is the storage Policy Based Management (SPBM) profile name.
+ 		false
+ + +### OpAMPBridge.status +[↩ Parent](#opampbridge) + + + +OpAMPBridgeStatus defines the observed state of OpAMPBridge. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
versionstring + Version of the managed OpAMP Bridge (operand)
+ 		false
\ No newline at end of file diff --git a/docs/api/opentelemetrycollectors.md b/docs/api/opentelemetrycollectors.md new file mode 100644 index 0000000000..85b6ee2227 --- /dev/null +++ b/docs/api/opentelemetrycollectors.md @@ -0,0 +1,39263 @@ +# API Reference + +Packages: + +- [opentelemetry.io/v1alpha1](#opentelemetryiov1alpha1) +- [opentelemetry.io/v1beta1](#opentelemetryiov1beta1) + +# opentelemetry.io/v1alpha1 + +Resource Types: + +- [OpenTelemetryCollector](#opentelemetrycollector) + + + + +## OpenTelemetryCollector +[↩ Parent](#opentelemetryiov1alpha1 ) + + + + + + +OpenTelemetryCollector is the Schema for the opentelemetrycollectors API. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringOpenTelemetryCollectortrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.
+ 		false
statusobject + OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector.
+ 		false
+ + +### OpenTelemetryCollector.spec +[↩ Parent](#opentelemetrycollector) + + + +OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configstring + Config is the raw YAML to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.
+ 		true
managementStateenum + ManagementState defines if the CR should be managed by the operator or not. +Default is managed.
+
+ Enum: managed, unmanaged
+ Default: managed
+ 		true
additionalContainers[]object + AdditionalContainers allows injecting additional containers into the Collector's pod definition. +These sidecar containers can be used for authentication proxies, log shipping sidecars, agents for shipping +metrics to their cloud, or in general sidecars that do not support automatic injection. This option only +applies to Deployment, DaemonSet, and StatefulSet deployment modes of the collector. It does not apply to the sidecar +deployment mode. More info about sidecars: +https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/ + +Container names managed by the operator: +* `otc-container` + +Overriding containers managed by the operator is outside the scope of what the maintainers will support and by +doing so, you wil accept the risk of it breaking things.
+ 		false
affinityobject + If specified, indicates the pod's scheduling constraints
+ 		false
argsmap[string]string + Args is the set of arguments to pass to the OpenTelemetry Collector binary
+ 		false
autoscalerobject + Autoscaler specifies the pod autoscaling configuration to use +for the OpenTelemetryCollector workload.
+ 		false
configmaps[]object + ConfigMaps is a list of ConfigMaps in the same namespace as the OpenTelemetryCollector +object, which shall be mounted into the Collector Pods. +Each ConfigMap will be added to the Collector's Deployments as a volume named `configmap-`.
+ 		false
deploymentUpdateStrategyobject + UpdateStrategy represents the strategy the operator will take replacing existing Deployment pods with new pods +https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/#DeploymentSpec +This is only applicable to Deployment mode.
+ 		false
env[]object + ENV vars to set on the OpenTelemetry Collector's Pods. These can then in certain cases be +consumed in the config file for the Collector.
+ 		false
envFrom[]object + List of sources to populate environment variables on the OpenTelemetry Collector's Pods. +These can then in certain cases be consumed in the config file for the Collector.
+ 		false
hostNetworkboolean + HostNetwork indicates if the pod should run in the host networking namespace.
+ 		false
imagestring + Image indicates the container image to use for the OpenTelemetry Collector.
+ 		false
imagePullPolicystring + ImagePullPolicy indicates the pull policy to be used for retrieving the container image (Always, Never, IfNotPresent)
+ 		false
ingressobject + Ingress is used to specify how OpenTelemetry Collector is exposed. This +functionality is only available if one of the valid modes is set. +Valid modes are: deployment, daemonset and statefulset.
+ 		false
initContainers[]object + InitContainers allows injecting initContainers to the Collector's pod definition. +These init containers can be used to fetch secrets for injection into the +configuration from external sources, run added checks, etc. Any errors during the execution of +an initContainer will lead to a restart of the Pod. More info: +https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
+ 		false
lifecycleobject + Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ 		false
livenessProbeobject + Liveness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. +It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline.
+ 		false
maxReplicasinteger + MaxReplicas sets an upper bound to the autoscaling feature. If MaxReplicas is set autoscaling is enabled. +Deprecated: use "OpenTelemetryCollector.Spec.Autoscaler.MaxReplicas" instead.
+
+ Format: int32
+ 		false
minReplicasinteger + MinReplicas sets a lower bound to the autoscaling feature. Set this if you are using autoscaling. It must be at least 1 +Deprecated: use "OpenTelemetryCollector.Spec.Autoscaler.MinReplicas" instead.
+
+ Format: int32
+ 		false
modeenum + Mode represents how the collector should be deployed (deployment, daemonset, statefulset or sidecar)
+
+ Enum: daemonset, deployment, sidecar, statefulset
+ 		false
nodeSelectormap[string]string + NodeSelector to schedule OpenTelemetry Collector pods. +This is only relevant to daemonset, statefulset, and deployment mode
+ 		false
observabilityobject + ObservabilitySpec defines how telemetry data gets handled.
+ 		false
podAnnotationsmap[string]string + PodAnnotations is the set of annotations that will be attached to +Collector and Target Allocator pods.
+ 		false
podDisruptionBudgetobject + PodDisruptionBudget specifies the pod disruption budget configuration to use +for the OpenTelemetryCollector workload.
+ 		false
podSecurityContextobject + PodSecurityContext configures the pod security context for the +opentelemetry-collector pod, when running as a deployment, daemonset, +or statefulset. + +In sidecar mode, the opentelemetry-operator will ignore this setting.
+ 		false
ports[]object + Ports allows a set of ports to be exposed by the underlying v1.Service. By default, the operator +will attempt to infer the required ports by parsing the .Spec.Config property but this property can be +used to open additional ports that can't be inferred by the operator, like for custom receivers.
+ 		false
priorityClassNamestring + If specified, indicates the pod's priority. +If not specified, the pod priority will be default or zero if there is no +default.
+ 		false
replicasinteger + Replicas is the number of pod instances for the underlying OpenTelemetry Collector. Set this if your are not using autoscaling
+
+ Format: int32
+ 		false
resourcesobject + Resources to set on the OpenTelemetry Collector pods.
+ 		false
securityContextobject + SecurityContext configures the container security context for +the opentelemetry-collector container. + +In deployment, daemonset, or statefulset mode, this controls +the security context settings for the primary application +container. + +In sidecar mode, this controls the security context for the +injected sidecar container.
+ 		false
serviceAccountstring + ServiceAccount indicates the name of an existing service account to use with this instance. When set, +the operator will not automatically create a ServiceAccount for the collector.
+ 		false
shareProcessNamespaceboolean + ShareProcessNamespace indicates if the pod's containers should share process namespace.
+ 		false
targetAllocatorobject + TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not.
+ 		false
terminationGracePeriodSecondsinteger + Duration in seconds the pod needs to terminate gracefully upon probe failure.
+
+ Format: int64
+ 		false
tolerations[]object + Toleration to schedule OpenTelemetry Collector pods. +This is only relevant to daemonset, statefulset, and deployment mode
+ 		false
topologySpreadConstraints[]object + TopologySpreadConstraints embedded kubernetes pod configuration option, +controls how pods are spread across your cluster among failure-domains +such as regions, zones, nodes, and other user-defined topology domains +https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ +This is only relevant to statefulset, and deployment mode
+ 		false
updateStrategyobject + UpdateStrategy represents the strategy the operator will take replacing existing DaemonSet pods with new pods +https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/daemon-set-v1/#DaemonSetSpec +This is only applicable to Daemonset mode.
+ 		false
upgradeStrategyenum + UpgradeStrategy represents how the operator will handle upgrades to the CR when a newer version of the operator is deployed
+
+ Enum: automatic, none
+ 		false
volumeClaimTemplates[]object + VolumeClaimTemplates will provide stable storage using PersistentVolumes. Only available when the mode=statefulset.
+ 		false
volumeMounts[]object + VolumeMounts represents the mount points to use in the underlying collector deployment(s)
+ 		false
volumes[]object + Volumes represents which volumes to use in the underlying collector deployment(s).
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +A single application container that you want to run within a pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + 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 container 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 container 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
imagestring + Container 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
imagePullPolicystring + 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
lifecycleobject + Actions that the management system should take in response to container lifecycle events. +Cannot be updated.
+ 		false
livenessProbeobject + 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. 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. +Modifying this array with strategic merge patch may corrupt the data. +For more information See https://github.com/kubernetes/kubernetes/issues/108255. +Cannot be updated.
+ 		false
readinessProbeobject + 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
resizePolicy[]object + Resources resize policy for the container.
+ 		false
resourcesobject + Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
restartPolicystring + RestartPolicy defines the restart behavior of individual containers in a pod. +This field may only be set for init containers, and the only allowed value is "Always". +For non-init containers or when this field is not specified, +the restart behavior is defined by the Pod's restart policy and the container type. +Setting the RestartPolicy as "Always" for the init container will have the following effect: +this init container will be continually restarted on +exit until all regular containers have terminated. Once all regular +containers have completed, all init containers with restartPolicy "Always" +will be shut down. This lifecycle differs from normal init containers and +is often referred to as a "sidecar" container. Although this init +container still starts in the init container sequence, it does not wait +for the container to complete before proceeding to the next init +container. Instead, the next init container starts immediately after this +init container is started, or after any startupProbe has successfully +completed.
+ 		false
securityContextobject + 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
startupProbeobject + 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
stdinboolean + 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
stdinOnceboolean + 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
terminationMessagePathstring + 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
terminationMessagePolicystring + 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
ttyboolean + 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
workingDirstring + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.configMapKeyRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.fieldRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.secretKeyRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index].configMapRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvfromindex) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index].secretRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvfromindex) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
postStartobject + 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
preStopobject + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststarthttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.sleep +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestophttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.sleep +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.grpc +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].ports[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +ContainerPort represents a network port in a single container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
containerPortinteger + Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536.
+
+ Format: int32
+ 		true
hostIPstring + What host IP to bind the external port to.
+ 		false
hostPortinteger + 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
namestring + 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
protocolstring + Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP".
+
+ Default: TCP
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.grpc +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].resizePolicy[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +ContainerResizePolicy represents resource resize policy for the container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourceNamestring + Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory.
+ 		true
restartPolicystring + Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired.
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].resources +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].resources.claims[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexresources) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +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/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.capabilities +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.grpc +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].volumeDevices[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +volumeDevice describes a mapping of a raw block device within a container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
devicePathstring + devicePath is the path inside of the container that the device will be mapped to.
+ 		true
namestring + name must match the name of a persistentVolumeClaim in the pod
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].volumeMounts[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### OpenTelemetryCollector.spec.affinity +[↩ Parent](#opentelemetrycollectorspec) + + + +If specified, indicates the pod's scheduling constraints + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeAffinityobject + Describes node affinity scheduling rules for the pod.
+ 		false
podAffinityobject + Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
podAntiAffinityobject + Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity +[↩ Parent](#opentelemetrycollectorspecaffinity) + + + +Describes node affinity scheduling rules for the pod. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject + 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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinity) + + + +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). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
preferenceobject + A node selector term, associated with the corresponding weight.
+ 		true
weightinteger + Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +A node selector term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinity) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeSelectorTerms[]object + Required. A list of node selector terms. The terms are ORed.
+ 		true
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity +[↩ Parent](#opentelemetrycollectorspecaffinity) + + + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinity) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinity) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity +[↩ Parent](#opentelemetrycollectorspecaffinity) + + + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinity) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinity) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.autoscaler +[↩ Parent](#opentelemetrycollectorspec) + + + +Autoscaler specifies the pod autoscaling configuration to use +for the OpenTelemetryCollector workload. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
behaviorobject + HorizontalPodAutoscalerBehavior configures the scaling behavior of the target +in both Up and Down directions (scaleUp and scaleDown fields respectively).
+ 		false
maxReplicasinteger + MaxReplicas sets an upper bound to the autoscaling feature. If MaxReplicas is set autoscaling is enabled.
+
+ Format: int32
+ 		false
metrics[]object + Metrics is meant to provide a customizable way to configure HPA metrics. +currently the only supported custom metrics is type=Pod. +Use TargetCPUUtilization or TargetMemoryUtilization instead if scaling on these common resource metrics.
+ 		false
minReplicasinteger + MinReplicas sets a lower bound to the autoscaling feature. Set this if your are using autoscaling. It must be at least 1
+
+ Format: int32
+ 		false
targetCPUUtilizationinteger + TargetCPUUtilization sets the target average CPU used across all replicas. +If average CPU exceeds this value, the HPA will scale up. Defaults to 90 percent.
+
+ Format: int32
+ 		false
targetMemoryUtilizationinteger + TargetMemoryUtilization sets the target average memory utilization across all replicas
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior +[↩ Parent](#opentelemetrycollectorspecautoscaler) + + + +HorizontalPodAutoscalerBehavior configures the scaling behavior of the target +in both Up and Down directions (scaleUp and scaleDown fields respectively). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
scaleDownobject + scaleDown is scaling policy for scaling Down. +If not set, the default value is to allow to scale down to minReplicas pods, with a +300 second stabilization window (i.e., the highest recommendation for +the last 300sec is used).
+ 		false
scaleUpobject + scaleUp is scaling policy for scaling Up. +If not set, the default value is the higher of: + * increase no more than 4 pods per 60 seconds + * double the number of pods per 60 seconds +No stabilization is used.
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior.scaleDown +[↩ Parent](#opentelemetrycollectorspecautoscalerbehavior) + + + +scaleDown is scaling policy for scaling Down. +If not set, the default value is to allow to scale down to minReplicas pods, with a +300 second stabilization window (i.e., the highest recommendation for +the last 300sec is used). + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
policies[]object + policies is a list of potential scaling polices which can be used during scaling. +At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
+ 		false
selectPolicystring + selectPolicy is used to specify which policy should be used. +If not set, the default value Max is used.
+ 		false
stabilizationWindowSecondsinteger + stabilizationWindowSeconds is the number of seconds for which past recommendations should be +considered while scaling up or scaling down. +StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). +If not set, use the default values: +- For scale up: 0 (i.e. no stabilization is done). +- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior.scaleDown.policies[index] +[↩ Parent](#opentelemetrycollectorspecautoscalerbehaviorscaledown) + + + +HPAScalingPolicy is a single policy which must hold true for a specified past interval. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
periodSecondsinteger + periodSeconds specifies the window of time for which the policy should hold true. +PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
+
+ Format: int32
+ 		true
typestring + type is used to specify the scaling policy.
+ 		true
valueinteger + value contains the amount of change which is permitted by the policy. +It must be greater than zero
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior.scaleUp +[↩ Parent](#opentelemetrycollectorspecautoscalerbehavior) + + + +scaleUp is scaling policy for scaling Up. +If not set, the default value is the higher of: + * increase no more than 4 pods per 60 seconds + * double the number of pods per 60 seconds +No stabilization is used. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
policies[]object + policies is a list of potential scaling polices which can be used during scaling. +At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
+ 		false
selectPolicystring + selectPolicy is used to specify which policy should be used. +If not set, the default value Max is used.
+ 		false
stabilizationWindowSecondsinteger + stabilizationWindowSeconds is the number of seconds for which past recommendations should be +considered while scaling up or scaling down. +StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). +If not set, use the default values: +- For scale up: 0 (i.e. no stabilization is done). +- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior.scaleUp.policies[index] +[↩ Parent](#opentelemetrycollectorspecautoscalerbehaviorscaleup) + + + +HPAScalingPolicy is a single policy which must hold true for a specified past interval. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
periodSecondsinteger + periodSeconds specifies the window of time for which the policy should hold true. +PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
+
+ Format: int32
+ 		true
typestring + type is used to specify the scaling policy.
+ 		true
valueinteger + value contains the amount of change which is permitted by the policy. +It must be greater than zero
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index] +[↩ Parent](#opentelemetrycollectorspecautoscaler) + + + +MetricSpec defines a subset of metrics to be defined for the HPA's metric array +more metric type can be supported as needed. +See https://pkg.go.dev/k8s.io/api/autoscaling/v2#MetricSpec for reference. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + MetricSourceType indicates the type of metric.
+ 		true
podsobject + PodsMetricSource indicates how to scale on a metric describing each pod in +the current scale target (for example, transactions-processed-per-second). +The values will be averaged together before being compared to the target +value.
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindex) + + + +PodsMetricSource indicates how to scale on a metric describing each pod in +the current scale target (for example, transactions-processed-per-second). +The values will be averaged together before being compared to the target +value. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
metricobject + metric identifies the target metric by name and selector
+ 		true
targetobject + target specifies the target value for the given metric
+ 		true
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpods) + + + +metric identifies the target metric by name and selector + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + name is the name of the given metric
+ 		true
selectorobject + selector is the string-encoded form of a standard kubernetes label selector for the given metric +When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. +When unset, just the metricName will be used to gather metrics.
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric.selector +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpodsmetric) + + + +selector is the string-encoded form of a standard kubernetes label selector for the given metric +When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. +When unset, just the metricName will be used to gather metrics. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric.selector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpodsmetricselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.target +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpods) + + + +target specifies the target value for the given metric + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type represents whether the metric type is Utilization, Value, or AverageValue
+ 		true
averageUtilizationinteger + averageUtilization is the target value of the average of the +resource metric across all relevant pods, represented as a percentage of +the requested value of the resource for the pods. +Currently only valid for Resource metric source type
+
+ Format: int32
+ 		false
averageValueint or string + averageValue is the target value of the average of the +metric across all relevant pods (as a quantity)
+ 		false
valueint or string + value is the target value of the metric (as a quantity).
+ 		false
+ + +### OpenTelemetryCollector.spec.configmaps[index] +[↩ Parent](#opentelemetrycollectorspec) + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountpathstring +
+ 		true
namestring + Configmap defines name and path where the configMaps should be mounted.
+ 		true
+ + +### OpenTelemetryCollector.spec.deploymentUpdateStrategy +[↩ Parent](#opentelemetrycollectorspec) + + + +UpdateStrategy represents the strategy the operator will take replacing existing Deployment pods with new pods +https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/#DeploymentSpec +This is only applicable to Deployment mode. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
rollingUpdateobject + Rolling update config params. Present only if DeploymentStrategyType = +RollingUpdate.
+ 		false
typestring + Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
+ 		false
+ + +### OpenTelemetryCollector.spec.deploymentUpdateStrategy.rollingUpdate +[↩ Parent](#opentelemetrycollectorspecdeploymentupdatestrategy) + + + +Rolling update config params. Present only if DeploymentStrategyType = +RollingUpdate. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSurgeint or string + The maximum number of pods that can be scheduled above the desired number of +pods. +Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). +This can not be 0 if MaxUnavailable is 0. +Absolute number is calculated from percentage by rounding up. +Defaults to 25%. +Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when +the rolling update starts, such that the total number of old and new pods do not exceed +130% of desired pods. Once old pods have been killed, +new ReplicaSet can be scaled up further, ensuring that total number of pods running +at any time during the update is at most 130% of desired pods.
+ 		false
maxUnavailableint or string + The maximum number of pods that can be unavailable during the update. +Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). +Absolute number is calculated from percentage by rounding down. +This can not be 0 if MaxSurge is 0. +Defaults to 25%. +Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods +immediately when the rolling update starts. Once new pods are ready, old ReplicaSet +can be scaled down further, followed by scaling up the new ReplicaSet, ensuring +that the total number of pods available at all times during the update is at +least 70% of desired pods.
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom +[↩ Parent](#opentelemetrycollectorspecenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.configMapKeyRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.fieldRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.secretKeyRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.envFrom[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### OpenTelemetryCollector.spec.envFrom[index].configMapRef +[↩ Parent](#opentelemetrycollectorspecenvfromindex) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.envFrom[index].secretRef +[↩ Parent](#opentelemetrycollectorspecenvfromindex) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.ingress +[↩ Parent](#opentelemetrycollectorspec) + + + +Ingress is used to specify how OpenTelemetry Collector is exposed. This +functionality is only available if one of the valid modes is set. +Valid modes are: deployment, daemonset and statefulset. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string + Annotations to add to ingress. +e.g. 'cert-manager.io/cluster-issuer: "letsencrypt"'
+ 		false
hostnamestring + Hostname by which the ingress proxy can be reached.
+ 		false
ingressClassNamestring + IngressClassName is the name of an IngressClass cluster resource. Ingress +controller implementations use this field to know whether they should be +serving this Ingress resource.
+ 		false
routeobject + Route is an OpenShift specific section that is only considered when +type "route" is used.
+ 		false
ruleTypeenum + RuleType defines how Ingress exposes collector receivers. +IngressRuleTypePath ("path") exposes each receiver port on a unique path on single domain defined in Hostname. +IngressRuleTypeSubdomain ("subdomain") exposes each receiver port on a unique subdomain of Hostname. +Default is IngressRuleTypePath ("path").
+
+ Enum: path, subdomain
+ 		false
tls[]object + TLS configuration.
+ 		false
typeenum + Type default value is: "" +Supported types are: ingress, route
+
+ Enum: ingress, route
+ 		false
+ + +### OpenTelemetryCollector.spec.ingress.route +[↩ Parent](#opentelemetrycollectorspecingress) + + + +Route is an OpenShift specific section that is only considered when +type "route" is used. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
terminationenum + Termination indicates termination type. By default "edge" is used.
+
+ Enum: insecure, edge, passthrough, reencrypt
+ 		false
+ + +### OpenTelemetryCollector.spec.ingress.tls[index] +[↩ Parent](#opentelemetrycollectorspecingress) + + + +IngressTLS describes the transport layer security associated with an ingress. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
hosts[]string + hosts is a list of hosts included in the TLS certificate. The values in +this list must match the name/s used in the tlsSecret. Defaults to the +wildcard host setting for the loadbalancer controller fulfilling this +Ingress, if left unspecified.
+ 		false
secretNamestring + secretName is the name of the secret used to terminate TLS traffic on +port 443. Field is left optional to allow TLS routing based on SNI +hostname alone. If the SNI host in a listener conflicts with the "Host" +header field used by an IngressRule, the SNI host is used for termination +and value of the "Host" header is used for routing.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +A single application container that you want to run within a pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + 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 container 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 container 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
imagestring + Container 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
imagePullPolicystring + 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
lifecycleobject + Actions that the management system should take in response to container lifecycle events. +Cannot be updated.
+ 		false
livenessProbeobject + 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. 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. +Modifying this array with strategic merge patch may corrupt the data. +For more information See https://github.com/kubernetes/kubernetes/issues/108255. +Cannot be updated.
+ 		false
readinessProbeobject + 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
resizePolicy[]object + Resources resize policy for the container.
+ 		false
resourcesobject + Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
restartPolicystring + RestartPolicy defines the restart behavior of individual containers in a pod. +This field may only be set for init containers, and the only allowed value is "Always". +For non-init containers or when this field is not specified, +the restart behavior is defined by the Pod's restart policy and the container type. +Setting the RestartPolicy as "Always" for the init container will have the following effect: +this init container will be continually restarted on +exit until all regular containers have terminated. Once all regular +containers have completed, all init containers with restartPolicy "Always" +will be shut down. This lifecycle differs from normal init containers and +is often referred to as a "sidecar" container. Although this init +container still starts in the init container sequence, it does not wait +for the container to complete before proceeding to the next init +container. Instead, the next init container starts immediately after this +init container is started, or after any startupProbe has successfully +completed.
+ 		false
securityContextobject + 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
startupProbeobject + 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
stdinboolean + 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
stdinOnceboolean + 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
terminationMessagePathstring + 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
terminationMessagePolicystring + 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
ttyboolean + 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
workingDirstring + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.configMapKeyRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.fieldRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.secretKeyRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].envFrom[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].envFrom[index].configMapRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvfromindex) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].envFrom[index].secretRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvfromindex) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
postStartobject + 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
preStopobject + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststarthttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.sleep +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestophttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.sleep +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.grpc +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].ports[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +ContainerPort represents a network port in a single container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
containerPortinteger + Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536.
+
+ Format: int32
+ 		true
hostIPstring + What host IP to bind the external port to.
+ 		false
hostPortinteger + 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
namestring + 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
protocolstring + Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP".
+
+ Default: TCP
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.grpc +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].resizePolicy[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +ContainerResizePolicy represents resource resize policy for the container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourceNamestring + Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory.
+ 		true
restartPolicystring + Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired.
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].resources +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].resources.claims[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexresources) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +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/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.capabilities +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.grpc +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].volumeDevices[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +volumeDevice describes a mapping of a raw block device within a container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
devicePathstring + devicePath is the path inside of the container that the device will be mapped to.
+ 		true
namestring + name must match the name of a persistentVolumeClaim in the pod
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].volumeMounts[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### OpenTelemetryCollector.spec.lifecycle +[↩ Parent](#opentelemetrycollectorspec) + + + +Actions that the management system should take in response to container lifecycle events. Cannot be updated. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
postStartobject + 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
preStopobject + 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
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart +[↩ Parent](#opentelemetrycollectorspeclifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.exec +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.httpGet +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststarthttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.sleep +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.tcpSocket +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop +[↩ Parent](#opentelemetrycollectorspeclifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.exec +[↩ Parent](#opentelemetrycollectorspeclifecycleprestop) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.httpGet +[↩ Parent](#opentelemetrycollectorspeclifecycleprestop) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspeclifecycleprestophttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.sleep +[↩ Parent](#opentelemetrycollectorspeclifecycleprestop) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.tcpSocket +[↩ Parent](#opentelemetrycollectorspeclifecycleprestop) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.livenessProbe +[↩ Parent](#opentelemetrycollectorspec) + + + +Liveness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. +It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
initialDelaySecondsinteger + Number of seconds after the container has started before liveness probes are initiated. +Defaults to 0 seconds. Minimum value is 0. +More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+
+ Format: int32
+ 		false
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.observability +[↩ Parent](#opentelemetrycollectorspec) + + + +ObservabilitySpec defines how telemetry data gets handled. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
metricsobject + Metrics defines the metrics configuration for operands.
+ 		false
+ + +### OpenTelemetryCollector.spec.observability.metrics +[↩ Parent](#opentelemetrycollectorspecobservability) + + + +Metrics defines the metrics configuration for operands. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
DisablePrometheusAnnotationsboolean + DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations +('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
+ 		false
enableMetricsboolean + EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. +The operator.observability.prometheus feature gate must be enabled to use this feature.
+ 		false
+ + +### OpenTelemetryCollector.spec.podDisruptionBudget +[↩ Parent](#opentelemetrycollectorspec) + + + +PodDisruptionBudget specifies the pod disruption budget configuration to use +for the OpenTelemetryCollector workload. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxUnavailableint or string + An eviction is allowed if at most "maxUnavailable" pods selected by +"selector" are unavailable after the eviction, i.e. even in absence of +the evicted pod. For example, one can prevent all voluntary evictions +by specifying 0. This is a mutually exclusive setting with "minAvailable".
+ 		false
minAvailableint or string + An eviction is allowed if at least "minAvailable" pods selected by +"selector" will still be available after the eviction, i.e. even in the +absence of the evicted pod. So for example you can prevent all voluntary +evictions by specifying "100%".
+ 		false
+ + +### OpenTelemetryCollector.spec.podSecurityContext +[↩ Parent](#opentelemetrycollectorspec) + + + +PodSecurityContext configures the pod security context for the +opentelemetry-collector pod, when running as a deployment, daemonset, +or statefulset. + +In sidecar mode, the opentelemetry-operator will ignore this setting. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
appArmorProfileobject + appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
fsGroupinteger + 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
fsGroupChangePolicystring + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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 and fsGroup (if specified). If +the SupplementalGroupsPolicy feature is enabled, the +supplementalGroupsPolicy field determines whether these are in addition +to or instead of any group memberships defined in the container image. +If unspecified, no additional groups are added, though group memberships +defined in the container image may still be used, depending on the +supplementalGroupsPolicy field. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
supplementalGroupsPolicystring + Defines how supplemental groups of the first container processes are calculated. +Valid values are "Merge" and "Strict". If not specified, "Merge" is used. +(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled +and the container runtime must implement support for this feature. +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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.podSecurityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.podSecurityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.podSecurityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) + + + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.podSecurityContext.sysctls[index] +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) + + + +Sysctl defines a kernel parameter to be set + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of a property to set
+ 		true
valuestring + Value of a property to set
+ 		true
+ + +### OpenTelemetryCollector.spec.podSecurityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.ports[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +PortsSpec defines the OpenTelemetryCollector's container/service ports additional specifications. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + The port that will be exposed by this service.
+
+ Format: int32
+ 		true
appProtocolstring + The application protocol for this port. +This is used as a hint for implementations to offer richer behavior for protocols that they understand. +This field follows standard Kubernetes label syntax. +Valid values are either: + +* Un-prefixed protocol names - reserved for IANA standard service names (as per +RFC-6335 and https://www.iana.org/assignments/service-names). + +* Kubernetes-defined prefixed names: + * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- + * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 + * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 + +* Other protocols should use implementation-defined prefixed names such as +mycompany.com/my-custom-protocol.
+ 		false
hostPortinteger + Allows defining which port to bind to the host in the Container.
+
+ Format: int32
+ 		false
namestring + The name of this port within the service. This must be a DNS_LABEL. +All ports within a ServiceSpec must have unique names. When considering +the endpoints for a Service, this must match the 'name' field in the +EndpointPort. +Optional if only one ServicePort is defined on this service.
+ 		false
nodePortinteger + The port on each node on which this service is exposed when type is +NodePort or LoadBalancer. Usually assigned by the system. If a value is +specified, in-range, and not in use it will be used, otherwise the +operation will fail. If not specified, a port will be allocated if this +Service requires one. If this field is specified when creating a +Service which does not need it, creation will fail. This field will be +wiped when updating a Service to no longer need it (e.g. changing type +from NodePort to ClusterIP). +More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
+
+ Format: int32
+ 		false
protocolstring + The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". +Default is TCP.
+
+ Default: TCP
+ 		false
targetPortint or string + Number or name of the port to access on the pods targeted by the service. +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +If this is a string, it will be looked up as a named port in the +target Pod's container ports. If this is not specified, the value +of the 'port' field is used (an identity map). +This field is ignored for services with clusterIP=None, and should be +omitted or set equal to the 'port' field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
+ 		false
+ + +### OpenTelemetryCollector.spec.resources +[↩ Parent](#opentelemetrycollectorspec) + + + +Resources to set on the OpenTelemetry Collector pods. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.resources.claims[index] +[↩ Parent](#opentelemetrycollectorspecresources) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext +[↩ Parent](#opentelemetrycollectorspec) + + + +SecurityContext configures the container security context for +the opentelemetry-collector container. + +In deployment, daemonset, or statefulset mode, this controls +the security context settings for the primary application +container. + +In sidecar mode, this controls the security context for the +injected sidecar container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.securityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspecsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.capabilities +[↩ Parent](#opentelemetrycollectorspecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator +[↩ Parent](#opentelemetrycollectorspec) + + + +TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
affinityobject + If specified, indicates the pod's scheduling constraints
+ 		false
allocationStrategyenum + AllocationStrategy determines which strategy the target allocator should use for allocation. +The current options are least-weighted, consistent-hashing and per-node. The default is +consistent-hashing. +WARNING: The per-node strategy currently ignores targets without a Node, like control plane components.
+
+ Enum: least-weighted, consistent-hashing, per-node
+ Default: consistent-hashing
+ 		false
enabledboolean + Enabled indicates whether to use a target allocation mechanism for Prometheus targets or not.
+ 		false
env[]object + ENV vars to set on the OpenTelemetry TargetAllocator's Pods. These can then in certain cases be +consumed in the config file for the TargetAllocator.
+ 		false
filterStrategystring + FilterStrategy determines how to filter targets before allocating them among the collectors. +The only current option is relabel-config (drops targets based on prom relabel_config). +The default is relabel-config.
+
+ Default: relabel-config
+ 		false
imagestring + Image indicates the container image to use for the OpenTelemetry TargetAllocator.
+ 		false
nodeSelectormap[string]string + NodeSelector to schedule OpenTelemetry TargetAllocator pods.
+ 		false
observabilityobject + ObservabilitySpec defines how telemetry data gets handled.
+ 		false
podDisruptionBudgetobject + PodDisruptionBudget specifies the pod disruption budget configuration to use +for the target allocator workload.
+ 		false
podSecurityContextobject + PodSecurityContext configures the pod security context for the +targetallocator.
+ 		false
prometheusCRobject + PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ) retrieval. +All CR instances which the ServiceAccount has access to will be retrieved. This includes other namespaces.
+ 		false
replicasinteger + Replicas is the number of pod instances for the underlying TargetAllocator. This should only be set to a value +other than 1 if a strategy that allows for high availability is chosen. Currently, the only allocation strategy +that can be run in a high availability mode is consistent-hashing.
+
+ Format: int32
+ 		false
resourcesobject + Resources to set on the OpenTelemetryTargetAllocator containers.
+ 		false
securityContextobject + SecurityContext configures the container security context for +the targetallocator.
+ 		false
serviceAccountstring + ServiceAccount indicates the name of an existing service account to use with this instance. When set, +the operator will not automatically create a ServiceAccount for the TargetAllocator.
+ 		false
tolerations[]object + Toleration embedded kubernetes pod configuration option, +controls how pods can be scheduled with matching taints
+ 		false
topologySpreadConstraints[]object + TopologySpreadConstraints embedded kubernetes pod configuration option, +controls how pods are spread across your cluster among failure-domains +such as regions, zones, nodes, and other user-defined topology domains +https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +If specified, indicates the pod's scheduling constraints + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeAffinityobject + Describes node affinity scheduling rules for the pod.
+ 		false
podAffinityobject + Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
podAntiAffinityobject + Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity) + + + +Describes node affinity scheduling rules for the pod. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinity) + + + +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). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
preferenceobject + A node selector term, associated with the corresponding weight.
+ 		true
weightinteger + Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +A node selector term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinity) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeSelectorTerms[]object + Required. A list of node selector terms. The terms are ORed.
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecution) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity) + + + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinity) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinity) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity) + + + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinity) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinity) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index] +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.configMapKeyRef +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.fieldRef +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.resourceFieldRef +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.secretKeyRef +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.observability +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +ObservabilitySpec defines how telemetry data gets handled. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
metricsobject + Metrics defines the metrics configuration for operands.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.observability.metrics +[↩ Parent](#opentelemetrycollectorspectargetallocatorobservability) + + + +Metrics defines the metrics configuration for operands. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
DisablePrometheusAnnotationsboolean + DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations +('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
+ 		false
enableMetricsboolean + EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. +The operator.observability.prometheus feature gate must be enabled to use this feature.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podDisruptionBudget +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +PodDisruptionBudget specifies the pod disruption budget configuration to use +for the target allocator workload. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxUnavailableint or string + An eviction is allowed if at most "maxUnavailable" pods selected by +"selector" are unavailable after the eviction, i.e. even in absence of +the evicted pod. For example, one can prevent all voluntary evictions +by specifying 0. This is a mutually exclusive setting with "minAvailable".
+ 		false
minAvailableint or string + An eviction is allowed if at least "minAvailable" pods selected by +"selector" will still be available after the eviction, i.e. even in the +absence of the evicted pod. So for example you can prevent all voluntary +evictions by specifying "100%".
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +PodSecurityContext configures the pod security context for the +targetallocator. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
appArmorProfileobject + appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
fsGroupinteger + 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
fsGroupChangePolicystring + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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 and fsGroup (if specified). If +the SupplementalGroupsPolicy feature is enabled, the +supplementalGroupsPolicy field determines whether these are in addition +to or instead of any group memberships defined in the container image. +If unspecified, no additional groups are added, though group memberships +defined in the container image may still be used, depending on the +supplementalGroupsPolicy field. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
supplementalGroupsPolicystring + Defines how supplemental groups of the first container processes are calculated. +Valid values are "Merge" and "Strict". If not specified, "Merge" is used. +(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled +and the container runtime must implement support for this feature. +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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) + + + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.sysctls[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) + + + +Sysctl defines a kernel parameter to be set + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of a property to set
+ 		true
valuestring + Value of a property to set
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ) retrieval. +All CR instances which the ServiceAccount has access to will be retrieved. This includes other namespaces. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Enabled indicates whether to use a PrometheusOperator custom resources as targets or not.
+ 		false
podMonitorSelectormap[string]string + PodMonitors to be selected for target discovery. +This is a map of {key,value} pairs. Each {key,value} in the map is going to exactly match a label in a +PodMonitor's meta labels. The requirements are ANDed. +Empty or nil map matches all pod monitors.
+ 		false
scrapeIntervalstring + Interval between consecutive scrapes. Equivalent to the same setting on the Prometheus CRD. + +Default: "30s"
+
+ Format: duration
+ Default: 30s
+ 		false
serviceMonitorSelectormap[string]string + ServiceMonitors to be selected for target discovery. +This is a map of {key,value} pairs. Each {key,value} in the map is going to exactly match a label in a +ServiceMonitor's meta labels. The requirements are ANDed. +Empty or nil map matches all service monitors.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.resources +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +Resources to set on the OpenTelemetryTargetAllocator containers. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.resources.claims[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatorresources) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +SecurityContext configures the container security context for +the targetallocator. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.capabilities +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.tolerations[index] +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +The pod this Toleration is attached to tolerates any taint that matches +the triple using the matching operator . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
effectstring + Effect indicates the taint effect to match. Empty means match all taint effects. +When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ 		false
keystring + 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
operatorstring + 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
tolerationSecondsinteger + 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
valuestring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index] +[↩ Parent](#opentelemetrycollectorspectargetallocator) + + + +TopologySpreadConstraint specifies how to spread matching pods among the given topology. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSkewinteger + 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. +The global minimum is the minimum number of matching pods in an eligible domain +or zero if the number of eligible domains is less than MinDomains. +For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same +labelSelector spread as 2/2/1: +In this case, the global minimum is 1. +| zone1 | zone2 | zone3 | +| P P | P P | P | +- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; +scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring + 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 as a "bucket", and try to put balanced number +of pods into each bucket. +We define a domain as a particular instance of a topology. +Also, we define an eligible domain as a domain whose nodes meet the requirements of +nodeAffinityPolicy and nodeTaintsPolicy. +e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. +And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. +It's a required field.
+ 		true
whenUnsatisfiablestring + 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
labelSelectorobject + 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
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select the pods over which +spreading will be calculated. The keys are used to lookup values from the +incoming pod labels, those key-value labels are ANDed with labelSelector +to select the group of existing pods over which spreading will be calculated +for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +MatchLabelKeys cannot be set when LabelSelector isn't set. +Keys that don't exist in the incoming pod labels will +be ignored. A null or empty list means only match against labelSelector. + +This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ 		false
minDomainsinteger + MinDomains indicates a minimum number of eligible domains. +When the number of eligible domains with matching topology keys is less than minDomains, +Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. +And when the number of eligible domains with matching topology keys equals or greater than minDomains, +this value has no effect on scheduling. +As a result, when the number of eligible domains is less than minDomains, +scheduler won't schedule more than maxSkew Pods to those domains. +If value is nil, the constraint behaves as if MinDomains is equal to 1. +Valid values are integers greater than 0. +When value is not nil, WhenUnsatisfiable must be DoNotSchedule. + +For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same +labelSelector spread as 2/2/2: +| zone1 | zone2 | zone3 | +| P P | P P | P P | +The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. +In this situation, new pod with the same labelSelector cannot be scheduled, +because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, +it will violate MaxSkew.
+
+ Format: int32
+ 		false
nodeAffinityPolicystring + NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector +when calculating pod topology spread skew. Options are: +- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. +- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. + +If this value is nil, the behavior is equivalent to the Honor policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
nodeTaintsPolicystring + NodeTaintsPolicy indicates how we will treat node taints when calculating +pod topology spread skew. Options are: +- Honor: nodes without taints, along with tainted nodes for which the incoming pod +has a toleration, are included. +- Ignore: node taints are ignored. All nodes are included. + +If this value is nil, the behavior is equivalent to the Ignore policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index].labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatortopologyspreadconstraintsindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatortopologyspreadconstraintsindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.tolerations[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +The pod this Toleration is attached to tolerates any taint that matches +the triple using the matching operator . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
effectstring + Effect indicates the taint effect to match. Empty means match all taint effects. +When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ 		false
keystring + 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
operatorstring + 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
tolerationSecondsinteger + 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
valuestring + 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
+ + +### OpenTelemetryCollector.spec.topologySpreadConstraints[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +TopologySpreadConstraint specifies how to spread matching pods among the given topology. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSkewinteger + 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. +The global minimum is the minimum number of matching pods in an eligible domain +or zero if the number of eligible domains is less than MinDomains. +For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same +labelSelector spread as 2/2/1: +In this case, the global minimum is 1. +| zone1 | zone2 | zone3 | +| P P | P P | P | +- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; +scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring + 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 as a "bucket", and try to put balanced number +of pods into each bucket. +We define a domain as a particular instance of a topology. +Also, we define an eligible domain as a domain whose nodes meet the requirements of +nodeAffinityPolicy and nodeTaintsPolicy. +e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. +And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. +It's a required field.
+ 		true
whenUnsatisfiablestring + 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
labelSelectorobject + 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
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select the pods over which +spreading will be calculated. The keys are used to lookup values from the +incoming pod labels, those key-value labels are ANDed with labelSelector +to select the group of existing pods over which spreading will be calculated +for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +MatchLabelKeys cannot be set when LabelSelector isn't set. +Keys that don't exist in the incoming pod labels will +be ignored. A null or empty list means only match against labelSelector. + +This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ 		false
minDomainsinteger + MinDomains indicates a minimum number of eligible domains. +When the number of eligible domains with matching topology keys is less than minDomains, +Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. +And when the number of eligible domains with matching topology keys equals or greater than minDomains, +this value has no effect on scheduling. +As a result, when the number of eligible domains is less than minDomains, +scheduler won't schedule more than maxSkew Pods to those domains. +If value is nil, the constraint behaves as if MinDomains is equal to 1. +Valid values are integers greater than 0. +When value is not nil, WhenUnsatisfiable must be DoNotSchedule. + +For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same +labelSelector spread as 2/2/2: +| zone1 | zone2 | zone3 | +| P P | P P | P P | +The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. +In this situation, new pod with the same labelSelector cannot be scheduled, +because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, +it will violate MaxSkew.
+
+ Format: int32
+ 		false
nodeAffinityPolicystring + NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector +when calculating pod topology spread skew. Options are: +- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. +- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. + +If this value is nil, the behavior is equivalent to the Honor policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
nodeTaintsPolicystring + NodeTaintsPolicy indicates how we will treat node taints when calculating +pod topology spread skew. Options are: +- Honor: nodes without taints, along with tainted nodes for which the incoming pod +has a toleration, are included. +- Ignore: node taints are ignored. All nodes are included. + +If this value is nil, the behavior is equivalent to the Ignore policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
+ + +### OpenTelemetryCollector.spec.topologySpreadConstraints[index].labelSelector +[↩ Parent](#opentelemetrycollectorspectopologyspreadconstraintsindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectopologyspreadconstraintsindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.updateStrategy +[↩ Parent](#opentelemetrycollectorspec) + + + +UpdateStrategy represents the strategy the operator will take replacing existing DaemonSet pods with new pods +https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/daemon-set-v1/#DaemonSetSpec +This is only applicable to Daemonset mode. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
rollingUpdateobject + Rolling update config params. Present only if type = "RollingUpdate".
+ 		false
typestring + Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
+ 		false
+ + +### OpenTelemetryCollector.spec.updateStrategy.rollingUpdate +[↩ Parent](#opentelemetrycollectorspecupdatestrategy) + + + +Rolling update config params. Present only if type = "RollingUpdate". + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSurgeint or string + The maximum number of nodes with an existing available DaemonSet pod that +can have an updated DaemonSet pod during during an update. +Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). +This can not be 0 if MaxUnavailable is 0. +Absolute number is calculated from percentage by rounding up to a minimum of 1. +Default value is 0. +Example: when this is set to 30%, at most 30% of the total number of nodes +that should be running the daemon pod (i.e. status.desiredNumberScheduled) +can have their a new pod created before the old pod is marked as deleted. +The update starts by launching new pods on 30% of nodes. Once an updated +pod is available (Ready for at least minReadySeconds) the old DaemonSet pod +on that node is marked deleted. If the old pod becomes unavailable for any +reason (Ready transitions to false, is evicted, or is drained) an updated +pod is immediatedly created on that node without considering surge limits.
+ 		false
maxUnavailableint or string + The maximum number of DaemonSet pods that can be unavailable during the +update. Value can be an absolute number (ex: 5) or a percentage of total +number of DaemonSet pods at the start of the update (ex: 10%). Absolute +number is calculated from percentage by rounding up. +This cannot be 0 if MaxSurge is 0 +Default value is 1. +Example: when this is set to 30%, at most 30% of the total number of nodes +that should be running the daemon pod (i.e. status.desiredNumberScheduled) +can have their pods stopped for an update at any given time. The update +starts by stopping at most 30% of those DaemonSet pods and then brings +up new DaemonSet pods in their place. Once the new pods are available, +it then proceeds onto other DaemonSet pods, thus ensuring that at least +70% of original number of DaemonSet pods are available at all times during +the update.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +PersistentVolumeClaim is a user's request for and claim to a persistent volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstring + APIVersion defines the versioned schema of this representation of an object. +Servers should convert recognized schemas to the latest internal value, and +may reject unrecognized values. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ 		false
kindstring + Kind is a string value representing the REST resource this object represents. +Servers may infer this from the endpoint the client submits requests to. +Cannot be updated. +In CamelCase. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 		false
metadataobject + Standard object's metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+ 		false
specobject + spec defines the desired characteristics of a volume requested by a pod author. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
statusobject + status represents the current information/status of a persistent volume claim. +Read-only. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].metadata +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex) + + + +Standard object's metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex) + + + +spec defines the desired characteristics of a volume requested by a pod author. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSource +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSourceRef +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.resources +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex) + + + +status represents the current information/status of a persistent volume claim. +Read-only. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
accessModes[]string + accessModes contains the actual access modes the volume backing the PVC has. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ 		false
allocatedResourceStatusesmap[string]string + allocatedResourceStatuses stores status of resource being resized for the given PVC. +Key names follow standard Kubernetes label syntax. Valid values are either: + * Un-prefixed keys: + - storage - the capacity of the volume. + * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" +Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered +reserved and hence may not be used. + +ClaimResourceStatus can be in any of following states: + - ControllerResizeInProgress: + State set when resize controller starts resizing the volume in control-plane. + - ControllerResizeFailed: + State set when resize has failed in resize controller with a terminal error. + - NodeResizePending: + State set when resize controller has finished resizing the volume but further resizing of + volume is needed on the node. + - NodeResizeInProgress: + State set when kubelet starts resizing the volume. + - NodeResizeFailed: + State set when resizing has failed in kubelet with a terminal error. Transient errors don't set + NodeResizeFailed.
+ 		false
allocatedResourcesmap[string]int or string + allocatedResources tracks the resources allocated to a PVC including its capacity. +Key names follow standard Kubernetes label syntax. Valid values are either: + * Un-prefixed keys: + - storage - the capacity of the volume. + * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" +Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered +reserved and hence may not be used. + +Capacity reported here may be larger than the actual capacity when a volume expansion operation +is requested. +For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. +If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. +If a volume expansion capacity request is lowered, allocatedResources is only +lowered if there are no expansion operations in progress and if the actual volume capacity +is equal or lower than the requested capacity. + +A controller that receives PVC update with previously unknown resourceName +should ignore the update for the purpose it was designed.
+ 		false
capacitymap[string]int or string + capacity represents the actual resources of the underlying volume.
+ 		false
conditions[]object + conditions is the current Condition of persistent volume claim. If underlying persistent volume is being +resized then the Condition will be set to 'Resizing'.
+ 		false
currentVolumeAttributesClassNamestring + currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. +When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim +This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
+ 		false
modifyVolumeStatusobject + ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. +When this is unset, there is no ModifyVolume operation being attempted. +This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
+ 		false
phasestring + phase represents the current phase of PersistentVolumeClaim.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.conditions[index] +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexstatus) + + + +PersistentVolumeClaimCondition contains details about state of pvc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
statusstring +
+ 		true
typestring + PersistentVolumeClaimConditionType defines the condition of PV claim. +Valid values are: + - "Resizing", "FileSystemResizePending" + +If RecoverVolumeExpansionFailure feature gate is enabled, then following additional values can be expected: + - "ControllerResizeError", "NodeResizeError" + +If VolumeAttributesClass feature gate is enabled, then following additional values can be expected: + - "ModifyVolumeError", "ModifyingVolume"
+ 		true
lastProbeTimestring + lastProbeTime is the time we probed the condition.
+
+ Format: date-time
+ 		false
lastTransitionTimestring + lastTransitionTime is the time the condition transitioned from one status to another.
+
+ Format: date-time
+ 		false
messagestring + message is the human-readable message indicating details about last transition.
+ 		false
reasonstring + reason is a unique, this should be a short, machine understandable string that gives the reason +for condition's last transition. If it reports "Resizing" that means the underlying +persistent volume is being resized.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.modifyVolumeStatus +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexstatus) + + + +ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. +When this is unset, there is no ModifyVolume operation being attempted. +This is a beta field and requires enabling VolumeAttributesClass feature (off by default). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
statusstring + status is the status of the ControllerModifyVolume operation. It can be in any of following states: + - Pending + Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as + the specified VolumeAttributesClass not existing. + - InProgress + InProgress indicates that the volume is being modified. + - Infeasible + Infeasible indicates that the request has been rejected as invalid by the CSI driver. To + resolve the error, a valid VolumeAttributesClass needs to be specified. +Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
+ 		true
targetVolumeAttributesClassNamestring + targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeMounts[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +Volume represents a named volume in a pod that may be accessed by any container in the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + name of the volume. +Must be a DNS_LABEL and unique within the pod. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ 		true
awsElasticBlockStoreobject + 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
azureDiskobject + azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ 		false
azureFileobject + azureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ 		false
cephfsobject + cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ 		false
cinderobject + cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		false
configMapobject + configMap represents a configMap that should populate this volume
+ 		false
csiobject + csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ 		false
downwardAPIobject + downwardAPI represents downward API about the pod that should populate this volume
+ 		false
emptyDirobject + emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
ephemeralobject + 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
fcobject + fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ 		false
flexVolumeobject + flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin.
+ 		false
flockerobject + flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ 		false
gcePersistentDiskobject + 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
gitRepoobject + 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
glusterfsobject + 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
hostPathobject + 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
+ 		false
imageobject + image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. +The volume is resolved at pod startup depending on which PullPolicy value is provided: + +- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. + +The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. +A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
+ 		false
iscsiobject + 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
nfsobject + 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
persistentVolumeClaimobject + persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
photonPersistentDiskobject + photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ 		false
portworxVolumeobject + portworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ 		false
projectedobject + projected items for all in one resources secrets, configmaps, and downward API
+ 		false
quobyteobject + quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ 		false
rbdobject + 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
scaleIOobject + scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ 		false
secretobject + secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
storageosobject + storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ 		false
vsphereVolumeobject + vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].awsElasticBlockStore +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		true
fsTypestring + fsType is the 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
+ 		false
partitioninteger + partition is 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
readOnlyboolean + readOnly value true will force the readOnly setting in VolumeMounts. +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].azureDisk +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
diskNamestring + diskName is the Name of the data disk in the blob storage
+ 		true
diskURIstring + diskURI is the URI of data disk in the blob storage
+ 		true
cachingModestring + cachingMode is the Host Caching mode: None, Read Only, Read Write.
+ 		false
fsTypestring + fsType is 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.
+
+ Default: ext4
+ 		false
kindstring + kind expected values are 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
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+
+ Default: false
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].azureFile +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +azureFile represents an Azure File Service mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secretNamestring + secretName is the name of secret that contains Azure Storage Account Name and Key
+ 		true
shareNamestring + shareName is the azure share Name
+ 		true
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].cephfs +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +cephFS represents a Ceph FS mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
monitors[]string + monitors is Required: Monitors is a collection of Ceph monitors +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		true
pathstring + path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
+ 		false
readOnlyboolean + readOnly is 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
secretFilestring + secretFile is 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
secretRefobject + secretRef is 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
userstring + user is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].cephfs.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexcephfs) + + + +secretRef is 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 + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].cinder +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID used to identify the volume in cinder. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		true
fsTypestring + fsType is the 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
readOnlyboolean + readOnly 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
secretRefobject + secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].cinder.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexcinder) + + + +secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].configMap +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +configMap represents a configMap that should populate this volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is 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 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].configMap.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexconfigmap) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].csi +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + 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
fsTypestring + fsType 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
nodePublishSecretRefobject + 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
readOnlyboolean + readOnly specifies a read-only configuration for the volume. +Defaults to false (read/write).
+ 		false
volumeAttributesmap[string]string + volumeAttributes stores driver-specific properties that are passed to the CSI +driver. Consult your driver's documentation for supported values.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].csi.nodePublishSecretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexcsi) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +downwardAPI represents downward API about the pod that should populate this volume + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapi) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
+ 		false
modeinteger + 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
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].fieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex) + + + +Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex) + + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].emptyDir +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mediumstring + medium represents 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
sizeLimitint or string + sizeLimit is the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeClaimTemplateobject + 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 `-` where +`` 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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeral) + + + +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 `-` where +`` 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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].fc +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the 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
luninteger + lun is Optional: FC target lun number
+
+ Format: int32
+ 		false
readOnlyboolean + readOnly is Optional: Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
targetWWNs[]string + targetWWNs is Optional: FC target worldwide names (WWNs)
+ 		false
wwids[]string + wwids Optional: FC volume world wide identifiers (wwids) +Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].flexVolume +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + driver is the name of the driver to use for this volume.
+ 		true
fsTypestring + fsType is the 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
optionsmap[string]string + options is Optional: this field holds extra command options if any.
+ 		false
readOnlyboolean + readOnly is Optional: defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].flexVolume.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexflexvolume) + + + +secretRef is 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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].flocker +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
datasetNamestring + datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker +should be considered as deprecated
+ 		false
datasetUUIDstring + datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].gcePersistentDisk +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdNamestring + pdName is 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
fsTypestring + fsType is 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
+ 		false
partitioninteger + partition is 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
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].gitRepo +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
repositorystring + repository is the URL
+ 		true
directorystring + directory is the 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
revisionstring + revision is the commit hash for the specified revision.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].glusterfs +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/glusterfs/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
endpointsstring + endpoints is the endpoint name that details Glusterfs topology. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
pathstring + path is the Glusterfs volume path. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
readOnlyboolean + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].hostPath +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
typestring + type for HostPath Volume +Defaults to "" +More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].image +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. +The volume is resolved at pod startup depending on which PullPolicy value is provided: + +- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. + +The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. +A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pullPolicystring + Policy for pulling OCI objects. Possible values are: +Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. +Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
+ 		false
referencestring + Required: Image or artifact reference to be used. +Behaves in the same way as pod.spec.containers[*].image. +Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. +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
+ + +### OpenTelemetryCollector.spec.volumes[index].iscsi +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
iqnstring + iqn is the target iSCSI Qualified Name.
+ 		true
luninteger + lun represents iSCSI Target Lun number.
+
+ Format: int32
+ 		true
targetPortalstring + targetPortal is 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
chapAuthDiscoveryboolean + chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
+ 		false
chapAuthSessionboolean + chapAuthSession defines whether support iSCSI Session CHAP authentication
+ 		false
fsTypestring + fsType is the 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
+ 		false
initiatorNamestring + initiatorName is the custom iSCSI Initiator Name. +If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface +: will be created for the connection.
+ 		false
iscsiInterfacestring + iscsiInterface is the interface Name that uses an iSCSI transport. +Defaults to 'default' (tcp).
+
+ Default: default
+ 		false
portals[]string + portals is the 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
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false.
+ 		false
secretRefobject + secretRef is the CHAP Secret for iSCSI target and initiator authentication
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].iscsi.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexiscsi) + + + +secretRef is the CHAP Secret for iSCSI target and initiator authentication + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].nfs +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +nfs represents an NFS mount on the host that shares a pod's lifetime +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path that is exported by the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
serverstring + server is the hostname or IP address of the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
readOnlyboolean + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].persistentVolumeClaim +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claimNamestring + 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
readOnlyboolean + readOnly Will force the ReadOnly setting in VolumeMounts. +Default false.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].photonPersistentDisk +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdIDstring + pdID is the ID that identifies Photon Controller persistent disk
+ 		true
fsTypestring + fsType is the 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
+ + +### OpenTelemetryCollector.spec.volumes[index].portworxVolume +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +portworxVolume represents a portworx volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID uniquely identifies a Portworx volume
+ 		true
fsTypestring + 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
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +projected items for all in one resources secrets, configmaps, and downward API + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode are the 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 + sources is the list of volume projections. Each entry in this list +handles one source.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojected) + + + +Projection that may be projected along with other supported volume types. +Exactly one of these fields must be set. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
clusterTrustBundleobject + ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time.
+ 		false
configMapobject + configMap information about the configMap data to project
+ 		false
downwardAPIobject + downwardAPI information about the downwardAPI data to project
+ 		false
secretobject + secret information about the secret data to project
+ 		false
serviceAccountTokenobject + serviceAccountToken is information about the serviceAccountToken data to project
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) + + + +ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Relative path from the volume root to write the bundle.
+ 		true
labelSelectorobject + Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything".
+ 		false
namestring + Select a single ClusterTrustBundle by object name. Mutually-exclusive +with signerName and labelSelector.
+ 		false
optionalboolean + If true, don't block pod startup if the referenced ClusterTrustBundle(s) +aren't available. If using name, then the named ClusterTrustBundle is +allowed not to exist. If using signerName, then the combination of +signerName and labelSelector is allowed to match zero +ClusterTrustBundles.
+ 		false
signerNamestring + Select all ClusterTrustBundles that match this signer name. +Mutually-exclusive with name. The contents of all selected +ClusterTrustBundles will be unified and deduplicated.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexclustertrustbundle) + + + +Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything". + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexclustertrustbundlelabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) + + + +configMap information about the configMap data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexconfigmap) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) + + + +downwardAPI information about the downwardAPI data to project + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + Items is a list of DownwardAPIVolume file
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapi) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
+ 		false
modeinteger + 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
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + + +Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) + + + +secret information about the secret data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional field specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexsecret) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].serviceAccountToken +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) + + + +serviceAccountToken is information about the serviceAccountToken data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path is the path relative to the mount point of the file to project the +token into.
+ 		true
audiencestring + 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
expirationSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].quobyte +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +quobyte represents a Quobyte mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
registrystring + 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
volumestring + volume is a string that references an already created Quobyte volume by name.
+ 		true
groupstring + group to map volume access to +Default is no group
+ 		false
readOnlyboolean + readOnly here will force the Quobyte volume to be mounted with read-only permissions. +Defaults to false.
+ 		false
tenantstring + tenant owning the given Quobyte volume in the Backend +Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ 		false
userstring + user to map volume access to +Defaults to serivceaccount user
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].rbd +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + image is the rados image name. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
monitors[]string + monitors is a collection of Ceph monitors. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
fsTypestring + fsType is the 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
+ 		false
keyringstring + 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
+
+ Default: /etc/ceph/keyring
+ 		false
poolstring + pool is the rados pool name. +Default is rbd. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+
+ Default: rbd
+ 		false
readOnlyboolean + 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
secretRefobject + 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
userstring + user is the rados user name. +Default is admin. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+
+ Default: admin
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].rbd.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexrbd) + + + +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 + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].scaleIO +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gatewaystring + gateway is the host address of the ScaleIO API Gateway.
+ 		true
secretRefobject + secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail.
+ 		true
systemstring + system is the name of the storage system as configured in ScaleIO.
+ 		true
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". +Default is "xfs".
+
+ Default: xfs
+ 		false
protectionDomainstring + protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
+ 		false
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
sslEnabledboolean + sslEnabled Flag enable/disable SSL communication with Gateway, default false
+ 		false
storageModestring + storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. +Default is ThinProvisioned.
+
+ Default: ThinProvisioned
+ 		false
storagePoolstring + storagePool is the ScaleIO Storage Pool associated with the protection domain.
+ 		false
volumeNamestring + volumeName is the name of a volume already created in the ScaleIO system +that is associated with this volume source.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].scaleIO.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexscaleio) + + + +secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].secret +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is 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 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
optionalboolean + optional field specify whether the Secret or its keys must be defined
+ 		false
secretNamestring + secretName is the name of the secret in the pod's namespace to use. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].secret.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexsecret) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].storageos +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the 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
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted.
+ 		false
volumeNamestring + volumeName is the human-readable name of the StorageOS volume. Volume +names are only unique within a namespace.
+ 		false
volumeNamespacestring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].storageos.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexstorageos) + + + +secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].vsphereVolume +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumePathstring + volumePath is the path that identifies vSphere volume vmdk
+ 		true
fsTypestring + fsType is 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
storagePolicyIDstring + storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ 		false
storagePolicyNamestring + storagePolicyName is the storage Policy Based Management (SPBM) profile name.
+ 		false
+ + +### OpenTelemetryCollector.status +[↩ Parent](#opentelemetrycollector) + + + +OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + Image indicates the container image to use for the OpenTelemetry Collector.
+ 		false
messages[]string + Messages about actions performed by the operator on this resource. +Deprecated: use Kubernetes events instead.
+ 		false
replicasinteger + Replicas is currently not being set and might be removed in the next version. +Deprecated: use "OpenTelemetryCollector.Status.Scale.Replicas" instead.
+
+ Format: int32
+ 		false
scaleobject + Scale is the OpenTelemetryCollector's scale subresource status.
+ 		false
versionstring + Version of the managed OpenTelemetry Collector (operand)
+ 		false
+ + +### OpenTelemetryCollector.status.scale +[↩ Parent](#opentelemetrycollectorstatus) + + + +Scale is the OpenTelemetryCollector's scale subresource status. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
replicasinteger + The total number non-terminated pods targeted by this +OpenTelemetryCollector's deployment or statefulSet.
+
+ Format: int32
+ 		false
selectorstring + The selector used to match the OpenTelemetryCollector's +deployment or statefulSet pods.
+ 		false
statusReplicasstring + StatusReplicas is the number of pods targeted by this OpenTelemetryCollector's with a Ready Condition / +Total number of non-terminated pods targeted by this OpenTelemetryCollector's (their labels match the selector). +Deployment, Daemonset, StatefulSet.
+ 		false
+ +# opentelemetry.io/v1beta1 + +Resource Types: + +- [OpenTelemetryCollector](#opentelemetrycollector) + + + + +## OpenTelemetryCollector +[↩ Parent](#opentelemetryiov1beta1 ) + + + + + + +OpenTelemetryCollector is the Schema for the opentelemetrycollectors API. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1beta1true
kindstringOpenTelemetryCollectortrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.
+ 		false
statusobject + OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector.
+ 		false
+ + +### OpenTelemetryCollector.spec +[↩ Parent](#opentelemetrycollector-1) + + + +OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configobject + Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details. +The empty objects e.g. batch: should be written as batch: {} otherwise they won't work with kustomize or kubectl edit.
+ 		true
managementStateenum + ManagementState defines if the CR should be managed by the operator or not. +Default is managed.
+
+ Enum: managed, unmanaged
+ Default: managed
+ 		true
additionalContainers[]object + AdditionalContainers allows injecting additional containers into the generated pod definition. +These sidecar containers can be used for authentication proxies, log shipping sidecars, agents for shipping +metrics to their cloud, or in general sidecars that do not support automatic injection. +This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment. + +Container names managed by the operator: +* `otc-container` + +Overriding containers managed by the operator is outside the scope of what the maintainers will support and by +doing so, you wil accept the risk of it breaking things.
+ 		false
affinityobject + If specified, indicates the pod's scheduling constraints
+ 		false
argsmap[string]string + Args is the set of arguments to pass to the main container's binary.
+ 		false
autoscalerobject + Autoscaler specifies the pod autoscaling configuration to use +for the workload.
+ 		false
configVersionsinteger + ConfigVersions defines the number versions to keep for the collector config. Each config version is stored in a separate ConfigMap. +Defaults to 3. The minimum value is 1.
+
+ Default: 3
+ Minimum: 1
+ 		false
configmaps[]object + ConfigMaps is a list of ConfigMaps in the same namespace as the OpenTelemetryCollector +object, which shall be mounted into the Collector Pods. +Each ConfigMap will be added to the Collector's Deployments as a volume named `configmap-`.
+ 		false
daemonSetUpdateStrategyobject + UpdateStrategy represents the strategy the operator will take replacing existing DaemonSet pods with new pods +https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/daemon-set-v1/#DaemonSetSpec +This is only applicable to Daemonset mode.
+ 		false
deploymentUpdateStrategyobject + UpdateStrategy represents the strategy the operator will take replacing existing Deployment pods with new pods +https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/#DeploymentSpec +This is only applicable to Deployment mode.
+ 		false
env[]object + Environment variables to set on the generated pods.
+ 		false
envFrom[]object + List of sources to populate environment variables on the generated pods.
+ 		false
hostNetworkboolean + HostNetwork indicates if the pod should run in the host networking namespace.
+ 		false
imagestring + Image indicates the container image to use for the generated pods.
+ 		false
imagePullPolicystring + ImagePullPolicy indicates the pull policy to be used for retrieving the container image.
+ 		false
ingressobject + Ingress is used to specify how OpenTelemetry Collector is exposed. This +functionality is only available if one of the valid modes is set. +Valid modes are: deployment, daemonset and statefulset.
+ 		false
initContainers[]object + InitContainers allows injecting initContainers to the generated pod definition. +These init containers can be used to fetch secrets for injection into the +configuration from external sources, run added checks, etc. Any errors during the execution of +an initContainer will lead to a restart of the Pod. More info: +https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
+ 		false
ipFamilies[]string + IPFamily represents the IP Family (IPv4 or IPv6). This type is used +to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
+ 		false
ipFamilyPolicystring + IPFamilyPolicy represents the dual-stack-ness requested or required by a Service
+
+ Default: SingleStack
+ 		false
lifecycleobject + Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ 		false
livenessProbeobject + Liveness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. +It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline.
+ 		false
modeenum + Mode represents how the collector should be deployed (deployment, daemonset, statefulset or sidecar)
+
+ Enum: daemonset, deployment, sidecar, statefulset
+ 		false
nodeSelectormap[string]string + NodeSelector to schedule generated pods. +This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment.
+ 		false
observabilityobject + ObservabilitySpec defines how telemetry data gets handled.
+ 		false
persistentVolumeClaimRetentionPolicyobject + PersistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims +created from volumeClaimTemplates. +This only works with the following OpenTelemetryCollector modes: statefulset.
+ 		false
podAnnotationsmap[string]string + PodAnnotations is the set of annotations that will be attached to +the generated pods.
+ 		false
podDisruptionBudgetobject + PodDisruptionBudget specifies the pod disruption budget configuration to use +for the generated workload. By default, a PDB with a MaxUnavailable of one is set.
+ 		false
podDnsConfigobject + PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
+ 		false
podSecurityContextobject + PodSecurityContext configures the pod security context for the +generated pod, when running as a deployment, daemonset, +or statefulset. + +In sidecar mode, the opentelemetry-operator will ignore this setting.
+ 		false
ports[]object + Ports allows a set of ports to be exposed by the underlying v1.Service & v1.ContainerPort. By default, the operator +will attempt to infer the required ports by parsing the .Spec.Config property but this property can be +used to open additional ports that can't be inferred by the operator, like for custom receivers.
+ 		false
priorityClassNamestring + If specified, indicates the pod's priority. +If not specified, the pod priority will be default or zero if there is no +default.
+ 		false
readinessProbeobject + Readiness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. +It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline.
+ 		false
replicasinteger + Replicas is the number of pod instances for the underlying replicaset. Set this if you are not using autoscaling.
+
+ Format: int32
+ 		false
resourcesobject + Resources to set on generated pods.
+ 		false
securityContextobject + SecurityContext configures the container security context for +the generated main container. + +In deployment, daemonset, or statefulset mode, this controls +the security context settings for the primary application +container. + +In sidecar mode, this controls the security context for the +injected sidecar container.
+ 		false
serviceAccountstring + ServiceAccount indicates the name of an existing service account to use with this instance. When set, +the operator will not automatically create a ServiceAccount.
+ 		false
shareProcessNamespaceboolean + ShareProcessNamespace indicates if the pod's containers should share process namespace.
+ 		false
targetAllocatorobject + TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not.
+ 		false
terminationGracePeriodSecondsinteger + Duration in seconds the pod needs to terminate gracefully upon probe failure.
+
+ Format: int64
+ 		false
tolerations[]object + Toleration to schedule the generated pods. +This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment.
+ 		false
topologySpreadConstraints[]object + TopologySpreadConstraints embedded kubernetes pod configuration option, +controls how pods are spread across your cluster among failure-domains +such as regions, zones, nodes, and other user-defined topology domains +https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ +This only works with the following OpenTelemetryCollector mode's: statefulset, and deployment.
+ 		false
upgradeStrategyenum + UpgradeStrategy represents how the operator will handle upgrades to the CR when a newer version of the operator is deployed
+
+ Enum: automatic, none
+ 		false
volumeClaimTemplates[]object + VolumeClaimTemplates will provide stable storage using PersistentVolumes. +This only works with the following OpenTelemetryCollector mode's: statefulset.
+ 		false
volumeMounts[]object + VolumeMounts represents the mount points to use in the underlying deployment(s).
+ 		false
volumes[]object + Volumes represents which volumes to use in the underlying deployment(s).
+ 		false
+ + +### OpenTelemetryCollector.spec.config +[↩ Parent](#opentelemetrycollectorspec-1) + + + +Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details. +The empty objects e.g. batch: should be written as batch: {} otherwise they won't work with kustomize or kubectl edit. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
exportersobject + AnyConfig represent parts of the config.
+ 		true
receiversobject + AnyConfig represent parts of the config.
+ 		true
serviceobject +
+ 		true
connectorsobject + AnyConfig represent parts of the config.
+ 		false
extensionsobject + AnyConfig represent parts of the config.
+ 		false
processorsobject + AnyConfig represent parts of the config.
+ 		false
+ + +### OpenTelemetryCollector.spec.config.service +[↩ Parent](#opentelemetrycollectorspecconfig) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pipelinesmap[string]object +
+ 		true
extensions[]string +
+ 		false
telemetryobject + AnyConfig represent parts of the config.
+ 		false
+ + +### OpenTelemetryCollector.spec.config.service.pipelines[key] +[↩ Parent](#opentelemetrycollectorspecconfigservice) + + + +Pipeline is a struct of component type to a list of component IDs. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
exporters[]string +
+ 		true
receivers[]string +
+ 		true
processors[]string +
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +A single application container that you want to run within a pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + 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 container 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 container 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
imagestring + Container 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
imagePullPolicystring + 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
lifecycleobject + Actions that the management system should take in response to container lifecycle events. +Cannot be updated.
+ 		false
livenessProbeobject + 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. 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. +Modifying this array with strategic merge patch may corrupt the data. +For more information See https://github.com/kubernetes/kubernetes/issues/108255. +Cannot be updated.
+ 		false
readinessProbeobject + 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
resizePolicy[]object + Resources resize policy for the container.
+ 		false
resourcesobject + Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
restartPolicystring + RestartPolicy defines the restart behavior of individual containers in a pod. +This field may only be set for init containers, and the only allowed value is "Always". +For non-init containers or when this field is not specified, +the restart behavior is defined by the Pod's restart policy and the container type. +Setting the RestartPolicy as "Always" for the init container will have the following effect: +this init container will be continually restarted on +exit until all regular containers have terminated. Once all regular +containers have completed, all init containers with restartPolicy "Always" +will be shut down. This lifecycle differs from normal init containers and +is often referred to as a "sidecar" container. Although this init +container still starts in the init container sequence, it does not wait +for the container to complete before proceeding to the next init +container. Instead, the next init container starts immediately after this +init container is started, or after any startupProbe has successfully +completed.
+ 		false
securityContextobject + 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
startupProbeobject + 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
stdinboolean + 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
stdinOnceboolean + 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
terminationMessagePathstring + 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
terminationMessagePolicystring + 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
ttyboolean + 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
workingDirstring + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindex-1) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.configMapKeyRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom-1) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.fieldRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom-1) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].env[index].valueFrom.secretKeyRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvindexvaluefrom-1) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index].configMapRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvfromindex-1) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].envFrom[index].secretRef +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexenvfromindex-1) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
postStartobject + 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
preStopobject + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycle-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststarthttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.sleep +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart-1) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.postStart.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecyclepoststart-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycle-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestophttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.sleep +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop-1) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].lifecycle.preStop.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlifecycleprestop-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.grpc +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe-1) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobehttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].livenessProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexlivenessprobe-1) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].ports[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +ContainerPort represents a network port in a single container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
containerPortinteger + Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536.
+
+ Format: int32
+ 		true
hostIPstring + What host IP to bind the external port to.
+ 		false
hostPortinteger + 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
namestring + 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
protocolstring + Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP".
+
+ Default: TCP
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.grpc +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe-1) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobehttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].readinessProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexreadinessprobe-1) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].resizePolicy[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +ContainerResizePolicy represents resource resize policy for the container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourceNamestring + Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory.
+ 		true
restartPolicystring + Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired.
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].resources +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].resources.claims[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexresources-1) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +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/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.capabilities +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].securityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.exec +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.grpc +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe-1) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobehttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].startupProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindexstartupprobe-1) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].volumeDevices[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +volumeDevice describes a mapping of a raw block device within a container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
devicePathstring + devicePath is the path inside of the container that the device will be mapped to.
+ 		true
namestring + name must match the name of a persistentVolumeClaim in the pod
+ 		true
+ + +### OpenTelemetryCollector.spec.additionalContainers[index].volumeMounts[index] +[↩ Parent](#opentelemetrycollectorspecadditionalcontainersindex-1) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### OpenTelemetryCollector.spec.affinity +[↩ Parent](#opentelemetrycollectorspec-1) + + + +If specified, indicates the pod's scheduling constraints + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeAffinityobject + Describes node affinity scheduling rules for the pod.
+ 		false
podAffinityobject + Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
podAntiAffinityobject + Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity +[↩ Parent](#opentelemetrycollectorspecaffinity-1) + + + +Describes node affinity scheduling rules for the pod. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject + 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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinity-1) + + + +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). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
preferenceobject + A node selector term, associated with the corresponding weight.
+ 		true
weightinteger + Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex-1) + + + +A node selector term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference-1) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference-1) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinity-1) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeSelectorTerms[]object + Required. A list of node selector terms. The terms are ORed.
+ 		true
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecution-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex-1) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] +[↩ Parent](#opentelemetrycollectorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex-1) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity +[↩ Parent](#opentelemetrycollectorspecaffinity-1) + + + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinity-1) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex-1) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinity-1) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex-1) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity +[↩ Parent](#opentelemetrycollectorspecaffinity-1) + + + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinity-1) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex-1) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinity-1) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex-1) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.autoscaler +[↩ Parent](#opentelemetrycollectorspec-1) + + + +Autoscaler specifies the pod autoscaling configuration to use +for the workload. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
behaviorobject + HorizontalPodAutoscalerBehavior configures the scaling behavior of the target +in both Up and Down directions (scaleUp and scaleDown fields respectively).
+ 		false
maxReplicasinteger + MaxReplicas sets an upper bound to the autoscaling feature. If MaxReplicas is set autoscaling is enabled.
+
+ Format: int32
+ 		false
metrics[]object + Metrics is meant to provide a customizable way to configure HPA metrics. +currently the only supported custom metrics is type=Pod. +Use TargetCPUUtilization or TargetMemoryUtilization instead if scaling on these common resource metrics.
+ 		false
minReplicasinteger + MinReplicas sets a lower bound to the autoscaling feature. Set this if your are using autoscaling. It must be at least 1
+
+ Format: int32
+ 		false
targetCPUUtilizationinteger + TargetCPUUtilization sets the target average CPU used across all replicas. +If average CPU exceeds this value, the HPA will scale up. Defaults to 90 percent.
+
+ Format: int32
+ 		false
targetMemoryUtilizationinteger + TargetMemoryUtilization sets the target average memory utilization across all replicas
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior +[↩ Parent](#opentelemetrycollectorspecautoscaler-1) + + + +HorizontalPodAutoscalerBehavior configures the scaling behavior of the target +in both Up and Down directions (scaleUp and scaleDown fields respectively). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
scaleDownobject + scaleDown is scaling policy for scaling Down. +If not set, the default value is to allow to scale down to minReplicas pods, with a +300 second stabilization window (i.e., the highest recommendation for +the last 300sec is used).
+ 		false
scaleUpobject + scaleUp is scaling policy for scaling Up. +If not set, the default value is the higher of: + * increase no more than 4 pods per 60 seconds + * double the number of pods per 60 seconds +No stabilization is used.
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior.scaleDown +[↩ Parent](#opentelemetrycollectorspecautoscalerbehavior-1) + + + +scaleDown is scaling policy for scaling Down. +If not set, the default value is to allow to scale down to minReplicas pods, with a +300 second stabilization window (i.e., the highest recommendation for +the last 300sec is used). + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
policies[]object + policies is a list of potential scaling polices which can be used during scaling. +At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
+ 		false
selectPolicystring + selectPolicy is used to specify which policy should be used. +If not set, the default value Max is used.
+ 		false
stabilizationWindowSecondsinteger + stabilizationWindowSeconds is the number of seconds for which past recommendations should be +considered while scaling up or scaling down. +StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). +If not set, use the default values: +- For scale up: 0 (i.e. no stabilization is done). +- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior.scaleDown.policies[index] +[↩ Parent](#opentelemetrycollectorspecautoscalerbehaviorscaledown-1) + + + +HPAScalingPolicy is a single policy which must hold true for a specified past interval. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
periodSecondsinteger + periodSeconds specifies the window of time for which the policy should hold true. +PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
+
+ Format: int32
+ 		true
typestring + type is used to specify the scaling policy.
+ 		true
valueinteger + value contains the amount of change which is permitted by the policy. +It must be greater than zero
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior.scaleUp +[↩ Parent](#opentelemetrycollectorspecautoscalerbehavior-1) + + + +scaleUp is scaling policy for scaling Up. +If not set, the default value is the higher of: + * increase no more than 4 pods per 60 seconds + * double the number of pods per 60 seconds +No stabilization is used. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
policies[]object + policies is a list of potential scaling polices which can be used during scaling. +At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid
+ 		false
selectPolicystring + selectPolicy is used to specify which policy should be used. +If not set, the default value Max is used.
+ 		false
stabilizationWindowSecondsinteger + stabilizationWindowSeconds is the number of seconds for which past recommendations should be +considered while scaling up or scaling down. +StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). +If not set, use the default values: +- For scale up: 0 (i.e. no stabilization is done). +- For scale down: 300 (i.e. the stabilization window is 300 seconds long).
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.behavior.scaleUp.policies[index] +[↩ Parent](#opentelemetrycollectorspecautoscalerbehaviorscaleup-1) + + + +HPAScalingPolicy is a single policy which must hold true for a specified past interval. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
periodSecondsinteger + periodSeconds specifies the window of time for which the policy should hold true. +PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
+
+ Format: int32
+ 		true
typestring + type is used to specify the scaling policy.
+ 		true
valueinteger + value contains the amount of change which is permitted by the policy. +It must be greater than zero
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index] +[↩ Parent](#opentelemetrycollectorspecautoscaler-1) + + + +MetricSpec defines a subset of metrics to be defined for the HPA's metric array +more metric type can be supported as needed. +See https://pkg.go.dev/k8s.io/api/autoscaling/v2#MetricSpec for reference. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + MetricSourceType indicates the type of metric.
+ 		true
podsobject + PodsMetricSource indicates how to scale on a metric describing each pod in +the current scale target (for example, transactions-processed-per-second). +The values will be averaged together before being compared to the target +value.
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindex-1) + + + +PodsMetricSource indicates how to scale on a metric describing each pod in +the current scale target (for example, transactions-processed-per-second). +The values will be averaged together before being compared to the target +value. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
metricobject + metric identifies the target metric by name and selector
+ 		true
targetobject + target specifies the target value for the given metric
+ 		true
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpods-1) + + + +metric identifies the target metric by name and selector + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + name is the name of the given metric
+ 		true
selectorobject + selector is the string-encoded form of a standard kubernetes label selector for the given metric +When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. +When unset, just the metricName will be used to gather metrics.
+ 		false
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric.selector +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpodsmetric-1) + + + +selector is the string-encoded form of a standard kubernetes label selector for the given metric +When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. +When unset, just the metricName will be used to gather metrics. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.metric.selector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpodsmetricselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.autoscaler.metrics[index].pods.target +[↩ Parent](#opentelemetrycollectorspecautoscalermetricsindexpods-1) + + + +target specifies the target value for the given metric + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type represents whether the metric type is Utilization, Value, or AverageValue
+ 		true
averageUtilizationinteger + averageUtilization is the target value of the average of the +resource metric across all relevant pods, represented as a percentage of +the requested value of the resource for the pods. +Currently only valid for Resource metric source type
+
+ Format: int32
+ 		false
averageValueint or string + averageValue is the target value of the average of the +metric across all relevant pods (as a quantity)
+ 		false
valueint or string + value is the target value of the metric (as a quantity).
+ 		false
+ + +### OpenTelemetryCollector.spec.configmaps[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountpathstring +
+ 		true
namestring + Configmap defines name and path where the configMaps should be mounted.
+ 		true
+ + +### OpenTelemetryCollector.spec.daemonSetUpdateStrategy +[↩ Parent](#opentelemetrycollectorspec-1) + + + +UpdateStrategy represents the strategy the operator will take replacing existing DaemonSet pods with new pods +https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/daemon-set-v1/#DaemonSetSpec +This is only applicable to Daemonset mode. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
rollingUpdateobject + Rolling update config params. Present only if type = "RollingUpdate".
+ 		false
typestring + Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
+ 		false
+ + +### OpenTelemetryCollector.spec.daemonSetUpdateStrategy.rollingUpdate +[↩ Parent](#opentelemetrycollectorspecdaemonsetupdatestrategy) + + + +Rolling update config params. Present only if type = "RollingUpdate". + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSurgeint or string + The maximum number of nodes with an existing available DaemonSet pod that +can have an updated DaemonSet pod during during an update. +Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). +This can not be 0 if MaxUnavailable is 0. +Absolute number is calculated from percentage by rounding up to a minimum of 1. +Default value is 0. +Example: when this is set to 30%, at most 30% of the total number of nodes +that should be running the daemon pod (i.e. status.desiredNumberScheduled) +can have their a new pod created before the old pod is marked as deleted. +The update starts by launching new pods on 30% of nodes. Once an updated +pod is available (Ready for at least minReadySeconds) the old DaemonSet pod +on that node is marked deleted. If the old pod becomes unavailable for any +reason (Ready transitions to false, is evicted, or is drained) an updated +pod is immediatedly created on that node without considering surge limits.
+ 		false
maxUnavailableint or string + The maximum number of DaemonSet pods that can be unavailable during the +update. Value can be an absolute number (ex: 5) or a percentage of total +number of DaemonSet pods at the start of the update (ex: 10%). Absolute +number is calculated from percentage by rounding up. +This cannot be 0 if MaxSurge is 0 +Default value is 1. +Example: when this is set to 30%, at most 30% of the total number of nodes +that should be running the daemon pod (i.e. status.desiredNumberScheduled) +can have their pods stopped for an update at any given time. The update +starts by stopping at most 30% of those DaemonSet pods and then brings +up new DaemonSet pods in their place. Once the new pods are available, +it then proceeds onto other DaemonSet pods, thus ensuring that at least +70% of original number of DaemonSet pods are available at all times during +the update.
+ 		false
+ + +### OpenTelemetryCollector.spec.deploymentUpdateStrategy +[↩ Parent](#opentelemetrycollectorspec-1) + + + +UpdateStrategy represents the strategy the operator will take replacing existing Deployment pods with new pods +https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/#DeploymentSpec +This is only applicable to Deployment mode. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
rollingUpdateobject + Rolling update config params. Present only if DeploymentStrategyType = +RollingUpdate.
+ 		false
typestring + Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
+ 		false
+ + +### OpenTelemetryCollector.spec.deploymentUpdateStrategy.rollingUpdate +[↩ Parent](#opentelemetrycollectorspecdeploymentupdatestrategy-1) + + + +Rolling update config params. Present only if DeploymentStrategyType = +RollingUpdate. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSurgeint or string + The maximum number of pods that can be scheduled above the desired number of +pods. +Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). +This can not be 0 if MaxUnavailable is 0. +Absolute number is calculated from percentage by rounding up. +Defaults to 25%. +Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when +the rolling update starts, such that the total number of old and new pods do not exceed +130% of desired pods. Once old pods have been killed, +new ReplicaSet can be scaled up further, ensuring that total number of pods running +at any time during the update is at most 130% of desired pods.
+ 		false
maxUnavailableint or string + The maximum number of pods that can be unavailable during the update. +Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). +Absolute number is calculated from percentage by rounding down. +This can not be 0 if MaxSurge is 0. +Defaults to 25%. +Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods +immediately when the rolling update starts. Once new pods are ready, old ReplicaSet +can be scaled down further, followed by scaling up the new ReplicaSet, ensuring +that the total number of pods available at all times during the update is at +least 70% of desired pods.
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom +[↩ Parent](#opentelemetrycollectorspecenvindex-1) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.configMapKeyRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom-1) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.fieldRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom-1) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.secretKeyRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom-1) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.envFrom[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### OpenTelemetryCollector.spec.envFrom[index].configMapRef +[↩ Parent](#opentelemetrycollectorspecenvfromindex-1) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.envFrom[index].secretRef +[↩ Parent](#opentelemetrycollectorspecenvfromindex-1) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.ingress +[↩ Parent](#opentelemetrycollectorspec-1) + + + +Ingress is used to specify how OpenTelemetry Collector is exposed. This +functionality is only available if one of the valid modes is set. +Valid modes are: deployment, daemonset and statefulset. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string + Annotations to add to ingress. +e.g. 'cert-manager.io/cluster-issuer: "letsencrypt"'
+ 		false
hostnamestring + Hostname by which the ingress proxy can be reached.
+ 		false
ingressClassNamestring + IngressClassName is the name of an IngressClass cluster resource. Ingress +controller implementations use this field to know whether they should be +serving this Ingress resource.
+ 		false
routeobject + Route is an OpenShift specific section that is only considered when +type "route" is used.
+ 		false
ruleTypeenum + RuleType defines how Ingress exposes collector receivers. +IngressRuleTypePath ("path") exposes each receiver port on a unique path on single domain defined in Hostname. +IngressRuleTypeSubdomain ("subdomain") exposes each receiver port on a unique subdomain of Hostname. +Default is IngressRuleTypePath ("path").
+
+ Enum: path, subdomain
+ 		false
tls[]object + TLS configuration.
+ 		false
typeenum + Type default value is: "" +Supported types are: ingress, route
+
+ Enum: ingress, route
+ 		false
+ + +### OpenTelemetryCollector.spec.ingress.route +[↩ Parent](#opentelemetrycollectorspecingress-1) + + + +Route is an OpenShift specific section that is only considered when +type "route" is used. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
terminationenum + Termination indicates termination type. By default "edge" is used.
+
+ Enum: insecure, edge, passthrough, reencrypt
+ 		false
+ + +### OpenTelemetryCollector.spec.ingress.tls[index] +[↩ Parent](#opentelemetrycollectorspecingress-1) + + + +IngressTLS describes the transport layer security associated with an ingress. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
hosts[]string + hosts is a list of hosts included in the TLS certificate. The values in +this list must match the name/s used in the tlsSecret. Defaults to the +wildcard host setting for the loadbalancer controller fulfilling this +Ingress, if left unspecified.
+ 		false
secretNamestring + secretName is the name of the secret used to terminate TLS traffic on +port 443. Field is left optional to allow TLS routing based on SNI +hostname alone. If the SNI host in a listener conflicts with the "Host" +header field used by an IngressRule, the SNI host is used for termination +and value of the "Host" header is used for routing.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +A single application container that you want to run within a pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + 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 container 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 container 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
imagestring + Container 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
imagePullPolicystring + 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
lifecycleobject + Actions that the management system should take in response to container lifecycle events. +Cannot be updated.
+ 		false
livenessProbeobject + 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. 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. +Modifying this array with strategic merge patch may corrupt the data. +For more information See https://github.com/kubernetes/kubernetes/issues/108255. +Cannot be updated.
+ 		false
readinessProbeobject + 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
resizePolicy[]object + Resources resize policy for the container.
+ 		false
resourcesobject + Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
restartPolicystring + RestartPolicy defines the restart behavior of individual containers in a pod. +This field may only be set for init containers, and the only allowed value is "Always". +For non-init containers or when this field is not specified, +the restart behavior is defined by the Pod's restart policy and the container type. +Setting the RestartPolicy as "Always" for the init container will have the following effect: +this init container will be continually restarted on +exit until all regular containers have terminated. Once all regular +containers have completed, all init containers with restartPolicy "Always" +will be shut down. This lifecycle differs from normal init containers and +is often referred to as a "sidecar" container. Although this init +container still starts in the init container sequence, it does not wait +for the container to complete before proceeding to the next init +container. Instead, the next init container starts immediately after this +init container is started, or after any startupProbe has successfully +completed.
+ 		false
securityContextobject + 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
startupProbeobject + 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
stdinboolean + 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
stdinOnceboolean + 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
terminationMessagePathstring + 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
terminationMessagePolicystring + 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
ttyboolean + 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
workingDirstring + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindex-1) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.configMapKeyRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom-1) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.fieldRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom-1) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].env[index].valueFrom.secretKeyRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvindexvaluefrom-1) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].envFrom[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].envFrom[index].configMapRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvfromindex-1) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].envFrom[index].secretRef +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexenvfromindex-1) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
postStartobject + 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
preStopobject + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycle-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststarthttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.sleep +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart-1) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.postStart.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecyclepoststart-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycle-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestophttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.sleep +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop-1) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].lifecycle.preStop.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlifecycleprestop-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.grpc +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe-1) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobehttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].livenessProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexlivenessprobe-1) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].ports[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +ContainerPort represents a network port in a single container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
containerPortinteger + Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536.
+
+ Format: int32
+ 		true
hostIPstring + What host IP to bind the external port to.
+ 		false
hostPortinteger + 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
namestring + 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
protocolstring + Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP".
+
+ Default: TCP
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.grpc +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe-1) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobehttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].readinessProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexreadinessprobe-1) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].resizePolicy[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +ContainerResizePolicy represents resource resize policy for the container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourceNamestring + Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory.
+ 		true
restartPolicystring + Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired.
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].resources +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].resources.claims[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexresources-1) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +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/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.capabilities +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].securityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.exec +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.grpc +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe-1) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.httpGet +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobehttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].startupProbe.tcpSocket +[↩ Parent](#opentelemetrycollectorspecinitcontainersindexstartupprobe-1) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.initContainers[index].volumeDevices[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +volumeDevice describes a mapping of a raw block device within a container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
devicePathstring + devicePath is the path inside of the container that the device will be mapped to.
+ 		true
namestring + name must match the name of a persistentVolumeClaim in the pod
+ 		true
+ + +### OpenTelemetryCollector.spec.initContainers[index].volumeMounts[index] +[↩ Parent](#opentelemetrycollectorspecinitcontainersindex-1) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### OpenTelemetryCollector.spec.lifecycle +[↩ Parent](#opentelemetrycollectorspec-1) + + + +Actions that the management system should take in response to container lifecycle events. Cannot be updated. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
postStartobject + 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
preStopobject + 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
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart +[↩ Parent](#opentelemetrycollectorspeclifecycle-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.exec +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.httpGet +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststarthttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.sleep +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart-1) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.lifecycle.postStart.tcpSocket +[↩ Parent](#opentelemetrycollectorspeclifecyclepoststart-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop +[↩ Parent](#opentelemetrycollectorspeclifecycle-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.exec +[↩ Parent](#opentelemetrycollectorspeclifecycleprestop-1) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.httpGet +[↩ Parent](#opentelemetrycollectorspeclifecycleprestop-1) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.httpGet.httpHeaders[index] +[↩ Parent](#opentelemetrycollectorspeclifecycleprestophttpget-1) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.sleep +[↩ Parent](#opentelemetrycollectorspeclifecycleprestop-1) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### OpenTelemetryCollector.spec.lifecycle.preStop.tcpSocket +[↩ Parent](#opentelemetrycollectorspeclifecycleprestop-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### OpenTelemetryCollector.spec.livenessProbe +[↩ Parent](#opentelemetrycollectorspec-1) + + + +Liveness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. +It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
initialDelaySecondsinteger + Number of seconds after the container has started before liveness probes are initiated. +Defaults to 0 seconds. Minimum value is 0. +More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+
+ Format: int32
+ 		false
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.observability +[↩ Parent](#opentelemetrycollectorspec-1) + + + +ObservabilitySpec defines how telemetry data gets handled. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
metricsobject + Metrics defines the metrics configuration for operands.
+ 		false
+ + +### OpenTelemetryCollector.spec.observability.metrics +[↩ Parent](#opentelemetrycollectorspecobservability-1) + + + +Metrics defines the metrics configuration for operands. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
disablePrometheusAnnotationsboolean + DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations +('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
+ 		false
enableMetricsboolean + EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. +The operator.observability.prometheus feature gate must be enabled to use this feature.
+ 		false
+ + +### OpenTelemetryCollector.spec.persistentVolumeClaimRetentionPolicy +[↩ Parent](#opentelemetrycollectorspec-1) + + + +PersistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims +created from volumeClaimTemplates. +This only works with the following OpenTelemetryCollector modes: statefulset. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
whenDeletedstring + WhenDeleted specifies what happens to PVCs created from StatefulSet +VolumeClaimTemplates when the StatefulSet is deleted. The default policy +of `Retain` causes PVCs to not be affected by StatefulSet deletion. The +`Delete` policy causes those PVCs to be deleted.
+ 		false
whenScaledstring + WhenScaled specifies what happens to PVCs created from StatefulSet +VolumeClaimTemplates when the StatefulSet is scaled down. The default +policy of `Retain` causes PVCs to not be affected by a scaledown. The +`Delete` policy causes the associated PVCs for any excess pods above +the replica count to be deleted.
+ 		false
+ + +### OpenTelemetryCollector.spec.podDisruptionBudget +[↩ Parent](#opentelemetrycollectorspec-1) + + + +PodDisruptionBudget specifies the pod disruption budget configuration to use +for the generated workload. By default, a PDB with a MaxUnavailable of one is set. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxUnavailableint or string + An eviction is allowed if at most "maxUnavailable" pods selected by +"selector" are unavailable after the eviction, i.e. even in absence of +the evicted pod. For example, one can prevent all voluntary evictions +by specifying 0. This is a mutually exclusive setting with "minAvailable".
+ 		false
minAvailableint or string + An eviction is allowed if at least "minAvailable" pods selected by +"selector" will still be available after the eviction, i.e. even in the +absence of the evicted pod. So for example you can prevent all voluntary +evictions by specifying "100%".
+ 		false
+ + +### OpenTelemetryCollector.spec.podDnsConfig +[↩ Parent](#opentelemetrycollectorspec-1) + + + +PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.podDnsConfig.options[index] +[↩ Parent](#opentelemetrycollectorspecpoddnsconfig) + + + +PodDNSConfigOption defines DNS resolver options of a pod. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Required.
+ 		false
valuestring +
+ 		false
+ + +### OpenTelemetryCollector.spec.podSecurityContext +[↩ Parent](#opentelemetrycollectorspec-1) + + + +PodSecurityContext configures the pod security context for the +generated pod, when running as a deployment, daemonset, +or statefulset. + +In sidecar mode, the opentelemetry-operator will ignore this setting. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
appArmorProfileobject + appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
fsGroupinteger + 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
fsGroupChangePolicystring + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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 and fsGroup (if specified). If +the SupplementalGroupsPolicy feature is enabled, the +supplementalGroupsPolicy field determines whether these are in addition +to or instead of any group memberships defined in the container image. +If unspecified, no additional groups are added, though group memberships +defined in the container image may still be used, depending on the +supplementalGroupsPolicy field. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
supplementalGroupsPolicystring + Defines how supplemental groups of the first container processes are calculated. +Valid values are "Merge" and "Strict". If not specified, "Merge" is used. +(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled +and the container runtime must implement support for this feature. +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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.podSecurityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) + + + +appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.podSecurityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.podSecurityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) + + + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.podSecurityContext.sysctls[index] +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) + + + +Sysctl defines a kernel parameter to be set + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of a property to set
+ 		true
valuestring + Value of a property to set
+ 		true
+ + +### OpenTelemetryCollector.spec.podSecurityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspecpodsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.ports[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +PortsSpec defines the OpenTelemetryCollector's container/service ports additional specifications. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + The port that will be exposed by this service.
+
+ Format: int32
+ 		true
appProtocolstring + The application protocol for this port. +This is used as a hint for implementations to offer richer behavior for protocols that they understand. +This field follows standard Kubernetes label syntax. +Valid values are either: + +* Un-prefixed protocol names - reserved for IANA standard service names (as per +RFC-6335 and https://www.iana.org/assignments/service-names). + +* Kubernetes-defined prefixed names: + * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- + * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 + * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 + +* Other protocols should use implementation-defined prefixed names such as +mycompany.com/my-custom-protocol.
+ 		false
hostPortinteger + Allows defining which port to bind to the host in the Container.
+
+ Format: int32
+ 		false
namestring + The name of this port within the service. This must be a DNS_LABEL. +All ports within a ServiceSpec must have unique names. When considering +the endpoints for a Service, this must match the 'name' field in the +EndpointPort. +Optional if only one ServicePort is defined on this service.
+ 		false
nodePortinteger + The port on each node on which this service is exposed when type is +NodePort or LoadBalancer. Usually assigned by the system. If a value is +specified, in-range, and not in use it will be used, otherwise the +operation will fail. If not specified, a port will be allocated if this +Service requires one. If this field is specified when creating a +Service which does not need it, creation will fail. This field will be +wiped when updating a Service to no longer need it (e.g. changing type +from NodePort to ClusterIP). +More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
+
+ Format: int32
+ 		false
protocolstring + The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". +Default is TCP.
+
+ Default: TCP
+ 		false
targetPortint or string + Number or name of the port to access on the pods targeted by the service. +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +If this is a string, it will be looked up as a named port in the +target Pod's container ports. If this is not specified, the value +of the 'port' field is used (an identity map). +This field is ignored for services with clusterIP=None, and should be +omitted or set equal to the 'port' field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
+ 		false
+ + +### OpenTelemetryCollector.spec.readinessProbe +[↩ Parent](#opentelemetrycollectorspec-1) + + + +Readiness config for the OpenTelemetry Collector except the probe handler which is auto generated from the health extension of the collector. +It is only effective when healthcheckextension is configured in the OpenTelemetry Collector pipeline. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
initialDelaySecondsinteger + Number of seconds after the container has started before liveness probes are initiated. +Defaults to 0 seconds. Minimum value is 0. +More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
+
+ Format: int32
+ 		false
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.resources +[↩ Parent](#opentelemetrycollectorspec-1) + + + +Resources to set on generated pods. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.resources.claims[index] +[↩ Parent](#opentelemetrycollectorspecresources-1) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext +[↩ Parent](#opentelemetrycollectorspec-1) + + + +SecurityContext configures the container security context for +the generated main container. + +In deployment, daemonset, or statefulset mode, this controls +the security context settings for the primary application +container. + +In sidecar mode, this controls the security context for the +injected sidecar container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.securityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.capabilities +[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspecsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator +[↩ Parent](#opentelemetrycollectorspec-1) + + + +TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
affinityobject + If specified, indicates the pod's scheduling constraints
+ 		false
allocationStrategyenum + AllocationStrategy determines which strategy the target allocator should use for allocation. +The current options are least-weighted, consistent-hashing and per-node. The default is +consistent-hashing. +WARNING: The per-node strategy currently ignores targets without a Node, like control plane components.
+
+ Enum: least-weighted, consistent-hashing, per-node
+ Default: consistent-hashing
+ 		false
enabledboolean + Enabled indicates whether to use a target allocation mechanism for Prometheus targets or not.
+ 		false
env[]object + ENV vars to set on the OpenTelemetry TargetAllocator's Pods. These can then in certain cases be +consumed in the config file for the TargetAllocator.
+ 		false
filterStrategyenum + FilterStrategy determines how to filter targets before allocating them among the collectors. +The only current option is relabel-config (drops targets based on prom relabel_config). +The default is relabel-config.
+
+ Enum: , relabel-config
+ Default: relabel-config
+ 		false
imagestring + Image indicates the container image to use for the OpenTelemetry TargetAllocator.
+ 		false
nodeSelectormap[string]string + NodeSelector to schedule OpenTelemetry TargetAllocator pods.
+ 		false
observabilityobject + ObservabilitySpec defines how telemetry data gets handled.
+ 		false
podDisruptionBudgetobject + PodDisruptionBudget specifies the pod disruption budget configuration to use +for the target allocator workload. By default, a PDB with a MaxUnavailable of one is set for a valid +allocation strategy.
+ 		false
podSecurityContextobject + PodSecurityContext configures the pod security context for the +targetallocator.
+ 		false
prometheusCRobject + PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ) retrieval. +All CR instances which the ServiceAccount has access to will be retrieved. This includes other namespaces.
+ 		false
replicasinteger + Replicas is the number of pod instances for the underlying TargetAllocator. This should only be set to a value +other than 1 if a strategy that allows for high availability is chosen. Currently, the only allocation strategy +that can be run in a high availability mode is consistent-hashing.
+
+ Format: int32
+ 		false
resourcesobject + Resources to set on the OpenTelemetryTargetAllocator containers.
+ 		false
securityContextobject + SecurityContext configures the container security context for +the targetallocator.
+ 		false
serviceAccountstring + ServiceAccount indicates the name of an existing service account to use with this instance. When set, +the operator will not automatically create a ServiceAccount for the TargetAllocator.
+ 		false
tolerations[]object + Toleration embedded kubernetes pod configuration option, +controls how pods can be scheduled with matching taints
+ 		false
topologySpreadConstraints[]object + TopologySpreadConstraints embedded kubernetes pod configuration option, +controls how pods are spread across your cluster among failure-domains +such as regions, zones, nodes, and other user-defined topology domains +https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +If specified, indicates the pod's scheduling constraints + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeAffinityobject + Describes node affinity scheduling rules for the pod.
+ 		false
podAffinityobject + Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
podAntiAffinityobject + Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity-1) + + + +Describes node affinity scheduling rules for the pod. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinity-1) + + + +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). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
preferenceobject + A node selector term, associated with the corresponding weight.
+ 		true
weightinteger + Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex-1) + + + +A node selector term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference-1) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference-1) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinity-1) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeSelectorTerms[]object + Required. A list of node selector terms. The terms are ORed.
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecution-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex-1) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex-1) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity-1) + + + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinity-1) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex-1) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinity-1) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex-1) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinity-1) + + + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinity-1) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex-1) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinity-1) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex-1) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatoraffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index] +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindex-1) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.configMapKeyRef +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom-1) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.fieldRef +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom-1) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.resourceFieldRef +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.env[index].valueFrom.secretKeyRef +[↩ Parent](#opentelemetrycollectorspectargetallocatorenvindexvaluefrom-1) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.observability +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +ObservabilitySpec defines how telemetry data gets handled. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
metricsobject + Metrics defines the metrics configuration for operands.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.observability.metrics +[↩ Parent](#opentelemetrycollectorspectargetallocatorobservability-1) + + + +Metrics defines the metrics configuration for operands. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
disablePrometheusAnnotationsboolean + DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations +('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
+ 		false
enableMetricsboolean + EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. +The operator.observability.prometheus feature gate must be enabled to use this feature.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podDisruptionBudget +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +PodDisruptionBudget specifies the pod disruption budget configuration to use +for the target allocator workload. By default, a PDB with a MaxUnavailable of one is set for a valid +allocation strategy. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxUnavailableint or string + An eviction is allowed if at most "maxUnavailable" pods selected by +"selector" are unavailable after the eviction, i.e. even in absence of +the evicted pod. For example, one can prevent all voluntary evictions +by specifying 0. This is a mutually exclusive setting with "minAvailable".
+ 		false
minAvailableint or string + An eviction is allowed if at least "minAvailable" pods selected by +"selector" will still be available after the eviction, i.e. even in the +absence of the evicted pod. So for example you can prevent all voluntary +evictions by specifying "100%".
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +PodSecurityContext configures the pod security context for the +targetallocator. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
appArmorProfileobject + appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
fsGroupinteger + 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
fsGroupChangePolicystring + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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 and fsGroup (if specified). If +the SupplementalGroupsPolicy feature is enabled, the +supplementalGroupsPolicy field determines whether these are in addition +to or instead of any group memberships defined in the container image. +If unspecified, no additional groups are added, though group memberships +defined in the container image may still be used, depending on the +supplementalGroupsPolicy field. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
supplementalGroupsPolicystring + Defines how supplemental groups of the first container processes are calculated. +Valid values are "Merge" and "Strict". If not specified, "Merge" is used. +(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled +and the container runtime must implement support for this feature. +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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) + + + +appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) + + + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.sysctls[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) + + + +Sysctl defines a kernel parameter to be set + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of a property to set
+ 		true
valuestring + Value of a property to set
+ 		true
+ + +### OpenTelemetryCollector.spec.targetAllocator.podSecurityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspectargetallocatorpodsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ) retrieval. +All CR instances which the ServiceAccount has access to will be retrieved. This includes other namespaces. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Enabled indicates whether to use a PrometheusOperator custom resources as targets or not.
+ 		false
podMonitorSelectorobject + PodMonitors to be selected for target discovery. +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
probeSelectorobject + Probes to be selected for target discovery. +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
scrapeConfigSelectorobject + ScrapeConfigs to be selected for target discovery. +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
scrapeIntervalstring + Default interval between consecutive scrapes. Intervals set in ServiceMonitors and PodMonitors override it. +Equivalent to the same setting on the Prometheus CR. + +Default: "30s"
+
+ Format: duration
+ Default: 30s
+ 		false
serviceMonitorSelectorobject + ServiceMonitors to be selected for target discovery. +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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.podMonitorSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscr-1) + + + +PodMonitors to be selected for target discovery. +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.podMonitorSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscrpodmonitorselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.probeSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscr-1) + + + +Probes to be selected for target discovery. +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.probeSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscrprobeselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.scrapeConfigSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscr-1) + + + +ScrapeConfigs to be selected for target discovery. +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.scrapeConfigSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscrscrapeconfigselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.serviceMonitorSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscr-1) + + + +ServiceMonitors to be selected for target discovery. +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.prometheusCR.serviceMonitorSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatorprometheuscrservicemonitorselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.resources +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +Resources to set on the OpenTelemetryTargetAllocator containers. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.resources.claims[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatorresources-1) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +SecurityContext configures the container security context for +the targetallocator. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.appArmorProfile +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.capabilities +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.securityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspectargetallocatorsecuritycontext-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.tolerations[index] +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +The pod this Toleration is attached to tolerates any taint that matches +the triple using the matching operator . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
effectstring + Effect indicates the taint effect to match. Empty means match all taint effects. +When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ 		false
keystring + 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
operatorstring + 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
tolerationSecondsinteger + 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
valuestring + 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
+ + +### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index] +[↩ Parent](#opentelemetrycollectorspectargetallocator-1) + + + +TopologySpreadConstraint specifies how to spread matching pods among the given topology. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSkewinteger + 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. +The global minimum is the minimum number of matching pods in an eligible domain +or zero if the number of eligible domains is less than MinDomains. +For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same +labelSelector spread as 2/2/1: +In this case, the global minimum is 1. +| zone1 | zone2 | zone3 | +| P P | P P | P | +- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; +scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring + 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 as a "bucket", and try to put balanced number +of pods into each bucket. +We define a domain as a particular instance of a topology. +Also, we define an eligible domain as a domain whose nodes meet the requirements of +nodeAffinityPolicy and nodeTaintsPolicy. +e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. +And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. +It's a required field.
+ 		true
whenUnsatisfiablestring + 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
labelSelectorobject + 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
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select the pods over which +spreading will be calculated. The keys are used to lookup values from the +incoming pod labels, those key-value labels are ANDed with labelSelector +to select the group of existing pods over which spreading will be calculated +for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +MatchLabelKeys cannot be set when LabelSelector isn't set. +Keys that don't exist in the incoming pod labels will +be ignored. A null or empty list means only match against labelSelector. + +This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ 		false
minDomainsinteger + MinDomains indicates a minimum number of eligible domains. +When the number of eligible domains with matching topology keys is less than minDomains, +Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. +And when the number of eligible domains with matching topology keys equals or greater than minDomains, +this value has no effect on scheduling. +As a result, when the number of eligible domains is less than minDomains, +scheduler won't schedule more than maxSkew Pods to those domains. +If value is nil, the constraint behaves as if MinDomains is equal to 1. +Valid values are integers greater than 0. +When value is not nil, WhenUnsatisfiable must be DoNotSchedule. + +For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same +labelSelector spread as 2/2/2: +| zone1 | zone2 | zone3 | +| P P | P P | P P | +The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. +In this situation, new pod with the same labelSelector cannot be scheduled, +because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, +it will violate MaxSkew.
+
+ Format: int32
+ 		false
nodeAffinityPolicystring + NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector +when calculating pod topology spread skew. Options are: +- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. +- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. + +If this value is nil, the behavior is equivalent to the Honor policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
nodeTaintsPolicystring + NodeTaintsPolicy indicates how we will treat node taints when calculating +pod topology spread skew. Options are: +- Honor: nodes without taints, along with tainted nodes for which the incoming pod +has a toleration, are included. +- Ignore: node taints are ignored. All nodes are included. + +If this value is nil, the behavior is equivalent to the Ignore policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index].labelSelector +[↩ Parent](#opentelemetrycollectorspectargetallocatortopologyspreadconstraintsindex-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.targetAllocator.topologySpreadConstraints[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectargetallocatortopologyspreadconstraintsindexlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.tolerations[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +The pod this Toleration is attached to tolerates any taint that matches +the triple using the matching operator . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
effectstring + Effect indicates the taint effect to match. Empty means match all taint effects. +When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ 		false
keystring + 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
operatorstring + 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
tolerationSecondsinteger + 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
valuestring + 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
+ + +### OpenTelemetryCollector.spec.topologySpreadConstraints[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +TopologySpreadConstraint specifies how to spread matching pods among the given topology. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSkewinteger + 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. +The global minimum is the minimum number of matching pods in an eligible domain +or zero if the number of eligible domains is less than MinDomains. +For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same +labelSelector spread as 2/2/1: +In this case, the global minimum is 1. +| zone1 | zone2 | zone3 | +| P P | P P | P | +- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; +scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring + 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 as a "bucket", and try to put balanced number +of pods into each bucket. +We define a domain as a particular instance of a topology. +Also, we define an eligible domain as a domain whose nodes meet the requirements of +nodeAffinityPolicy and nodeTaintsPolicy. +e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. +And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. +It's a required field.
+ 		true
whenUnsatisfiablestring + 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
labelSelectorobject + 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
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select the pods over which +spreading will be calculated. The keys are used to lookup values from the +incoming pod labels, those key-value labels are ANDed with labelSelector +to select the group of existing pods over which spreading will be calculated +for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +MatchLabelKeys cannot be set when LabelSelector isn't set. +Keys that don't exist in the incoming pod labels will +be ignored. A null or empty list means only match against labelSelector. + +This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ 		false
minDomainsinteger + MinDomains indicates a minimum number of eligible domains. +When the number of eligible domains with matching topology keys is less than minDomains, +Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. +And when the number of eligible domains with matching topology keys equals or greater than minDomains, +this value has no effect on scheduling. +As a result, when the number of eligible domains is less than minDomains, +scheduler won't schedule more than maxSkew Pods to those domains. +If value is nil, the constraint behaves as if MinDomains is equal to 1. +Valid values are integers greater than 0. +When value is not nil, WhenUnsatisfiable must be DoNotSchedule. + +For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same +labelSelector spread as 2/2/2: +| zone1 | zone2 | zone3 | +| P P | P P | P P | +The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. +In this situation, new pod with the same labelSelector cannot be scheduled, +because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, +it will violate MaxSkew.
+
+ Format: int32
+ 		false
nodeAffinityPolicystring + NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector +when calculating pod topology spread skew. Options are: +- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. +- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. + +If this value is nil, the behavior is equivalent to the Honor policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
nodeTaintsPolicystring + NodeTaintsPolicy indicates how we will treat node taints when calculating +pod topology spread skew. Options are: +- Honor: nodes without taints, along with tainted nodes for which the incoming pod +has a toleration, are included. +- Ignore: node taints are ignored. All nodes are included. + +If this value is nil, the behavior is equivalent to the Ignore policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
+ + +### OpenTelemetryCollector.spec.topologySpreadConstraints[index].labelSelector +[↩ Parent](#opentelemetrycollectorspectopologyspreadconstraintsindex-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspectopologyspreadconstraintsindexlabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +PersistentVolumeClaim is a user's request for and claim to a persistent volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstring + APIVersion defines the versioned schema of this representation of an object. +Servers should convert recognized schemas to the latest internal value, and +may reject unrecognized values. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ 		false
kindstring + Kind is a string value representing the REST resource this object represents. +Servers may infer this from the endpoint the client submits requests to. +Cannot be updated. +In CamelCase. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 		false
metadataobject + Standard object's metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+ 		false
specobject + spec defines the desired characteristics of a volume requested by a pod author. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
statusobject + status represents the current information/status of a persistent volume claim. +Read-only. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].metadata +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex-1) + + + +Standard object's metadata. +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex-1) + + + +spec defines the desired characteristics of a volume requested by a pod author. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSource +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec-1) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSourceRef +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec-1) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.resources +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec-1) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspecselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex-1) + + + +status represents the current information/status of a persistent volume claim. +Read-only. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
accessModes[]string + accessModes contains the actual access modes the volume backing the PVC has. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ 		false
allocatedResourceStatusesmap[string]string + allocatedResourceStatuses stores status of resource being resized for the given PVC. +Key names follow standard Kubernetes label syntax. Valid values are either: + * Un-prefixed keys: + - storage - the capacity of the volume. + * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" +Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered +reserved and hence may not be used. + +ClaimResourceStatus can be in any of following states: + - ControllerResizeInProgress: + State set when resize controller starts resizing the volume in control-plane. + - ControllerResizeFailed: + State set when resize has failed in resize controller with a terminal error. + - NodeResizePending: + State set when resize controller has finished resizing the volume but further resizing of + volume is needed on the node. + - NodeResizeInProgress: + State set when kubelet starts resizing the volume. + - NodeResizeFailed: + State set when resizing has failed in kubelet with a terminal error. Transient errors don't set + NodeResizeFailed.
+ 		false
allocatedResourcesmap[string]int or string + allocatedResources tracks the resources allocated to a PVC including its capacity. +Key names follow standard Kubernetes label syntax. Valid values are either: + * Un-prefixed keys: + - storage - the capacity of the volume. + * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" +Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered +reserved and hence may not be used. + +Capacity reported here may be larger than the actual capacity when a volume expansion operation +is requested. +For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. +If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. +If a volume expansion capacity request is lowered, allocatedResources is only +lowered if there are no expansion operations in progress and if the actual volume capacity +is equal or lower than the requested capacity. + +A controller that receives PVC update with previously unknown resourceName +should ignore the update for the purpose it was designed.
+ 		false
capacitymap[string]int or string + capacity represents the actual resources of the underlying volume.
+ 		false
conditions[]object + conditions is the current Condition of persistent volume claim. If underlying persistent volume is being +resized then the Condition will be set to 'Resizing'.
+ 		false
currentVolumeAttributesClassNamestring + currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. +When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim +This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
+ 		false
modifyVolumeStatusobject + ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. +When this is unset, there is no ModifyVolume operation being attempted. +This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
+ 		false
phasestring + phase represents the current phase of PersistentVolumeClaim.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.conditions[index] +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexstatus-1) + + + +PersistentVolumeClaimCondition contains details about state of pvc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
statusstring +
+ 		true
typestring + PersistentVolumeClaimConditionType defines the condition of PV claim. +Valid values are: + - "Resizing", "FileSystemResizePending" + +If RecoverVolumeExpansionFailure feature gate is enabled, then following additional values can be expected: + - "ControllerResizeError", "NodeResizeError" + +If VolumeAttributesClass feature gate is enabled, then following additional values can be expected: + - "ModifyVolumeError", "ModifyingVolume"
+ 		true
lastProbeTimestring + lastProbeTime is the time we probed the condition.
+
+ Format: date-time
+ 		false
lastTransitionTimestring + lastTransitionTime is the time the condition transitioned from one status to another.
+
+ Format: date-time
+ 		false
messagestring + message is the human-readable message indicating details about last transition.
+ 		false
reasonstring + reason is a unique, this should be a short, machine understandable string that gives the reason +for condition's last transition. If it reports "Resizing" that means the underlying +persistent volume is being resized.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.modifyVolumeStatus +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexstatus-1) + + + +ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. +When this is unset, there is no ModifyVolume operation being attempted. +This is a beta field and requires enabling VolumeAttributesClass feature (off by default). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
statusstring + status is the status of the ControllerModifyVolume operation. It can be in any of following states: + - Pending + Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as + the specified VolumeAttributesClass not existing. + - InProgress + InProgress indicates that the volume is being modified. + - Infeasible + Infeasible indicates that the request has been rejected as invalid by the CSI driver. To + resolve the error, a valid VolumeAttributesClass needs to be specified. +Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.
+ 		true
targetVolumeAttributesClassNamestring + targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeMounts[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index] +[↩ Parent](#opentelemetrycollectorspec-1) + + + +Volume represents a named volume in a pod that may be accessed by any container in the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + name of the volume. +Must be a DNS_LABEL and unique within the pod. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ 		true
awsElasticBlockStoreobject + 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
azureDiskobject + azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ 		false
azureFileobject + azureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ 		false
cephfsobject + cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ 		false
cinderobject + cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		false
configMapobject + configMap represents a configMap that should populate this volume
+ 		false
csiobject + csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ 		false
downwardAPIobject + downwardAPI represents downward API about the pod that should populate this volume
+ 		false
emptyDirobject + emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
ephemeralobject + 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
fcobject + fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ 		false
flexVolumeobject + flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin.
+ 		false
flockerobject + flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ 		false
gcePersistentDiskobject + 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
gitRepoobject + 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
glusterfsobject + 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
hostPathobject + 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
+ 		false
imageobject + image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. +The volume is resolved at pod startup depending on which PullPolicy value is provided: + +- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. + +The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. +A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
+ 		false
iscsiobject + 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
nfsobject + 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
persistentVolumeClaimobject + persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
photonPersistentDiskobject + photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ 		false
portworxVolumeobject + portworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ 		false
projectedobject + projected items for all in one resources secrets, configmaps, and downward API
+ 		false
quobyteobject + quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ 		false
rbdobject + 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
scaleIOobject + scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ 		false
secretobject + secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
storageosobject + storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ 		false
vsphereVolumeobject + vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].awsElasticBlockStore +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		true
fsTypestring + fsType is the 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
+ 		false
partitioninteger + partition is 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
readOnlyboolean + readOnly value true will force the readOnly setting in VolumeMounts. +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].azureDisk +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
diskNamestring + diskName is the Name of the data disk in the blob storage
+ 		true
diskURIstring + diskURI is the URI of data disk in the blob storage
+ 		true
cachingModestring + cachingMode is the Host Caching mode: None, Read Only, Read Write.
+ 		false
fsTypestring + fsType is 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.
+
+ Default: ext4
+ 		false
kindstring + kind expected values are 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
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+
+ Default: false
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].azureFile +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +azureFile represents an Azure File Service mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secretNamestring + secretName is the name of secret that contains Azure Storage Account Name and Key
+ 		true
shareNamestring + shareName is the azure share Name
+ 		true
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].cephfs +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +cephFS represents a Ceph FS mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
monitors[]string + monitors is Required: Monitors is a collection of Ceph monitors +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		true
pathstring + path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
+ 		false
readOnlyboolean + readOnly is 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
secretFilestring + secretFile is 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
secretRefobject + secretRef is 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
userstring + user is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].cephfs.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexcephfs-1) + + + +secretRef is 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 + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].cinder +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID used to identify the volume in cinder. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		true
fsTypestring + fsType is the 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
readOnlyboolean + readOnly 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
secretRefobject + secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].cinder.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexcinder-1) + + + +secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].configMap +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +configMap represents a configMap that should populate this volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is 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 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].configMap.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexconfigmap-1) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].csi +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + 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
fsTypestring + fsType 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
nodePublishSecretRefobject + 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
readOnlyboolean + readOnly specifies a read-only configuration for the volume. +Defaults to false (read/write).
+ 		false
volumeAttributesmap[string]string + volumeAttributes stores driver-specific properties that are passed to the CSI +driver. Consult your driver's documentation for supported values.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].csi.nodePublishSecretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexcsi-1) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +downwardAPI represents downward API about the pod that should populate this volume + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapi-1) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
+ 		false
modeinteger + 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
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].fieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex-1) + + + +Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex-1) + + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].emptyDir +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mediumstring + medium represents 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
sizeLimitint or string + sizeLimit is the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeClaimTemplateobject + 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 `-` where +`` 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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeral-1) + + + +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 `-` where +`` 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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec-1) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec-1) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec-1) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespecselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].fc +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the 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
luninteger + lun is Optional: FC target lun number
+
+ Format: int32
+ 		false
readOnlyboolean + readOnly is Optional: Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
targetWWNs[]string + targetWWNs is Optional: FC target worldwide names (WWNs)
+ 		false
wwids[]string + wwids Optional: FC volume world wide identifiers (wwids) +Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].flexVolume +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + driver is the name of the driver to use for this volume.
+ 		true
fsTypestring + fsType is the 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
optionsmap[string]string + options is Optional: this field holds extra command options if any.
+ 		false
readOnlyboolean + readOnly is Optional: defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].flexVolume.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexflexvolume-1) + + + +secretRef is 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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].flocker +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
datasetNamestring + datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker +should be considered as deprecated
+ 		false
datasetUUIDstring + datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].gcePersistentDisk +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdNamestring + pdName is 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
fsTypestring + fsType is 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
+ 		false
partitioninteger + partition is 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
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].gitRepo +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
repositorystring + repository is the URL
+ 		true
directorystring + directory is the 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
revisionstring + revision is the commit hash for the specified revision.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].glusterfs +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/glusterfs/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
endpointsstring + endpoints is the endpoint name that details Glusterfs topology. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
pathstring + path is the Glusterfs volume path. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
readOnlyboolean + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].hostPath +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
typestring + type for HostPath Volume +Defaults to "" +More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].image +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. +The volume is resolved at pod startup depending on which PullPolicy value is provided: + +- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. + +The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. +A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pullPolicystring + Policy for pulling OCI objects. Possible values are: +Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. +Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
+ 		false
referencestring + Required: Image or artifact reference to be used. +Behaves in the same way as pod.spec.containers[*].image. +Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. +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
+ + +### OpenTelemetryCollector.spec.volumes[index].iscsi +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
iqnstring + iqn is the target iSCSI Qualified Name.
+ 		true
luninteger + lun represents iSCSI Target Lun number.
+
+ Format: int32
+ 		true
targetPortalstring + targetPortal is 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
chapAuthDiscoveryboolean + chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
+ 		false
chapAuthSessionboolean + chapAuthSession defines whether support iSCSI Session CHAP authentication
+ 		false
fsTypestring + fsType is the 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
+ 		false
initiatorNamestring + initiatorName is the custom iSCSI Initiator Name. +If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface +: will be created for the connection.
+ 		false
iscsiInterfacestring + iscsiInterface is the interface Name that uses an iSCSI transport. +Defaults to 'default' (tcp).
+
+ Default: default
+ 		false
portals[]string + portals is the 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
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false.
+ 		false
secretRefobject + secretRef is the CHAP Secret for iSCSI target and initiator authentication
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].iscsi.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexiscsi-1) + + + +secretRef is the CHAP Secret for iSCSI target and initiator authentication + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].nfs +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +nfs represents an NFS mount on the host that shares a pod's lifetime +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path that is exported by the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
serverstring + server is the hostname or IP address of the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
readOnlyboolean + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].persistentVolumeClaim +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claimNamestring + 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
readOnlyboolean + readOnly Will force the ReadOnly setting in VolumeMounts. +Default false.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].photonPersistentDisk +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdIDstring + pdID is the ID that identifies Photon Controller persistent disk
+ 		true
fsTypestring + fsType is the 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
+ + +### OpenTelemetryCollector.spec.volumes[index].portworxVolume +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +portworxVolume represents a portworx volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID uniquely identifies a Portworx volume
+ 		true
fsTypestring + 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
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +projected items for all in one resources secrets, configmaps, and downward API + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode are the 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 + sources is the list of volume projections. Each entry in this list +handles one source.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojected-1) + + + +Projection that may be projected along with other supported volume types. +Exactly one of these fields must be set. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
clusterTrustBundleobject + ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time.
+ 		false
configMapobject + configMap information about the configMap data to project
+ 		false
downwardAPIobject + downwardAPI information about the downwardAPI data to project
+ 		false
secretobject + secret information about the secret data to project
+ 		false
serviceAccountTokenobject + serviceAccountToken is information about the serviceAccountToken data to project
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) + + + +ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Relative path from the volume root to write the bundle.
+ 		true
labelSelectorobject + Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything".
+ 		false
namestring + Select a single ClusterTrustBundle by object name. Mutually-exclusive +with signerName and labelSelector.
+ 		false
optionalboolean + If true, don't block pod startup if the referenced ClusterTrustBundle(s) +aren't available. If using name, then the named ClusterTrustBundle is +allowed not to exist. If using signerName, then the combination of +signerName and labelSelector is allowed to match zero +ClusterTrustBundles.
+ 		false
signerNamestring + Select all ClusterTrustBundles that match this signer name. +Mutually-exclusive with name. The contents of all selected +ClusterTrustBundles will be unified and deduplicated.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexclustertrustbundle-1) + + + +Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything". + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexclustertrustbundlelabelselector-1) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) + + + +configMap information about the configMap data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexconfigmap-1) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) + + + +downwardAPI information about the downwardAPI data to project + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + Items is a list of DownwardAPIVolume file
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapi-1) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
+ 		false
modeinteger + 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
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex-1) + + + +Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex-1) + + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) + + + +secret information about the secret data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional field specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexsecret-1) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].serviceAccountToken +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex-1) + + + +serviceAccountToken is information about the serviceAccountToken data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path is the path relative to the mount point of the file to project the +token into.
+ 		true
audiencestring + 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
expirationSecondsinteger + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].quobyte +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +quobyte represents a Quobyte mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
registrystring + 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
volumestring + volume is a string that references an already created Quobyte volume by name.
+ 		true
groupstring + group to map volume access to +Default is no group
+ 		false
readOnlyboolean + readOnly here will force the Quobyte volume to be mounted with read-only permissions. +Defaults to false.
+ 		false
tenantstring + tenant owning the given Quobyte volume in the Backend +Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ 		false
userstring + user to map volume access to +Defaults to serivceaccount user
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].rbd +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + image is the rados image name. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
monitors[]string + monitors is a collection of Ceph monitors. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
fsTypestring + fsType is the 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
+ 		false
keyringstring + 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
+
+ Default: /etc/ceph/keyring
+ 		false
poolstring + pool is the rados pool name. +Default is rbd. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+
+ Default: rbd
+ 		false
readOnlyboolean + 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
secretRefobject + 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
userstring + user is the rados user name. +Default is admin. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+
+ Default: admin
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].rbd.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexrbd-1) + + + +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 + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].scaleIO +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gatewaystring + gateway is the host address of the ScaleIO API Gateway.
+ 		true
secretRefobject + secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail.
+ 		true
systemstring + system is the name of the storage system as configured in ScaleIO.
+ 		true
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". +Default is "xfs".
+
+ Default: xfs
+ 		false
protectionDomainstring + protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
+ 		false
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
sslEnabledboolean + sslEnabled Flag enable/disable SSL communication with Gateway, default false
+ 		false
storageModestring + storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. +Default is ThinProvisioned.
+
+ Default: ThinProvisioned
+ 		false
storagePoolstring + storagePool is the ScaleIO Storage Pool associated with the protection domain.
+ 		false
volumeNamestring + volumeName is the name of a volume already created in the ScaleIO system +that is associated with this volume source.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].scaleIO.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexscaleio-1) + + + +secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].secret +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is 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 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
optionalboolean + optional field specify whether the Secret or its keys must be defined
+ 		false
secretNamestring + secretName is the name of the secret in the pod's namespace to use. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].secret.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexsecret-1) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### OpenTelemetryCollector.spec.volumes[index].storageos +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the 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
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted.
+ 		false
volumeNamestring + volumeName is the human-readable name of the StorageOS volume. Volume +names are only unique within a namespace.
+ 		false
volumeNamespacestring + 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
+ + +### OpenTelemetryCollector.spec.volumes[index].storageos.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexstorageos-1) + + + +secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].vsphereVolume +[↩ Parent](#opentelemetrycollectorspecvolumesindex-1) + + + +vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumePathstring + volumePath is the path that identifies vSphere volume vmdk
+ 		true
fsTypestring + fsType is 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
storagePolicyIDstring + storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ 		false
storagePolicyNamestring + storagePolicyName is the storage Policy Based Management (SPBM) profile name.
+ 		false
+ + +### OpenTelemetryCollector.status +[↩ Parent](#opentelemetrycollector-1) + + + +OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + Image indicates the container image to use for the OpenTelemetry Collector.
+ 		false
scaleobject + Scale is the OpenTelemetryCollector's scale subresource status.
+ 		false
versionstring + Version of the managed OpenTelemetry Collector (operand)
+ 		false
+ + +### OpenTelemetryCollector.status.scale +[↩ Parent](#opentelemetrycollectorstatus-1) + + + +Scale is the OpenTelemetryCollector's scale subresource status. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
replicasinteger + The total number non-terminated pods targeted by this +OpenTelemetryCollector's deployment or statefulSet.
+
+ Format: int32
+ 		false
selectorstring + The selector used to match the OpenTelemetryCollector's +deployment or statefulSet pods.
+ 		false
statusReplicasstring + StatusReplicas is the number of pods targeted by this OpenTelemetryCollector's with a Ready Condition / +Total number of non-terminated pods targeted by this OpenTelemetryCollector's (their labels match the selector). +Deployment, Daemonset, StatefulSet.
+ 		false
\ No newline at end of file diff --git a/docs/api/targetallocators.md b/docs/api/targetallocators.md new file mode 100644 index 0000000000..3c2547aeeb --- /dev/null +++ b/docs/api/targetallocators.md @@ -0,0 +1,14478 @@ +# API Reference + +Packages: + +- [opentelemetry.io/v1alpha1](#opentelemetryiov1alpha1) + +# opentelemetry.io/v1alpha1 + +Resource Types: + +- [TargetAllocator](#targetallocator) + + + + +## TargetAllocator +[↩ Parent](#opentelemetryiov1alpha1 ) + + + + + + +TargetAllocator is the Schema for the targetallocators API. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringTargetAllocatortrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + TargetAllocatorSpec defines the desired state of TargetAllocator.
+ 		false
statusobject + TargetAllocatorStatus defines the observed state of Target Allocator.
+ 		false
+ + +### TargetAllocator.spec +[↩ Parent](#targetallocator) + + + +TargetAllocatorSpec defines the desired state of TargetAllocator. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
managementStateenum + ManagementState defines if the CR should be managed by the operator or not. +Default is managed.
+
+ Enum: managed, unmanaged
+ Default: managed
+ 		true
additionalContainers[]object + AdditionalContainers allows injecting additional containers into the generated pod definition. +These sidecar containers can be used for authentication proxies, log shipping sidecars, agents for shipping +metrics to their cloud, or in general sidecars that do not support automatic injection. +This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment. + +Container names managed by the operator: +* `otc-container` + +Overriding containers managed by the operator is outside the scope of what the maintainers will support and by +doing so, you wil accept the risk of it breaking things.
+ 		false
affinityobject + If specified, indicates the pod's scheduling constraints
+ 		false
allocationStrategyenum + AllocationStrategy determines which strategy the target allocator should use for allocation. +The current options are least-weighted, consistent-hashing and per-node. The default is +consistent-hashing. +WARNING: The per-node strategy currently ignores targets without a Node, like control plane components.
+
+ Enum: least-weighted, consistent-hashing, per-node
+ Default: consistent-hashing
+ 		false
argsmap[string]string + Args is the set of arguments to pass to the main container's binary.
+ 		false
env[]object + Environment variables to set on the generated pods.
+ 		false
envFrom[]object + List of sources to populate environment variables on the generated pods.
+ 		false
filterStrategyenum + FilterStrategy determines how to filter targets before allocating them among the collectors. +The only current option is relabel-config (drops targets based on prom relabel_config). +The default is relabel-config.
+
+ Enum: , relabel-config
+ Default: relabel-config
+ 		false
globalobject + GlobalConfig configures the global configuration for Prometheus +For more info, see https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file.
+ 		false
hostNetworkboolean + HostNetwork indicates if the pod should run in the host networking namespace.
+ 		false
imagestring + Image indicates the container image to use for the generated pods.
+ 		false
imagePullPolicystring + ImagePullPolicy indicates the pull policy to be used for retrieving the container image.
+ 		false
initContainers[]object + InitContainers allows injecting initContainers to the generated pod definition. +These init containers can be used to fetch secrets for injection into the +configuration from external sources, run added checks, etc. Any errors during the execution of +an initContainer will lead to a restart of the Pod. More info: +https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
+ 		false
ipFamilies[]string + IPFamily represents the IP Family (IPv4 or IPv6). This type is used +to express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).
+ 		false
ipFamilyPolicystring + IPFamilyPolicy represents the dual-stack-ness requested or required by a Service
+
+ Default: SingleStack
+ 		false
lifecycleobject + Actions that the management system should take in response to container lifecycle events. Cannot be updated.
+ 		false
nodeSelectormap[string]string + NodeSelector to schedule generated pods. +This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment.
+ 		false
observabilityobject + ObservabilitySpec defines how telemetry data gets handled.
+ 		false
podAnnotationsmap[string]string + PodAnnotations is the set of annotations that will be attached to +the generated pods.
+ 		false
podDisruptionBudgetobject + PodDisruptionBudget specifies the pod disruption budget configuration to use +for the generated workload. By default, a PDB with a MaxUnavailable of one is set.
+ 		false
podDnsConfigobject + PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
+ 		false
podSecurityContextobject + PodSecurityContext configures the pod security context for the +generated pod, when running as a deployment, daemonset, +or statefulset. + +In sidecar mode, the opentelemetry-operator will ignore this setting.
+ 		false
ports[]object + Ports allows a set of ports to be exposed by the underlying v1.Service & v1.ContainerPort. By default, the operator +will attempt to infer the required ports by parsing the .Spec.Config property but this property can be +used to open additional ports that can't be inferred by the operator, like for custom receivers.
+ 		false
priorityClassNamestring + If specified, indicates the pod's priority. +If not specified, the pod priority will be default or zero if there is no +default.
+ 		false
prometheusCRobject + PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ).
+ 		false
replicasinteger + Replicas is the number of pod instances for the underlying replicaset. Set this if you are not using autoscaling.
+
+ Format: int32
+ 		false
resourcesobject + Resources to set on generated pods.
+ 		false
scrapeConfigs[]object + ScrapeConfigs define static Prometheus scrape configurations for the target allocator. +To use dynamic configurations from ServiceMonitors and PodMonitors, see the PrometheusCR section. +For the exact format, see https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.
+ 		false
securityContextobject + SecurityContext configures the container security context for +the generated main container. + +In deployment, daemonset, or statefulset mode, this controls +the security context settings for the primary application +container. + +In sidecar mode, this controls the security context for the +injected sidecar container.
+ 		false
serviceAccountstring + ServiceAccount indicates the name of an existing service account to use with this instance. When set, +the operator will not automatically create a ServiceAccount.
+ 		false
shareProcessNamespaceboolean + ShareProcessNamespace indicates if the pod's containers should share process namespace.
+ 		false
terminationGracePeriodSecondsinteger + Duration in seconds the pod needs to terminate gracefully upon probe failure.
+
+ Format: int64
+ 		false
tolerations[]object + Toleration to schedule the generated pods. +This only works with the following OpenTelemetryCollector mode's: daemonset, statefulset, and deployment.
+ 		false
topologySpreadConstraints[]object + TopologySpreadConstraints embedded kubernetes pod configuration option, +controls how pods are spread across your cluster among failure-domains +such as regions, zones, nodes, and other user-defined topology domains +https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ +This only works with the following OpenTelemetryCollector mode's: statefulset, and deployment.
+ 		false
volumeMounts[]object + VolumeMounts represents the mount points to use in the underlying deployment(s).
+ 		false
volumes[]object + Volumes represents which volumes to use in the underlying deployment(s).
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index] +[↩ Parent](#targetallocatorspec) + + + +A single application container that you want to run within a pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + 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 container 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 container 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
imagestring + Container 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
imagePullPolicystring + 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
lifecycleobject + Actions that the management system should take in response to container lifecycle events. +Cannot be updated.
+ 		false
livenessProbeobject + 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. 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. +Modifying this array with strategic merge patch may corrupt the data. +For more information See https://github.com/kubernetes/kubernetes/issues/108255. +Cannot be updated.
+ 		false
readinessProbeobject + 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
resizePolicy[]object + Resources resize policy for the container.
+ 		false
resourcesobject + Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
restartPolicystring + RestartPolicy defines the restart behavior of individual containers in a pod. +This field may only be set for init containers, and the only allowed value is "Always". +For non-init containers or when this field is not specified, +the restart behavior is defined by the Pod's restart policy and the container type. +Setting the RestartPolicy as "Always" for the init container will have the following effect: +this init container will be continually restarted on +exit until all regular containers have terminated. Once all regular +containers have completed, all init containers with restartPolicy "Always" +will be shut down. This lifecycle differs from normal init containers and +is often referred to as a "sidecar" container. Although this init +container still starts in the init container sequence, it does not wait +for the container to complete before proceeding to the next init +container. Instead, the next init container starts immediately after this +init container is started, or after any startupProbe has successfully +completed.
+ 		false
securityContextobject + 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
startupProbeobject + 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
stdinboolean + 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
stdinOnceboolean + 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
terminationMessagePathstring + 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
terminationMessagePolicystring + 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
ttyboolean + 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
workingDirstring + 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
+ + +### TargetAllocator.spec.additionalContainers[index].env[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom +[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom.configMapKeyRef +[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom.fieldRef +[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom.resourceFieldRef +[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].env[index].valueFrom.secretKeyRef +[↩ Parent](#targetallocatorspecadditionalcontainersindexenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].envFrom[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].envFrom[index].configMapRef +[↩ Parent](#targetallocatorspecadditionalcontainersindexenvfromindex) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].envFrom[index].secretRef +[↩ Parent](#targetallocatorspecadditionalcontainersindexenvfromindex) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
postStartobject + 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
preStopobject + 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
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.exec +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststart) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.httpGet +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststart) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststarthttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.sleep +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststart) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.postStart.tcpSocket +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecyclepoststart) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.exec +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestop) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.httpGet +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestop) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestophttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.sleep +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestop) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### TargetAllocator.spec.additionalContainers[index].lifecycle.preStop.tcpSocket +[↩ Parent](#targetallocatorspecadditionalcontainersindexlifecycleprestop) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].livenessProbe +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### TargetAllocator.spec.additionalContainers[index].livenessProbe.exec +[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.additionalContainers[index].livenessProbe.grpc +[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].livenessProbe.httpGet +[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].livenessProbe.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.additionalContainers[index].livenessProbe.tcpSocket +[↩ Parent](#targetallocatorspecadditionalcontainersindexlivenessprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].ports[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +ContainerPort represents a network port in a single container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
containerPortinteger + Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536.
+
+ Format: int32
+ 		true
hostIPstring + What host IP to bind the external port to.
+ 		false
hostPortinteger + 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
namestring + 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
protocolstring + Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP".
+
+ Default: TCP
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].readinessProbe +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### TargetAllocator.spec.additionalContainers[index].readinessProbe.exec +[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.additionalContainers[index].readinessProbe.grpc +[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].readinessProbe.httpGet +[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].readinessProbe.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.additionalContainers[index].readinessProbe.tcpSocket +[↩ Parent](#targetallocatorspecadditionalcontainersindexreadinessprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].resizePolicy[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +ContainerResizePolicy represents resource resize policy for the container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourceNamestring + Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory.
+ 		true
restartPolicystring + Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired.
+ 		true
+ + +### TargetAllocator.spec.additionalContainers[index].resources +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].resources.claims[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindexresources) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].securityContext +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +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/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### TargetAllocator.spec.additionalContainers[index].securityContext.appArmorProfile +[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].securityContext.capabilities +[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].securityContext.seLinuxOptions +[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].securityContext.seccompProfile +[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].securityContext.windowsOptions +[↩ Parent](#targetallocatorspecadditionalcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### TargetAllocator.spec.additionalContainers[index].startupProbe +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### TargetAllocator.spec.additionalContainers[index].startupProbe.exec +[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.additionalContainers[index].startupProbe.grpc +[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].startupProbe.httpGet +[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].startupProbe.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.additionalContainers[index].startupProbe.tcpSocket +[↩ Parent](#targetallocatorspecadditionalcontainersindexstartupprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.additionalContainers[index].volumeDevices[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +volumeDevice describes a mapping of a raw block device within a container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
devicePathstring + devicePath is the path inside of the container that the device will be mapped to.
+ 		true
namestring + name must match the name of a persistentVolumeClaim in the pod
+ 		true
+ + +### TargetAllocator.spec.additionalContainers[index].volumeMounts[index] +[↩ Parent](#targetallocatorspecadditionalcontainersindex) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### TargetAllocator.spec.affinity +[↩ Parent](#targetallocatorspec) + + + +If specified, indicates the pod's scheduling constraints + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeAffinityobject + Describes node affinity scheduling rules for the pod.
+ 		false
podAffinityobject + Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
podAntiAffinityobject + Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+ 		false
+ + +### TargetAllocator.spec.affinity.nodeAffinity +[↩ Parent](#targetallocatorspecaffinity) + + + +Describes node affinity scheduling rules for the pod. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
requiredDuringSchedulingIgnoredDuringExecutionobject + 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
+ + +### TargetAllocator.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#targetallocatorspecaffinitynodeaffinity) + + + +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). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
preferenceobject + A node selector term, associated with the corresponding weight.
+ 		true
weightinteger + Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### TargetAllocator.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference +[↩ Parent](#targetallocatorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +A node selector term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].preference.matchFields[index] +[↩ Parent](#targetallocatorspecaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionindexpreference) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution +[↩ Parent](#targetallocatorspecaffinitynodeaffinity) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
nodeSelectorTerms[]object + Required. A list of node selector terms. The terms are ORed.
+ 		true
+ + +### TargetAllocator.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index] +[↩ Parent](#targetallocatorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[index].matchFields[index] +[↩ Parent](#targetallocatorspecaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsindex) + + + +A node selector requirement is a selector that contains values, a key, and an operator +that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.podAffinity +[↩ Parent](#targetallocatorspecaffinity) + + + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#targetallocatorspecaffinitypodaffinity) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitypodaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#targetallocatorspecaffinitypodaffinity) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#targetallocatorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#targetallocatorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitypodaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity +[↩ Parent](#targetallocatorspecaffinity) + + + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#targetallocatorspecaffinitypodantiaffinity) + + + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
podAffinityTermobject + Required. A pod affinity term, associated with the corresponding weight.
+ 		true
weightinteger + weight associated with matching the corresponding podAffinityTerm, +in the range 1-100.
+
+ Format: int32
+ 		true
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm +[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindex) + + + +Required. A pod affinity term, associated with the corresponding weight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector +[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.labelSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector +[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinityterm) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[index].podAffinityTerm.namespaceSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionindexpodaffinitytermnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index] +[↩ Parent](#targetallocatorspecaffinitypodantiaffinity) + + + +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 matches that of any node on which +a pod of the set of pods is running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
topologyKeystring + 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
labelSelectorobject + A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods.
+ 		false
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both matchLabelKeys and labelSelector. +Also, matchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
mismatchLabelKeys[]string + MismatchLabelKeys is a set of pod label keys to select which pods will +be taken into consideration. The keys are used to lookup values from the +incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` +to select the group of existing pods which pods will be taken into consideration +for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming +pod labels will be ignored. The default value is empty. +The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. +Also, mismatchLabelKeys cannot be set when labelSelector isn't set. +This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).
+ 		false
namespaceSelectorobject + 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.
+ 		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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector +[↩ Parent](#targetallocatorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +A label query over a set of resources, in this case pods. +If it's null, this PodAffinityTerm matches with no Pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].labelSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector +[↩ Parent](#targetallocatorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[index].namespaceSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionindexnamespaceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.env[index] +[↩ Parent](#targetallocatorspec) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### TargetAllocator.spec.env[index].valueFrom +[↩ Parent](#targetallocatorspecenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### TargetAllocator.spec.env[index].valueFrom.configMapKeyRef +[↩ Parent](#targetallocatorspecenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### TargetAllocator.spec.env[index].valueFrom.fieldRef +[↩ Parent](#targetallocatorspecenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### TargetAllocator.spec.env[index].valueFrom.resourceFieldRef +[↩ Parent](#targetallocatorspecenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### TargetAllocator.spec.env[index].valueFrom.secretKeyRef +[↩ Parent](#targetallocatorspecenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### TargetAllocator.spec.envFrom[index] +[↩ Parent](#targetallocatorspec) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### TargetAllocator.spec.envFrom[index].configMapRef +[↩ Parent](#targetallocatorspecenvfromindex) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### TargetAllocator.spec.envFrom[index].secretRef +[↩ Parent](#targetallocatorspecenvfromindex) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### TargetAllocator.spec.initContainers[index] +[↩ Parent](#targetallocatorspec) + + + +A single application container that you want to run within a pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + 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 container 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 container 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
imagestring + Container 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
imagePullPolicystring + 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
lifecycleobject + Actions that the management system should take in response to container lifecycle events. +Cannot be updated.
+ 		false
livenessProbeobject + 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. 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. +Modifying this array with strategic merge patch may corrupt the data. +For more information See https://github.com/kubernetes/kubernetes/issues/108255. +Cannot be updated.
+ 		false
readinessProbeobject + 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
resizePolicy[]object + Resources resize policy for the container.
+ 		false
resourcesobject + Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
restartPolicystring + RestartPolicy defines the restart behavior of individual containers in a pod. +This field may only be set for init containers, and the only allowed value is "Always". +For non-init containers or when this field is not specified, +the restart behavior is defined by the Pod's restart policy and the container type. +Setting the RestartPolicy as "Always" for the init container will have the following effect: +this init container will be continually restarted on +exit until all regular containers have terminated. Once all regular +containers have completed, all init containers with restartPolicy "Always" +will be shut down. This lifecycle differs from normal init containers and +is often referred to as a "sidecar" container. Although this init +container still starts in the init container sequence, it does not wait +for the container to complete before proceeding to the next init +container. Instead, the next init container starts immediately after this +init container is started, or after any startupProbe has successfully +completed.
+ 		false
securityContextobject + 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
startupProbeobject + 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
stdinboolean + 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
stdinOnceboolean + 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
terminationMessagePathstring + 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
terminationMessagePolicystring + 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
ttyboolean + 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
workingDirstring + 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
+ + +### TargetAllocator.spec.initContainers[index].env[index] +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + 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
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].env[index].valueFrom +[↩ Parent](#targetallocatorspecinitcontainersindexenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + 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
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].env[index].valueFrom.configMapKeyRef +[↩ Parent](#targetallocatorspecinitcontainersindexenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].env[index].valueFrom.fieldRef +[↩ Parent](#targetallocatorspecinitcontainersindexenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].env[index].valueFrom.resourceFieldRef +[↩ Parent](#targetallocatorspecinitcontainersindexenvindexvaluefrom) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].env[index].valueFrom.secretKeyRef +[↩ Parent](#targetallocatorspecinitcontainersindexenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].envFrom[index] +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].envFrom[index].configMapRef +[↩ Parent](#targetallocatorspecinitcontainersindexenvfromindex) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].envFrom[index].secretRef +[↩ Parent](#targetallocatorspecinitcontainersindexenvfromindex) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].lifecycle +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +Actions that the management system should take in response to container lifecycle events. +Cannot be updated. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
postStartobject + 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
preStopobject + 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
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.postStart +[↩ Parent](#targetallocatorspecinitcontainersindexlifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.postStart.exec +[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststart) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.postStart.httpGet +[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststart) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.postStart.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststarthttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.postStart.sleep +[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststart) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.postStart.tcpSocket +[↩ Parent](#targetallocatorspecinitcontainersindexlifecyclepoststart) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.preStop +[↩ Parent](#targetallocatorspecinitcontainersindexlifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.preStop.exec +[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestop) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.preStop.httpGet +[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestop) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.preStop.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestophttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.preStop.sleep +[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestop) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### TargetAllocator.spec.initContainers[index].lifecycle.preStop.tcpSocket +[↩ Parent](#targetallocatorspecinitcontainersindexlifecycleprestop) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].livenessProbe +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### TargetAllocator.spec.initContainers[index].livenessProbe.exec +[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.initContainers[index].livenessProbe.grpc +[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].livenessProbe.httpGet +[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].livenessProbe.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.initContainers[index].livenessProbe.tcpSocket +[↩ Parent](#targetallocatorspecinitcontainersindexlivenessprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].ports[index] +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +ContainerPort represents a network port in a single container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
containerPortinteger + Number of port to expose on the pod's IP address. +This must be a valid port number, 0 < x < 65536.
+
+ Format: int32
+ 		true
hostIPstring + What host IP to bind the external port to.
+ 		false
hostPortinteger + 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
namestring + 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
protocolstring + Protocol for port. Must be UDP, TCP, or SCTP. +Defaults to "TCP".
+
+ Default: TCP
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].readinessProbe +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### TargetAllocator.spec.initContainers[index].readinessProbe.exec +[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.initContainers[index].readinessProbe.grpc +[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].readinessProbe.httpGet +[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].readinessProbe.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.initContainers[index].readinessProbe.tcpSocket +[↩ Parent](#targetallocatorspecinitcontainersindexreadinessprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].resizePolicy[index] +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +ContainerResizePolicy represents resource resize policy for the container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourceNamestring + Name of the resource to which this resource resize policy applies. +Supported values: cpu, memory.
+ 		true
restartPolicystring + Restart policy to apply when specified resource is resized. +If not specified, it defaults to NotRequired.
+ 		true
+ + +### TargetAllocator.spec.initContainers[index].resources +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +Compute Resources required by this container. +Cannot be updated. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].resources.claims[index] +[↩ Parent](#targetallocatorspecinitcontainersindexresources) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].securityContext +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +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/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### TargetAllocator.spec.initContainers[index].securityContext.appArmorProfile +[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].securityContext.capabilities +[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].securityContext.seLinuxOptions +[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].securityContext.seccompProfile +[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].securityContext.windowsOptions +[↩ Parent](#targetallocatorspecinitcontainersindexsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### TargetAllocator.spec.initContainers[index].startupProbe +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ 		false
grpcobject + GRPC specifies an action involving a GRPC port.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
initialDelaySecondsinteger + 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
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ 		false
successThresholdinteger + 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
tcpSocketobject + TCPSocket specifies an action involving a TCP port.
+ 		false
terminationGracePeriodSecondsinteger + 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
timeoutSecondsinteger + 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
+ + +### TargetAllocator.spec.initContainers[index].startupProbe.exec +[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobe) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.initContainers[index].startupProbe.grpc +[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobe) + + + +GRPC specifies an action involving a GRPC port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + Port number of the gRPC service. Number must be in the range 1 to 65535.
+
+ Format: int32
+ 		true
servicestring + 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.
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].startupProbe.httpGet +[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobe) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].startupProbe.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobehttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.initContainers[index].startupProbe.tcpSocket +[↩ Parent](#targetallocatorspecinitcontainersindexstartupprobe) + + + +TCPSocket specifies an action involving a TCP port. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.initContainers[index].volumeDevices[index] +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +volumeDevice describes a mapping of a raw block device within a container. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
devicePathstring + devicePath is the path inside of the container that the device will be mapped to.
+ 		true
namestring + name must match the name of a persistentVolumeClaim in the pod
+ 		true
+ + +### TargetAllocator.spec.initContainers[index].volumeMounts[index] +[↩ Parent](#targetallocatorspecinitcontainersindex) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### TargetAllocator.spec.lifecycle +[↩ Parent](#targetallocatorspec) + + + +Actions that the management system should take in response to container lifecycle events. Cannot be updated. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
postStartobject + 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
preStopobject + 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
+ + +### TargetAllocator.spec.lifecycle.postStart +[↩ Parent](#targetallocatorspeclifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### TargetAllocator.spec.lifecycle.postStart.exec +[↩ Parent](#targetallocatorspeclifecyclepoststart) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.lifecycle.postStart.httpGet +[↩ Parent](#targetallocatorspeclifecyclepoststart) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.lifecycle.postStart.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspeclifecyclepoststarthttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.lifecycle.postStart.sleep +[↩ Parent](#targetallocatorspeclifecyclepoststart) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### TargetAllocator.spec.lifecycle.postStart.tcpSocket +[↩ Parent](#targetallocatorspeclifecyclepoststart) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.lifecycle.preStop +[↩ Parent](#targetallocatorspeclifecycle) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
execobject + Exec specifies the action to take.
+ 		false
httpGetobject + HTTPGet specifies the http request to perform.
+ 		false
sleepobject + Sleep represents the duration that the container should sleep before being terminated.
+ 		false
tcpSocketobject + 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
+ + +### TargetAllocator.spec.lifecycle.preStop.exec +[↩ Parent](#targetallocatorspeclifecycleprestop) + + + +Exec specifies the action to take. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.lifecycle.preStop.httpGet +[↩ Parent](#targetallocatorspeclifecycleprestop) + + + +HTTPGet specifies the http request to perform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + 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
pathstring + Path to access on the HTTP server.
+ 		false
schemestring + Scheme to use for connecting to the host. +Defaults to HTTP.
+ 		false
+ + +### TargetAllocator.spec.lifecycle.preStop.httpGet.httpHeaders[index] +[↩ Parent](#targetallocatorspeclifecycleprestophttpget) + + + +HTTPHeader describes a custom header to be used in HTTP probes + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + The header field name. +This will be canonicalized upon output, so case-variant names will be understood as the same header.
+ 		true
valuestring + The header field value
+ 		true
+ + +### TargetAllocator.spec.lifecycle.preStop.sleep +[↩ Parent](#targetallocatorspeclifecycleprestop) + + + +Sleep represents the duration that the container should sleep before being terminated. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secondsinteger + Seconds is the number of seconds to sleep.
+
+ Format: int64
+ 		true
+ + +### TargetAllocator.spec.lifecycle.preStop.tcpSocket +[↩ Parent](#targetallocatorspeclifecycleprestop) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portint 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
hoststring + Optional: Host name to connect to, defaults to the pod IP.
+ 		false
+ + +### TargetAllocator.spec.observability +[↩ Parent](#targetallocatorspec) + + + +ObservabilitySpec defines how telemetry data gets handled. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
metricsobject + Metrics defines the metrics configuration for operands.
+ 		false
+ + +### TargetAllocator.spec.observability.metrics +[↩ Parent](#targetallocatorspecobservability) + + + +Metrics defines the metrics configuration for operands. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
disablePrometheusAnnotationsboolean + DisablePrometheusAnnotations controls the automatic addition of default Prometheus annotations +('prometheus.io/scrape', 'prometheus.io/port', and 'prometheus.io/path')
+ 		false
enableMetricsboolean + EnableMetrics specifies if ServiceMonitor or PodMonitor(for sidecar mode) should be created for the service managed by the OpenTelemetry Operator. +The operator.observability.prometheus feature gate must be enabled to use this feature.
+ 		false
+ + +### TargetAllocator.spec.podDisruptionBudget +[↩ Parent](#targetallocatorspec) + + + +PodDisruptionBudget specifies the pod disruption budget configuration to use +for the generated workload. By default, a PDB with a MaxUnavailable of one is set. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxUnavailableint or string + An eviction is allowed if at most "maxUnavailable" pods selected by +"selector" are unavailable after the eviction, i.e. even in absence of +the evicted pod. For example, one can prevent all voluntary evictions +by specifying 0. This is a mutually exclusive setting with "minAvailable".
+ 		false
minAvailableint or string + An eviction is allowed if at least "minAvailable" pods selected by +"selector" will still be available after the eviction, i.e. even in the +absence of the evicted pod. So for example you can prevent all voluntary +evictions by specifying "100%".
+ 		false
+ + +### TargetAllocator.spec.podDnsConfig +[↩ Parent](#targetallocatorspec) + + + +PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
+ + +### TargetAllocator.spec.podDnsConfig.options[index] +[↩ Parent](#targetallocatorspecpoddnsconfig) + + + +PodDNSConfigOption defines DNS resolver options of a pod. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Required.
+ 		false
valuestring +
+ 		false
+ + +### TargetAllocator.spec.podSecurityContext +[↩ Parent](#targetallocatorspec) + + + +PodSecurityContext configures the pod security context for the +generated pod, when running as a deployment, daemonset, +or statefulset. + +In sidecar mode, the opentelemetry-operator will ignore this setting. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
appArmorProfileobject + appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
fsGroupinteger + 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
fsGroupChangePolicystring + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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 and fsGroup (if specified). If +the SupplementalGroupsPolicy feature is enabled, the +supplementalGroupsPolicy field determines whether these are in addition +to or instead of any group memberships defined in the container image. +If unspecified, no additional groups are added, though group memberships +defined in the container image may still be used, depending on the +supplementalGroupsPolicy field. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
supplementalGroupsPolicystring + Defines how supplemental groups of the first container processes are calculated. +Valid values are "Merge" and "Strict". If not specified, "Merge" is used. +(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled +and the container runtime must implement support for this feature. +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
windowsOptionsobject + 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
+ + +### TargetAllocator.spec.podSecurityContext.appArmorProfile +[↩ Parent](#targetallocatorspecpodsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### TargetAllocator.spec.podSecurityContext.seLinuxOptions +[↩ Parent](#targetallocatorspecpodsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### TargetAllocator.spec.podSecurityContext.seccompProfile +[↩ Parent](#targetallocatorspecpodsecuritycontext) + + + +The seccomp options to use by the containers in this pod. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### TargetAllocator.spec.podSecurityContext.sysctls[index] +[↩ Parent](#targetallocatorspecpodsecuritycontext) + + + +Sysctl defines a kernel parameter to be set + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of a property to set
+ 		true
valuestring + Value of a property to set
+ 		true
+ + +### TargetAllocator.spec.podSecurityContext.windowsOptions +[↩ Parent](#targetallocatorspecpodsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### TargetAllocator.spec.ports[index] +[↩ Parent](#targetallocatorspec) + + + +PortsSpec defines the OpenTelemetryCollector's container/service ports additional specifications. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + The port that will be exposed by this service.
+
+ Format: int32
+ 		true
appProtocolstring + The application protocol for this port. +This is used as a hint for implementations to offer richer behavior for protocols that they understand. +This field follows standard Kubernetes label syntax. +Valid values are either: + +* Un-prefixed protocol names - reserved for IANA standard service names (as per +RFC-6335 and https://www.iana.org/assignments/service-names). + +* Kubernetes-defined prefixed names: + * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- + * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 + * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 + +* Other protocols should use implementation-defined prefixed names such as +mycompany.com/my-custom-protocol.
+ 		false
hostPortinteger + Allows defining which port to bind to the host in the Container.
+
+ Format: int32
+ 		false
namestring + The name of this port within the service. This must be a DNS_LABEL. +All ports within a ServiceSpec must have unique names. When considering +the endpoints for a Service, this must match the 'name' field in the +EndpointPort. +Optional if only one ServicePort is defined on this service.
+ 		false
nodePortinteger + The port on each node on which this service is exposed when type is +NodePort or LoadBalancer. Usually assigned by the system. If a value is +specified, in-range, and not in use it will be used, otherwise the +operation will fail. If not specified, a port will be allocated if this +Service requires one. If this field is specified when creating a +Service which does not need it, creation will fail. This field will be +wiped when updating a Service to no longer need it (e.g. changing type +from NodePort to ClusterIP). +More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
+
+ Format: int32
+ 		false
protocolstring + The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". +Default is TCP.
+
+ Default: TCP
+ 		false
targetPortint or string + Number or name of the port to access on the pods targeted by the service. +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. +If this is a string, it will be looked up as a named port in the +target Pod's container ports. If this is not specified, the value +of the 'port' field is used (an identity map). +This field is ignored for services with clusterIP=None, and should be +omitted or set equal to the 'port' field. +More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
+ 		false
+ + +### TargetAllocator.spec.prometheusCR +[↩ Parent](#targetallocatorspec) + + + +PrometheusCR defines the configuration for the retrieval of PrometheusOperator CRDs ( servicemonitor.monitoring.coreos.com/v1 and podmonitor.monitoring.coreos.com/v1 ). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Enabled indicates whether to use a PrometheusOperator custom resources as targets or not.
+ 		false
podMonitorSelectorobject + PodMonitors to be selected for target discovery. +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
probeSelectorobject + Probes to be selected for target discovery. +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
scrapeConfigSelectorobject + ScrapeConfigs to be selected for target discovery. +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
scrapeIntervalstring + Default interval between consecutive scrapes. Intervals set in ServiceMonitors and PodMonitors override it. +Equivalent to the same setting on the Prometheus CR. + +Default: "30s"
+
+ Format: duration
+ Default: 30s
+ 		false
serviceMonitorSelectorobject + ServiceMonitors to be selected for target discovery. +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
+ + +### TargetAllocator.spec.prometheusCR.podMonitorSelector +[↩ Parent](#targetallocatorspecprometheuscr) + + + +PodMonitors to be selected for target discovery. +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.prometheusCR.podMonitorSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecprometheuscrpodmonitorselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.prometheusCR.probeSelector +[↩ Parent](#targetallocatorspecprometheuscr) + + + +Probes to be selected for target discovery. +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.prometheusCR.probeSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecprometheuscrprobeselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.prometheusCR.scrapeConfigSelector +[↩ Parent](#targetallocatorspecprometheuscr) + + + +ScrapeConfigs to be selected for target discovery. +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.prometheusCR.scrapeConfigSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecprometheuscrscrapeconfigselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.prometheusCR.serviceMonitorSelector +[↩ Parent](#targetallocatorspecprometheuscr) + + + +ServiceMonitors to be selected for target discovery. +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.prometheusCR.serviceMonitorSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecprometheuscrservicemonitorselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.resources +[↩ Parent](#targetallocatorspec) + + + +Resources to set on generated pods. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claims[]object + Claims lists the names of resources, defined in spec.resourceClaims, +that are used by this container. + +This is an alpha field and requires enabling the +DynamicResourceAllocation feature gate. + +This field is immutable. It can only be set for containers.
+ 		false
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### TargetAllocator.spec.resources.claims[index] +[↩ Parent](#targetallocatorspecresources) + + + +ResourceClaim references one entry in PodSpec.ResourceClaims. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name must match the name of one entry in pod.spec.resourceClaims of +the Pod where this field is used. It makes that resource available +inside a container.
+ 		true
requeststring + Request is the name chosen for a request in the referenced claim. +If empty, everything from the claim is made available, otherwise +only the result of this request.
+ 		false
+ + +### TargetAllocator.spec.securityContext +[↩ Parent](#targetallocatorspec) + + + +SecurityContext configures the container security context for +the generated main container. + +In deployment, daemonset, or statefulset mode, this controls +the security context settings for the primary application +container. + +In sidecar mode, this controls the security context for the +injected sidecar container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + 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
appArmorProfileobject + appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows.
+ 		false
capabilitiesobject + 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
privilegedboolean + 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
procMountstring + procMount denotes the type of proc mount to use for the containers. +The default value is Default 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
readOnlyRootFilesystemboolean + 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
runAsGroupinteger + 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
runAsNonRootboolean + 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
runAsUserinteger + 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
seLinuxOptionsobject + 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
seccompProfileobject + 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
windowsOptionsobject + 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
+ + +### TargetAllocator.spec.securityContext.appArmorProfile +[↩ Parent](#targetallocatorspecsecuritycontext) + + + +appArmorProfile is the AppArmor options to use by this container. If set, this profile +overrides the pod's appArmorProfile. +Note that this field cannot be set when spec.os.name is windows. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of AppArmor profile will be applied. +Valid options are: + Localhost - a profile pre-loaded on the node. + RuntimeDefault - the container runtime's default profile. + Unconfined - no AppArmor enforcement.
+ 		true
localhostProfilestring + localhostProfile indicates a profile loaded on the node that should be used. +The profile must be preconfigured on the node to work. +Must match the loaded name of the profile. +Must be set if and only if type is "Localhost".
+ 		false
+ + +### TargetAllocator.spec.securityContext.capabilities +[↩ Parent](#targetallocatorspecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### TargetAllocator.spec.securityContext.seLinuxOptions +[↩ Parent](#targetallocatorspecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### TargetAllocator.spec.securityContext.seccompProfile +[↩ Parent](#targetallocatorspecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + 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
localhostProfilestring + 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 be set if type is "Localhost". Must NOT be set for any other type.
+ 		false
+ + +### TargetAllocator.spec.securityContext.windowsOptions +[↩ Parent](#targetallocatorspecsecuritycontext) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + 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
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. +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
runAsUserNamestring + 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
+ + +### TargetAllocator.spec.tolerations[index] +[↩ Parent](#targetallocatorspec) + + + +The pod this Toleration is attached to tolerates any taint that matches +the triple using the matching operator . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
effectstring + Effect indicates the taint effect to match. Empty means match all taint effects. +When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ 		false
keystring + 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
operatorstring + 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
tolerationSecondsinteger + 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
valuestring + 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
+ + +### TargetAllocator.spec.topologySpreadConstraints[index] +[↩ Parent](#targetallocatorspec) + + + +TopologySpreadConstraint specifies how to spread matching pods among the given topology. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
maxSkewinteger + 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. +The global minimum is the minimum number of matching pods in an eligible domain +or zero if the number of eligible domains is less than MinDomains. +For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same +labelSelector spread as 2/2/1: +In this case, the global minimum is 1. +| zone1 | zone2 | zone3 | +| P P | P P | P | +- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; +scheduling it onto zone1(zone2) would make the ActualSkew(3-1) 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
topologyKeystring + 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 as a "bucket", and try to put balanced number +of pods into each bucket. +We define a domain as a particular instance of a topology. +Also, we define an eligible domain as a domain whose nodes meet the requirements of +nodeAffinityPolicy and nodeTaintsPolicy. +e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. +And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. +It's a required field.
+ 		true
whenUnsatisfiablestring + 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
labelSelectorobject + 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
matchLabelKeys[]string + MatchLabelKeys is a set of pod label keys to select the pods over which +spreading will be calculated. The keys are used to lookup values from the +incoming pod labels, those key-value labels are ANDed with labelSelector +to select the group of existing pods over which spreading will be calculated +for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. +MatchLabelKeys cannot be set when LabelSelector isn't set. +Keys that don't exist in the incoming pod labels will +be ignored. A null or empty list means only match against labelSelector. + +This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
+ 		false
minDomainsinteger + MinDomains indicates a minimum number of eligible domains. +When the number of eligible domains with matching topology keys is less than minDomains, +Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. +And when the number of eligible domains with matching topology keys equals or greater than minDomains, +this value has no effect on scheduling. +As a result, when the number of eligible domains is less than minDomains, +scheduler won't schedule more than maxSkew Pods to those domains. +If value is nil, the constraint behaves as if MinDomains is equal to 1. +Valid values are integers greater than 0. +When value is not nil, WhenUnsatisfiable must be DoNotSchedule. + +For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same +labelSelector spread as 2/2/2: +| zone1 | zone2 | zone3 | +| P P | P P | P P | +The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. +In this situation, new pod with the same labelSelector cannot be scheduled, +because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, +it will violate MaxSkew.
+
+ Format: int32
+ 		false
nodeAffinityPolicystring + NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector +when calculating pod topology spread skew. Options are: +- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. +- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. + +If this value is nil, the behavior is equivalent to the Honor policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
nodeTaintsPolicystring + NodeTaintsPolicy indicates how we will treat node taints when calculating +pod topology spread skew. Options are: +- Honor: nodes without taints, along with tainted nodes for which the incoming pod +has a toleration, are included. +- Ignore: node taints are ignored. All nodes are included. + +If this value is nil, the behavior is equivalent to the Ignore policy. +This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ 		false
+ + +### TargetAllocator.spec.topologySpreadConstraints[index].labelSelector +[↩ Parent](#targetallocatorspectopologyspreadconstraintsindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.topologySpreadConstraints[index].labelSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspectopologyspreadconstraintsindexlabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.volumeMounts[index] +[↩ Parent](#targetallocatorspec) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + 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. +When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified +(which defaults to None).
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
recursiveReadOnlystring + RecursiveReadOnly specifies whether read-only mounts should be handled +recursively. + +If ReadOnly is false, this field has no meaning and must be unspecified. + +If ReadOnly is true, and this field is set to Disabled, the mount is not made +recursively read-only. If this field is set to IfPossible, the mount is made +recursively read-only, if it is supported by the container runtime. If this +field is set to Enabled, the mount is made recursively read-only if it is +supported by the container runtime, otherwise the pod will not be started and +an error will be generated to indicate the reason. + +If this field is set to IfPossible or Enabled, MountPropagation must be set to +None (or be unspecified, which defaults to None). + +If this field is not specified, it is treated as an equivalent of Disabled.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + 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
+ + +### TargetAllocator.spec.volumes[index] +[↩ Parent](#targetallocatorspec) + + + +Volume represents a named volume in a pod that may be accessed by any container in the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + name of the volume. +Must be a DNS_LABEL and unique within the pod. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ 		true
awsElasticBlockStoreobject + 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
azureDiskobject + azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ 		false
azureFileobject + azureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ 		false
cephfsobject + cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ 		false
cinderobject + cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		false
configMapobject + configMap represents a configMap that should populate this volume
+ 		false
csiobject + csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ 		false
downwardAPIobject + downwardAPI represents downward API about the pod that should populate this volume
+ 		false
emptyDirobject + emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
ephemeralobject + 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
fcobject + fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ 		false
flexVolumeobject + flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin.
+ 		false
flockerobject + flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ 		false
gcePersistentDiskobject + 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
gitRepoobject + 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
glusterfsobject + 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
hostPathobject + 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
+ 		false
imageobject + image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. +The volume is resolved at pod startup depending on which PullPolicy value is provided: + +- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. + +The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. +A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.
+ 		false
iscsiobject + 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
nfsobject + 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
persistentVolumeClaimobject + persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
photonPersistentDiskobject + photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ 		false
portworxVolumeobject + portworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ 		false
projectedobject + projected items for all in one resources secrets, configmaps, and downward API
+ 		false
quobyteobject + quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ 		false
rbdobject + 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
scaleIOobject + scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ 		false
secretobject + secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
storageosobject + storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ 		false
vsphereVolumeobject + vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ 		false
+ + +### TargetAllocator.spec.volumes[index].awsElasticBlockStore +[↩ Parent](#targetallocatorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		true
fsTypestring + fsType is the 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
+ 		false
partitioninteger + partition is 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
readOnlyboolean + readOnly value true will force the readOnly setting in VolumeMounts. +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		false
+ + +### TargetAllocator.spec.volumes[index].azureDisk +[↩ Parent](#targetallocatorspecvolumesindex) + + + +azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
diskNamestring + diskName is the Name of the data disk in the blob storage
+ 		true
diskURIstring + diskURI is the URI of data disk in the blob storage
+ 		true
cachingModestring + cachingMode is the Host Caching mode: None, Read Only, Read Write.
+ 		false
fsTypestring + fsType is 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.
+
+ Default: ext4
+ 		false
kindstring + kind expected values are 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
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+
+ Default: false
+ 		false
+ + +### TargetAllocator.spec.volumes[index].azureFile +[↩ Parent](#targetallocatorspecvolumesindex) + + + +azureFile represents an Azure File Service mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secretNamestring + secretName is the name of secret that contains Azure Storage Account Name and Key
+ 		true
shareNamestring + shareName is the azure share Name
+ 		true
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].cephfs +[↩ Parent](#targetallocatorspecvolumesindex) + + + +cephFS represents a Ceph FS mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
monitors[]string + monitors is Required: Monitors is a collection of Ceph monitors +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		true
pathstring + path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
+ 		false
readOnlyboolean + readOnly is 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
secretFilestring + secretFile is 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
secretRefobject + secretRef is 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
userstring + user is 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
+ + +### TargetAllocator.spec.volumes[index].cephfs.secretRef +[↩ Parent](#targetallocatorspecvolumesindexcephfs) + + + +secretRef is 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 + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.volumes[index].cinder +[↩ Parent](#targetallocatorspecvolumesindex) + + + +cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID used to identify the volume in cinder. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		true
fsTypestring + fsType is the 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
readOnlyboolean + readOnly 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
secretRefobject + secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].cinder.secretRef +[↩ Parent](#targetallocatorspecvolumesindexcinder) + + + +secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.volumes[index].configMap +[↩ Parent](#targetallocatorspecvolumesindex) + + + +configMap represents a configMap that should populate this volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is 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 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### TargetAllocator.spec.volumes[index].configMap.items[index] +[↩ Parent](#targetallocatorspecvolumesindexconfigmap) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### TargetAllocator.spec.volumes[index].csi +[↩ Parent](#targetallocatorspecvolumesindex) + + + +csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + 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
fsTypestring + fsType 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
nodePublishSecretRefobject + 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
readOnlyboolean + readOnly specifies a read-only configuration for the volume. +Defaults to false (read/write).
+ 		false
volumeAttributesmap[string]string + volumeAttributes stores driver-specific properties that are passed to the CSI +driver. Consult your driver's documentation for supported values.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].csi.nodePublishSecretRef +[↩ Parent](#targetallocatorspecvolumesindexcsi) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.volumes[index].downwardAPI +[↩ Parent](#targetallocatorspecvolumesindex) + + + +downwardAPI represents downward API about the pod that should populate this volume + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + 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
+ + +### TargetAllocator.spec.volumes[index].downwardAPI.items[index] +[↩ Parent](#targetallocatorspecvolumesindexdownwardapi) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
+ 		false
modeinteger + 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
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].downwardAPI.items[index].fieldRef +[↩ Parent](#targetallocatorspecvolumesindexdownwardapiitemsindex) + + + +Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### TargetAllocator.spec.volumes[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#targetallocatorspecvolumesindexdownwardapiitemsindex) + + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### TargetAllocator.spec.volumes[index].emptyDir +[↩ Parent](#targetallocatorspecvolumesindex) + + + +emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mediumstring + medium represents 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
sizeLimitint or string + sizeLimit is the 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: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
+ + +### TargetAllocator.spec.volumes[index].ephemeral +[↩ Parent](#targetallocatorspecvolumesindex) + + + +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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeClaimTemplateobject + 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 `-` where +`` 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
+ + +### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate +[↩ Parent](#targetallocatorspecvolumesindexephemeral) + + + +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 `-` where +`` 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. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + 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
metadataobject + 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
+ + +### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec +[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
dataSourceobject + dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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.
+ 		false
resourcesobject + 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
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ +(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource +[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +dataSource 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. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
+ + +### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any 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, when namespace isn't specified in dataSourceRef, +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. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + 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
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources +[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[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
requestsmap[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. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector +[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata +[↩ Parent](#targetallocatorspecvolumesindexephemeralvolumeclaimtemplate) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### TargetAllocator.spec.volumes[index].fc +[↩ Parent](#targetallocatorspecvolumesindex) + + + +fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the 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
luninteger + lun is Optional: FC target lun number
+
+ Format: int32
+ 		false
readOnlyboolean + readOnly is Optional: Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
targetWWNs[]string + targetWWNs is Optional: FC target worldwide names (WWNs)
+ 		false
wwids[]string + wwids Optional: FC volume world wide identifiers (wwids) +Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].flexVolume +[↩ Parent](#targetallocatorspecvolumesindex) + + + +flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + driver is the name of the driver to use for this volume.
+ 		true
fsTypestring + fsType is the 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
optionsmap[string]string + options is Optional: this field holds extra command options if any.
+ 		false
readOnlyboolean + readOnly is Optional: defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef is 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
+ + +### TargetAllocator.spec.volumes[index].flexVolume.secretRef +[↩ Parent](#targetallocatorspecvolumesindexflexvolume) + + + +secretRef is 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. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.volumes[index].flocker +[↩ Parent](#targetallocatorspecvolumesindex) + + + +flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
datasetNamestring + datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker +should be considered as deprecated
+ 		false
datasetUUIDstring + datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
+ 		false
+ + +### TargetAllocator.spec.volumes[index].gcePersistentDisk +[↩ Parent](#targetallocatorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdNamestring + pdName is 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
fsTypestring + fsType is 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
+ 		false
partitioninteger + partition is 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
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		false
+ + +### TargetAllocator.spec.volumes[index].gitRepo +[↩ Parent](#targetallocatorspecvolumesindex) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
repositorystring + repository is the URL
+ 		true
directorystring + directory is the 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
revisionstring + revision is the commit hash for the specified revision.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].glusterfs +[↩ Parent](#targetallocatorspecvolumesindex) + + + +glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/glusterfs/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
endpointsstring + endpoints is the endpoint name that details Glusterfs topology. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
pathstring + path is the Glusterfs volume path. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
readOnlyboolean + 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
+ + +### TargetAllocator.spec.volumes[index].hostPath +[↩ Parent](#targetallocatorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
typestring + type for HostPath Volume +Defaults to "" +More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ 		false
+ + +### TargetAllocator.spec.volumes[index].image +[↩ Parent](#targetallocatorspecvolumesindex) + + + +image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine. +The volume is resolved at pod startup depending on which PullPolicy value is provided: + +- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. + +The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. +A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pullPolicystring + Policy for pulling OCI objects. Possible values are: +Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. +Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present. +IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails. +Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
+ 		false
referencestring + Required: Image or artifact reference to be used. +Behaves in the same way as pod.spec.containers[*].image. +Pull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets. +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
+ + +### TargetAllocator.spec.volumes[index].iscsi +[↩ Parent](#targetallocatorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
iqnstring + iqn is the target iSCSI Qualified Name.
+ 		true
luninteger + lun represents iSCSI Target Lun number.
+
+ Format: int32
+ 		true
targetPortalstring + targetPortal is 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
chapAuthDiscoveryboolean + chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
+ 		false
chapAuthSessionboolean + chapAuthSession defines whether support iSCSI Session CHAP authentication
+ 		false
fsTypestring + fsType is the 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
+ 		false
initiatorNamestring + initiatorName is the custom iSCSI Initiator Name. +If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface +: will be created for the connection.
+ 		false
iscsiInterfacestring + iscsiInterface is the interface Name that uses an iSCSI transport. +Defaults to 'default' (tcp).
+
+ Default: default
+ 		false
portals[]string + portals is the 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
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false.
+ 		false
secretRefobject + secretRef is the CHAP Secret for iSCSI target and initiator authentication
+ 		false
+ + +### TargetAllocator.spec.volumes[index].iscsi.secretRef +[↩ Parent](#targetallocatorspecvolumesindexiscsi) + + + +secretRef is the CHAP Secret for iSCSI target and initiator authentication + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.volumes[index].nfs +[↩ Parent](#targetallocatorspecvolumesindex) + + + +nfs represents an NFS mount on the host that shares a pod's lifetime +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path that is exported by the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
serverstring + server is the hostname or IP address of the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
readOnlyboolean + 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
+ + +### TargetAllocator.spec.volumes[index].persistentVolumeClaim +[↩ Parent](#targetallocatorspecvolumesindex) + + + +persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claimNamestring + 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
readOnlyboolean + readOnly Will force the ReadOnly setting in VolumeMounts. +Default false.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].photonPersistentDisk +[↩ Parent](#targetallocatorspecvolumesindex) + + + +photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdIDstring + pdID is the ID that identifies Photon Controller persistent disk
+ 		true
fsTypestring + fsType is the 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
+ + +### TargetAllocator.spec.volumes[index].portworxVolume +[↩ Parent](#targetallocatorspecvolumesindex) + + + +portworxVolume represents a portworx volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID uniquely identifies a Portworx volume
+ 		true
fsTypestring + 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
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected +[↩ Parent](#targetallocatorspecvolumesindex) + + + +projected items for all in one resources secrets, configmaps, and downward API + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode are the 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 + sources is the list of volume projections. Each entry in this list +handles one source.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index] +[↩ Parent](#targetallocatorspecvolumesindexprojected) + + + +Projection that may be projected along with other supported volume types. +Exactly one of these fields must be set. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
clusterTrustBundleobject + ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time.
+ 		false
configMapobject + configMap information about the configMap data to project
+ 		false
downwardAPIobject + downwardAPI information about the downwardAPI data to project
+ 		false
secretobject + secret information about the secret data to project
+ 		false
serviceAccountTokenobject + serviceAccountToken is information about the serviceAccountToken data to project
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].clusterTrustBundle +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) + + + +ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Relative path from the volume root to write the bundle.
+ 		true
labelSelectorobject + Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything".
+ 		false
namestring + Select a single ClusterTrustBundle by object name. Mutually-exclusive +with signerName and labelSelector.
+ 		false
optionalboolean + If true, don't block pod startup if the referenced ClusterTrustBundle(s) +aren't available. If using name, then the named ClusterTrustBundle is +allowed not to exist. If using signerName, then the combination of +signerName and labelSelector is allowed to match zero +ClusterTrustBundles.
+ 		false
signerNamestring + Select all ClusterTrustBundles that match this signer name. +Mutually-exclusive with name. The contents of all selected +ClusterTrustBundles will be unified and deduplicated.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexclustertrustbundle) + + + +Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything". + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[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
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index] +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexclustertrustbundlelabelselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + 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
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].configMap +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) + + + +configMap information about the configMap data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].configMap.items[index] +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexconfigmap) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].downwardAPI +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) + + + +downwardAPI information about the downwardAPI data to project + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + Items is a list of DownwardAPIVolume file
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].downwardAPI.items[index] +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexdownwardapi) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + 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
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
+ 		false
modeinteger + 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
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + + +Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].secret +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) + + + +secret information about the secret data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items 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
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
optionalboolean + optional field specify whether the Secret or its key must be defined
+ 		false
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].secret.items[index] +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindexsecret) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### TargetAllocator.spec.volumes[index].projected.sources[index].serviceAccountToken +[↩ Parent](#targetallocatorspecvolumesindexprojectedsourcesindex) + + + +serviceAccountToken is information about the serviceAccountToken data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path is the path relative to the mount point of the file to project the +token into.
+ 		true
audiencestring + 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
expirationSecondsinteger + 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
+ + +### TargetAllocator.spec.volumes[index].quobyte +[↩ Parent](#targetallocatorspecvolumesindex) + + + +quobyte represents a Quobyte mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
registrystring + 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
volumestring + volume is a string that references an already created Quobyte volume by name.
+ 		true
groupstring + group to map volume access to +Default is no group
+ 		false
readOnlyboolean + readOnly here will force the Quobyte volume to be mounted with read-only permissions. +Defaults to false.
+ 		false
tenantstring + tenant owning the given Quobyte volume in the Backend +Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ 		false
userstring + user to map volume access to +Defaults to serivceaccount user
+ 		false
+ + +### TargetAllocator.spec.volumes[index].rbd +[↩ Parent](#targetallocatorspecvolumesindex) + + + +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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + image is the rados image name. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
monitors[]string + monitors is a collection of Ceph monitors. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
fsTypestring + fsType is the 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
+ 		false
keyringstring + 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
+
+ Default: /etc/ceph/keyring
+ 		false
poolstring + pool is the rados pool name. +Default is rbd. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+
+ Default: rbd
+ 		false
readOnlyboolean + 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
secretRefobject + 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
userstring + user is the rados user name. +Default is admin. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+
+ Default: admin
+ 		false
+ + +### TargetAllocator.spec.volumes[index].rbd.secretRef +[↩ Parent](#targetallocatorspecvolumesindexrbd) + + + +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 + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.volumes[index].scaleIO +[↩ Parent](#targetallocatorspecvolumesindex) + + + +scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gatewaystring + gateway is the host address of the ScaleIO API Gateway.
+ 		true
secretRefobject + secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail.
+ 		true
systemstring + system is the name of the storage system as configured in ScaleIO.
+ 		true
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". +Default is "xfs".
+
+ Default: xfs
+ 		false
protectionDomainstring + protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
+ 		false
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
sslEnabledboolean + sslEnabled Flag enable/disable SSL communication with Gateway, default false
+ 		false
storageModestring + storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. +Default is ThinProvisioned.
+
+ Default: ThinProvisioned
+ 		false
storagePoolstring + storagePool is the ScaleIO Storage Pool associated with the protection domain.
+ 		false
volumeNamestring + volumeName is the name of a volume already created in the ScaleIO system +that is associated with this volume source.
+ 		false
+ + +### TargetAllocator.spec.volumes[index].scaleIO.secretRef +[↩ Parent](#targetallocatorspecvolumesindexscaleio) + + + +secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.volumes[index].secret +[↩ Parent](#targetallocatorspecvolumesindex) + + + +secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is 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 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
optionalboolean + optional field specify whether the Secret or its keys must be defined
+ 		false
secretNamestring + secretName is the name of the secret in the pod's namespace to use. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
+ + +### TargetAllocator.spec.volumes[index].secret.items[index] +[↩ Parent](#targetallocatorspecvolumesindexsecret) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is 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
modeinteger + mode is 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
+ + +### TargetAllocator.spec.volumes[index].storageos +[↩ Parent](#targetallocatorspecvolumesindex) + + + +storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the 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
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted.
+ 		false
volumeNamestring + volumeName is the human-readable name of the StorageOS volume. Volume +names are only unique within a namespace.
+ 		false
volumeNamespacestring + 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
+ + +### TargetAllocator.spec.volumes[index].storageos.secretRef +[↩ Parent](#targetallocatorspecvolumesindexstorageos) + + + +secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +This field is effectively required, but due to backwards compatibility is +allowed to be empty. Instances of this type with an empty value here are +almost certainly wrong. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+
+ Default:
+ 		false
+ + +### TargetAllocator.spec.volumes[index].vsphereVolume +[↩ Parent](#targetallocatorspecvolumesindex) + + + +vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumePathstring + volumePath is the path that identifies vSphere volume vmdk
+ 		true
fsTypestring + fsType is 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
storagePolicyIDstring + storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ 		false
storagePolicyNamestring + storagePolicyName is the storage Policy Based Management (SPBM) profile name.
+ 		false
+ + +### TargetAllocator.status +[↩ Parent](#targetallocator) + + + +TargetAllocatorStatus defines the observed state of Target Allocator. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + Image indicates the container image to use for the Target Allocator.
+ 		false
versionstring + Version of the managed Target Allocator (operand)
+ 		false
\ No newline at end of file