Skip to content

Latest commit

 

History

History
5098 lines (4449 loc) · 180 KB

api.md

File metadata and controls

5098 lines (4449 loc) · 180 KB

API Reference

Packages:

opentelemetry.io/v1alpha1

Resource Types:

Instrumentation

↩ Parent

Instrumentation is the spec for OpenTelemetry instrumentation.

Name Type Description Required
apiVersion string opentelemetry.io/v1alpha1 true
kind string Instrumentation true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object InstrumentationSpec defines the desired state of OpenTelemetry SDK and instrumentation.
false
status object InstrumentationStatus defines status of the instrumentation.
false

Instrumentation.spec

↩ Parent

InstrumentationSpec defines the desired state of OpenTelemetry SDK and instrumentation.

Name Type Description Required
exporter object Exporter defines exporter configuration.
false
java object Java defines configuration for java auto-instrumentation.
false
nodejs object NodeJS defines configuration for nodejs auto-instrumentation.
false
propagators []enum Propagators defines inter-process context propagation configuration.
false
python object Python defines configuration for python auto-instrumentation.
false
resource object Resource defines the configuration for the resource attributes, as defined by the OpenTelemetry specification.
false
sampler object Sampler defines sampling configuration.
false

Instrumentation.spec.exporter

↩ Parent

Exporter defines exporter configuration.

Name Type Description Required
endpoint string Endpoint is address of the collector with OTLP endpoint.
false

Instrumentation.spec.java

↩ Parent

Java defines configuration for java auto-instrumentation.

Name Type Description Required
image string Image is a container image with javaagent auto-instrumentation JAR.
false

Instrumentation.spec.nodejs

↩ Parent

NodeJS defines configuration for nodejs auto-instrumentation.

Name Type Description Required
image string Image is a container image with NodeJS SDK and auto-instrumentation.
false

Instrumentation.spec.python

↩ Parent

Python defines configuration for python auto-instrumentation.

Name Type Description Required
image string Image is a container image with Python SDK and auto-instrumentation.
false

Instrumentation.spec.resource

↩ Parent

Resource defines the configuration for the resource attributes, as defined by the OpenTelemetry specification.

Name Type Description Required
addK8sUIDAttributes boolean AddK8sUIDAttributes defines whether K8s UID attributes should be collected (e.g. k8s.deployment.uid).
false
resourceAttributes map[string]string Attributes defines attributes that are added to the resource. For example environment: dev
false

Instrumentation.spec.sampler

↩ Parent

Sampler defines sampling configuration.

Name Type Description Required
argument string 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.
false
type enum Type defines sampler type. 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

OpenTelemetryCollector

↩ Parent

OpenTelemetryCollector is the Schema for the opentelemetrycollectors API.

Name Type Description Required
apiVersion string opentelemetry.io/v1alpha1 true
kind string OpenTelemetryCollector true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.
false
status object OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector.
false

OpenTelemetryCollector.spec

↩ Parent

OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.

Name Type Description Required
args map[string]string Args is the set of arguments to pass to the OpenTelemetry Collector binary
false
config string Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.
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
hostNetwork boolean HostNetwork indicates if the pod should run in the host networking namespace.
false
image string Image indicates the container image to use for the OpenTelemetry Collector.
false
imagePullPolicy string ImagePullPolicy indicates the pull policy to be used for retrieving the container image (Always, Never, IfNotPresent)
false
mode enum Mode represents how the collector should be deployed (deployment, daemonset, statefulset or sidecar)

Enum: daemonset, deployment, sidecar, statefulset
false
podAnnotations map[string]string PodAnnotations is the set of annotations that will be attached to Collector and Target Allocator pods.
false
podSecurityContext object PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
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 aditional ports that can't be inferred by the operator, like for custom receivers.
false
replicas integer Replicas is the number of pod instances for the underlying OpenTelemetry Collector

Format: int32
false
resources object Resources to set on the OpenTelemetry Collector pods.
false
securityContext object SecurityContext will be set as the container security context.
false
serviceAccount string ServiceAccount indicates the name of an existing service account to use with this instance.
false
targetAllocator object TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not.
false
tolerations []object Toleration to schedule OpenTelemetry Collector pods. This is only relevant to daemonsets, statefulsets and deployments
false
upgradeStrategy enum 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.env[index]

↩ Parent

EnvVar represents an environment variable present in a Container.

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

OpenTelemetryCollector.spec.env[index].valueFrom

↩ Parent

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

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

OpenTelemetryCollector.spec.env[index].valueFrom.configMapKeyRef

↩ Parent

