From 3b9e378837dfb1ede0d2ae219abf848bf57a81ac Mon Sep 17 00:00:00 2001 From: Israel Blancas Date: Thu, 4 Nov 2021 13:32:06 +0100 Subject: [PATCH 1/5] Generate docs from CRD spec. Closes #325 Signed-off-by: Israel Blancas --- .github/workflows/continuous-integration.yaml | 20 + Makefile | 25 + README.md | 3 +- docs/api.md | 4660 +++++++++++++++++ docs/otelcol_cr_spec.md | 82 - docs/otelinst_cr_spec.md | 20 - 6 files changed, 4706 insertions(+), 104 deletions(-) create mode 100644 docs/api.md delete mode 100644 docs/otelcol_cr_spec.md delete mode 100644 docs/otelinst_cr_spec.md diff --git a/.github/workflows/continuous-integration.yaml b/.github/workflows/continuous-integration.yaml index bf42bbb0b1..894ca9cf7c 100644 --- a/.github/workflows/continuous-integration.yaml +++ b/.github/workflows/continuous-integration.yaml @@ -62,3 +62,23 @@ jobs: - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v1 + + api-docs: + runs-on: ubuntu-latest + steps: + - name: Clone repo + uses: actions/checkout@v2.4.0 + - name: Setup go + uses: actions/setup-go@v2 + with: + go-version: 1.17 + - name: Run api-docs + run: | + make api-docs + - name: Check if working tree is dirty + run: | + if [[ $(git status --porcelain) ]]; then + git diff + echo 'run make api-docs and commit changes' + exit 1 + fi diff --git a/Makefile b/Makefile index 4613ab5c8c..4e39658de5 100644 --- a/Makefile +++ b/Makefile @@ -227,3 +227,28 @@ bundle-build: docker build -f bundle.Dockerfile -t $(BUNDLE_IMG) . tools: ginkgo kustomize controller-gen operator-sdk + + +api-docs: gen-crd-api-reference-docs kustomize + @{ \ + set -e ;\ + TMP_DIR=$$(mktemp -d) ; \ + $(KUSTOMIZE) build config/crd -o $$TMP_DIR/crd-output.yaml ;\ + $(API_REF_GEN) crdoc --resources $$TMP_DIR/crd-output.yaml --output docs/api.md ;\ + } + +# Find or download gen-crd-api-reference-docs +gen-crd-api-reference-docs: +ifeq (, $(shell which crdoc)) + @{ \ + set -e ;\ + API_REF_GEN_TMP_DIR=$$(mktemp -d) ;\ + cd $$API_REF_GEN_TMP_DIR ;\ + go mod init tmp ;\ + go get fybrik.io/crdoc@latest ;\ + rm -rf $$API_REF_GEN_TMP_DIR ;\ + } +API_REF_GEN=$(GOBIN)/crdoc +else +API_REF_GEN=$(shell which crdoc) +endif \ No newline at end of file diff --git a/README.md b/README.md index 04b8f5fa70..8d6095b1a8 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,7 @@ The operator manages: ## Documentation -* [OpenTelemetryCollector Custom Resource Specification](./docs/otelcol_cr_spec.md) -* [Instrumentation Custom Resource Specification](./docs/otelinst_cr_spec.md) +* [API docs](./docs/api.md) ## Getting started diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000000..c374c33824 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,4660 @@ +# API Reference + +Packages: + +- [opentelemetry.io/v1alpha1](#opentelemetryiov1alpha1) + +# opentelemetry.io/v1alpha1 + +Resource Types: + +- [Instrumentation](#instrumentation) + +- [OpenTelemetryCollector](#opentelemetrycollector) + + + + +## Instrumentation +[↩ Parent](#opentelemetryiov1alpha1 ) + + + + + + +Instrumentation is the spec for OpenTelemetry instrumentation. nolint: maligned + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringInstrumentationtrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + InstrumentationSpec defines the desired state of OpenTelemetry SDK and instrumentation.
+ 		false
statusobject + InstrumentationStatus defines status of the instrumentation.
+ 		false
+ + +### Instrumentation.spec +[↩ Parent](#instrumentation) + + + +InstrumentationSpec defines the desired state of OpenTelemetry SDK and instrumentation. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
exporterobject + Exporter defines exporter configuration.
+ 		false
javaobject + Java defines configuration for java auto-instrumentation.
+ 		false
+ + +### Instrumentation.spec.exporter +[↩ Parent](#instrumentationspec) + + + +Exporter defines exporter configuration. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
endpointstring + Endpoint is address of the collector with OTLP endpoint.
+ 		false
+ + +### Instrumentation.spec.java +[↩ Parent](#instrumentationspec) + + + +Java defines configuration for java auto-instrumentation. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + Image is a container image with javaagent JAR.
+ 		false
+ +## OpenTelemetryCollector +[↩ Parent](#opentelemetryiov1alpha1 ) + + + + + + +OpenTelemetryCollector is the Schema for the opentelemetrycollectors API. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringopentelemetry.io/v1alpha1true
kindstringOpenTelemetryCollectortrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.
+ 		false
statusobject + OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector.
+ 		false
+ + +### OpenTelemetryCollector.spec +[↩ Parent](#opentelemetrycollector) + + + +OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
argsmap[string]string + Args is the set of arguments to pass to the OpenTelemetry Collector binary
+ 		false
configstring + 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
hostNetworkboolean + HostNetwork indicates if the pod should run in the host networking namespace.
+ 		false
imagestring + Image indicates the container image to use for the OpenTelemetry Collector.
+ 		false
imagePullPolicystring + ImagePullPolicy indicates the pull policy to be used for retrieving the container image (Always, Never, IfNotPresent)
+ 		false
modeenum + Mode represents how the collector should be deployed (deployment, daemonset, statefulset or sidecar)
+
+ Enum: daemonset, deployment, sidecar, statefulset
+ 		false
podAnnotationsmap[string]string + PodAnnotations is the set of annotations that will be attached to Collector and Target Allocator pods.
+ 		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
replicasinteger + Replicas is the number of pod instances for the underlying OpenTelemetry Collector
+
+ Format: int32
+ 		false
resourcesobject + Resources to set on the OpenTelemetry Collector pods.
+ 		false
securityContextobject + SecurityContext will be set as the container security context.
+ 		false
serviceAccountstring + ServiceAccount indicates the name of an existing service account to use with this instance.
+ 		false
targetAllocatorobject + 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
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](#opentelemetrycollectorspec) + + + +EnvVar represents an environment variable present in a Container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the environment variable. Must be a C_IDENTIFIER.
+ 		true
valuestring + Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
+ 		false
valueFromobject + Source for the environment variable's value. Cannot be used if value is not empty.
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom +[↩ Parent](#opentelemetrycollectorspecenvindex) + + + +Source for the environment variable's value. Cannot be used if value is not empty. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ 		false
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.configMapKeyRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) + + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.fieldRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) + + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) + + + +Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.env[index].valueFrom.secretKeyRef +[↩ Parent](#opentelemetrycollectorspecenvindexvaluefrom) + + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.envFrom[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +EnvFromSource represents the source of a set of ConfigMaps + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapRefobject + The ConfigMap to select from
+ 		false
prefixstring + An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+ 		false
secretRefobject + The Secret to select from
+ 		false
+ + +### OpenTelemetryCollector.spec.envFrom[index].configMapRef +[↩ Parent](#opentelemetrycollectorspecenvfromindex) + + + +The ConfigMap to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the ConfigMap must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.envFrom[index].secretRef +[↩ Parent](#opentelemetrycollectorspecenvfromindex) + + + +The Secret to select from + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the Secret must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.ports[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +ServicePort contains information on service's port. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + The port that will be exposed by this service.
+
+ Format: int32
+ 		true
appProtocolstring + The application protocol for this port. This 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
namestring + The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.
+ 		false
nodePortinteger + The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
+
+ Format: int32
+ 		false
protocolstring + The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.
+
+ Default: TCP
+ 		false
targetPortint or string + Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
+ 		false
+ + +### OpenTelemetryCollector.spec.resources +[↩ Parent](#opentelemetrycollectorspec) + + + +Resources to set on the OpenTelemetry Collector pods. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[string]int or string + Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
requestsmap[string]int or string + Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext +[↩ Parent](#opentelemetrycollectorspec) + + + +SecurityContext will be set as the container security context. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
allowPrivilegeEscalationboolean + AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN
+ 		false
capabilitiesobject + The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
+ 		false
privilegedboolean + Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+ 		false
procMountstring + 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
readOnlyRootFilesystemboolean + Whether this container has a read-only root filesystem. Default is false.
+ 		false
runAsGroupinteger + The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+
+ Format: int64
+ 		false
runAsNonRootboolean + Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ 		false
runAsUserinteger + The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+
+ Format: int64
+ 		false
seLinuxOptionsobject + The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ 		false
seccompProfileobject + The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options.
+ 		false
windowsOptionsobject + The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.capabilities +[↩ Parent](#opentelemetrycollectorspecsecuritycontext) + + + +The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
add[]string + Added capabilities
+ 		false
drop[]string + Removed capabilities
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.seLinuxOptions +[↩ Parent](#opentelemetrycollectorspecsecuritycontext) + + + +The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
levelstring + Level is SELinux level label that applies to the container.
+ 		false
rolestring + Role is a SELinux role label that applies to the container.
+ 		false
typestring + Type is a SELinux type label that applies to the container.
+ 		false
userstring + User is a SELinux user label that applies to the container.
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.seccompProfile +[↩ Parent](#opentelemetrycollectorspecsecuritycontext) + + + +The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring + type indicates which kind of seccomp profile will be applied. Valid options are: + Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.
+ 		true
localhostProfilestring + localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost".
+ 		false
+ + +### OpenTelemetryCollector.spec.securityContext.windowsOptions +[↩ Parent](#opentelemetrycollectorspecsecuritycontext) + + + +The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gmsaCredentialSpecstring + GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
+ 		false
gmsaCredentialSpecNamestring + GMSACredentialSpecName is the name of the GMSA credential spec to use.
+ 		false
hostProcessboolean + HostProcess determines if a container should be run as a 'Host Process' container. 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
runAsUserNamestring + The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+ 		false
+ + +### OpenTelemetryCollector.spec.targetAllocator +[↩ Parent](#opentelemetrycollectorspec) + + + +TargetAllocator indicates a value which determines whether to spawn a target allocation resource or not. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Enabled indicates whether to use a target allocation mechanism for Prometheus targets or not.
+ 		false
imagestring + Image indicates the container image to use for the OpenTelemetry TargetAllocator.
+ 		false
+ + +### OpenTelemetryCollector.spec.tolerations[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
effectstring + Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+ 		false
keystring + Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
+ 		false
operatorstring + Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
+ 		false
tolerationSecondsinteger + TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
+
+ Format: int64
+ 		false
valuestring + Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +PersistentVolumeClaim is a user's request for and claim to a persistent volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstring + APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+ 		false
kindstring + Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+ 		false
metadataobject + Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+ 		false
specobject + Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
statusobject + Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].metadata +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex) + + + +Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex) + + + +Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
accessModes[]string + AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ 		false
dataSourceobject + 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
dataSourceRefobject + 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
resourcesobject + Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+ 		false
selectorobject + A label query over volumes to consider for binding.
+ 		false
storageClassNamestring + Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + VolumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSource +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.dataSourceRef +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.resources +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) + + + +Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[string]int or string + Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
requestsmap[string]int or string + Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspec) + + + +A label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[string]string + matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].spec.selector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexspecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ 		true
values[]string + values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindex) + + + +Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
accessModes[]string + AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ 		false
capacitymap[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
phasestring + Phase represents the current phase of PersistentVolumeClaim.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumeClaimTemplates[index].status.conditions[index] +[↩ Parent](#opentelemetrycollectorspecvolumeclaimtemplatesindexstatus) + + + +PersistentVolumeClaimCondition contails details about state of pvc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
statusstring +
+ 		true
typestring + PersistentVolumeClaimConditionType is a valid value of PersistentVolumeClaimCondition.Type
+ 		true
lastProbeTimestring + Last time we probed the condition.
+
+ Format: date-time
+ 		false
lastTransitionTimestring + Last time the condition transitioned from one status to another.
+
+ Format: date-time
+ 		false
messagestring + Human-readable message indicating details about last transition.
+ 		false
reasonstring + 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](#opentelemetrycollectorspec) + + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+ 		false
subPathExprstring + Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index] +[↩ Parent](#opentelemetrycollectorspec) + + + +Volume represents a named volume in a pod that may be accessed by any container in the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + 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
awsElasticBlockStoreobject + AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		false
azureDiskobject + AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ 		false
azureFileobject + AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ 		false
cephfsobject + CephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ 		false
cinderobject + Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		false
configMapobject + ConfigMap represents a configMap that should populate this volume
+ 		false
csiobject + CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ 		false
downwardAPIobject + DownwardAPI represents downward API about the pod that should populate this volume
+ 		false
emptyDirobject + EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
ephemeralobject + Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. + Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). + Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. + Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. + A pod can use both types of ephemeral volumes and persistent volumes at the same time. + This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.
+ 		false
fcobject + FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ 		false
flexVolumeobject + FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
+ 		false
flockerobject + Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ 		false
gcePersistentDiskobject + GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		false
gitRepoobject + GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
+ 		false
glusterfsobject + Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md
+ 		false
hostPathobject + HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.
+ 		false
iscsiobject + ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md
+ 		false
nfsobject + NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		false
persistentVolumeClaimobject + PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
photonPersistentDiskobject + PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ 		false
portworxVolumeobject + PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ 		false
projectedobject + Items for all in one resources secrets, configmaps, and downward API
+ 		false
quobyteobject + Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ 		false
rbdobject + RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md
+ 		false
scaleIOobject + ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ 		false
secretobject + Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
storageosobject + StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ 		false
vsphereVolumeobject + VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].awsElasticBlockStore +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		true
fsTypestring + 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
partitioninteger + The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+
+ Format: int32
+ 		false
readOnlyboolean + 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](#opentelemetrycollectorspecvolumesindex) + + + +AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
diskNamestring + The Name of the data disk in the blob storage
+ 		true
diskURIstring + The URI the data disk in the blob storage
+ 		true
cachingModestring + Host Caching mode: None, Read Only, Read Write.
+ 		false
fsTypestring + 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
kindstring + 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
readOnlyboolean + Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].azureFile +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secretNamestring + the name of secret that contains Azure Storage Account Name and Key
+ 		true
shareNamestring + Share Name
+ 		true
readOnlyboolean + Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].cephfs +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +CephFS represents a Ceph FS mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
monitors[]string + Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		true
pathstring + Optional: Used as the mounted root, rather than the full Ceph tree, default is /
+ 		false
readOnlyboolean + Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		false
secretFilestring + Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		false
secretRefobject + Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		false
userstring + Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].cephfs.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexcephfs) + + + +Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. 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](#opentelemetrycollectorspecvolumesindex) + + + +Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		true
fsTypestring + Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		false
readOnlyboolean + 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
secretRefobject + Optional: points to a secret object containing parameters used to connect to OpenStack.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].cinder.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexcinder) + + + +Optional: points to a secret object containing parameters used to connect to OpenStack. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + 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](#opentelemetrycollectorspecvolumesindex) + + + +ConfigMap represents a configMap that should populate this volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + 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
namestring + 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
optionalboolean + Specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].configMap.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexconfigmap) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to project.
+ 		true
pathstring + The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
+ 		true
modeinteger + Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].csi +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.
+ 		true
fsTypestring + 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
nodePublishSecretRefobject + NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.
+ 		false
readOnlyboolean + Specifies a read-only configuration for the volume. Defaults to false (read/write).
+ 		false
volumeAttributesmap[string]string + VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].csi.nodePublishSecretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexcsi) + + + +NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. 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](#opentelemetrycollectorspecvolumesindex) + + + +DownwardAPI represents downward API about the pod that should populate this volume + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
items[]object + Items is a list of downward API volume file
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapi) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
+ 		true
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
+ 		false
modeinteger + Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].fieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex) + + + +Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexdownwardapiitemsindex) + + + +Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].emptyDir +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mediumstring + What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
sizeLimitint or string + 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](#opentelemetrycollectorspecvolumesindex) + + + +Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. + Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). + Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. + Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. + A pod can use both types of ephemeral volumes and persistent volumes at the same time. + This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeClaimTemplateobject + Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). + An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. + This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. + Required, must not be nil.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeral) + + + +Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). + An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. + This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. + Required, must not be nil. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.
+ 		true
metadataobject + May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate) + + + +The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
accessModes[]string + AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ 		false
dataSourceobject + 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
dataSourceRefobject + 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
resourcesobject + Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+ 		false
selectorobject + A label query over volumes to consider for binding.
+ 		false
storageClassNamestring + Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + VolumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +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. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[string]int or string + Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
requestsmap[string]int or string + Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespec) + + + +A label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[string]string + matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplatespecselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
+ 		true
values[]string + values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].ephemeral.volumeClaimTemplate.metadata +[↩ Parent](#opentelemetrycollectorspecvolumesindexephemeralvolumeclaimtemplate) + + + +May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
annotationsmap[string]string +
+ 		false
finalizers[]string +
+ 		false
labelsmap[string]string +
+ 		false
namestring +
+ 		false
namespacestring +
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].fc +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + 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
luninteger + Optional: FC target lun number
+
+ Format: int32
+ 		false
readOnlyboolean + 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](#opentelemetrycollectorspecvolumesindex) + + + +FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + Driver is the name of the driver to use for this volume.
+ 		true
fsTypestring + Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ 		false
optionsmap[string]string + Optional: Extra command options if any.
+ 		false
readOnlyboolean + Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].flexVolume.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexflexvolume) + + + +Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. 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](#opentelemetrycollectorspecvolumesindex) + + + +Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
datasetNamestring + Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
+ 		false
datasetUUIDstring + UUID of the dataset. This is unique identifier of a Flocker dataset
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].gcePersistentDisk +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdNamestring + Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		true
fsTypestring + 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
partitioninteger + The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+
+ Format: int32
+ 		false
readOnlyboolean + ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].gitRepo +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
repositorystring + Repository URL
+ 		true
directorystring + Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
+ 		false
revisionstring + Commit hash for the specified revision.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].glusterfs +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
endpointsstring + EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
pathstring + Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
readOnlyboolean + ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].hostPath +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ 		true
typestring + Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].iscsi +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
iqnstring + Target iSCSI Qualified Name.
+ 		true
luninteger + iSCSI Target Lun number.
+
+ Format: int32
+ 		true
targetPortalstring + iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
+ 		true
chapAuthDiscoveryboolean + whether support iSCSI Discovery CHAP authentication
+ 		false
chapAuthSessionboolean + whether support iSCSI Session CHAP authentication
+ 		false
fsTypestring + 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
initiatorNamestring + Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection.
+ 		false
iscsiInterfacestring + 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
readOnlyboolean + ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
+ 		false
secretRefobject + CHAP Secret for iSCSI target and initiator authentication
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].iscsi.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexiscsi) + + + +CHAP Secret for iSCSI target and initiator authentication + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + 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](#opentelemetrycollectorspecvolumesindex) + + + +NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
serverstring + Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
readOnlyboolean + ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].persistentVolumeClaim +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claimNamestring + ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		true
readOnlyboolean + Will force the ReadOnly setting in VolumeMounts. Default false.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].photonPersistentDisk +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdIDstring + ID that identifies Photon Controller persistent disk
+ 		true
fsTypestring + Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].portworxVolume +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +PortworxVolume represents a portworx volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + VolumeID uniquely identifies a Portworx volume
+ 		true
fsTypestring + FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ 		false
readOnlyboolean + Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +Items for all in one resources secrets, configmaps, and downward API + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + 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](#opentelemetrycollectorspecvolumesindexprojected) + + + +Projection that may be projected along with other supported volume types + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapobject + information about the configMap data to project
+ 		false
downwardAPIobject + information about the downwardAPI data to project
+ 		false
secretobject + information about the secret data to project
+ 		false
serviceAccountTokenobject + information about the serviceAccountToken data to project
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) + + + +information about the configMap data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
namestring + 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
optionalboolean + Specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].configMap.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexconfigmap) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to project.
+ 		true
pathstring + The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
+ 		true
modeinteger + Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) + + + +information about the downwardAPI data to project + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + Items is a list of DownwardAPIVolume file
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapi) + + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
+ 		true
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
+ 		false
modeinteger + Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + + +Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + + +Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) + + + +information about the secret data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
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
namestring + 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
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].secret.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindexsecret) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to project.
+ 		true
pathstring + The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
+ 		true
modeinteger + Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].projected.sources[index].serviceAccountToken +[↩ Parent](#opentelemetrycollectorspecvolumesindexprojectedsourcesindex) + + + +information about the serviceAccountToken data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Path is the path relative to the mount point of the file to project the token into.
+ 		true
audiencestring + Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
+ 		false
expirationSecondsinteger + ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
+
+ Format: int64
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].quobyte +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +Quobyte represents a Quobyte mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
registrystring + Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
+ 		true
volumestring + Volume is a string that references an already created Quobyte volume by name.
+ 		true
groupstring + Group to map volume access to Default is no group
+ 		false
readOnlyboolean + ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
+ 		false
tenantstring + Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ 		false
userstring + User to map volume access to Defaults to serivceaccount user
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].rbd +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + 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
fsTypestring + 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
keyringstring + Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		false
poolstring + The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		false
readOnlyboolean + ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		false
secretRefobject + SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		false
userstring + 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](#opentelemetrycollectorspecvolumesindexrbd) + + + +SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. 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](#opentelemetrycollectorspecvolumesindex) + + + +ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gatewaystring + The host address of the ScaleIO API Gateway.
+ 		true
secretRefobject + SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
+ 		true
systemstring + The name of the storage system as configured in ScaleIO.
+ 		true
fsTypestring + Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
+ 		false
protectionDomainstring + The name of the ScaleIO Protection Domain for the configured storage.
+ 		false
readOnlyboolean + Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ 		false
sslEnabledboolean + Flag to enable/disable SSL communication with Gateway, default false
+ 		false
storageModestring + Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
+ 		false
storagePoolstring + The ScaleIO Storage Pool associated with the protection domain.
+ 		false
volumeNamestring + The name of a volume already created in the ScaleIO system that is associated with this volume source.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].scaleIO.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexscaleio) + + + +SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. 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](#opentelemetrycollectorspecvolumesindex) + + + +Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + 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
optionalboolean + Specify whether the Secret or its keys must be defined
+ 		false
secretNamestring + Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].secret.items[index] +[↩ Parent](#opentelemetrycollectorspecvolumesindexsecret) + + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to project.
+ 		true
pathstring + The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
+ 		true
modeinteger + Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].storageos +[↩ Parent](#opentelemetrycollectorspecvolumesindex) + + + +StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ 		false
readOnlyboolean + Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
+ 		false
volumeNamestring + VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
+ 		false
volumeNamespacestring + VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
+ 		false
+ + +### OpenTelemetryCollector.spec.volumes[index].storageos.secretRef +[↩ Parent](#opentelemetrycollectorspecvolumesindexstorageos) + + + +SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. 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](#opentelemetrycollectorspecvolumesindex) + + + +VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumePathstring + Path that identifies vSphere volume vmdk
+ 		true
fsTypestring + Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ 		false
storagePolicyIDstring + Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ 		false
storagePolicyNamestring + Storage Policy Based Management (SPBM) profile name.
+ 		false
+ + +### OpenTelemetryCollector.status +[↩ Parent](#opentelemetrycollector) + + + +OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollector. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
messages[]string + Messages about actions performed by the operator on this resource.
+ 		false
replicasinteger + Replicas is currently not being set and might be removed in the next version.
+
+ Format: int32
+ 		false
versionstring + Version of the managed OpenTelemetry Collector (operand)
+ 		false
\ No newline at end of file diff --git a/docs/otelcol_cr_spec.md b/docs/otelcol_cr_spec.md deleted file mode 100644 index a38526af53..0000000000 --- a/docs/otelcol_cr_spec.md +++ /dev/null @@ -1,82 +0,0 @@ -# OpenTelemetryCollector Custom Resource Specification - -The below `OpenTelemetryCollector` custom resource contains all the specification that can be configured. - -```yaml -apiVersion: opentelemetry.io/v1alpha1 -kind: OpenTelemetryCollector -metadata: - name: example-collector -spec: - // +optional Mode represents how the collector should be deployed (deployment, daemonset, statefulset or sidecar) - mode: "" - - // +required Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details. - config: | - receivers: - otlp: - protocols: - grpc: - http: - processors: - exporters: - logging: - service: - pipelines: - traces: - receivers: [otlp] - processors: [] - exporters: [logging] - - // +optional Args is the set of arguments to pass to the OpenTelemetry Collector binary - args: - metrics-level: detailed - log-level: debug - - // +optional Replicas is the number of pod instances for the underlying OpenTelemetry Collector - replicas: 1 - - // +optional Image indicates the container image to use for the OpenTelemetry Collector. - image: "" - - // +optional ImagePullPolicy indicates what image pull policy to be used to retrieve the container image to use for the OpenTelemetry Collector. - imagePullPolicy: "" - - // +optional ServiceAccount indicates the name of an existing service account to use with this instance. - serviceAccount: "" - - // +optional VolumeClaimTemplates will provide stable storage using PersistentVolumes. Only available when the mode=statefulset. - volumeClaimTemplates: [] - - // +optional VolumeMounts represents the mount points to use in the underlying collector deployment(s) - volumeMounts: [] - - // +optional Volumes represents which volumes to use in the underlying collector deployment(s). - volumes: [] - - // +optional 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. - ports: [] - - // +optional 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. - env: [] - - // +optional 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. - envFrom: [] - - // +optional Resources to set on the OpenTelemetry Collector pods. - resources: {} - - // +optional SecurityContext will be set as the container security context. - securityContext: {} - - // +optional HostNetwork indicates if the pod should run in the host networking namespace. - hostNetwork: false - - // +optional Toleration to schedule OpenTelemetry Collector pods. - // This is only relevant to daemonsets, statefulsets and deployments - tolerations: [] -``` diff --git a/docs/otelinst_cr_spec.md b/docs/otelinst_cr_spec.md deleted file mode 100644 index 00fa2c07c8..0000000000 --- a/docs/otelinst_cr_spec.md +++ /dev/null @@ -1,20 +0,0 @@ -# Instrumentation Custom Resource Specification - -The below `Instrumentation` custom resource contains all the specification that can be configured. - -```yaml -apiVersion: opentelemetry.io/v1alpha1 -kind: Instrumentation -metadata: - name: example-instrumentation -spec: - // +optional Exporter defines exporter configuration. - exporter: - // +optional Endpoint is address of the collector with OTLP endpoint. - endpoint: - - // +optional Java defines configuration for java auto-instrumentation. - java: - // +optional Image is a container image with javaagent JAR. - image: -``` From 3ee5ce262b45492c079f3f4df905bb0f5e98488c Mon Sep 17 00:00:00 2001 From: Israel Blancas Date: Thu, 4 Nov 2021 16:08:35 +0100 Subject: [PATCH 2/5] Apply changes suggested in CR Signed-off-by: Israel Blancas --- .github/workflows/continuous-integration.yaml | 2 +- Makefile | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/continuous-integration.yaml b/.github/workflows/continuous-integration.yaml index 894ca9cf7c..483b28c4b5 100644 --- a/.github/workflows/continuous-integration.yaml +++ b/.github/workflows/continuous-integration.yaml @@ -74,7 +74,7 @@ jobs: go-version: 1.17 - name: Run api-docs run: | - make api-docs + make ensure-generate-is-noo api-docs - name: Check if working tree is dirty run: | if [[ $(git status --porcelain) ]]; then diff --git a/Makefile b/Makefile index 4e39658de5..d1d09dffe4 100644 --- a/Makefile +++ b/Makefile @@ -110,7 +110,7 @@ lint: golangci-lint run # Generate code -generate: controller-gen +generate: controller-gen api-docs $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..." # end-to-tests @@ -133,7 +133,7 @@ container: container-push: docker push ${IMG} -start-kind: +start-kind: kind create cluster --config $(KIND_CONFIG) kind load docker-image local/opentelemetry-operator:e2e From f1660625ac267c7845ca4d0ee8a52300e0794c78 Mon Sep 17 00:00:00 2001 From: Israel Blancas Date: Thu, 4 Nov 2021 17:41:48 +0100 Subject: [PATCH 3/5] Apply changes requested in CR Signed-off-by: Israel Blancas --- .github/workflows/continuous-integration.yaml | 9 +-------- Makefile | 1 + 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/.github/workflows/continuous-integration.yaml b/.github/workflows/continuous-integration.yaml index 483b28c4b5..4747a39eea 100644 --- a/.github/workflows/continuous-integration.yaml +++ b/.github/workflows/continuous-integration.yaml @@ -74,11 +74,4 @@ jobs: go-version: 1.17 - name: Run api-docs run: | - make ensure-generate-is-noo api-docs - - name: Check if working tree is dirty - run: | - if [[ $(git status --porcelain) ]]; then - git diff - echo 'run make api-docs and commit changes' - exit 1 - fi + make api-docs diff --git a/Makefile b/Makefile index d1d09dffe4..d490c6402e 100644 --- a/Makefile +++ b/Makefile @@ -52,6 +52,7 @@ ensure-generate-is-noop: set-image-controller generate bundle @git restore config/manager/kustomization.yaml @git diff -s --exit-code api/v1alpha1/zz_generated.*.go || (echo "Build failed: a model has been changed but the generated resources aren't up to date. Run 'make generate' and update your PR." && exit 1) @git diff -s --exit-code bundle config || (echo "Build failed: the bundle, config files has been changed but the generated bundle, config files aren't up to date. Run 'make bundle' and update your PR." && git diff && exit 1) + @git diff -s --exit-code docs/api.md || (echo "Build failed: the api.md file has been changed but the generated api.md file isn't up to date. Run 'make api-docs' and update your PR." && git diff && exit 1) all: manager ci: test From 0b7794ea78ae76443122af54725ab69f61d439a6 Mon Sep 17 00:00:00 2001 From: Israel Blancas Date: Wed, 10 Nov 2021 21:10:54 +0100 Subject: [PATCH 4/5] Apply changes requested in CR Signed-off-by: Israel Blancas --- .github/workflows/continuous-integration.yaml | 13 ------------- Makefile | 4 ++-- 2 files changed, 2 insertions(+), 15 deletions(-) diff --git a/.github/workflows/continuous-integration.yaml b/.github/workflows/continuous-integration.yaml index 4747a39eea..bf42bbb0b1 100644 --- a/.github/workflows/continuous-integration.yaml +++ b/.github/workflows/continuous-integration.yaml @@ -62,16 +62,3 @@ jobs: - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v1 - - api-docs: - runs-on: ubuntu-latest - steps: - - name: Clone repo - uses: actions/checkout@v2.4.0 - - name: Setup go - uses: actions/setup-go@v2 - with: - go-version: 1.17 - - name: Run api-docs - run: | - make api-docs diff --git a/Makefile b/Makefile index d490c6402e..797dd56ed8 100644 --- a/Makefile +++ b/Makefile @@ -238,7 +238,7 @@ api-docs: gen-crd-api-reference-docs kustomize $(API_REF_GEN) crdoc --resources $$TMP_DIR/crd-output.yaml --output docs/api.md ;\ } -# Find or download gen-crd-api-reference-docs +# Find or download crdoc gen-crd-api-reference-docs: ifeq (, $(shell which crdoc)) @{ \ @@ -246,7 +246,7 @@ ifeq (, $(shell which crdoc)) API_REF_GEN_TMP_DIR=$$(mktemp -d) ;\ cd $$API_REF_GEN_TMP_DIR ;\ go mod init tmp ;\ - go get fybrik.io/crdoc@latest ;\ + go get fybrik.io/crdoc@v0.5.2 ;\ rm -rf $$API_REF_GEN_TMP_DIR ;\ } API_REF_GEN=$(GOBIN)/crdoc From ef409ba19122607c6fbb88249959063a95d1f213 Mon Sep 17 00:00:00 2001 From: Israel Blancas Date: Wed, 10 Nov 2021 21:22:17 +0100 Subject: [PATCH 5/5] Update docs API and fix target name Signed-off-by: Israel Blancas --- Makefile | 4 +-- docs/api.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 93 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 89d8f5685d..0da967528c 100644 --- a/Makefile +++ b/Makefile @@ -235,7 +235,7 @@ bundle-push: tools: ginkgo kustomize controller-gen operator-sdk -api-docs: gen-crd-api-reference-docs kustomize +api-docs: crdoc kustomize @{ \ set -e ;\ TMP_DIR=$$(mktemp -d) ; \ @@ -244,7 +244,7 @@ api-docs: gen-crd-api-reference-docs kustomize } # Find or download crdoc -gen-crd-api-reference-docs: +crdoc: ifeq (, $(shell which crdoc)) @{ \ set -e ;\ diff --git a/docs/api.md b/docs/api.md index c374c33824..4c95bf16cf 100644 --- a/docs/api.md +++ b/docs/api.md @@ -99,6 +99,34 @@ InstrumentationSpec defines the desired state of OpenTelemetry SDK and instrumen 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 + + resourceAttributes + map[string]string + + ResourceAttributes defines attributes that are added to resource.
+ + false + + sampler + object + + Sampler defines sampling configuration.
+ + false @@ -156,6 +184,69 @@ Java defines configuration for java auto-instrumentation. + +### Instrumentation.spec.nodejs +[↩ Parent](#instrumentationspec) + + + +NodeJS defines configuration for nodejs auto-instrumentation. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + Image is a container image with NodeJS SDK and autoinstrumentation.
+ 		false
+ + +### Instrumentation.spec.sampler +[↩ Parent](#instrumentationspec) + + + +Sampler defines sampling configuration. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
argumentstring + Argument defines sampler argument. The value depends on the sampler type. For instance for parentbased_traceidratio sampler type it is a number in range [0..1] e.g. 0.25.
+ 		false
typeenum + 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](#opentelemetryiov1alpha1 )