Selects a key of a ConfigMap.

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

OpenTelemetryCollector.spec.env[index].valueFrom.fieldRef

↩ Parent

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

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

OpenTelemetryCollector.spec.env[index].valueFrom.resourceFieldRef

↩ Parent

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

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

OpenTelemetryCollector.spec.env[index].valueFrom.secretKeyRef

↩ Parent

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

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

OpenTelemetryCollector.spec.envFrom[index]

↩ Parent

EnvFromSource represents the source of a set of ConfigMaps

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

OpenTelemetryCollector.spec.envFrom[index].configMapRef

↩ Parent

The ConfigMap to select from

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

OpenTelemetryCollector.spec.envFrom[index].secretRef

↩ Parent

The Secret to select from

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

OpenTelemetryCollector.spec.podSecurityContext

↩ Parent

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

Name Type Description Required
fsGroup integer A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.

Format: int64
false
fsGroupChangePolicy string fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
false
runAsGroup integer The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

Format: int64
false
runAsNonRoot boolean Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
false
runAsUser integer The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

Format: int64
false
seLinuxOptions object The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
false
seccompProfile object The seccomp options to use by the containers in this pod.
false
supplementalGroups []integer A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
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.
false
windowsOptions object The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
false

OpenTelemetryCollector.spec.podSecurityContext.seLinuxOptions

↩ Parent

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

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

OpenTelemetryCollector.spec.podSecurityContext.seccompProfile

↩ Parent

The seccomp options to use by the containers in this pod.

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

OpenTelemetryCollector.spec.podSecurityContext.sysctls[index]

↩ Parent

Sysctl defines a kernel parameter to be set

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

OpenTelemetryCollector.spec.podSecurityContext.windowsOptions

↩ Parent

The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

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

OpenTelemetryCollector.spec.ports[index]

↩ Parent

ServicePort contains information on service's port.

Name Type Description Required
port integer The port that will be exposed by this service.

Format: int32
true
appProtocol string The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
false
name string 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
nodePort integer 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
protocol string The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.

Default: TCP
false
targetPort int 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

Resources to set on the OpenTelemetry Collector pods.

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

OpenTelemetryCollector.spec.securityContext

↩ Parent

SecurityContext will be set as the container security context.

Name Type Description Required
allowPrivilegeEscalation boolean AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN
false
capabilities object The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
false
privileged boolean Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
false
procMount string procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.
false
readOnlyRootFilesystem boolean Whether this container has a read-only root filesystem. Default is false.
false
runAsGroup integer The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

Format: int64
false
runAsNonRoot boolean Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
false
runAsUser integer The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

Format: int64
false
seLinuxOptions object The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
false
seccompProfile object The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
false
windowsOptions object The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
false

OpenTelemetryCollector.spec.securityContext.capabilities

↩ Parent

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

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

OpenTelemetryCollector.spec.securityContext.seLinuxOptions

↩ Parent

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

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

OpenTelemetryCollector.spec.securityContext.seccompProfile

↩ Parent

The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.

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

OpenTelemetryCollector.spec.securityContext.windowsOptions

↩ Parent

The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

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

OpenTelemetryCollector.spec.targetAllocator

↩ Parent

TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not.

Name Type Description Required
enabled boolean Enabled indicates whether to use a target allocation mechanism for Prometheus targets or not.
false
image string Image indicates the container image to use for the OpenTelemetry TargetAllocator.
false

OpenTelemetryCollector.spec.tolerations[index]

↩ Parent

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

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

Format: int64
false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
false

OpenTelemetryCollector.spec.volumeClaimTemplates[index]

↩ Parent

PersistentVolumeClaim is a user's request for and claim to a persistent volume

Name Type Description Required
apiVersion string 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
kind string 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
metadata object Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
false
spec object 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
status object 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

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Name Type Description Required
annotations map[string]string
false
finalizers []string
false
labels map[string]string
false
name string
false
namespace string
false

OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec

↩ Parent

Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

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

OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSource

↩ Parent

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

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

OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSourceRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.resources

↩ Parent

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

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

OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector

↩ Parent

A label query over volumes to consider for binding.

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

OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector.matchExpressions[index]

↩ Parent

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

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

OpenTelemetryCollector.spec.volumeClaimTemplates[index].status

↩ Parent

Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

Name Type Description Required
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
capacity map[string]int or string Represents the actual resources of the underlying volume.
false
conditions []object Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
false
phase string Phase represents the current phase of PersistentVolumeClaim.
false

OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.conditions[index]

↩ Parent

PersistentVolumeClaimCondition contails details about state of pvc

Name Type Description Required
status string
true
type string PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
true
lastProbeTime string Last time we probed the condition.

Format: date-time
false
lastTransitionTime string Last time the condition transitioned from one status to another.

Format: date-time
false
message string Human-readable message indicating details about last transition.
false
reason string Unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized.
false

OpenTelemetryCollector.spec.volumeMounts[index]

↩ Parent

VolumeMount describes a mounting of a Volume within a container.

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

OpenTelemetryCollector.spec.volumes[index]

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].awsElasticBlockStore

↩ Parent

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

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

Format: int32
false
readOnly boolean Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
false

OpenTelemetryCollector.spec.volumes[index].azureDisk

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].azureFile

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].cephfs

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].cephfs.secretRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].cinder

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].cinder.secretRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].configMap

↩ Parent

ConfigMap represents a configMap that should populate this volume

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

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

OpenTelemetryCollector.spec.volumes[index].configMap.items[index]

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

OpenTelemetryCollector.spec.volumes[index].csi

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].csi.nodePublishSecretRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].downwardAPI

↩ Parent

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

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

Format: int32
false
items []object Items is a list of downward API volume file
false

OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index]

↩ Parent

DownwardAPIVolumeFile represents information to create the file containing the pod field

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

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

OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].fieldRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].resourceFieldRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].emptyDir

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].ephemeral

↩ Parent

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

Name Type Description Required
volumeClaimTemplate object Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` 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

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

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

OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources

↩ Parent

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

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

OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector

↩ Parent

A label query over volumes to consider for binding.

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

OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata

↩ Parent

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.

Name Type Description Required
annotations map[string]string
false
finalizers []string
false
labels map[string]string
false
name string
false
namespace string
false

OpenTelemetryCollector.spec.volumes[index].fc

↩ Parent

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

Name Type Description Required
fsType string Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine
false
lun integer Optional: FC target lun number

Format: int32
false
readOnly boolean Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
false
targetWWNs []string Optional: FC target worldwide names (WWNs)
false
wwids []string Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
false

OpenTelemetryCollector.spec.volumes[index].flexVolume

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].flexVolume.secretRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].flocker

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].gcePersistentDisk

↩ Parent

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

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

Format: int32
false
readOnly boolean ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
false

OpenTelemetryCollector.spec.volumes[index].gitRepo

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].glusterfs

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].hostPath

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].iscsi

↩ Parent

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

Name Type Description Required
iqn string Target iSCSI Qualified Name.
true
lun integer iSCSI Target Lun number.

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

OpenTelemetryCollector.spec.volumes[index].iscsi.secretRef

↩ Parent

CHAP Secret for iSCSI target and initiator authentication

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

OpenTelemetryCollector.spec.volumes[index].nfs

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].persistentVolumeClaim

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].photonPersistentDisk

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].portworxVolume

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].projected

↩ Parent

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

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

Format: int32
false
sources []object list of volume projections
false

OpenTelemetryCollector.spec.volumes[index].projected.sources[index]

↩ Parent

Projection that may be projected along with other supported volume types

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

OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap

↩ Parent

information about the configMap data to project

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

OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap.items[index]

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI

↩ Parent

information about the downwardAPI data to project

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

OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index]

↩ Parent

DownwardAPIVolumeFile represents information to create the file containing the pod field

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

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

OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret

↩ Parent

information about the secret data to project

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

OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret.items[index]

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

OpenTelemetryCollector.spec.volumes[index].projected.sources[index].serviceAccountToken

↩ Parent

information about the serviceAccountToken data to project

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

Format: int64
false

OpenTelemetryCollector.spec.volumes[index].quobyte

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].rbd

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].rbd.secretRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].scaleIO

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].scaleIO.secretRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].secret

↩ Parent

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

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

Format: int32
false
items []object If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
false
optional boolean Specify whether the Secret or its keys must be defined
false
secretName string Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
false

OpenTelemetryCollector.spec.volumes[index].secret.items[index]

↩ Parent

Maps a string key to a path within a volume.

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

Format: int32
false

OpenTelemetryCollector.spec.volumes[index].storageos

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].storageos.secretRef

↩ Parent

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

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

OpenTelemetryCollector.spec.volumes[index].vsphereVolume

↩ Parent

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

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

OpenTelemetryCollector.status

↩ Parent

OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector.

Name Type Description Required
messages []string Messages about actions performed by the operator on this resource.
false
replicas integer Replicas is currently not being set and might be removed in the next version.

Format: int32
false
version string Version of the managed OpenTelemetry Collector (operand)
false