datadoghq.v1alpha1.datadogAgent

"DatadogAgent Deployment with Datadog Operator."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of DatadogAgent

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"DatadogAgentSpec defines the desired state of DatadogAgent."

fn spec.withClusterName

withClusterName(clusterName)

"Set a unique cluster name to allow scoping hosts and Cluster Checks Runner easily."

fn spec.withRegistry

withRegistry(registry)

"Registry to use for all Agent images (default gcr.io/datadoghq). Use public.ecr.aws/datadog for AWS Use docker.io/datadog for DockerHub"

fn spec.withSite

withSite(site)

"The site of the Datadog intake to send Agent data to. Set to 'datadoghq.eu' to send data to the EU site."

obj spec.agent

"The desired state of the Agent as an extended daemonset. Contains the Node Agent configuration and deployment strategy."

fn spec.agent.withAdditionalAnnotations

withAdditionalAnnotations(additionalAnnotations)

"AdditionalAnnotations provide annotations that will be added to the Agent Pods."

fn spec.agent.withAdditionalAnnotationsMixin

withAdditionalAnnotationsMixin(additionalAnnotations)

"AdditionalAnnotations provide annotations that will be added to the Agent Pods."

Note: This function appends passed data to existing values

fn spec.agent.withAdditionalLabels

withAdditionalLabels(additionalLabels)

"AdditionalLabels provide labels that will be added to the Agent Pods."

fn spec.agent.withAdditionalLabelsMixin

withAdditionalLabelsMixin(additionalLabels)

"AdditionalLabels provide labels that will be added to the Agent Pods."

Note: This function appends passed data to existing values

fn spec.agent.withDaemonsetName

withDaemonsetName(daemonsetName)

"Name of the Daemonset to create or migrate from."

fn spec.agent.withDnsPolicy

withDnsPolicy(dnsPolicy)

"Set DNS policy for the pod. Defaults to \"ClusterFirst\". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'."

fn spec.agent.withEnabled

withEnabled(enabled)

"Enabled"

fn spec.agent.withEnv

withEnv(env)

"Environment variables for all Datadog Agents. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.withEnvMixin

withEnvMixin(env)

"Environment variables for all Datadog Agents. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

Note: This function appends passed data to existing values

fn spec.agent.withHostNetwork

withHostNetwork(hostNetwork)

"Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false."

fn spec.agent.withHostPID

withHostPID(hostPID)

"Use the host's pid namespace. Optional: Default to false."

fn spec.agent.withKeepAnnotations

withKeepAnnotations(keepAnnotations)

"KeepAnnotations allows the specification of annotations not managed by the Operator that will be kept on Agent DaemonSet. All annotations containing 'datadoghq.com' are always included. This field uses glob syntax."

fn spec.agent.withKeepLabels

withKeepLabels(keepLabels)

"KeepLabels allows the specification of labels not managed by the Operator that will be kept on Agent DaemonSet. All labels containing 'datadoghq.com' are always included. This field uses glob syntax."

fn spec.agent.withPriorityClassName

withPriorityClassName(priorityClassName)

"If specified, indicates the pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default."

fn spec.agent.withUseExtendedDaemonset

withUseExtendedDaemonset(useExtendedDaemonset)

"UseExtendedDaemonset use ExtendedDaemonset for Agent deployment. default value is false."

obj spec.agent.affinity

"If specified, the pod's scheduling constraints."

obj spec.agent.affinity.nodeAffinity

"Describes node affinity scheduling rules for the pod."

fn spec.agent.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

fn spec.agent.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

obj spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."

obj spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"A node selector term, associated with the corresponding weight."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

"A list of node selector requirements by node's fields."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.agent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

Note: This function appends passed data to existing values

obj spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

"Required. A list of node selector terms. The terms are ORed."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

"A list of node selector requirements by node's fields."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.agent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAffinity

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

fn spec.agent.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.agent.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.agent.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

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

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

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

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

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

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAntiAffinity

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

fn spec.agent.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.agent.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.agent.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

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

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

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

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

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

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.apm

"Trace Agent configuration"

fn spec.agent.apm.withArgs

withArgs(args)

"Args allows the specification of extra args to Command parameter"

fn spec.agent.apm.withArgsMixin

withArgsMixin(args)

"Args allows the specification of extra args to Command parameter"

Note: This function appends passed data to existing values

fn spec.agent.apm.withCommand

withCommand(command)

"Command allows the specification of custom entrypoint for Trace Agent container"

fn spec.agent.apm.withCommandMixin

withCommandMixin(command)

"Command allows the specification of custom entrypoint for Trace Agent container"

Note: This function appends passed data to existing values

fn spec.agent.apm.withEnabled

withEnabled(enabled)

"Enable this to enable APM and tracing, on port 8126. See also: https://github.com/DataDog/docker-dd-agent#tracing-from-the-host"

fn spec.agent.apm.withEnv

withEnv(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.apm.withEnvMixin

withEnvMixin(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

Note: This function appends passed data to existing values

fn spec.agent.apm.withHostPort

withHostPort(hostPort)

"Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this."

fn spec.agent.apm.withVolumeMounts

withVolumeMounts(volumeMounts)

"Specify additional volume mounts in the APM Agent container."

fn spec.agent.apm.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Specify additional volume mounts in the APM Agent container."

Note: This function appends passed data to existing values

obj spec.agent.apm.env

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.apm.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.agent.apm.env.withValue

withValue(value)

"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 \"\"."

obj spec.agent.apm.env.valueFrom

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

obj spec.agent.apm.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.agent.apm.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.agent.apm.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.agent.apm.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.agent.apm.env.valueFrom.fieldRef

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

fn spec.agent.apm.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.agent.apm.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.agent.apm.env.valueFrom.resourceFieldRef

"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."

fn spec.agent.apm.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.agent.apm.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.agent.apm.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.agent.apm.env.valueFrom.secretKeyRef

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

fn spec.agent.apm.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.agent.apm.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.agent.apm.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.agent.apm.livenessProbe

"Configure the Liveness Probe of the APM container"

fn spec.agent.apm.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.agent.apm.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.agent.apm.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.agent.apm.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.agent.apm.livenessProbe.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset."

fn spec.agent.apm.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.agent.apm.livenessProbe.exec

"Exec specifies the action to take."

fn spec.agent.apm.livenessProbe.exec.withCommand

withCommand(command)

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

fn spec.agent.apm.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

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

Note: This function appends passed data to existing values

obj spec.agent.apm.livenessProbe.grpc

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

fn spec.agent.apm.livenessProbe.grpc.withPort

withPort(port)

"Port number of the gRPC service. Number must be in the range 1 to 65535."

fn spec.agent.apm.livenessProbe.grpc.withService

withService(service)

"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."

obj spec.agent.apm.livenessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.agent.apm.livenessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.agent.apm.livenessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.agent.apm.livenessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.agent.apm.livenessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.agent.apm.livenessProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.agent.apm.livenessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.agent.apm.livenessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.agent.apm.livenessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.agent.apm.livenessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.agent.apm.livenessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port."

fn spec.agent.apm.livenessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.agent.apm.livenessProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.agent.apm.resources

"Datadog APM Agent resource requests and limits. Make sure to keep requests and limits equal to keep the pods in the Guaranteed QoS class. See also: http://kubernetes.io/docs/user-guide/compute-resources/"

fn spec.agent.apm.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.agent.apm.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.agent.apm.resources.withRequests

withRequests(requests)

"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/"

fn spec.agent.apm.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.agent.apm.unixDomainSocket

"UnixDomainSocket socket configuration. See also: https://docs.datadoghq.com/agent/kubernetes/apm/?tab=helm#agent-environment-variables"

fn spec.agent.apm.unixDomainSocket.withEnabled

withEnabled(enabled)

"Enable APM over Unix Domain Socket See also: https://docs.datadoghq.com/agent/kubernetes/apm/?tab=helm#agent-environment-variables"

fn spec.agent.apm.unixDomainSocket.withHostFilepath

withHostFilepath(hostFilepath)

"Define the host APM socket filepath used when APM over Unix Domain Socket is enabled. (default value: /var/run/datadog/apm.sock) See also: https://docs.datadoghq.com/agent/kubernetes/apm/?tab=helm#agent-environment-variables"

obj spec.agent.apm.volumeMounts

"Specify additional volume mounts in the APM Agent container."

fn spec.agent.apm.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.agent.apm.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"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."

fn spec.agent.apm.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.agent.apm.volumeMounts.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.agent.apm.volumeMounts.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.agent.apm.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"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."

obj spec.agent.config

"Agent configuration."

fn spec.agent.config.withArgs

withArgs(args)

"Args allows the specification of extra args to Command parameter"

fn spec.agent.config.withArgsMixin

withArgsMixin(args)

"Args allows the specification of extra args to Command parameter"

Note: This function appends passed data to existing values

fn spec.agent.config.withCollectEvents

withCollectEvents(collectEvents)

"Enables this to start event collection from the Kubernetes API. See also: https://docs.datadoghq.com/agent/kubernetes/event_collection/"

fn spec.agent.config.withCommand

withCommand(command)

"Command allows the specification of custom entrypoint for the Agent container"

fn spec.agent.config.withCommandMixin

withCommandMixin(command)

"Command allows the specification of custom entrypoint for the Agent container"

Note: This function appends passed data to existing values

fn spec.agent.config.withDdUrl

withDdUrl(ddUrl)

"The host of the Datadog intake server to send Agent data to, only set this option if you need the Agent to send data to a custom URL. Overrides the site setting defined in \"site\"."

fn spec.agent.config.withEnv

withEnv(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.config.withEnvMixin

withEnvMixin(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

Note: This function appends passed data to existing values

fn spec.agent.config.withHealthPort

withHealthPort(healthPort)

"HealthPort of the Agent container for internal liveness probe. Must be the same as the Liveness/Readiness probes."

fn spec.agent.config.withHostPort

withHostPort(hostPort)

"Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this."

fn spec.agent.config.withLeaderElection

withLeaderElection(leaderElection)

"Enables leader election mechanism for event collection."

fn spec.agent.config.withLogLevel

withLogLevel(logLevel)

"Set logging verbosity, valid log levels are: trace, debug, info, warn, error, critical, and off"

fn spec.agent.config.withNamespaceLabelsAsTags

withNamespaceLabelsAsTags(namespaceLabelsAsTags)

"Provide a mapping of Kubernetes Namespace Labels to Datadog Tags. : "

fn spec.agent.config.withNamespaceLabelsAsTagsMixin

withNamespaceLabelsAsTagsMixin(namespaceLabelsAsTags)

"Provide a mapping of Kubernetes Namespace Labels to Datadog Tags. : "

Note: This function appends passed data to existing values

fn spec.agent.config.withNodeLabelsAsTags

withNodeLabelsAsTags(nodeLabelsAsTags)

"Provide a mapping of Kubernetes Node Labels to Datadog Tags. : "

fn spec.agent.config.withNodeLabelsAsTagsMixin

withNodeLabelsAsTagsMixin(nodeLabelsAsTags)

"Provide a mapping of Kubernetes Node Labels to Datadog Tags. : "

Note: This function appends passed data to existing values

fn spec.agent.config.withPodAnnotationsAsTags

withPodAnnotationsAsTags(podAnnotationsAsTags)

"Provide a mapping of Kubernetes Pod Annotations to Datadog Tags. : "

fn spec.agent.config.withPodAnnotationsAsTagsMixin

withPodAnnotationsAsTagsMixin(podAnnotationsAsTags)

"Provide a mapping of Kubernetes Pod Annotations to Datadog Tags. : "

Note: This function appends passed data to existing values

fn spec.agent.config.withPodLabelsAsTags

withPodLabelsAsTags(podLabelsAsTags)

"Provide a mapping of Kubernetes Pod Labels to Datadog Tags. : "

fn spec.agent.config.withPodLabelsAsTagsMixin

withPodLabelsAsTagsMixin(podLabelsAsTags)

"Provide a mapping of Kubernetes Pod Labels to Datadog Tags. : "

Note: This function appends passed data to existing values

fn spec.agent.config.withTags

withTags(tags)

"List of tags to attach to every metric, event and service check collected by this Agent. Learn more about tagging: https://docs.datadoghq.com/tagging/"

fn spec.agent.config.withTagsMixin

withTagsMixin(tags)

"List of tags to attach to every metric, event and service check collected by this Agent. Learn more about tagging: https://docs.datadoghq.com/tagging/"

Note: This function appends passed data to existing values

fn spec.agent.config.withTolerations

withTolerations(tolerations)

"If specified, the Agent pod's tolerations."

fn spec.agent.config.withTolerationsMixin

withTolerationsMixin(tolerations)

"If specified, the Agent pod's tolerations."

Note: This function appends passed data to existing values

fn spec.agent.config.withVolumeMounts

withVolumeMounts(volumeMounts)

"Specify additional volume mounts in the Datadog Agent container."

fn spec.agent.config.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Specify additional volume mounts in the Datadog Agent container."

Note: This function appends passed data to existing values

fn spec.agent.config.withVolumes

withVolumes(volumes)

"Specify additional volumes in the Datadog Agent container."

fn spec.agent.config.withVolumesMixin

withVolumesMixin(volumes)

"Specify additional volumes in the Datadog Agent container."

Note: This function appends passed data to existing values

obj spec.agent.config.checksd

"Checksd configuration allowing to specify custom checks placed under /etc/datadog-agent/checks.d/ See https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6 for more details."

fn spec.agent.config.checksd.withConfigMapName

withConfigMapName(configMapName)

"ConfigMapName name of a ConfigMap used to mount a directory."

fn spec.agent.config.checksd.withItems

withItems(items)

"items mapping between configMap data key and file path mount."

fn spec.agent.config.checksd.withItemsMixin

withItemsMixin(items)

"items mapping between configMap data key and file path mount."

Note: This function appends passed data to existing values

obj spec.agent.config.checksd.items

"items mapping between configMap data key and file path mount."

fn spec.agent.config.checksd.items.withKey

withKey(key)

"key is the key to project."

fn spec.agent.config.checksd.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.agent.config.checksd.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.agent.config.confd

"Confd configuration allowing to specify config files for custom checks placed under /etc/datadog-agent/conf.d/. See https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6 for more details."

fn spec.agent.config.confd.withConfigMapName

withConfigMapName(configMapName)

"ConfigMapName name of a ConfigMap used to mount a directory."

fn spec.agent.config.confd.withItems

withItems(items)

"items mapping between configMap data key and file path mount."

fn spec.agent.config.confd.withItemsMixin

withItemsMixin(items)

"items mapping between configMap data key and file path mount."

Note: This function appends passed data to existing values

obj spec.agent.config.confd.items

"items mapping between configMap data key and file path mount."

fn spec.agent.config.confd.items.withKey

withKey(key)

"key is the key to project."

fn spec.agent.config.confd.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.agent.config.confd.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.agent.config.criSocket

"Configure the CRI Socket."

fn spec.agent.config.criSocket.withCriSocketPath

withCriSocketPath(criSocketPath)

"Path to the container runtime socket (if different from Docker). This is supported starting from agent 6.6.0."

fn spec.agent.config.criSocket.withDockerSocketPath

withDockerSocketPath(dockerSocketPath)

"Path to the docker runtime socket."

obj spec.agent.config.dogstatsd

"Configure Dogstatsd."

fn spec.agent.config.dogstatsd.withDogstatsdOriginDetection

withDogstatsdOriginDetection(dogstatsdOriginDetection)

"Enable origin detection for container tagging. See also: https://docs.datadoghq.com/developers/dogstatsd/unix_socket/#using-origin-detection-for-container-tagging"

obj spec.agent.config.dogstatsd.mapperProfiles

"Configure the Dogstasd Mapper Profiles. Can be passed as raw data or via a json encoded string in a config map. See also: https://docs.datadoghq.com/developers/dogstatsd/dogstatsd_mapper/"

fn spec.agent.config.dogstatsd.mapperProfiles.withConfigData

withConfigData(configData)

"ConfigData corresponds to the configuration file content."

obj spec.agent.config.dogstatsd.mapperProfiles.configMap

"Enable to specify a reference to an already existing ConfigMap."

fn spec.agent.config.dogstatsd.mapperProfiles.configMap.withFileKey

withFileKey(fileKey)

"FileKey corresponds to the key used in the ConfigMap.Data to store the configuration file content."

fn spec.agent.config.dogstatsd.mapperProfiles.configMap.withName

withName(name)

"The name of source ConfigMap."

obj spec.agent.config.dogstatsd.unixDomainSocket

"Configure the Dogstatsd Unix Domain Socket. See also: https://docs.datadoghq.com/developers/dogstatsd/unix_socket/"

fn spec.agent.config.dogstatsd.unixDomainSocket.withEnabled

withEnabled(enabled)

"Enable APM over Unix Domain Socket. See also: https://docs.datadoghq.com/developers/dogstatsd/unix_socket/"

fn spec.agent.config.dogstatsd.unixDomainSocket.withHostFilepath

withHostFilepath(hostFilepath)

"Define the host APM socket filepath used when APM over Unix Domain Socket is enabled. (default value: /var/run/datadog/statsd.sock). See also: https://docs.datadoghq.com/developers/dogstatsd/unix_socket/"

obj spec.agent.config.env

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.config.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.agent.config.env.withValue

withValue(value)

"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 \"\"."

obj spec.agent.config.env.valueFrom

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

obj spec.agent.config.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.agent.config.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.agent.config.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.agent.config.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.agent.config.env.valueFrom.fieldRef

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

fn spec.agent.config.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.agent.config.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.agent.config.env.valueFrom.resourceFieldRef

"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."

fn spec.agent.config.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.agent.config.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.agent.config.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.agent.config.env.valueFrom.secretKeyRef

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

fn spec.agent.config.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.agent.config.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.agent.config.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.agent.config.kubelet

"KubeletConfig contains the Kubelet configuration parameters"

fn spec.agent.config.kubelet.withAgentCAPath

withAgentCAPath(agentCAPath)

"AgentCAPath is the container path where the kubelet CA certificate is stored. Default: '/var/run/host-kubelet-ca.crt' if hostCAPath is set, else '/var/run/secrets/kubernetes.io/serviceaccount/ca.crt'"

fn spec.agent.config.kubelet.withHostCAPath

withHostCAPath(hostCAPath)

"HostCAPath is the host path where the kubelet CA certificate is stored."

fn spec.agent.config.kubelet.withTlsVerify

withTlsVerify(tlsVerify)

"TLSVerify toggles kubelet TLS verification. Default: true"

obj spec.agent.config.kubelet.host

"Host overrides the host used to contact kubelet API (default to status.hostIP)."

obj spec.agent.config.kubelet.host.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.agent.config.kubelet.host.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.agent.config.kubelet.host.configMapKeyRef.withName

withName(name)

"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?"

fn spec.agent.config.kubelet.host.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.agent.config.kubelet.host.fieldRef

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

fn spec.agent.config.kubelet.host.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.agent.config.kubelet.host.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.agent.config.kubelet.host.resourceFieldRef

"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."

fn spec.agent.config.kubelet.host.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.agent.config.kubelet.host.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.agent.config.kubelet.host.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.agent.config.kubelet.host.secretKeyRef

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

fn spec.agent.config.kubelet.host.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.agent.config.kubelet.host.secretKeyRef.withName

withName(name)

"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?"

fn spec.agent.config.kubelet.host.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.agent.config.livenessProbe

"Configure the Liveness Probe of the Agent container"

fn spec.agent.config.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.agent.config.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.agent.config.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.agent.config.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.agent.config.livenessProbe.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset."

fn spec.agent.config.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.agent.config.livenessProbe.exec

"Exec specifies the action to take."

fn spec.agent.config.livenessProbe.exec.withCommand

withCommand(command)

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

fn spec.agent.config.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

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

Note: This function appends passed data to existing values

obj spec.agent.config.livenessProbe.grpc

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

fn spec.agent.config.livenessProbe.grpc.withPort

withPort(port)

"Port number of the gRPC service. Number must be in the range 1 to 65535."

fn spec.agent.config.livenessProbe.grpc.withService

withService(service)

"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."

obj spec.agent.config.livenessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.agent.config.livenessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.agent.config.livenessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.agent.config.livenessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.agent.config.livenessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.agent.config.livenessProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.agent.config.livenessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.agent.config.livenessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.agent.config.livenessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.agent.config.livenessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.agent.config.livenessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port."

fn spec.agent.config.livenessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.agent.config.livenessProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.agent.config.readinessProbe

"Configure the Readiness Probe of the Agent container"

fn spec.agent.config.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.agent.config.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.agent.config.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.agent.config.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.agent.config.readinessProbe.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset."

fn spec.agent.config.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.agent.config.readinessProbe.exec

"Exec specifies the action to take."

fn spec.agent.config.readinessProbe.exec.withCommand

withCommand(command)

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

fn spec.agent.config.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

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

Note: This function appends passed data to existing values

obj spec.agent.config.readinessProbe.grpc

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

fn spec.agent.config.readinessProbe.grpc.withPort

withPort(port)

"Port number of the gRPC service. Number must be in the range 1 to 65535."

fn spec.agent.config.readinessProbe.grpc.withService

withService(service)

"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."

obj spec.agent.config.readinessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.agent.config.readinessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.agent.config.readinessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.agent.config.readinessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.agent.config.readinessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.agent.config.readinessProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.agent.config.readinessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.agent.config.readinessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.agent.config.readinessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.agent.config.readinessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.agent.config.readinessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port."

fn spec.agent.config.readinessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.agent.config.readinessProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.agent.config.resources

"Datadog Agent resource requests and limits. Make sure to keep requests and limits equal to keep the pods in the Guaranteed QoS class. See also: http://kubernetes.io/docs/user-guide/compute-resources/"

fn spec.agent.config.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.agent.config.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.agent.config.resources.withRequests

withRequests(requests)

"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/"

fn spec.agent.config.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.agent.config.securityContext

"Pod-level SecurityContext."

fn spec.agent.config.securityContext.withFsGroup

withFsGroup(fsGroup)

"A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.config.securityContext.withFsGroupChangePolicy

withFsGroupChangePolicy(fsGroupChangePolicy)

"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.config.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.config.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.agent.config.securityContext.withRunAsUser

withRunAsUser(runAsUser)

"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.config.securityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.config.securityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows."

Note: This function appends passed data to existing values

fn spec.agent.config.securityContext.withSysctls

withSysctls(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.config.securityContext.withSysctlsMixin

withSysctlsMixin(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."

Note: This function appends passed data to existing values

obj spec.agent.config.securityContext.seLinuxOptions

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

fn spec.agent.config.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.agent.config.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.agent.config.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.agent.config.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.agent.config.securityContext.seccompProfile

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

fn spec.agent.config.securityContext.seccompProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"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\"."

fn spec.agent.config.securityContext.seccompProfile.withType

withType(type)

"type indicates which kind of seccomp profile will be applied. Valid options are: \n 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."

obj spec.agent.config.securityContext.sysctls

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.config.securityContext.sysctls.withName

withName(name)

"Name of a property to set"

fn spec.agent.config.securityContext.sysctls.withValue

withValue(value)

"Value of a property to set"

obj spec.agent.config.securityContext.windowsOptions

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

fn spec.agent.config.securityContext.windowsOptions.withGmsaCredentialSpec

withGmsaCredentialSpec(gmsaCredentialSpec)

"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."

fn spec.agent.config.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.agent.config.securityContext.windowsOptions.withHostProcess

withHostProcess(hostProcess)

"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."

fn spec.agent.config.securityContext.windowsOptions.withRunAsUserName

withRunAsUserName(runAsUserName)

"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."

obj spec.agent.config.tolerations

"If specified, the Agent pod's tolerations."

fn spec.agent.config.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.agent.config.tolerations.withKey

withKey(key)

"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."

fn spec.agent.config.tolerations.withOperator

withOperator(operator)

"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."

fn spec.agent.config.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"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."

fn spec.agent.config.tolerations.withValue

withValue(value)

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

obj spec.agent.config.volumeMounts

"Specify additional volume mounts in the Datadog Agent container."

fn spec.agent.config.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.agent.config.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"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."

fn spec.agent.config.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.agent.config.volumeMounts.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.agent.config.volumeMounts.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.agent.config.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"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."

obj spec.agent.config.volumes

"Specify additional volumes in the Datadog Agent container."

fn spec.agent.config.volumes.withName

withName(name)

"name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.agent.config.volumes.awsElasticBlockStore

"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"

fn spec.agent.config.volumes.awsElasticBlockStore.withFsType

withFsType(fsType)

"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.agent.config.volumes.awsElasticBlockStore.withPartition

withPartition(partition)

"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)."

fn spec.agent.config.volumes.awsElasticBlockStore.withReadOnly

withReadOnly(readOnly)

"readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

fn spec.agent.config.volumes.awsElasticBlockStore.withVolumeID

withVolumeID(volumeID)

"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

obj spec.agent.config.volumes.azureDisk

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

fn spec.agent.config.volumes.azureDisk.withCachingMode

withCachingMode(cachingMode)

"cachingMode is the Host Caching mode: None, Read Only, Read Write."

fn spec.agent.config.volumes.azureDisk.withDiskName

withDiskName(diskName)

"diskName is the Name of the data disk in the blob storage"

fn spec.agent.config.volumes.azureDisk.withDiskURI

withDiskURI(diskURI)

"diskURI is the URI of data disk in the blob storage"

fn spec.agent.config.volumes.azureDisk.withFsType

withFsType(fsType)

"fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.agent.config.volumes.azureDisk.withKind

withKind(kind)

"kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared"

fn spec.agent.config.volumes.azureDisk.withReadOnly

withReadOnly(readOnly)

"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.agent.config.volumes.azureFile

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

fn spec.agent.config.volumes.azureFile.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.agent.config.volumes.azureFile.withSecretName

withSecretName(secretName)

"secretName is the name of secret that contains Azure Storage Account Name and Key"

fn spec.agent.config.volumes.azureFile.withShareName

withShareName(shareName)

"shareName is the azure share Name"

obj spec.agent.config.volumes.cephfs

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

fn spec.agent.config.volumes.cephfs.withMonitors

withMonitors(monitors)

"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.agent.config.volumes.cephfs.withMonitorsMixin

withMonitorsMixin(monitors)

"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.cephfs.withPath

withPath(path)

"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /"

fn spec.agent.config.volumes.cephfs.withReadOnly

withReadOnly(readOnly)

"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.agent.config.volumes.cephfs.withSecretFile

withSecretFile(secretFile)

"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.agent.config.volumes.cephfs.withUser

withUser(user)

"user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

obj spec.agent.config.volumes.cephfs.secretRef

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

fn spec.agent.config.volumes.cephfs.secretRef.withName

withName(name)

"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?"

obj spec.agent.config.volumes.cinder

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

fn spec.agent.config.volumes.cinder.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.agent.config.volumes.cinder.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.agent.config.volumes.cinder.withVolumeID

withVolumeID(volumeID)

"volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

obj spec.agent.config.volumes.cinder.secretRef

"secretRef is optional: points to a secret object containing parameters used to connect to OpenStack."

fn spec.agent.config.volumes.cinder.secretRef.withName

withName(name)

"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?"

obj spec.agent.config.volumes.configMap

"configMap represents a configMap that should populate this volume"

fn spec.agent.config.volumes.configMap.withDefaultMode

withDefaultMode(defaultMode)

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

fn spec.agent.config.volumes.configMap.withItems

withItems(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.agent.config.volumes.configMap.withItemsMixin

withItemsMixin(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.configMap.withName

withName(name)

"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?"

fn spec.agent.config.volumes.configMap.withOptional

withOptional(optional)

"optional specify whether the ConfigMap or its keys must be defined"

obj spec.agent.config.volumes.configMap.items

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.agent.config.volumes.configMap.items.withKey

withKey(key)

"key is the key to project."

fn spec.agent.config.volumes.configMap.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.agent.config.volumes.configMap.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.agent.config.volumes.csi

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

fn spec.agent.config.volumes.csi.withDriver

withDriver(driver)

"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."

fn spec.agent.config.volumes.csi.withFsType

withFsType(fsType)

"fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply."

fn spec.agent.config.volumes.csi.withReadOnly

withReadOnly(readOnly)

"readOnly specifies a read-only configuration for the volume. Defaults to false (read/write)."

fn spec.agent.config.volumes.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

fn spec.agent.config.volumes.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

Note: This function appends passed data to existing values

obj spec.agent.config.volumes.csi.nodePublishSecretRef

"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."

fn spec.agent.config.volumes.csi.nodePublishSecretRef.withName

withName(name)

"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?"

obj spec.agent.config.volumes.downwardAPI

"downwardAPI represents downward API about the pod that should populate this volume"

fn spec.agent.config.volumes.downwardAPI.withDefaultMode

withDefaultMode(defaultMode)

"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."

fn spec.agent.config.volumes.downwardAPI.withItems

withItems(items)

"Items is a list of downward API volume file"

fn spec.agent.config.volumes.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of downward API volume file"

Note: This function appends passed data to existing values

obj spec.agent.config.volumes.downwardAPI.items

"Items is a list of downward API volume file"

fn spec.agent.config.volumes.downwardAPI.items.withMode

withMode(mode)

"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."

fn spec.agent.config.volumes.downwardAPI.items.withPath

withPath(path)

"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 '..'"

obj spec.agent.config.volumes.downwardAPI.items.fieldRef

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

fn spec.agent.config.volumes.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.agent.config.volumes.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.agent.config.volumes.downwardAPI.items.resourceFieldRef

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

fn spec.agent.config.volumes.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.agent.config.volumes.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.agent.config.volumes.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.agent.config.volumes.emptyDir

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

fn spec.agent.config.volumes.emptyDir.withMedium

withMedium(medium)

"medium represents what type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"

fn spec.agent.config.volumes.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

"sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir"

obj spec.agent.config.volumes.ephemeral

"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. \n 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). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n 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. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."

obj spec.agent.config.volumes.ephemeral.volumeClaimTemplate

"Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n 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. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.withMetadata

withMetadata(metadata)

"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."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.withMetadataMixin

withMetadataMixin(metadata)

"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."

Note: This function appends passed data to existing values

obj spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec

"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."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModes

withAccessModes(accessModes)

"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin

withAccessModesMixin(accessModes)

"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.withStorageClassName

withStorageClassName(storageClassName)

"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeMode

withVolumeMode(volumeMode)

"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeName

withVolumeName(volumeName)

"volumeName is the binding reference to the PersistentVolume backing this claim."

obj spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource

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

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup

withApiGroup(apiGroup)

"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."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef

"dataSourceRef 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. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup

withApiGroup(apiGroup)

"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."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources

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

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequests

withRequests(requests)

"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/"

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector

"selector is a label query over volumes to consider for binding."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.config.volumes.fc

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

fn spec.agent.config.volumes.fc.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.agent.config.volumes.fc.withLun

withLun(lun)

"lun is Optional: FC target lun number"

fn spec.agent.config.volumes.fc.withReadOnly

withReadOnly(readOnly)

"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.agent.config.volumes.fc.withTargetWWNs

withTargetWWNs(targetWWNs)

"targetWWNs is Optional: FC target worldwide names (WWNs)"

fn spec.agent.config.volumes.fc.withTargetWWNsMixin

withTargetWWNsMixin(targetWWNs)

"targetWWNs is Optional: FC target worldwide names (WWNs)"

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.fc.withWwids

withWwids(wwids)

"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

fn spec.agent.config.volumes.fc.withWwidsMixin

withWwidsMixin(wwids)

"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

Note: This function appends passed data to existing values

obj spec.agent.config.volumes.flexVolume

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

fn spec.agent.config.volumes.flexVolume.withDriver

withDriver(driver)

"driver is the name of the driver to use for this volume."

fn spec.agent.config.volumes.flexVolume.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script."

fn spec.agent.config.volumes.flexVolume.withOptions

withOptions(options)

"options is Optional: this field holds extra command options if any."

fn spec.agent.config.volumes.flexVolume.withOptionsMixin

withOptionsMixin(options)

"options is Optional: this field holds extra command options if any."

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.flexVolume.withReadOnly

withReadOnly(readOnly)

"readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.agent.config.volumes.flexVolume.secretRef

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

fn spec.agent.config.volumes.flexVolume.secretRef.withName

withName(name)

"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?"

obj spec.agent.config.volumes.flocker

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

fn spec.agent.config.volumes.flocker.withDatasetName

withDatasetName(datasetName)

"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated"

fn spec.agent.config.volumes.flocker.withDatasetUUID

withDatasetUUID(datasetUUID)

"datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset"

obj spec.agent.config.volumes.gcePersistentDisk

"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"

fn spec.agent.config.volumes.gcePersistentDisk.withFsType

withFsType(fsType)

"fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.agent.config.volumes.gcePersistentDisk.withPartition

withPartition(partition)

"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.agent.config.volumes.gcePersistentDisk.withPdName

withPdName(pdName)

"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.agent.config.volumes.gcePersistentDisk.withReadOnly

withReadOnly(readOnly)

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

obj spec.agent.config.volumes.gitRepo

"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."

fn spec.agent.config.volumes.gitRepo.withDirectory

withDirectory(directory)

"directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name."

fn spec.agent.config.volumes.gitRepo.withRepository

withRepository(repository)

"repository is the URL"

fn spec.agent.config.volumes.gitRepo.withRevision

withRevision(revision)

"revision is the commit hash for the specified revision."

obj spec.agent.config.volumes.glusterfs

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

fn spec.agent.config.volumes.glusterfs.withEndpoints

withEndpoints(endpoints)

"endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.agent.config.volumes.glusterfs.withPath

withPath(path)

"path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.agent.config.volumes.glusterfs.withReadOnly

withReadOnly(readOnly)

"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"

obj spec.agent.config.volumes.hostPath

"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."

fn spec.agent.config.volumes.hostPath.withPath

withPath(path)

"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"

fn spec.agent.config.volumes.hostPath.withType

withType(type)

"type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"

obj spec.agent.config.volumes.iscsi

"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"

fn spec.agent.config.volumes.iscsi.withChapAuthDiscovery

withChapAuthDiscovery(chapAuthDiscovery)

"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication"

fn spec.agent.config.volumes.iscsi.withChapAuthSession

withChapAuthSession(chapAuthSession)

"chapAuthSession defines whether support iSCSI Session CHAP authentication"

fn spec.agent.config.volumes.iscsi.withFsType

withFsType(fsType)

"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.agent.config.volumes.iscsi.withInitiatorName

withInitiatorName(initiatorName)

"initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection."

fn spec.agent.config.volumes.iscsi.withIqn

withIqn(iqn)

"iqn is the target iSCSI Qualified Name."

fn spec.agent.config.volumes.iscsi.withIscsiInterface

withIscsiInterface(iscsiInterface)

"iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp)."

fn spec.agent.config.volumes.iscsi.withLun

withLun(lun)

"lun represents iSCSI Target Lun number."

fn spec.agent.config.volumes.iscsi.withPortals

withPortals(portals)

"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

fn spec.agent.config.volumes.iscsi.withPortalsMixin

withPortalsMixin(portals)

"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.iscsi.withReadOnly

withReadOnly(readOnly)

"readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false."

fn spec.agent.config.volumes.iscsi.withTargetPortal

withTargetPortal(targetPortal)

"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

obj spec.agent.config.volumes.iscsi.secretRef

"secretRef is the CHAP Secret for iSCSI target and initiator authentication"

fn spec.agent.config.volumes.iscsi.secretRef.withName

withName(name)

"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?"

obj spec.agent.config.volumes.nfs

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

fn spec.agent.config.volumes.nfs.withPath

withPath(path)

"path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.agent.config.volumes.nfs.withReadOnly

withReadOnly(readOnly)

"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"

fn spec.agent.config.volumes.nfs.withServer

withServer(server)

"server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

obj spec.agent.config.volumes.persistentVolumeClaim

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

fn spec.agent.config.volumes.persistentVolumeClaim.withClaimName

withClaimName(claimName)

"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"

fn spec.agent.config.volumes.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

"readOnly Will force the ReadOnly setting in VolumeMounts. Default false."

obj spec.agent.config.volumes.photonPersistentDisk

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

fn spec.agent.config.volumes.photonPersistentDisk.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.agent.config.volumes.photonPersistentDisk.withPdID

withPdID(pdID)

"pdID is the ID that identifies Photon Controller persistent disk"

obj spec.agent.config.volumes.portworxVolume

"portworxVolume represents a portworx volume attached and mounted on kubelets host machine"

fn spec.agent.config.volumes.portworxVolume.withFsType

withFsType(fsType)

"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."

fn spec.agent.config.volumes.portworxVolume.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.agent.config.volumes.portworxVolume.withVolumeID

withVolumeID(volumeID)

"volumeID uniquely identifies a Portworx volume"

obj spec.agent.config.volumes.projected

"projected items for all in one resources secrets, configmaps, and downward API"

fn spec.agent.config.volumes.projected.withDefaultMode

withDefaultMode(defaultMode)

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

fn spec.agent.config.volumes.projected.withSources

withSources(sources)

"sources is the list of volume projections"

fn spec.agent.config.volumes.projected.withSourcesMixin

withSourcesMixin(sources)

"sources is the list of volume projections"

Note: This function appends passed data to existing values

obj spec.agent.config.volumes.projected.sources

"sources is the list of volume projections"

obj spec.agent.config.volumes.projected.sources.configMap

"configMap information about the configMap data to project"

fn spec.agent.config.volumes.projected.sources.configMap.withItems

withItems(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.agent.config.volumes.projected.sources.configMap.withItemsMixin

withItemsMixin(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.projected.sources.configMap.withName

withName(name)

"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?"

fn spec.agent.config.volumes.projected.sources.configMap.withOptional

withOptional(optional)

"optional specify whether the ConfigMap or its keys must be defined"

obj spec.agent.config.volumes.projected.sources.configMap.items

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.agent.config.volumes.projected.sources.configMap.items.withKey

withKey(key)

"key is the key to project."

fn spec.agent.config.volumes.projected.sources.configMap.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.agent.config.volumes.projected.sources.configMap.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.agent.config.volumes.projected.sources.downwardAPI

"downwardAPI information about the downwardAPI data to project"

fn spec.agent.config.volumes.projected.sources.downwardAPI.withItems

withItems(items)

"Items is a list of DownwardAPIVolume file"

fn spec.agent.config.volumes.projected.sources.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of DownwardAPIVolume file"

Note: This function appends passed data to existing values

obj spec.agent.config.volumes.projected.sources.downwardAPI.items

"Items is a list of DownwardAPIVolume file"

fn spec.agent.config.volumes.projected.sources.downwardAPI.items.withMode

withMode(mode)

"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."

fn spec.agent.config.volumes.projected.sources.downwardAPI.items.withPath

withPath(path)

"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 '..'"

obj spec.agent.config.volumes.projected.sources.downwardAPI.items.fieldRef

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

fn spec.agent.config.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.agent.config.volumes.projected.sources.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.agent.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef

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

fn spec.agent.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.agent.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.agent.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.agent.config.volumes.projected.sources.secret

"secret information about the secret data to project"

fn spec.agent.config.volumes.projected.sources.secret.withItems

withItems(items)

"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.agent.config.volumes.projected.sources.secret.withItemsMixin

withItemsMixin(items)

"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.projected.sources.secret.withName

withName(name)

"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?"

fn spec.agent.config.volumes.projected.sources.secret.withOptional

withOptional(optional)

"optional field specify whether the Secret or its key must be defined"

obj spec.agent.config.volumes.projected.sources.secret.items

"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.agent.config.volumes.projected.sources.secret.items.withKey

withKey(key)

"key is the key to project."

fn spec.agent.config.volumes.projected.sources.secret.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.agent.config.volumes.projected.sources.secret.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.agent.config.volumes.projected.sources.serviceAccountToken

"serviceAccountToken is information about the serviceAccountToken data to project"

fn spec.agent.config.volumes.projected.sources.serviceAccountToken.withAudience

withAudience(audience)

"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."

fn spec.agent.config.volumes.projected.sources.serviceAccountToken.withExpirationSeconds

withExpirationSeconds(expirationSeconds)

"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."

fn spec.agent.config.volumes.projected.sources.serviceAccountToken.withPath

withPath(path)

"path is the path relative to the mount point of the file to project the token into."

obj spec.agent.config.volumes.quobyte

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

fn spec.agent.config.volumes.quobyte.withGroup

withGroup(group)

"group to map volume access to Default is no group"

fn spec.agent.config.volumes.quobyte.withReadOnly

withReadOnly(readOnly)

"readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false."

fn spec.agent.config.volumes.quobyte.withRegistry

withRegistry(registry)

"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"

fn spec.agent.config.volumes.quobyte.withTenant

withTenant(tenant)

"tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin"

fn spec.agent.config.volumes.quobyte.withUser

withUser(user)

"user to map volume access to Defaults to serivceaccount user"

fn spec.agent.config.volumes.quobyte.withVolume

withVolume(volume)

"volume is a string that references an already created Quobyte volume by name."

obj spec.agent.config.volumes.rbd

"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"

fn spec.agent.config.volumes.rbd.withFsType

withFsType(fsType)

"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.agent.config.volumes.rbd.withImage

withImage(image)

"image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.agent.config.volumes.rbd.withKeyring

withKeyring(keyring)

"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"

fn spec.agent.config.volumes.rbd.withMonitors

withMonitors(monitors)

"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.agent.config.volumes.rbd.withMonitorsMixin

withMonitorsMixin(monitors)

"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.rbd.withPool

withPool(pool)

"pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.agent.config.volumes.rbd.withReadOnly

withReadOnly(readOnly)

"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"

fn spec.agent.config.volumes.rbd.withUser

withUser(user)

"user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

obj spec.agent.config.volumes.rbd.secretRef

"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"

fn spec.agent.config.volumes.rbd.secretRef.withName

withName(name)

"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?"

obj spec.agent.config.volumes.scaleIO

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

fn spec.agent.config.volumes.scaleIO.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\"."

fn spec.agent.config.volumes.scaleIO.withGateway

withGateway(gateway)

"gateway is the host address of the ScaleIO API Gateway."

fn spec.agent.config.volumes.scaleIO.withProtectionDomain

withProtectionDomain(protectionDomain)

"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage."

fn spec.agent.config.volumes.scaleIO.withReadOnly

withReadOnly(readOnly)

"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.agent.config.volumes.scaleIO.withSslEnabled

withSslEnabled(sslEnabled)

"sslEnabled Flag enable/disable SSL communication with Gateway, default false"

fn spec.agent.config.volumes.scaleIO.withStorageMode

withStorageMode(storageMode)

"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned."

fn spec.agent.config.volumes.scaleIO.withStoragePool

withStoragePool(storagePool)

"storagePool is the ScaleIO Storage Pool associated with the protection domain."

fn spec.agent.config.volumes.scaleIO.withSystem

withSystem(system)

"system is the name of the storage system as configured in ScaleIO."

fn spec.agent.config.volumes.scaleIO.withVolumeName

withVolumeName(volumeName)

"volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source."

obj spec.agent.config.volumes.scaleIO.secretRef

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

fn spec.agent.config.volumes.scaleIO.secretRef.withName

withName(name)

"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?"

obj spec.agent.config.volumes.secret

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

fn spec.agent.config.volumes.secret.withDefaultMode

withDefaultMode(defaultMode)

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

fn spec.agent.config.volumes.secret.withItems

withItems(items)

"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.agent.config.volumes.secret.withItemsMixin

withItemsMixin(items)

"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.agent.config.volumes.secret.withOptional

withOptional(optional)

"optional field specify whether the Secret or its keys must be defined"

fn spec.agent.config.volumes.secret.withSecretName

withSecretName(secretName)

"secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"

obj spec.agent.config.volumes.secret.items

"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.agent.config.volumes.secret.items.withKey

withKey(key)

"key is the key to project."

fn spec.agent.config.volumes.secret.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.agent.config.volumes.secret.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.agent.config.volumes.storageos

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

fn spec.agent.config.volumes.storageos.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.agent.config.volumes.storageos.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.agent.config.volumes.storageos.withVolumeName

withVolumeName(volumeName)

"volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace."

fn spec.agent.config.volumes.storageos.withVolumeNamespace

withVolumeNamespace(volumeNamespace)

"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."

obj spec.agent.config.volumes.storageos.secretRef

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

fn spec.agent.config.volumes.storageos.secretRef.withName

withName(name)

"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?"

obj spec.agent.config.volumes.vsphereVolume

"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"

fn spec.agent.config.volumes.vsphereVolume.withFsType

withFsType(fsType)

"fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.agent.config.volumes.vsphereVolume.withStoragePolicyID

withStoragePolicyID(storagePolicyID)

"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."

fn spec.agent.config.volumes.vsphereVolume.withStoragePolicyName

withStoragePolicyName(storagePolicyName)

"storagePolicyName is the storage Policy Based Management (SPBM) profile name."

fn spec.agent.config.volumes.vsphereVolume.withVolumePath

withVolumePath(volumePath)

"volumePath is the path that identifies vSphere volume vmdk"

obj spec.agent.customConfig

"Allow to put custom configuration for the agent, corresponding to the datadog.yaml config file. See https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6 for more details."

fn spec.agent.customConfig.withConfigData

withConfigData(configData)

"ConfigData corresponds to the configuration file content."

obj spec.agent.customConfig.configMap

"Enable to specify a reference to an already existing ConfigMap."

fn spec.agent.customConfig.configMap.withFileKey

withFileKey(fileKey)

"FileKey corresponds to the key used in the ConfigMap.Data to store the configuration file content."

fn spec.agent.customConfig.configMap.withName

withName(name)

"The name of source ConfigMap."

obj spec.agent.deploymentStrategy

"Update strategy configuration for the DaemonSet."

fn spec.agent.deploymentStrategy.withReconcileFrequency

withReconcileFrequency(reconcileFrequency)

"The reconcile frequency of the ExtendDaemonSet."

fn spec.agent.deploymentStrategy.withUpdateStrategyType

withUpdateStrategyType(updateStrategyType)

"The update strategy used for the DaemonSet."

obj spec.agent.deploymentStrategy.canary

"Configure the canary deployment configuration using ExtendedDaemonSet."

fn spec.agent.deploymentStrategy.canary.withDuration

withDuration(duration)

fn spec.agent.deploymentStrategy.canary.withNoRestartsDuration

withNoRestartsDuration(noRestartsDuration)

"NoRestartsDuration defines min duration since last restart to end the canary phase."

fn spec.agent.deploymentStrategy.canary.withNodeAntiAffinityKeys

withNodeAntiAffinityKeys(nodeAntiAffinityKeys)

fn spec.agent.deploymentStrategy.canary.withNodeAntiAffinityKeysMixin

withNodeAntiAffinityKeysMixin(nodeAntiAffinityKeys)

Note: This function appends passed data to existing values

fn spec.agent.deploymentStrategy.canary.withReplicas

withReplicas(replicas)

fn spec.agent.deploymentStrategy.canary.withValidationMode

withValidationMode(validationMode)

"ValidationMode used to configure how a canary deployment is validated. Possible values are 'auto' (default) and 'manual'"

obj spec.agent.deploymentStrategy.canary.autoFail

"ExtendedDaemonSetSpecStrategyCanaryAutoFail defines the canary deployment AutoFail parameters of the ExtendedDaemonSet."

fn spec.agent.deploymentStrategy.canary.autoFail.withCanaryTimeout

withCanaryTimeout(canaryTimeout)

"CanaryTimeout defines the maximum duration of a Canary, after which the Canary deployment is autofailed. This is a safeguard against lengthy Canary pauses. There is no default value."

fn spec.agent.deploymentStrategy.canary.autoFail.withEnabled

withEnabled(enabled)

"Enabled enables AutoFail. Default value is true."

fn spec.agent.deploymentStrategy.canary.autoFail.withMaxRestarts

withMaxRestarts(maxRestarts)

"MaxRestarts defines the number of tolerable (per pod) Canary pod restarts after which the Canary deployment is autofailed. Default value is 5."

fn spec.agent.deploymentStrategy.canary.autoFail.withMaxRestartsDuration

withMaxRestartsDuration(maxRestartsDuration)

"MaxRestartsDuration defines the maximum duration of tolerable Canary pod restarts after which the Canary deployment is autofailed. There is no default value."

obj spec.agent.deploymentStrategy.canary.autoPause

"ExtendedDaemonSetSpecStrategyCanaryAutoPause defines the canary deployment AutoPause parameters of the ExtendedDaemonSet."

fn spec.agent.deploymentStrategy.canary.autoPause.withEnabled

withEnabled(enabled)

"Enabled enables AutoPause. Default value is true."

fn spec.agent.deploymentStrategy.canary.autoPause.withMaxRestarts

withMaxRestarts(maxRestarts)

"MaxRestarts defines the number of tolerable (per pod) Canary pod restarts after which the Canary deployment is autopaused. Default value is 2."

fn spec.agent.deploymentStrategy.canary.autoPause.withMaxSlowStartDuration

withMaxSlowStartDuration(maxSlowStartDuration)

"MaxSlowStartDuration defines the maximum slow start duration for a pod (stuck in Creating state) after which the Canary deployment is autopaused. There is no default value."

obj spec.agent.deploymentStrategy.canary.nodeSelector

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

fn spec.agent.deploymentStrategy.canary.nodeSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.deploymentStrategy.canary.nodeSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.deploymentStrategy.canary.nodeSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.deploymentStrategy.canary.nodeSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.deploymentStrategy.canary.nodeSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.deploymentStrategy.canary.nodeSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.deploymentStrategy.canary.nodeSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.deploymentStrategy.canary.nodeSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.deploymentStrategy.canary.nodeSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.deploymentStrategy.rollingUpdate

"Configure the rolling updater strategy of the DaemonSet or the ExtendedDaemonSet."

fn spec.agent.deploymentStrategy.rollingUpdate.withMaxParallelPodCreation

withMaxParallelPodCreation(maxParallelPodCreation)

"The maximum number of pods created in parallel. Default value is 250."

fn spec.agent.deploymentStrategy.rollingUpdate.withMaxPodSchedulerFailure

withMaxPodSchedulerFailure(maxPodSchedulerFailure)

"MaxPodSchedulerFailure the maximum number of not scheduled on its Node due to a scheduler failure: resource constraints. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute"

fn spec.agent.deploymentStrategy.rollingUpdate.withMaxUnavailable

withMaxUnavailable(maxUnavailable)

"The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1."

fn spec.agent.deploymentStrategy.rollingUpdate.withSlowStartAdditiveIncrease

withSlowStartAdditiveIncrease(slowStartAdditiveIncrease)

"SlowStartAdditiveIncrease Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Default value is 5."

fn spec.agent.deploymentStrategy.rollingUpdate.withSlowStartIntervalDuration

withSlowStartIntervalDuration(slowStartIntervalDuration)

"SlowStartIntervalDuration the duration between to 2 Default value is 1min."

obj spec.agent.dnsConfig

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

fn spec.agent.dnsConfig.withNameservers

withNameservers(nameservers)

"A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed."

fn spec.agent.dnsConfig.withNameserversMixin

withNameserversMixin(nameservers)

"A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed."

Note: This function appends passed data to existing values

fn spec.agent.dnsConfig.withOptions

withOptions(options)

"A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy."

fn spec.agent.dnsConfig.withOptionsMixin

withOptionsMixin(options)

"A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy."

Note: This function appends passed data to existing values

fn spec.agent.dnsConfig.withSearches

withSearches(searches)

"A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed."

fn spec.agent.dnsConfig.withSearchesMixin

withSearchesMixin(searches)

"A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed."

Note: This function appends passed data to existing values

obj spec.agent.dnsConfig.options

"A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy."

fn spec.agent.dnsConfig.options.withName

withName(name)

"Required."

fn spec.agent.dnsConfig.options.withValue

withValue(value)

obj spec.agent.env

"Environment variables for all Datadog Agents. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.agent.env.withValue

withValue(value)

"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 \"\"."

obj spec.agent.env.valueFrom

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

obj spec.agent.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.agent.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.agent.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.agent.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.agent.env.valueFrom.fieldRef

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

fn spec.agent.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.agent.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.agent.env.valueFrom.resourceFieldRef

"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."

fn spec.agent.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.agent.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.agent.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.agent.env.valueFrom.secretKeyRef

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

fn spec.agent.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.agent.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.agent.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.agent.image

"The container image of the Datadog Agent."

fn spec.agent.image.withJmxEnabled

withJmxEnabled(jmxEnabled)

"Define whether the Agent image should support JMX. To be used if the Name field does not correspond to a full image string."

fn spec.agent.image.withName

withName(name)

"Define the image to use: Use \"gcr.io/datadoghq/agent:latest\" for Datadog Agent 7. Use \"datadog/dogstatsd:latest\" for standalone Datadog Agent DogStatsD 7. Use \"gcr.io/datadoghq/cluster-agent:latest\" for Datadog Cluster Agent. Use \"agent\" with the registry and tag configurations for /agent:. Use \"cluster-agent\" with the registry and tag configurations for /cluster-agent:. If the name is the full image string—<name>:<tag> or <registry>/<name>:<tag>, then tag, jmxEnabled, and global.registry values are ignored. Otherwise, image string is created by overriding default settings with supplied name, tag, and jmxEnabled values; image string is created using default registry unless global.registry is configured."

fn spec.agent.image.withPullPolicy

withPullPolicy(pullPolicy)

"The Kubernetes pull policy: Use Always, Never, or IfNotPresent."

fn spec.agent.image.withPullSecrets

withPullSecrets(pullSecrets)

"It is possible to specify Docker registry credentials. See https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

fn spec.agent.image.withPullSecretsMixin

withPullSecretsMixin(pullSecrets)

"It is possible to specify Docker registry credentials. See https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

Note: This function appends passed data to existing values

fn spec.agent.image.withTag

withTag(tag)

"Define the image tag to use. To be used if the Name field does not correspond to a full image string."

obj spec.agent.image.pullSecrets

"It is possible to specify Docker registry credentials. See https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

fn spec.agent.image.pullSecrets.withName

withName(name)

"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?"

obj spec.agent.localService

"Options to customize the internal traffic policy service"

fn spec.agent.localService.withForceLocalServiceEnable

withForceLocalServiceEnable(forceLocalServiceEnable)

"Force the creation of the internal traffic policy service to target the agent running on the local node. By default, the internal traffic service is created only on Kubernetes 1.22+ where the feature became beta and enabled by default. This option allows to force the creation of the internal traffic service on kubernetes 1.21 where the feature was alpha and required a feature gate to be explicitly enabled."

fn spec.agent.localService.withOverrideName

withOverrideName(overrideName)

"Name of the internal traffic service to target the agent running on the local node"

obj spec.agent.log

"Log Agent configuration"

fn spec.agent.log.withContainerCollectUsingFiles

withContainerCollectUsingFiles(containerCollectUsingFiles)

"Collect logs from files in /var/log/pods instead of using the container runtime API. Collecting logs from files is usually the most efficient way of collecting logs. See also: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup Default is true"

fn spec.agent.log.withContainerLogsPath

withContainerLogsPath(containerLogsPath)

"Allows log collection from the container log path. Set to a different path if you are not using the Docker runtime. See also: https://docs.datadoghq.com/agent/kubernetes/daemonset_setup/?tab=k8sfile#create-manifest Defaults to /var/lib/docker/containers"

fn spec.agent.log.withContainerSymlinksPath

withContainerSymlinksPath(containerSymlinksPath)

"Allows the log collection to use symbolic links in this directory to validate container ID -> pod. Defaults to /var/log/containers"

fn spec.agent.log.withEnabled

withEnabled(enabled)

"Enable this option to activate Datadog Agent log collection. See also: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup"

fn spec.agent.log.withLogsConfigContainerCollectAll

withLogsConfigContainerCollectAll(logsConfigContainerCollectAll)

"Enable this option to allow log collection for all containers. See also: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup"

fn spec.agent.log.withOpenFilesLimit

withOpenFilesLimit(openFilesLimit)

"Sets the maximum number of log files that the Datadog Agent tails. Increasing this limit can increase resource consumption of the Agent. See also: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup Default is 100"

fn spec.agent.log.withPodLogsPath

withPodLogsPath(podLogsPath)

"Allows log collection from pod log path. Defaults to /var/log/pods."

fn spec.agent.log.withTempStoragePath

withTempStoragePath(tempStoragePath)

"This path (always mounted from the host) is used by Datadog Agent to store information about processed log files. If the Datadog Agent is restarted, it starts tailing the log files immediately. Default to /var/lib/datadog-agent/logs"

obj spec.agent.networkPolicy

"Provide Agent Network Policy configuration"

fn spec.agent.networkPolicy.withCreate

withCreate(create)

"If true, create a NetworkPolicy for the current agent."

fn spec.agent.networkPolicy.withDnsSelectorEndpoints

withDnsSelectorEndpoints(dnsSelectorEndpoints)

"Cilium selector of the DNS\u202fserver entity."

fn spec.agent.networkPolicy.withDnsSelectorEndpointsMixin

withDnsSelectorEndpointsMixin(dnsSelectorEndpoints)

"Cilium selector of the DNS\u202fserver entity."

Note: This function appends passed data to existing values

fn spec.agent.networkPolicy.withFlavor

withFlavor(flavor)

"Which network policy to use. Can be kubernetes or cilium."

obj spec.agent.networkPolicy.dnsSelectorEndpoints

"Cilium selector of the DNS\u202fserver entity."

fn spec.agent.networkPolicy.dnsSelectorEndpoints.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.networkPolicy.dnsSelectorEndpoints.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.agent.networkPolicy.dnsSelectorEndpoints.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.agent.networkPolicy.dnsSelectorEndpoints.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.agent.networkPolicy.dnsSelectorEndpoints.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.agent.networkPolicy.dnsSelectorEndpoints.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.agent.networkPolicy.dnsSelectorEndpoints.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.agent.networkPolicy.dnsSelectorEndpoints.matchExpressions.withValues

withValues(values)

"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."

fn spec.agent.networkPolicy.dnsSelectorEndpoints.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.agent.otlp

"OTLP ingest configuration"

obj spec.agent.otlp.receiver

"Receiver contains configuration for the OTLP ingest receiver."

obj spec.agent.otlp.receiver.protocols

"Protocols contains configuration for the OTLP ingest receiver protocols."

obj spec.agent.otlp.receiver.protocols.grpc

"GRPC contains configuration for the OTLP ingest OTLP/gRPC receiver."

fn spec.agent.otlp.receiver.protocols.grpc.withEnabled

withEnabled(enabled)

"Enable the OTLP/gRPC endpoint."

fn spec.agent.otlp.receiver.protocols.grpc.withEndpoint

withEndpoint(endpoint)

"Endpoint for OTLP/gRPC. gRPC supports several naming schemes: https://github.com/grpc/grpc/blob/master/doc/naming.md The Datadog Operator supports only 'host:port' (usually '0.0.0.0:port'). Default: '0.0.0.0:4317'."

obj spec.agent.otlp.receiver.protocols.http

"HTTP contains configuration for the OTLP ingest OTLP/HTTP receiver."

fn spec.agent.otlp.receiver.protocols.http.withEnabled

withEnabled(enabled)

"Enable the OTLP/HTTP endpoint."

fn spec.agent.otlp.receiver.protocols.http.withEndpoint

withEndpoint(endpoint)

"Endpoint for OTLP/HTTP. Default: '0.0.0.0:4318'."

obj spec.agent.process

"Process Agent configuration"

fn spec.agent.process.withArgs

withArgs(args)

"Args allows the specification of extra args to Command parameter"

fn spec.agent.process.withArgsMixin

withArgsMixin(args)

"Args allows the specification of extra args to Command parameter"

Note: This function appends passed data to existing values

fn spec.agent.process.withCommand

withCommand(command)

"Command allows the specification of custom entrypoint for Process Agent container"

fn spec.agent.process.withCommandMixin

withCommandMixin(command)

"Command allows the specification of custom entrypoint for Process Agent container"

Note: This function appends passed data to existing values

fn spec.agent.process.withEnabled

withEnabled(enabled)

"Enable the Process Agent container. See also: https://docs.datadoghq.com/infrastructure/process/?tab=kubernetes#installation"

fn spec.agent.process.withEnv

withEnv(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.process.withEnvMixin

withEnvMixin(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

Note: This function appends passed data to existing values

fn spec.agent.process.withProcessCollectionEnabled

withProcessCollectionEnabled(processCollectionEnabled)

"false (default): Only collect containers if available. true: collect process information as well. Note: If enabled, /etc/passwd is automatically mounted to allow username resolution."

fn spec.agent.process.withVolumeMounts

withVolumeMounts(volumeMounts)

"Specify additional volume mounts in the Process Agent container."

fn spec.agent.process.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Specify additional volume mounts in the Process Agent container."

Note: This function appends passed data to existing values

obj spec.agent.process.env

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.process.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.agent.process.env.withValue

withValue(value)

"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 \"\"."

obj spec.agent.process.env.valueFrom

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

obj spec.agent.process.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.agent.process.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.agent.process.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.agent.process.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.agent.process.env.valueFrom.fieldRef

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

fn spec.agent.process.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.agent.process.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.agent.process.env.valueFrom.resourceFieldRef

"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."

fn spec.agent.process.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.agent.process.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.agent.process.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.agent.process.env.valueFrom.secretKeyRef

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

fn spec.agent.process.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.agent.process.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.agent.process.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.agent.process.resources

"Datadog Process Agent resource requests and limits. Make sure to keep requests and limits equal to keep the pods in the Guaranteed QoS class. See also: http://kubernetes.io/docs/user-guide/compute-resources/"

fn spec.agent.process.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.agent.process.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.agent.process.resources.withRequests

withRequests(requests)

"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/"

fn spec.agent.process.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.agent.process.volumeMounts

"Specify additional volume mounts in the Process Agent container."

fn spec.agent.process.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.agent.process.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"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."

fn spec.agent.process.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.agent.process.volumeMounts.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.agent.process.volumeMounts.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.agent.process.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"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."

obj spec.agent.rbac

"RBAC configuration of the Agent."

fn spec.agent.rbac.withCreate

withCreate(create)

"Used to configure RBAC resources creation."

fn spec.agent.rbac.withServiceAccountName

withServiceAccountName(serviceAccountName)

"Used to set up the service account name to use. Ignored if the field Create is true."

obj spec.agent.security

"Security Agent configuration"

fn spec.agent.security.withArgs

withArgs(args)

"Args allows the specification of extra args to Command parameter"

fn spec.agent.security.withArgsMixin

withArgsMixin(args)

"Args allows the specification of extra args to Command parameter"

Note: This function appends passed data to existing values

fn spec.agent.security.withCommand

withCommand(command)

"Command allows the specification of custom entrypoint for Security Agent container"

fn spec.agent.security.withCommandMixin

withCommandMixin(command)

"Command allows the specification of custom entrypoint for Security Agent container"

Note: This function appends passed data to existing values

fn spec.agent.security.withEnv

withEnv(env)

"The Datadog Security Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.security.withEnvMixin

withEnvMixin(env)

"The Datadog Security Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

Note: This function appends passed data to existing values

fn spec.agent.security.withVolumeMounts

withVolumeMounts(volumeMounts)

"Specify additional volume mounts in the Security Agent container."

fn spec.agent.security.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Specify additional volume mounts in the Security Agent container."

Note: This function appends passed data to existing values

obj spec.agent.security.compliance

"Compliance configuration."

fn spec.agent.security.compliance.withCheckInterval

withCheckInterval(checkInterval)

"Check interval."

fn spec.agent.security.compliance.withEnabled

withEnabled(enabled)

"Enables continuous compliance monitoring."

obj spec.agent.security.compliance.configDir

"Config dir containing compliance benchmarks."

fn spec.agent.security.compliance.configDir.withConfigMapName

withConfigMapName(configMapName)

"ConfigMapName name of a ConfigMap used to mount a directory."

fn spec.agent.security.compliance.configDir.withItems

withItems(items)

"items mapping between configMap data key and file path mount."

fn spec.agent.security.compliance.configDir.withItemsMixin

withItemsMixin(items)

"items mapping between configMap data key and file path mount."

Note: This function appends passed data to existing values

obj spec.agent.security.compliance.configDir.items

"items mapping between configMap data key and file path mount."

fn spec.agent.security.compliance.configDir.items.withKey

withKey(key)

"key is the key to project."

fn spec.agent.security.compliance.configDir.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.agent.security.compliance.configDir.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.agent.security.env

"The Datadog Security Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.security.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.agent.security.env.withValue

withValue(value)

"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 \"\"."

obj spec.agent.security.env.valueFrom

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

obj spec.agent.security.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.agent.security.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.agent.security.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.agent.security.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.agent.security.env.valueFrom.fieldRef

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

fn spec.agent.security.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.agent.security.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.agent.security.env.valueFrom.resourceFieldRef

"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."

fn spec.agent.security.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.agent.security.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.agent.security.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.agent.security.env.valueFrom.secretKeyRef

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

fn spec.agent.security.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.agent.security.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.agent.security.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.agent.security.resources

"Datadog Security Agent resource requests and limits. Make sure to keep requests and limits equal to keep the pods in the Guaranteed QoS class. See also: http://kubernetes.io/docs/user-guide/compute-resources/"

fn spec.agent.security.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.agent.security.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.agent.security.resources.withRequests

withRequests(requests)

"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/"

fn spec.agent.security.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.agent.security.runtime

"Runtime security configuration."

fn spec.agent.security.runtime.withEnabled

withEnabled(enabled)

"Enables runtime security features."

obj spec.agent.security.runtime.policiesDir

"ConfigDir containing security policies."

fn spec.agent.security.runtime.policiesDir.withConfigMapName

withConfigMapName(configMapName)

"ConfigMapName name of a ConfigMap used to mount a directory."

fn spec.agent.security.runtime.policiesDir.withItems

withItems(items)

"items mapping between configMap data key and file path mount."

fn spec.agent.security.runtime.policiesDir.withItemsMixin

withItemsMixin(items)

"items mapping between configMap data key and file path mount."

Note: This function appends passed data to existing values

obj spec.agent.security.runtime.policiesDir.items

"items mapping between configMap data key and file path mount."

fn spec.agent.security.runtime.policiesDir.items.withKey

withKey(key)

"key is the key to project."

fn spec.agent.security.runtime.policiesDir.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.agent.security.runtime.policiesDir.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.agent.security.runtime.syscallMonitor

"Syscall monitor configuration."

fn spec.agent.security.runtime.syscallMonitor.withEnabled

withEnabled(enabled)

"Enabled enables syscall monitor"

obj spec.agent.security.volumeMounts

"Specify additional volume mounts in the Security Agent container."

fn spec.agent.security.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.agent.security.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"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."

fn spec.agent.security.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.agent.security.volumeMounts.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.agent.security.volumeMounts.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.agent.security.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"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."

obj spec.agent.systemProbe

"SystemProbe configuration"

fn spec.agent.systemProbe.withAppArmorProfileName

withAppArmorProfileName(appArmorProfileName)

"AppArmorProfileName specify a apparmor profile."

fn spec.agent.systemProbe.withArgs

withArgs(args)

"Args allows the specification of extra args to Command parameter"

fn spec.agent.systemProbe.withArgsMixin

withArgsMixin(args)

"Args allows the specification of extra args to Command parameter"

Note: This function appends passed data to existing values

fn spec.agent.systemProbe.withBpfDebugEnabled

withBpfDebugEnabled(bpfDebugEnabled)

"BPFDebugEnabled logging for kernel debug."

fn spec.agent.systemProbe.withCollectDNSStats

withCollectDNSStats(collectDNSStats)

"CollectDNSStats enables DNS stat collection."

fn spec.agent.systemProbe.withCommand

withCommand(command)

"Command allows the specification of custom entrypoint for System Probe container"

fn spec.agent.systemProbe.withCommandMixin

withCommandMixin(command)

"Command allows the specification of custom entrypoint for System Probe container"

Note: This function appends passed data to existing values

fn spec.agent.systemProbe.withConntrackEnabled

withConntrackEnabled(conntrackEnabled)

"ConntrackEnabled enable the system-probe agent to connect to the netlink/conntrack subsystem to add NAT information to connection data. See also: http://conntrack-tools.netfilter.org/"

fn spec.agent.systemProbe.withDebugPort

withDebugPort(debugPort)

"DebugPort Specify the port to expose pprof and expvar for system-probe agent."

fn spec.agent.systemProbe.withEnableOOMKill

withEnableOOMKill(enableOOMKill)

"EnableOOMKill enables the OOM kill eBPF-based check."

fn spec.agent.systemProbe.withEnableTCPQueueLength

withEnableTCPQueueLength(enableTCPQueueLength)

"EnableTCPQueueLength enables the TCP queue length eBPF-based check."

fn spec.agent.systemProbe.withEnabled

withEnabled(enabled)

"Enable this to activate live process monitoring. Note: /etc/passwd is automatically mounted to allow username resolution. See also: https://docs.datadoghq.com/infrastructure/process/?tab=kubernetes#installation"

fn spec.agent.systemProbe.withEnv

withEnv(env)

"The Datadog SystemProbe supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.systemProbe.withEnvMixin

withEnvMixin(env)

"The Datadog SystemProbe supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

Note: This function appends passed data to existing values

fn spec.agent.systemProbe.withSecCompCustomProfileConfigMap

withSecCompCustomProfileConfigMap(secCompCustomProfileConfigMap)

"SecCompCustomProfileConfigMap specify a pre-existing ConfigMap containing a custom SecComp profile. This ConfigMap must contain a file named system-probe-seccomp.json."

fn spec.agent.systemProbe.withSecCompProfileName

withSecCompProfileName(secCompProfileName)

"SecCompProfileName specify a seccomp profile."

fn spec.agent.systemProbe.withSecCompRootPath

withSecCompRootPath(secCompRootPath)

"SecCompRootPath specify the seccomp profile root directory."

fn spec.agent.systemProbe.withVolumeMounts

withVolumeMounts(volumeMounts)

"Specify additional volume mounts in the Security Agent container."

fn spec.agent.systemProbe.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Specify additional volume mounts in the Security Agent container."

Note: This function appends passed data to existing values

obj spec.agent.systemProbe.customConfig

"Enable custom configuration for system-probe, corresponding to the system-probe.yaml config file. This custom configuration has less priority than all settings above."

fn spec.agent.systemProbe.customConfig.withConfigData

withConfigData(configData)

"ConfigData corresponds to the configuration file content."

obj spec.agent.systemProbe.customConfig.configMap

"Enable to specify a reference to an already existing ConfigMap."

fn spec.agent.systemProbe.customConfig.configMap.withFileKey

withFileKey(fileKey)

"FileKey corresponds to the key used in the ConfigMap.Data to store the configuration file content."

fn spec.agent.systemProbe.customConfig.configMap.withName

withName(name)

"The name of source ConfigMap."

obj spec.agent.systemProbe.env

"The Datadog SystemProbe supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.agent.systemProbe.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.agent.systemProbe.env.withValue

withValue(value)

"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 \"\"."

obj spec.agent.systemProbe.env.valueFrom

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

obj spec.agent.systemProbe.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.agent.systemProbe.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.agent.systemProbe.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.agent.systemProbe.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.agent.systemProbe.env.valueFrom.fieldRef

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

fn spec.agent.systemProbe.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.agent.systemProbe.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.agent.systemProbe.env.valueFrom.resourceFieldRef

"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."

fn spec.agent.systemProbe.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.agent.systemProbe.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.agent.systemProbe.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.agent.systemProbe.env.valueFrom.secretKeyRef

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

fn spec.agent.systemProbe.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.agent.systemProbe.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.agent.systemProbe.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.agent.systemProbe.resources

"Datadog SystemProbe resource requests and limits. Make sure to keep requests and limits equal to keep the pods in the Guaranteed QoS class. See also: http://kubernetes.io/docs/user-guide/compute-resources/"

fn spec.agent.systemProbe.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.agent.systemProbe.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.agent.systemProbe.resources.withRequests

withRequests(requests)

"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/"

fn spec.agent.systemProbe.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.agent.systemProbe.securityContext

"You can modify the security context used to run the containers by modifying the label type."

fn spec.agent.systemProbe.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

"AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.systemProbe.securityContext.withPrivileged

withPrivileged(privileged)

"Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.systemProbe.securityContext.withProcMount

withProcMount(procMount)

"procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.systemProbe.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

"Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.systemProbe.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows."

fn spec.agent.systemProbe.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

"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."

fn spec.agent.systemProbe.securityContext.withRunAsUser

withRunAsUser(runAsUser)

"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows."

obj spec.agent.systemProbe.securityContext.capabilities

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

fn spec.agent.systemProbe.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.agent.systemProbe.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.agent.systemProbe.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.agent.systemProbe.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.agent.systemProbe.securityContext.seLinuxOptions

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

fn spec.agent.systemProbe.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.agent.systemProbe.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.agent.systemProbe.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.agent.systemProbe.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.agent.systemProbe.securityContext.seccompProfile

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

fn spec.agent.systemProbe.securityContext.seccompProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"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\"."

fn spec.agent.systemProbe.securityContext.seccompProfile.withType

withType(type)

"type indicates which kind of seccomp profile will be applied. Valid options are: \n 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."

obj spec.agent.systemProbe.securityContext.windowsOptions

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

fn spec.agent.systemProbe.securityContext.windowsOptions.withGmsaCredentialSpec

withGmsaCredentialSpec(gmsaCredentialSpec)

"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."

fn spec.agent.systemProbe.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.agent.systemProbe.securityContext.windowsOptions.withHostProcess

withHostProcess(hostProcess)

"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."

fn spec.agent.systemProbe.securityContext.windowsOptions.withRunAsUserName

withRunAsUserName(runAsUserName)

"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."

obj spec.agent.systemProbe.volumeMounts

"Specify additional volume mounts in the Security Agent container."

fn spec.agent.systemProbe.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.agent.systemProbe.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"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."

fn spec.agent.systemProbe.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.agent.systemProbe.volumeMounts.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.agent.systemProbe.volumeMounts.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.agent.systemProbe.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"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."

obj spec.clusterAgent

"The desired state of the Cluster Agent as a deployment."

fn spec.clusterAgent.withAdditionalAnnotations

withAdditionalAnnotations(additionalAnnotations)

"AdditionalAnnotations provide annotations that will be added to the Cluster Agent Pods."

fn spec.clusterAgent.withAdditionalAnnotationsMixin

withAdditionalAnnotationsMixin(additionalAnnotations)

"AdditionalAnnotations provide annotations that will be added to the Cluster Agent Pods."

Note: This function appends passed data to existing values

fn spec.clusterAgent.withAdditionalLabels

withAdditionalLabels(additionalLabels)

"AdditionalLabels provide labels that will be added to the Cluster Agent Pods."

fn spec.clusterAgent.withAdditionalLabelsMixin

withAdditionalLabelsMixin(additionalLabels)

"AdditionalLabels provide labels that will be added to the Cluster Agent Pods."

Note: This function appends passed data to existing values

fn spec.clusterAgent.withDeploymentName

withDeploymentName(deploymentName)

"Name of the Cluster Agent Deployment to create or migrate from."

fn spec.clusterAgent.withEnabled

withEnabled(enabled)

"Enabled"

fn spec.clusterAgent.withKeepAnnotations

withKeepAnnotations(keepAnnotations)

"KeepAnnotations allows the specification of annotations not managed by the Operator that will be kept on ClusterAgent Deployment. All annotations containing 'datadoghq.com' are always included. This field uses glob syntax."

fn spec.clusterAgent.withKeepLabels

withKeepLabels(keepLabels)

"KeepLabels allows the specification of labels not managed by the Operator that will be kept on ClusterAgent Deployment. All labels containing 'datadoghq.com' are always included. This field uses glob syntax."

fn spec.clusterAgent.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/"

fn spec.clusterAgent.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/"

Note: This function appends passed data to existing values

fn spec.clusterAgent.withPriorityClassName

withPriorityClassName(priorityClassName)

"If specified, indicates the pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default."

fn spec.clusterAgent.withReplicas

withReplicas(replicas)

"Number of the Cluster Agent replicas."

fn spec.clusterAgent.withTolerations

withTolerations(tolerations)

"If specified, the Cluster-Agent pod's tolerations."

fn spec.clusterAgent.withTolerationsMixin

withTolerationsMixin(tolerations)

"If specified, the Cluster-Agent pod's tolerations."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity

"If specified, the pod's scheduling constraints."

obj spec.clusterAgent.affinity.nodeAffinity

"Describes node affinity scheduling rules for the pod."

fn spec.clusterAgent.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

fn spec.clusterAgent.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."

obj spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"A node selector term, associated with the corresponding weight."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

"A list of node selector requirements by node's fields."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.clusterAgent.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

"Required. A list of node selector terms. The terms are ORed."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

"A list of node selector requirements by node's fields."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.clusterAgent.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAffinity

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

fn spec.clusterAgent.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.clusterAgent.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.clusterAgent.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

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

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

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

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

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

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAntiAffinity

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

fn spec.clusterAgent.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.clusterAgent.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.clusterAgent.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

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

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

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

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

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

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.config

"Cluster Agent configuration."

fn spec.clusterAgent.config.withArgs

withArgs(args)

"Args allows the specification of extra args to Command parameter"

fn spec.clusterAgent.config.withArgsMixin

withArgsMixin(args)

"Args allows the specification of extra args to Command parameter"

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.withClusterChecksEnabled

withClusterChecksEnabled(clusterChecksEnabled)

"Enable the Cluster Checks and Endpoint Checks feature on both the Cluster Agent and the daemonset. See also: https://docs.datadoghq.com/agent/cluster_agent/clusterchecks/ https://docs.datadoghq.com/agent/cluster_agent/endpointschecks/ Autodiscovery via Kube Service annotations is automatically enabled."

fn spec.clusterAgent.config.withCollectEvents

withCollectEvents(collectEvents)

"Enable this to start event collection from the kubernetes API. See also: https://docs.datadoghq.com/agent/cluster_agent/event_collection/"

fn spec.clusterAgent.config.withCommand

withCommand(command)

"Command allows the specification of custom entrypoint for Cluster Agent container"

fn spec.clusterAgent.config.withCommandMixin

withCommandMixin(command)

"Command allows the specification of custom entrypoint for Cluster Agent container"

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.withEnv

withEnv(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.clusterAgent.config.withEnvMixin

withEnvMixin(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.withHealthPort

withHealthPort(healthPort)

"HealthPort of the Agent container for internal liveness probe. Must be the same as the Liveness/Readiness probes."

fn spec.clusterAgent.config.withLogLevel

withLogLevel(logLevel)

"Set logging verbosity, valid log levels are: trace, debug, info, warn, error, critical, and off"

fn spec.clusterAgent.config.withVolumeMounts

withVolumeMounts(volumeMounts)

"Specify additional volume mounts in the Datadog Cluster Agent container."

fn spec.clusterAgent.config.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Specify additional volume mounts in the Datadog Cluster Agent container."

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.withVolumes

withVolumes(volumes)

"Specify additional volumes in the Datadog Cluster Agent container."

fn spec.clusterAgent.config.withVolumesMixin

withVolumesMixin(volumes)

"Specify additional volumes in the Datadog Cluster Agent container."

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.admissionController

"Configure the Admission Controller."

fn spec.clusterAgent.config.admissionController.withAgentCommunicationMode

withAgentCommunicationMode(agentCommunicationMode)

"agentCommunicationMode corresponds to the mode used by the Datadog application libraries to communicate with the Agent. It can be \"hostip\", \"service\", or \"socket\"."

fn spec.clusterAgent.config.admissionController.withEnabled

withEnabled(enabled)

"Enable the admission controller to be able to inject APM/Dogstatsd config and standard tags (env, service, version) automatically into your pods."

fn spec.clusterAgent.config.admissionController.withMutateUnlabelled

withMutateUnlabelled(mutateUnlabelled)

"MutateUnlabelled enables injecting config without having the pod label 'admission.datadoghq.com/enabled=\"true\"'."

fn spec.clusterAgent.config.admissionController.withServiceName

withServiceName(serviceName)

"ServiceName corresponds to the webhook service name."

obj spec.clusterAgent.config.confd

"Confd Provide additional cluster check configurations. Each key will become a file in /conf.d. see https://docs.datadoghq.com/agent/autodiscovery/ for more details."

fn spec.clusterAgent.config.confd.withConfigMapName

withConfigMapName(configMapName)

"ConfigMapName name of a ConfigMap used to mount a directory."

fn spec.clusterAgent.config.confd.withItems

withItems(items)

"items mapping between configMap data key and file path mount."

fn spec.clusterAgent.config.confd.withItemsMixin

withItemsMixin(items)

"items mapping between configMap data key and file path mount."

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.confd.items

"items mapping between configMap data key and file path mount."

fn spec.clusterAgent.config.confd.items.withKey

withKey(key)

"key is the key to project."

fn spec.clusterAgent.config.confd.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.clusterAgent.config.confd.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.clusterAgent.config.env

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.clusterAgent.config.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.clusterAgent.config.env.withValue

withValue(value)

"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 \"\"."

obj spec.clusterAgent.config.env.valueFrom

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

obj spec.clusterAgent.config.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.clusterAgent.config.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.clusterAgent.config.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.clusterAgent.config.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.clusterAgent.config.env.valueFrom.fieldRef

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

fn spec.clusterAgent.config.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.clusterAgent.config.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.clusterAgent.config.env.valueFrom.resourceFieldRef

"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."

fn spec.clusterAgent.config.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.clusterAgent.config.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.clusterAgent.config.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.clusterAgent.config.env.valueFrom.secretKeyRef

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

fn spec.clusterAgent.config.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.clusterAgent.config.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.clusterAgent.config.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.clusterAgent.config.externalMetrics

"ExternalMetricsConfig contains the configuration of the external metrics provider in Cluster Agent."

fn spec.clusterAgent.config.externalMetrics.withEnabled

withEnabled(enabled)

"Enable the metricsProvider to be able to scale based on metrics in Datadog."

fn spec.clusterAgent.config.externalMetrics.withEndpoint

withEndpoint(endpoint)

"Override the API endpoint for the external metrics server. Defaults to .spec.agent.config.ddUrl or \"https://app.datadoghq.com\" if that's empty."

fn spec.clusterAgent.config.externalMetrics.withPort

withPort(port)

"If specified configures the metricsProvider external metrics service port."

fn spec.clusterAgent.config.externalMetrics.withUseDatadogMetrics

withUseDatadogMetrics(useDatadogMetrics)

"Enable usage of DatadogMetrics CRD (allow to scale on arbitrary queries)."

fn spec.clusterAgent.config.externalMetrics.withWpaController

withWpaController(wpaController)

"Enable informer and controller of the watermark pod autoscaler. NOTE: The WatermarkPodAutoscaler controller needs to be installed. See also: https://github.com/DataDog/watermarkpodautoscaler."

obj spec.clusterAgent.config.externalMetrics.credentials

"Datadog credentials used by external metrics server to query Datadog. If not set, the external metrics server uses the global .spec.Credentials"

fn spec.clusterAgent.config.externalMetrics.credentials.withApiKey

withApiKey(apiKey)

"APIKey Set this to your Datadog API key before the Agent runs. See also: https://app.datadoghq.com/account/settings#agent/kubernetes"

fn spec.clusterAgent.config.externalMetrics.credentials.withApiKeyExistingSecret

withApiKeyExistingSecret(apiKeyExistingSecret)

"APIKeyExistingSecret is DEPRECATED. In order to pass the API key through an existing secret, please consider \"apiSecret\" instead. If set, this parameter takes precedence over \"apiKey\"."

fn spec.clusterAgent.config.externalMetrics.credentials.withAppKey

withAppKey(appKey)

"If you are using clusterAgent.metricsProvider.enabled = true, you must set a Datadog application key for read access to your metrics."

fn spec.clusterAgent.config.externalMetrics.credentials.withAppKeyExistingSecret

withAppKeyExistingSecret(appKeyExistingSecret)

"AppKeyExistingSecret is DEPRECATED. In order to pass the APP key through an existing secret, please consider \"appSecret\" instead. If set, this parameter takes precedence over \"appKey\"."

obj spec.clusterAgent.config.externalMetrics.credentials.apiSecret

"APISecret Use existing Secret which stores API key instead of creating a new one. If set, this parameter takes precedence over \"apiKey\" and \"apiKeyExistingSecret\"."

fn spec.clusterAgent.config.externalMetrics.credentials.apiSecret.withKeyName

withKeyName(keyName)

"KeyName is the key of the secret to use."

fn spec.clusterAgent.config.externalMetrics.credentials.apiSecret.withSecretName

withSecretName(secretName)

"SecretName is the name of the secret."

obj spec.clusterAgent.config.externalMetrics.credentials.appSecret

"APPSecret Use existing Secret which stores API key instead of creating a new one. If set, this parameter takes precedence over \"apiKey\" and \"appKeyExistingSecret\"."

fn spec.clusterAgent.config.externalMetrics.credentials.appSecret.withKeyName

withKeyName(keyName)

"KeyName is the key of the secret to use."

fn spec.clusterAgent.config.externalMetrics.credentials.appSecret.withSecretName

withSecretName(secretName)

"SecretName is the name of the secret."

obj spec.clusterAgent.config.resources

"Datadog Cluster Agent resource requests and limits."

fn spec.clusterAgent.config.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.clusterAgent.config.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.resources.withRequests

withRequests(requests)

"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/"

fn spec.clusterAgent.config.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.securityContext

"Pod-level SecurityContext."

fn spec.clusterAgent.config.securityContext.withFsGroup

withFsGroup(fsGroup)

"A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterAgent.config.securityContext.withFsGroupChangePolicy

withFsGroupChangePolicy(fsGroupChangePolicy)

"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterAgent.config.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterAgent.config.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.clusterAgent.config.securityContext.withRunAsUser

withRunAsUser(runAsUser)

"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterAgent.config.securityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterAgent.config.securityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows."

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.securityContext.withSysctls

withSysctls(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterAgent.config.securityContext.withSysctlsMixin

withSysctlsMixin(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.securityContext.seLinuxOptions

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

fn spec.clusterAgent.config.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.clusterAgent.config.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.clusterAgent.config.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.clusterAgent.config.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.clusterAgent.config.securityContext.seccompProfile

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

fn spec.clusterAgent.config.securityContext.seccompProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"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\"."

fn spec.clusterAgent.config.securityContext.seccompProfile.withType

withType(type)

"type indicates which kind of seccomp profile will be applied. Valid options are: \n 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."

obj spec.clusterAgent.config.securityContext.sysctls

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterAgent.config.securityContext.sysctls.withName

withName(name)

"Name of a property to set"

fn spec.clusterAgent.config.securityContext.sysctls.withValue

withValue(value)

"Value of a property to set"

obj spec.clusterAgent.config.securityContext.windowsOptions

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

fn spec.clusterAgent.config.securityContext.windowsOptions.withGmsaCredentialSpec

withGmsaCredentialSpec(gmsaCredentialSpec)

"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."

fn spec.clusterAgent.config.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.clusterAgent.config.securityContext.windowsOptions.withHostProcess

withHostProcess(hostProcess)

"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."

fn spec.clusterAgent.config.securityContext.windowsOptions.withRunAsUserName

withRunAsUserName(runAsUserName)

"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."

obj spec.clusterAgent.config.volumeMounts

"Specify additional volume mounts in the Datadog Cluster Agent container."

fn spec.clusterAgent.config.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.clusterAgent.config.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"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."

fn spec.clusterAgent.config.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.clusterAgent.config.volumeMounts.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.clusterAgent.config.volumeMounts.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.clusterAgent.config.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"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."

obj spec.clusterAgent.config.volumes

"Specify additional volumes in the Datadog Cluster Agent container."

fn spec.clusterAgent.config.volumes.withName

withName(name)

"name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.clusterAgent.config.volumes.awsElasticBlockStore

"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"

fn spec.clusterAgent.config.volumes.awsElasticBlockStore.withFsType

withFsType(fsType)

"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterAgent.config.volumes.awsElasticBlockStore.withPartition

withPartition(partition)

"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)."

fn spec.clusterAgent.config.volumes.awsElasticBlockStore.withReadOnly

withReadOnly(readOnly)

"readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

fn spec.clusterAgent.config.volumes.awsElasticBlockStore.withVolumeID

withVolumeID(volumeID)

"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

obj spec.clusterAgent.config.volumes.azureDisk

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

fn spec.clusterAgent.config.volumes.azureDisk.withCachingMode

withCachingMode(cachingMode)

"cachingMode is the Host Caching mode: None, Read Only, Read Write."

fn spec.clusterAgent.config.volumes.azureDisk.withDiskName

withDiskName(diskName)

"diskName is the Name of the data disk in the blob storage"

fn spec.clusterAgent.config.volumes.azureDisk.withDiskURI

withDiskURI(diskURI)

"diskURI is the URI of data disk in the blob storage"

fn spec.clusterAgent.config.volumes.azureDisk.withFsType

withFsType(fsType)

"fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.clusterAgent.config.volumes.azureDisk.withKind

withKind(kind)

"kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared"

fn spec.clusterAgent.config.volumes.azureDisk.withReadOnly

withReadOnly(readOnly)

"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.clusterAgent.config.volumes.azureFile

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

fn spec.clusterAgent.config.volumes.azureFile.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterAgent.config.volumes.azureFile.withSecretName

withSecretName(secretName)

"secretName is the name of secret that contains Azure Storage Account Name and Key"

fn spec.clusterAgent.config.volumes.azureFile.withShareName

withShareName(shareName)

"shareName is the azure share Name"

obj spec.clusterAgent.config.volumes.cephfs

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

fn spec.clusterAgent.config.volumes.cephfs.withMonitors

withMonitors(monitors)

"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.clusterAgent.config.volumes.cephfs.withMonitorsMixin

withMonitorsMixin(monitors)

"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.cephfs.withPath

withPath(path)

"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /"

fn spec.clusterAgent.config.volumes.cephfs.withReadOnly

withReadOnly(readOnly)

"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.clusterAgent.config.volumes.cephfs.withSecretFile

withSecretFile(secretFile)

"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.clusterAgent.config.volumes.cephfs.withUser

withUser(user)

"user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

obj spec.clusterAgent.config.volumes.cephfs.secretRef

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

fn spec.clusterAgent.config.volumes.cephfs.secretRef.withName

withName(name)

"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?"

obj spec.clusterAgent.config.volumes.cinder

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

fn spec.clusterAgent.config.volumes.cinder.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.clusterAgent.config.volumes.cinder.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.clusterAgent.config.volumes.cinder.withVolumeID

withVolumeID(volumeID)

"volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

obj spec.clusterAgent.config.volumes.cinder.secretRef

"secretRef is optional: points to a secret object containing parameters used to connect to OpenStack."

fn spec.clusterAgent.config.volumes.cinder.secretRef.withName

withName(name)

"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?"

obj spec.clusterAgent.config.volumes.configMap

"configMap represents a configMap that should populate this volume"

fn spec.clusterAgent.config.volumes.configMap.withDefaultMode

withDefaultMode(defaultMode)

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

fn spec.clusterAgent.config.volumes.configMap.withItems

withItems(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterAgent.config.volumes.configMap.withItemsMixin

withItemsMixin(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.configMap.withName

withName(name)

"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?"

fn spec.clusterAgent.config.volumes.configMap.withOptional

withOptional(optional)

"optional specify whether the ConfigMap or its keys must be defined"

obj spec.clusterAgent.config.volumes.configMap.items

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterAgent.config.volumes.configMap.items.withKey

withKey(key)

"key is the key to project."

fn spec.clusterAgent.config.volumes.configMap.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.clusterAgent.config.volumes.configMap.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.clusterAgent.config.volumes.csi

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

fn spec.clusterAgent.config.volumes.csi.withDriver

withDriver(driver)

"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."

fn spec.clusterAgent.config.volumes.csi.withFsType

withFsType(fsType)

"fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply."

fn spec.clusterAgent.config.volumes.csi.withReadOnly

withReadOnly(readOnly)

"readOnly specifies a read-only configuration for the volume. Defaults to false (read/write)."

fn spec.clusterAgent.config.volumes.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

fn spec.clusterAgent.config.volumes.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.volumes.csi.nodePublishSecretRef

"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."

fn spec.clusterAgent.config.volumes.csi.nodePublishSecretRef.withName

withName(name)

"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?"

obj spec.clusterAgent.config.volumes.downwardAPI

"downwardAPI represents downward API about the pod that should populate this volume"

fn spec.clusterAgent.config.volumes.downwardAPI.withDefaultMode

withDefaultMode(defaultMode)

"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."

fn spec.clusterAgent.config.volumes.downwardAPI.withItems

withItems(items)

"Items is a list of downward API volume file"

fn spec.clusterAgent.config.volumes.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of downward API volume file"

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.volumes.downwardAPI.items

"Items is a list of downward API volume file"

fn spec.clusterAgent.config.volumes.downwardAPI.items.withMode

withMode(mode)

"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."

fn spec.clusterAgent.config.volumes.downwardAPI.items.withPath

withPath(path)

"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 '..'"

obj spec.clusterAgent.config.volumes.downwardAPI.items.fieldRef

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

fn spec.clusterAgent.config.volumes.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.clusterAgent.config.volumes.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.clusterAgent.config.volumes.downwardAPI.items.resourceFieldRef

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

fn spec.clusterAgent.config.volumes.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.clusterAgent.config.volumes.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.clusterAgent.config.volumes.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.clusterAgent.config.volumes.emptyDir

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

fn spec.clusterAgent.config.volumes.emptyDir.withMedium

withMedium(medium)

"medium represents what type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"

fn spec.clusterAgent.config.volumes.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

"sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir"

obj spec.clusterAgent.config.volumes.ephemeral

"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. \n 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). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n 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. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."

obj spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate

"Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n 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. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.withMetadata

withMetadata(metadata)

"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."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.withMetadataMixin

withMetadataMixin(metadata)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec

"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."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModes

withAccessModes(accessModes)

"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin

withAccessModesMixin(accessModes)

"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.withStorageClassName

withStorageClassName(storageClassName)

"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeMode

withVolumeMode(volumeMode)

"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeName

withVolumeName(volumeName)

"volumeName is the binding reference to the PersistentVolume backing this claim."

obj spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource

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

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup

withApiGroup(apiGroup)

"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."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef

"dataSourceRef 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. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup

withApiGroup(apiGroup)

"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."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources

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

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequests

withRequests(requests)

"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/"

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector

"selector is a label query over volumes to consider for binding."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.volumes.fc

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

fn spec.clusterAgent.config.volumes.fc.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterAgent.config.volumes.fc.withLun

withLun(lun)

"lun is Optional: FC target lun number"

fn spec.clusterAgent.config.volumes.fc.withReadOnly

withReadOnly(readOnly)

"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterAgent.config.volumes.fc.withTargetWWNs

withTargetWWNs(targetWWNs)

"targetWWNs is Optional: FC target worldwide names (WWNs)"

fn spec.clusterAgent.config.volumes.fc.withTargetWWNsMixin

withTargetWWNsMixin(targetWWNs)

"targetWWNs is Optional: FC target worldwide names (WWNs)"

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.fc.withWwids

withWwids(wwids)

"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

fn spec.clusterAgent.config.volumes.fc.withWwidsMixin

withWwidsMixin(wwids)

"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.volumes.flexVolume

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

fn spec.clusterAgent.config.volumes.flexVolume.withDriver

withDriver(driver)

"driver is the name of the driver to use for this volume."

fn spec.clusterAgent.config.volumes.flexVolume.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script."

fn spec.clusterAgent.config.volumes.flexVolume.withOptions

withOptions(options)

"options is Optional: this field holds extra command options if any."

fn spec.clusterAgent.config.volumes.flexVolume.withOptionsMixin

withOptionsMixin(options)

"options is Optional: this field holds extra command options if any."

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.flexVolume.withReadOnly

withReadOnly(readOnly)

"readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.clusterAgent.config.volumes.flexVolume.secretRef

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

fn spec.clusterAgent.config.volumes.flexVolume.secretRef.withName

withName(name)

"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?"

obj spec.clusterAgent.config.volumes.flocker

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

fn spec.clusterAgent.config.volumes.flocker.withDatasetName

withDatasetName(datasetName)

"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated"

fn spec.clusterAgent.config.volumes.flocker.withDatasetUUID

withDatasetUUID(datasetUUID)

"datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset"

obj spec.clusterAgent.config.volumes.gcePersistentDisk

"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"

fn spec.clusterAgent.config.volumes.gcePersistentDisk.withFsType

withFsType(fsType)

"fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterAgent.config.volumes.gcePersistentDisk.withPartition

withPartition(partition)

"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.clusterAgent.config.volumes.gcePersistentDisk.withPdName

withPdName(pdName)

"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.clusterAgent.config.volumes.gcePersistentDisk.withReadOnly

withReadOnly(readOnly)

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

obj spec.clusterAgent.config.volumes.gitRepo

"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."

fn spec.clusterAgent.config.volumes.gitRepo.withDirectory

withDirectory(directory)

"directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name."

fn spec.clusterAgent.config.volumes.gitRepo.withRepository

withRepository(repository)

"repository is the URL"

fn spec.clusterAgent.config.volumes.gitRepo.withRevision

withRevision(revision)

"revision is the commit hash for the specified revision."

obj spec.clusterAgent.config.volumes.glusterfs

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

fn spec.clusterAgent.config.volumes.glusterfs.withEndpoints

withEndpoints(endpoints)

"endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.clusterAgent.config.volumes.glusterfs.withPath

withPath(path)

"path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.clusterAgent.config.volumes.glusterfs.withReadOnly

withReadOnly(readOnly)

"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"

obj spec.clusterAgent.config.volumes.hostPath

"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."

fn spec.clusterAgent.config.volumes.hostPath.withPath

withPath(path)

"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"

fn spec.clusterAgent.config.volumes.hostPath.withType

withType(type)

"type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"

obj spec.clusterAgent.config.volumes.iscsi

"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"

fn spec.clusterAgent.config.volumes.iscsi.withChapAuthDiscovery

withChapAuthDiscovery(chapAuthDiscovery)

"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication"

fn spec.clusterAgent.config.volumes.iscsi.withChapAuthSession

withChapAuthSession(chapAuthSession)

"chapAuthSession defines whether support iSCSI Session CHAP authentication"

fn spec.clusterAgent.config.volumes.iscsi.withFsType

withFsType(fsType)

"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterAgent.config.volumes.iscsi.withInitiatorName

withInitiatorName(initiatorName)

"initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection."

fn spec.clusterAgent.config.volumes.iscsi.withIqn

withIqn(iqn)

"iqn is the target iSCSI Qualified Name."

fn spec.clusterAgent.config.volumes.iscsi.withIscsiInterface

withIscsiInterface(iscsiInterface)

"iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp)."

fn spec.clusterAgent.config.volumes.iscsi.withLun

withLun(lun)

"lun represents iSCSI Target Lun number."

fn spec.clusterAgent.config.volumes.iscsi.withPortals

withPortals(portals)

"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

fn spec.clusterAgent.config.volumes.iscsi.withPortalsMixin

withPortalsMixin(portals)

"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.iscsi.withReadOnly

withReadOnly(readOnly)

"readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false."

fn spec.clusterAgent.config.volumes.iscsi.withTargetPortal

withTargetPortal(targetPortal)

"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

obj spec.clusterAgent.config.volumes.iscsi.secretRef

"secretRef is the CHAP Secret for iSCSI target and initiator authentication"

fn spec.clusterAgent.config.volumes.iscsi.secretRef.withName

withName(name)

"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?"

obj spec.clusterAgent.config.volumes.nfs

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

fn spec.clusterAgent.config.volumes.nfs.withPath

withPath(path)

"path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.clusterAgent.config.volumes.nfs.withReadOnly

withReadOnly(readOnly)

"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"

fn spec.clusterAgent.config.volumes.nfs.withServer

withServer(server)

"server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

obj spec.clusterAgent.config.volumes.persistentVolumeClaim

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

fn spec.clusterAgent.config.volumes.persistentVolumeClaim.withClaimName

withClaimName(claimName)

"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"

fn spec.clusterAgent.config.volumes.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

"readOnly Will force the ReadOnly setting in VolumeMounts. Default false."

obj spec.clusterAgent.config.volumes.photonPersistentDisk

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

fn spec.clusterAgent.config.volumes.photonPersistentDisk.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.clusterAgent.config.volumes.photonPersistentDisk.withPdID

withPdID(pdID)

"pdID is the ID that identifies Photon Controller persistent disk"

obj spec.clusterAgent.config.volumes.portworxVolume

"portworxVolume represents a portworx volume attached and mounted on kubelets host machine"

fn spec.clusterAgent.config.volumes.portworxVolume.withFsType

withFsType(fsType)

"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."

fn spec.clusterAgent.config.volumes.portworxVolume.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterAgent.config.volumes.portworxVolume.withVolumeID

withVolumeID(volumeID)

"volumeID uniquely identifies a Portworx volume"

obj spec.clusterAgent.config.volumes.projected

"projected items for all in one resources secrets, configmaps, and downward API"

fn spec.clusterAgent.config.volumes.projected.withDefaultMode

withDefaultMode(defaultMode)

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

fn spec.clusterAgent.config.volumes.projected.withSources

withSources(sources)

"sources is the list of volume projections"

fn spec.clusterAgent.config.volumes.projected.withSourcesMixin

withSourcesMixin(sources)

"sources is the list of volume projections"

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.volumes.projected.sources

"sources is the list of volume projections"

obj spec.clusterAgent.config.volumes.projected.sources.configMap

"configMap information about the configMap data to project"

fn spec.clusterAgent.config.volumes.projected.sources.configMap.withItems

withItems(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterAgent.config.volumes.projected.sources.configMap.withItemsMixin

withItemsMixin(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.projected.sources.configMap.withName

withName(name)

"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?"

fn spec.clusterAgent.config.volumes.projected.sources.configMap.withOptional

withOptional(optional)

"optional specify whether the ConfigMap or its keys must be defined"

obj spec.clusterAgent.config.volumes.projected.sources.configMap.items

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterAgent.config.volumes.projected.sources.configMap.items.withKey

withKey(key)

"key is the key to project."

fn spec.clusterAgent.config.volumes.projected.sources.configMap.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.clusterAgent.config.volumes.projected.sources.configMap.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.clusterAgent.config.volumes.projected.sources.downwardAPI

"downwardAPI information about the downwardAPI data to project"

fn spec.clusterAgent.config.volumes.projected.sources.downwardAPI.withItems

withItems(items)

"Items is a list of DownwardAPIVolume file"

fn spec.clusterAgent.config.volumes.projected.sources.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of DownwardAPIVolume file"

Note: This function appends passed data to existing values

obj spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items

"Items is a list of DownwardAPIVolume file"

fn spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items.withMode

withMode(mode)

"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."

fn spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items.withPath

withPath(path)

"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 '..'"

obj spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items.fieldRef

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

fn spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef

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

fn spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.clusterAgent.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.clusterAgent.config.volumes.projected.sources.secret

"secret information about the secret data to project"

fn spec.clusterAgent.config.volumes.projected.sources.secret.withItems

withItems(items)

"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterAgent.config.volumes.projected.sources.secret.withItemsMixin

withItemsMixin(items)

"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.projected.sources.secret.withName

withName(name)

"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?"

fn spec.clusterAgent.config.volumes.projected.sources.secret.withOptional

withOptional(optional)

"optional field specify whether the Secret or its key must be defined"

obj spec.clusterAgent.config.volumes.projected.sources.secret.items

"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterAgent.config.volumes.projected.sources.secret.items.withKey

withKey(key)

"key is the key to project."

fn spec.clusterAgent.config.volumes.projected.sources.secret.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.clusterAgent.config.volumes.projected.sources.secret.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.clusterAgent.config.volumes.projected.sources.serviceAccountToken

"serviceAccountToken is information about the serviceAccountToken data to project"

fn spec.clusterAgent.config.volumes.projected.sources.serviceAccountToken.withAudience

withAudience(audience)

"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."

fn spec.clusterAgent.config.volumes.projected.sources.serviceAccountToken.withExpirationSeconds

withExpirationSeconds(expirationSeconds)

"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."

fn spec.clusterAgent.config.volumes.projected.sources.serviceAccountToken.withPath

withPath(path)

"path is the path relative to the mount point of the file to project the token into."

obj spec.clusterAgent.config.volumes.quobyte

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

fn spec.clusterAgent.config.volumes.quobyte.withGroup

withGroup(group)

"group to map volume access to Default is no group"

fn spec.clusterAgent.config.volumes.quobyte.withReadOnly

withReadOnly(readOnly)

"readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false."

fn spec.clusterAgent.config.volumes.quobyte.withRegistry

withRegistry(registry)

"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"

fn spec.clusterAgent.config.volumes.quobyte.withTenant

withTenant(tenant)

"tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin"

fn spec.clusterAgent.config.volumes.quobyte.withUser

withUser(user)

"user to map volume access to Defaults to serivceaccount user"

fn spec.clusterAgent.config.volumes.quobyte.withVolume

withVolume(volume)

"volume is a string that references an already created Quobyte volume by name."

obj spec.clusterAgent.config.volumes.rbd

"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"

fn spec.clusterAgent.config.volumes.rbd.withFsType

withFsType(fsType)

"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterAgent.config.volumes.rbd.withImage

withImage(image)

"image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.clusterAgent.config.volumes.rbd.withKeyring

withKeyring(keyring)

"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"

fn spec.clusterAgent.config.volumes.rbd.withMonitors

withMonitors(monitors)

"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.clusterAgent.config.volumes.rbd.withMonitorsMixin

withMonitorsMixin(monitors)

"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.rbd.withPool

withPool(pool)

"pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.clusterAgent.config.volumes.rbd.withReadOnly

withReadOnly(readOnly)

"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"

fn spec.clusterAgent.config.volumes.rbd.withUser

withUser(user)

"user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

obj spec.clusterAgent.config.volumes.rbd.secretRef

"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"

fn spec.clusterAgent.config.volumes.rbd.secretRef.withName

withName(name)

"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?"

obj spec.clusterAgent.config.volumes.scaleIO

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

fn spec.clusterAgent.config.volumes.scaleIO.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\"."

fn spec.clusterAgent.config.volumes.scaleIO.withGateway

withGateway(gateway)

"gateway is the host address of the ScaleIO API Gateway."

fn spec.clusterAgent.config.volumes.scaleIO.withProtectionDomain

withProtectionDomain(protectionDomain)

"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage."

fn spec.clusterAgent.config.volumes.scaleIO.withReadOnly

withReadOnly(readOnly)

"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterAgent.config.volumes.scaleIO.withSslEnabled

withSslEnabled(sslEnabled)

"sslEnabled Flag enable/disable SSL communication with Gateway, default false"

fn spec.clusterAgent.config.volumes.scaleIO.withStorageMode

withStorageMode(storageMode)

"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned."

fn spec.clusterAgent.config.volumes.scaleIO.withStoragePool

withStoragePool(storagePool)

"storagePool is the ScaleIO Storage Pool associated with the protection domain."

fn spec.clusterAgent.config.volumes.scaleIO.withSystem

withSystem(system)

"system is the name of the storage system as configured in ScaleIO."

fn spec.clusterAgent.config.volumes.scaleIO.withVolumeName

withVolumeName(volumeName)

"volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source."

obj spec.clusterAgent.config.volumes.scaleIO.secretRef

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

fn spec.clusterAgent.config.volumes.scaleIO.secretRef.withName

withName(name)

"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?"

obj spec.clusterAgent.config.volumes.secret

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

fn spec.clusterAgent.config.volumes.secret.withDefaultMode

withDefaultMode(defaultMode)

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

fn spec.clusterAgent.config.volumes.secret.withItems

withItems(items)

"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterAgent.config.volumes.secret.withItemsMixin

withItemsMixin(items)

"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.clusterAgent.config.volumes.secret.withOptional

withOptional(optional)

"optional field specify whether the Secret or its keys must be defined"

fn spec.clusterAgent.config.volumes.secret.withSecretName

withSecretName(secretName)

"secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"

obj spec.clusterAgent.config.volumes.secret.items

"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterAgent.config.volumes.secret.items.withKey

withKey(key)

"key is the key to project."

fn spec.clusterAgent.config.volumes.secret.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.clusterAgent.config.volumes.secret.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.clusterAgent.config.volumes.storageos

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

fn spec.clusterAgent.config.volumes.storageos.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.clusterAgent.config.volumes.storageos.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterAgent.config.volumes.storageos.withVolumeName

withVolumeName(volumeName)

"volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace."

fn spec.clusterAgent.config.volumes.storageos.withVolumeNamespace

withVolumeNamespace(volumeNamespace)

"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."

obj spec.clusterAgent.config.volumes.storageos.secretRef

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

fn spec.clusterAgent.config.volumes.storageos.secretRef.withName

withName(name)

"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?"

obj spec.clusterAgent.config.volumes.vsphereVolume

"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"

fn spec.clusterAgent.config.volumes.vsphereVolume.withFsType

withFsType(fsType)

"fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.clusterAgent.config.volumes.vsphereVolume.withStoragePolicyID

withStoragePolicyID(storagePolicyID)

"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."

fn spec.clusterAgent.config.volumes.vsphereVolume.withStoragePolicyName

withStoragePolicyName(storagePolicyName)

"storagePolicyName is the storage Policy Based Management (SPBM) profile name."

fn spec.clusterAgent.config.volumes.vsphereVolume.withVolumePath

withVolumePath(volumePath)

"volumePath is the path that identifies vSphere volume vmdk"

obj spec.clusterAgent.customConfig

"Allow to put custom configuration for the Agent, corresponding to the datadog-cluster.yaml config file."

fn spec.clusterAgent.customConfig.withConfigData

withConfigData(configData)

"ConfigData corresponds to the configuration file content."

obj spec.clusterAgent.customConfig.configMap

"Enable to specify a reference to an already existing ConfigMap."

fn spec.clusterAgent.customConfig.configMap.withFileKey

withFileKey(fileKey)

"FileKey corresponds to the key used in the ConfigMap.Data to store the configuration file content."

fn spec.clusterAgent.customConfig.configMap.withName

withName(name)

"The name of source ConfigMap."

obj spec.clusterAgent.image

"The container image of the Datadog Cluster Agent."

fn spec.clusterAgent.image.withJmxEnabled

withJmxEnabled(jmxEnabled)

"Define whether the Agent image should support JMX. To be used if the Name field does not correspond to a full image string."

fn spec.clusterAgent.image.withName

withName(name)

"Define the image to use: Use \"gcr.io/datadoghq/agent:latest\" for Datadog Agent 7. Use \"datadog/dogstatsd:latest\" for standalone Datadog Agent DogStatsD 7. Use \"gcr.io/datadoghq/cluster-agent:latest\" for Datadog Cluster Agent. Use \"agent\" with the registry and tag configurations for /agent:. Use \"cluster-agent\" with the registry and tag configurations for /cluster-agent:. If the name is the full image string—<name>:<tag> or <registry>/<name>:<tag>, then tag, jmxEnabled, and global.registry values are ignored. Otherwise, image string is created by overriding default settings with supplied name, tag, and jmxEnabled values; image string is created using default registry unless global.registry is configured."

fn spec.clusterAgent.image.withPullPolicy

withPullPolicy(pullPolicy)

"The Kubernetes pull policy: Use Always, Never, or IfNotPresent."

fn spec.clusterAgent.image.withPullSecrets

withPullSecrets(pullSecrets)

"It is possible to specify Docker registry credentials. See https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

fn spec.clusterAgent.image.withPullSecretsMixin

withPullSecretsMixin(pullSecrets)

"It is possible to specify Docker registry credentials. See https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

Note: This function appends passed data to existing values

fn spec.clusterAgent.image.withTag

withTag(tag)

"Define the image tag to use. To be used if the Name field does not correspond to a full image string."

obj spec.clusterAgent.image.pullSecrets

"It is possible to specify Docker registry credentials. See https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

fn spec.clusterAgent.image.pullSecrets.withName

withName(name)

"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?"

obj spec.clusterAgent.networkPolicy

"Provide Cluster Agent Network Policy configuration."

fn spec.clusterAgent.networkPolicy.withCreate

withCreate(create)

"If true, create a NetworkPolicy for the current agent."

fn spec.clusterAgent.networkPolicy.withDnsSelectorEndpoints

withDnsSelectorEndpoints(dnsSelectorEndpoints)

"Cilium selector of the DNS\u202fserver entity."

fn spec.clusterAgent.networkPolicy.withDnsSelectorEndpointsMixin

withDnsSelectorEndpointsMixin(dnsSelectorEndpoints)

"Cilium selector of the DNS\u202fserver entity."

Note: This function appends passed data to existing values

fn spec.clusterAgent.networkPolicy.withFlavor

withFlavor(flavor)

"Which network policy to use. Can be kubernetes or cilium."

obj spec.clusterAgent.networkPolicy.dnsSelectorEndpoints

"Cilium selector of the DNS\u202fserver entity."

fn spec.clusterAgent.networkPolicy.dnsSelectorEndpoints.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.networkPolicy.dnsSelectorEndpoints.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterAgent.networkPolicy.dnsSelectorEndpoints.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterAgent.networkPolicy.dnsSelectorEndpoints.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.networkPolicy.dnsSelectorEndpoints.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterAgent.networkPolicy.dnsSelectorEndpoints.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterAgent.networkPolicy.dnsSelectorEndpoints.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterAgent.networkPolicy.dnsSelectorEndpoints.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterAgent.networkPolicy.dnsSelectorEndpoints.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterAgent.rbac

"RBAC configuration of the Datadog Cluster Agent."

fn spec.clusterAgent.rbac.withCreate

withCreate(create)

"Used to configure RBAC resources creation."

fn spec.clusterAgent.rbac.withServiceAccountName

withServiceAccountName(serviceAccountName)

"Used to set up the service account name to use. Ignored if the field Create is true."

obj spec.clusterAgent.tolerations

"If specified, the Cluster-Agent pod's tolerations."

fn spec.clusterAgent.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.clusterAgent.tolerations.withKey

withKey(key)

"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."

fn spec.clusterAgent.tolerations.withOperator

withOperator(operator)

"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."

fn spec.clusterAgent.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"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."

fn spec.clusterAgent.tolerations.withValue

withValue(value)

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

obj spec.clusterChecksRunner

"The desired state of the Cluster Checks Runner as a deployment."

fn spec.clusterChecksRunner.withAdditionalAnnotations

withAdditionalAnnotations(additionalAnnotations)

"AdditionalAnnotations provide annotations that will be added to the cluster checks runner Pods."

fn spec.clusterChecksRunner.withAdditionalAnnotationsMixin

withAdditionalAnnotationsMixin(additionalAnnotations)

"AdditionalAnnotations provide annotations that will be added to the cluster checks runner Pods."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.withAdditionalLabels

withAdditionalLabels(additionalLabels)

"AdditionalLabels provide labels that will be added to the cluster checks runner Pods."

fn spec.clusterChecksRunner.withAdditionalLabelsMixin

withAdditionalLabelsMixin(additionalLabels)

"AdditionalLabels provide labels that will be added to the cluster checks runner Pods."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.withDeploymentName

withDeploymentName(deploymentName)

"Name of the cluster checks deployment to create or migrate from."

fn spec.clusterChecksRunner.withEnabled

withEnabled(enabled)

"Enabled"

fn spec.clusterChecksRunner.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/"

fn spec.clusterChecksRunner.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.withPriorityClassName

withPriorityClassName(priorityClassName)

"If specified, indicates the pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default."

fn spec.clusterChecksRunner.withReplicas

withReplicas(replicas)

"Number of the Cluster Checks Runner replicas."

fn spec.clusterChecksRunner.withTolerations

withTolerations(tolerations)

"If specified, the Cluster-Checks pod's tolerations."

fn spec.clusterChecksRunner.withTolerationsMixin

withTolerationsMixin(tolerations)

"If specified, the Cluster-Checks pod's tolerations."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity

"If specified, the pod's scheduling constraints."

obj spec.clusterChecksRunner.affinity.nodeAffinity

"Describes node affinity scheduling rules for the pod."

fn spec.clusterChecksRunner.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

fn spec.clusterChecksRunner.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."

obj spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"A node selector term, associated with the corresponding weight."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

"A list of node selector requirements by node's fields."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.clusterChecksRunner.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

"Required. A list of node selector terms. The terms are ORed."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

"Required. A list of node selector terms. The terms are ORed."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

"A list of node selector requirements by node's labels."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"A list of node selector requirements by node's labels."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

"A list of node selector requirements by node's fields."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

"A list of node selector requirements by node's fields."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

"A list of node selector requirements by node's labels."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

"A list of node selector requirements by node's fields."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

"The label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

fn spec.clusterChecksRunner.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

"An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAffinity

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

fn spec.clusterChecksRunner.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.clusterChecksRunner.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.clusterChecksRunner.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

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

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

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

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

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

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAntiAffinity

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

fn spec.clusterChecksRunner.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

"The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

"weight associated with matching the corresponding podAffinityTerm, in the range 1-100."

obj spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

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

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

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

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

"If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces

withNamespaces(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin

withNamespacesMixin(namespaces)

"namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed."

obj spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

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

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector

"A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config

"Agent configuration."

fn spec.clusterChecksRunner.config.withArgs

withArgs(args)

"Args allows the specification of extra args to Command parameter"

fn spec.clusterChecksRunner.config.withArgsMixin

withArgsMixin(args)

"Args allows the specification of extra args to Command parameter"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.withCommand

withCommand(command)

"Command allows the specification of custom entrypoint for Cluster Checks Runner container"

fn spec.clusterChecksRunner.config.withCommandMixin

withCommandMixin(command)

"Command allows the specification of custom entrypoint for Cluster Checks Runner container"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.withEnv

withEnv(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.clusterChecksRunner.config.withEnvMixin

withEnvMixin(env)

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.withHealthPort

withHealthPort(healthPort)

"HealthPort of the Agent container for internal liveness probe. Must be the same as the Liveness/Readiness probes."

fn spec.clusterChecksRunner.config.withLogLevel

withLogLevel(logLevel)

"Set logging verbosity, valid log levels are: trace, debug, info, warn, error, critical, and off"

fn spec.clusterChecksRunner.config.withVolumeMounts

withVolumeMounts(volumeMounts)

"Specify additional volume mounts in the Datadog Cluster Check Runner container."

fn spec.clusterChecksRunner.config.withVolumeMountsMixin

withVolumeMountsMixin(volumeMounts)

"Specify additional volume mounts in the Datadog Cluster Check Runner container."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.withVolumes

withVolumes(volumes)

"Specify additional volumes in the Datadog Cluster Check Runner container."

fn spec.clusterChecksRunner.config.withVolumesMixin

withVolumesMixin(volumes)

"Specify additional volumes in the Datadog Cluster Check Runner container."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.env

"The Datadog Agent supports many environment variables. See also: https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables"

fn spec.clusterChecksRunner.config.env.withName

withName(name)

"Name of the environment variable. Must be a C_IDENTIFIER."

fn spec.clusterChecksRunner.config.env.withValue

withValue(value)

"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 \"\"."

obj spec.clusterChecksRunner.config.env.valueFrom

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

obj spec.clusterChecksRunner.config.env.valueFrom.configMapKeyRef

"Selects a key of a ConfigMap."

fn spec.clusterChecksRunner.config.env.valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn spec.clusterChecksRunner.config.env.valueFrom.configMapKeyRef.withName

withName(name)

"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?"

fn spec.clusterChecksRunner.config.env.valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.clusterChecksRunner.config.env.valueFrom.fieldRef

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

fn spec.clusterChecksRunner.config.env.valueFrom.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.clusterChecksRunner.config.env.valueFrom.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.clusterChecksRunner.config.env.valueFrom.resourceFieldRef

"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."

fn spec.clusterChecksRunner.config.env.valueFrom.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.clusterChecksRunner.config.env.valueFrom.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.clusterChecksRunner.config.env.valueFrom.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.clusterChecksRunner.config.env.valueFrom.secretKeyRef

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

fn spec.clusterChecksRunner.config.env.valueFrom.secretKeyRef.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.clusterChecksRunner.config.env.valueFrom.secretKeyRef.withName

withName(name)

"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?"

fn spec.clusterChecksRunner.config.env.valueFrom.secretKeyRef.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.clusterChecksRunner.config.livenessProbe

"Configure the Liveness Probe of the CLC container"

fn spec.clusterChecksRunner.config.livenessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.clusterChecksRunner.config.livenessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.clusterChecksRunner.config.livenessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.clusterChecksRunner.config.livenessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.clusterChecksRunner.config.livenessProbe.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset."

fn spec.clusterChecksRunner.config.livenessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.clusterChecksRunner.config.livenessProbe.exec

"Exec specifies the action to take."

fn spec.clusterChecksRunner.config.livenessProbe.exec.withCommand

withCommand(command)

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

fn spec.clusterChecksRunner.config.livenessProbe.exec.withCommandMixin

withCommandMixin(command)

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

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.livenessProbe.grpc

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

fn spec.clusterChecksRunner.config.livenessProbe.grpc.withPort

withPort(port)

"Port number of the gRPC service. Number must be in the range 1 to 65535."

fn spec.clusterChecksRunner.config.livenessProbe.grpc.withService

withService(service)

"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."

obj spec.clusterChecksRunner.config.livenessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.clusterChecksRunner.config.livenessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.clusterChecksRunner.config.livenessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.clusterChecksRunner.config.livenessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.livenessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.clusterChecksRunner.config.livenessProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.clusterChecksRunner.config.livenessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.clusterChecksRunner.config.livenessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.clusterChecksRunner.config.livenessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.clusterChecksRunner.config.livenessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.clusterChecksRunner.config.livenessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port."

fn spec.clusterChecksRunner.config.livenessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.clusterChecksRunner.config.livenessProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.clusterChecksRunner.config.readinessProbe

"Configure the Readiness Probe of the CLC container"

fn spec.clusterChecksRunner.config.readinessProbe.withFailureThreshold

withFailureThreshold(failureThreshold)

"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1."

fn spec.clusterChecksRunner.config.readinessProbe.withInitialDelaySeconds

withInitialDelaySeconds(initialDelaySeconds)

"Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

fn spec.clusterChecksRunner.config.readinessProbe.withPeriodSeconds

withPeriodSeconds(periodSeconds)

"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1."

fn spec.clusterChecksRunner.config.readinessProbe.withSuccessThreshold

withSuccessThreshold(successThreshold)

"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1."

fn spec.clusterChecksRunner.config.readinessProbe.withTerminationGracePeriodSeconds

withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)

"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset."

fn spec.clusterChecksRunner.config.readinessProbe.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"

obj spec.clusterChecksRunner.config.readinessProbe.exec

"Exec specifies the action to take."

fn spec.clusterChecksRunner.config.readinessProbe.exec.withCommand

withCommand(command)

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

fn spec.clusterChecksRunner.config.readinessProbe.exec.withCommandMixin

withCommandMixin(command)

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

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.readinessProbe.grpc

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

fn spec.clusterChecksRunner.config.readinessProbe.grpc.withPort

withPort(port)

"Port number of the gRPC service. Number must be in the range 1 to 65535."

fn spec.clusterChecksRunner.config.readinessProbe.grpc.withService

withService(service)

"Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). \n If this is not specified, the default behavior is defined by gRPC."

obj spec.clusterChecksRunner.config.readinessProbe.httpGet

"HTTPGet specifies the http request to perform."

fn spec.clusterChecksRunner.config.readinessProbe.httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn spec.clusterChecksRunner.config.readinessProbe.httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.clusterChecksRunner.config.readinessProbe.httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.readinessProbe.httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn spec.clusterChecksRunner.config.readinessProbe.httpGet.withPort

withPort(port)

"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

fn spec.clusterChecksRunner.config.readinessProbe.httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj spec.clusterChecksRunner.config.readinessProbe.httpGet.httpHeaders

"Custom headers to set in the request. HTTP allows repeated headers."

fn spec.clusterChecksRunner.config.readinessProbe.httpGet.httpHeaders.withName

withName(name)

"The header field name"

fn spec.clusterChecksRunner.config.readinessProbe.httpGet.httpHeaders.withValue

withValue(value)

"The header field value"

obj spec.clusterChecksRunner.config.readinessProbe.tcpSocket

"TCPSocket specifies an action involving a TCP port."

fn spec.clusterChecksRunner.config.readinessProbe.tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn spec.clusterChecksRunner.config.readinessProbe.tcpSocket.withPort

withPort(port)

"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."

obj spec.clusterChecksRunner.config.resources

"Datadog Cluster Checks Runner resource requests and limits."

fn spec.clusterChecksRunner.config.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.clusterChecksRunner.config.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.resources.withRequests

withRequests(requests)

"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/"

fn spec.clusterChecksRunner.config.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.securityContext

"Pod-level SecurityContext."

fn spec.clusterChecksRunner.config.securityContext.withFsGroup

withFsGroup(fsGroup)

"A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: \n 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- \n If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterChecksRunner.config.securityContext.withFsGroupChangePolicy

withFsGroupChangePolicy(fsGroupChangePolicy)

"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterChecksRunner.config.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

"The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterChecksRunner.config.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

"Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."

fn spec.clusterChecksRunner.config.securityContext.withRunAsUser

withRunAsUser(runAsUser)

"The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterChecksRunner.config.securityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterChecksRunner.config.securityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

"A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. Note that this field cannot be set when spec.os.name is windows."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.securityContext.withSysctls

withSysctls(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterChecksRunner.config.securityContext.withSysctlsMixin

withSysctlsMixin(sysctls)

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.securityContext.seLinuxOptions

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

fn spec.clusterChecksRunner.config.securityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.clusterChecksRunner.config.securityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.clusterChecksRunner.config.securityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.clusterChecksRunner.config.securityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.clusterChecksRunner.config.securityContext.seccompProfile

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

fn spec.clusterChecksRunner.config.securityContext.seccompProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"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\"."

fn spec.clusterChecksRunner.config.securityContext.seccompProfile.withType

withType(type)

"type indicates which kind of seccomp profile will be applied. Valid options are: \n 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."

obj spec.clusterChecksRunner.config.securityContext.sysctls

"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows."

fn spec.clusterChecksRunner.config.securityContext.sysctls.withName

withName(name)

"Name of a property to set"

fn spec.clusterChecksRunner.config.securityContext.sysctls.withValue

withValue(value)

"Value of a property to set"

obj spec.clusterChecksRunner.config.securityContext.windowsOptions

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

fn spec.clusterChecksRunner.config.securityContext.windowsOptions.withGmsaCredentialSpec

withGmsaCredentialSpec(gmsaCredentialSpec)

"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."

fn spec.clusterChecksRunner.config.securityContext.windowsOptions.withGmsaCredentialSpecName

withGmsaCredentialSpecName(gmsaCredentialSpecName)

"GMSACredentialSpecName is the name of the GMSA credential spec to use."

fn spec.clusterChecksRunner.config.securityContext.windowsOptions.withHostProcess

withHostProcess(hostProcess)

"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."

fn spec.clusterChecksRunner.config.securityContext.windowsOptions.withRunAsUserName

withRunAsUserName(runAsUserName)

"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."

obj spec.clusterChecksRunner.config.volumeMounts

"Specify additional volume mounts in the Datadog Cluster Check Runner container."

fn spec.clusterChecksRunner.config.volumeMounts.withMountPath

withMountPath(mountPath)

"Path within the container at which the volume should be mounted. Must not contain ':'."

fn spec.clusterChecksRunner.config.volumeMounts.withMountPropagation

withMountPropagation(mountPropagation)

"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."

fn spec.clusterChecksRunner.config.volumeMounts.withName

withName(name)

"This must match the Name of a Volume."

fn spec.clusterChecksRunner.config.volumeMounts.withReadOnly

withReadOnly(readOnly)

"Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false."

fn spec.clusterChecksRunner.config.volumeMounts.withSubPath

withSubPath(subPath)

"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."

fn spec.clusterChecksRunner.config.volumeMounts.withSubPathExpr

withSubPathExpr(subPathExpr)

"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."

obj spec.clusterChecksRunner.config.volumes

"Specify additional volumes in the Datadog Cluster Check Runner container."

fn spec.clusterChecksRunner.config.volumes.withName

withName(name)

"name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.clusterChecksRunner.config.volumes.awsElasticBlockStore

"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"

fn spec.clusterChecksRunner.config.volumes.awsElasticBlockStore.withFsType

withFsType(fsType)

"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterChecksRunner.config.volumes.awsElasticBlockStore.withPartition

withPartition(partition)

"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)."

fn spec.clusterChecksRunner.config.volumes.awsElasticBlockStore.withReadOnly

withReadOnly(readOnly)

"readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

fn spec.clusterChecksRunner.config.volumes.awsElasticBlockStore.withVolumeID

withVolumeID(volumeID)

"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"

obj spec.clusterChecksRunner.config.volumes.azureDisk

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

fn spec.clusterChecksRunner.config.volumes.azureDisk.withCachingMode

withCachingMode(cachingMode)

"cachingMode is the Host Caching mode: None, Read Only, Read Write."

fn spec.clusterChecksRunner.config.volumes.azureDisk.withDiskName

withDiskName(diskName)

"diskName is the Name of the data disk in the blob storage"

fn spec.clusterChecksRunner.config.volumes.azureDisk.withDiskURI

withDiskURI(diskURI)

"diskURI is the URI of data disk in the blob storage"

fn spec.clusterChecksRunner.config.volumes.azureDisk.withFsType

withFsType(fsType)

"fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.clusterChecksRunner.config.volumes.azureDisk.withKind

withKind(kind)

"kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared"

fn spec.clusterChecksRunner.config.volumes.azureDisk.withReadOnly

withReadOnly(readOnly)

"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.clusterChecksRunner.config.volumes.azureFile

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

fn spec.clusterChecksRunner.config.volumes.azureFile.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterChecksRunner.config.volumes.azureFile.withSecretName

withSecretName(secretName)

"secretName is the name of secret that contains Azure Storage Account Name and Key"

fn spec.clusterChecksRunner.config.volumes.azureFile.withShareName

withShareName(shareName)

"shareName is the azure share Name"

obj spec.clusterChecksRunner.config.volumes.cephfs

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

fn spec.clusterChecksRunner.config.volumes.cephfs.withMonitors

withMonitors(monitors)

"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.clusterChecksRunner.config.volumes.cephfs.withMonitorsMixin

withMonitorsMixin(monitors)

"monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.cephfs.withPath

withPath(path)

"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /"

fn spec.clusterChecksRunner.config.volumes.cephfs.withReadOnly

withReadOnly(readOnly)

"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.clusterChecksRunner.config.volumes.cephfs.withSecretFile

withSecretFile(secretFile)

"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

fn spec.clusterChecksRunner.config.volumes.cephfs.withUser

withUser(user)

"user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"

obj spec.clusterChecksRunner.config.volumes.cephfs.secretRef

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

fn spec.clusterChecksRunner.config.volumes.cephfs.secretRef.withName

withName(name)

"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?"

obj spec.clusterChecksRunner.config.volumes.cinder

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

fn spec.clusterChecksRunner.config.volumes.cinder.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.clusterChecksRunner.config.volumes.cinder.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

fn spec.clusterChecksRunner.config.volumes.cinder.withVolumeID

withVolumeID(volumeID)

"volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"

obj spec.clusterChecksRunner.config.volumes.cinder.secretRef

"secretRef is optional: points to a secret object containing parameters used to connect to OpenStack."

fn spec.clusterChecksRunner.config.volumes.cinder.secretRef.withName

withName(name)

"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?"

obj spec.clusterChecksRunner.config.volumes.configMap

"configMap represents a configMap that should populate this volume"

fn spec.clusterChecksRunner.config.volumes.configMap.withDefaultMode

withDefaultMode(defaultMode)

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

fn spec.clusterChecksRunner.config.volumes.configMap.withItems

withItems(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterChecksRunner.config.volumes.configMap.withItemsMixin

withItemsMixin(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.configMap.withName

withName(name)

"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?"

fn spec.clusterChecksRunner.config.volumes.configMap.withOptional

withOptional(optional)

"optional specify whether the ConfigMap or its keys must be defined"

obj spec.clusterChecksRunner.config.volumes.configMap.items

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterChecksRunner.config.volumes.configMap.items.withKey

withKey(key)

"key is the key to project."

fn spec.clusterChecksRunner.config.volumes.configMap.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.clusterChecksRunner.config.volumes.configMap.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.clusterChecksRunner.config.volumes.csi

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

fn spec.clusterChecksRunner.config.volumes.csi.withDriver

withDriver(driver)

"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."

fn spec.clusterChecksRunner.config.volumes.csi.withFsType

withFsType(fsType)

"fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply."

fn spec.clusterChecksRunner.config.volumes.csi.withReadOnly

withReadOnly(readOnly)

"readOnly specifies a read-only configuration for the volume. Defaults to false (read/write)."

fn spec.clusterChecksRunner.config.volumes.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

fn spec.clusterChecksRunner.config.volumes.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

"volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.volumes.csi.nodePublishSecretRef

"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."

fn spec.clusterChecksRunner.config.volumes.csi.nodePublishSecretRef.withName

withName(name)

"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?"

obj spec.clusterChecksRunner.config.volumes.downwardAPI

"downwardAPI represents downward API about the pod that should populate this volume"

fn spec.clusterChecksRunner.config.volumes.downwardAPI.withDefaultMode

withDefaultMode(defaultMode)

"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."

fn spec.clusterChecksRunner.config.volumes.downwardAPI.withItems

withItems(items)

"Items is a list of downward API volume file"

fn spec.clusterChecksRunner.config.volumes.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of downward API volume file"

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.volumes.downwardAPI.items

"Items is a list of downward API volume file"

fn spec.clusterChecksRunner.config.volumes.downwardAPI.items.withMode

withMode(mode)

"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."

fn spec.clusterChecksRunner.config.volumes.downwardAPI.items.withPath

withPath(path)

"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 '..'"

obj spec.clusterChecksRunner.config.volumes.downwardAPI.items.fieldRef

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

fn spec.clusterChecksRunner.config.volumes.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.clusterChecksRunner.config.volumes.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.clusterChecksRunner.config.volumes.downwardAPI.items.resourceFieldRef

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

fn spec.clusterChecksRunner.config.volumes.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.clusterChecksRunner.config.volumes.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.clusterChecksRunner.config.volumes.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.clusterChecksRunner.config.volumes.emptyDir

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

fn spec.clusterChecksRunner.config.volumes.emptyDir.withMedium

withMedium(medium)

"medium represents what type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"

fn spec.clusterChecksRunner.config.volumes.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

"sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir"

obj spec.clusterChecksRunner.config.volumes.ephemeral

"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. \n 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). \n Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. \n 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. \n A pod can use both types of ephemeral volumes and persistent volumes at the same time."

obj spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate

"Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be <pod name>-<volume name> where <volume name> is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). \n 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. \n This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. \n Required, must not be nil."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.withMetadata

withMetadata(metadata)

"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."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.withMetadataMixin

withMetadataMixin(metadata)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec

"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."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModes

withAccessModes(accessModes)

"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin

withAccessModesMixin(accessModes)

"accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.withStorageClassName

withStorageClassName(storageClassName)

"storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeMode

withVolumeMode(volumeMode)

"volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeName

withVolumeName(volumeName)

"volumeName is the binding reference to the PersistentVolume backing this claim."

obj spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource

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

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup

withApiGroup(apiGroup)

"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."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef

"dataSourceRef 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. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup

withApiGroup(apiGroup)

"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."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.resources

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

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequests

withRequests(requests)

"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/"

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin

withRequestsMixin(requests)

"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/"

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector

"selector is a label query over volumes to consider for binding."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.config.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.volumes.fc

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

fn spec.clusterChecksRunner.config.volumes.fc.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterChecksRunner.config.volumes.fc.withLun

withLun(lun)

"lun is Optional: FC target lun number"

fn spec.clusterChecksRunner.config.volumes.fc.withReadOnly

withReadOnly(readOnly)

"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterChecksRunner.config.volumes.fc.withTargetWWNs

withTargetWWNs(targetWWNs)

"targetWWNs is Optional: FC target worldwide names (WWNs)"

fn spec.clusterChecksRunner.config.volumes.fc.withTargetWWNsMixin

withTargetWWNsMixin(targetWWNs)

"targetWWNs is Optional: FC target worldwide names (WWNs)"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.fc.withWwids

withWwids(wwids)

"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

fn spec.clusterChecksRunner.config.volumes.fc.withWwidsMixin

withWwidsMixin(wwids)

"wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.volumes.flexVolume

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

fn spec.clusterChecksRunner.config.volumes.flexVolume.withDriver

withDriver(driver)

"driver is the name of the driver to use for this volume."

fn spec.clusterChecksRunner.config.volumes.flexVolume.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script."

fn spec.clusterChecksRunner.config.volumes.flexVolume.withOptions

withOptions(options)

"options is Optional: this field holds extra command options if any."

fn spec.clusterChecksRunner.config.volumes.flexVolume.withOptionsMixin

withOptionsMixin(options)

"options is Optional: this field holds extra command options if any."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.flexVolume.withReadOnly

withReadOnly(readOnly)

"readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

obj spec.clusterChecksRunner.config.volumes.flexVolume.secretRef

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

fn spec.clusterChecksRunner.config.volumes.flexVolume.secretRef.withName

withName(name)

"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?"

obj spec.clusterChecksRunner.config.volumes.flocker

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

fn spec.clusterChecksRunner.config.volumes.flocker.withDatasetName

withDatasetName(datasetName)

"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated"

fn spec.clusterChecksRunner.config.volumes.flocker.withDatasetUUID

withDatasetUUID(datasetUUID)

"datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset"

obj spec.clusterChecksRunner.config.volumes.gcePersistentDisk

"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"

fn spec.clusterChecksRunner.config.volumes.gcePersistentDisk.withFsType

withFsType(fsType)

"fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterChecksRunner.config.volumes.gcePersistentDisk.withPartition

withPartition(partition)

"partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.clusterChecksRunner.config.volumes.gcePersistentDisk.withPdName

withPdName(pdName)

"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"

fn spec.clusterChecksRunner.config.volumes.gcePersistentDisk.withReadOnly

withReadOnly(readOnly)

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

obj spec.clusterChecksRunner.config.volumes.gitRepo

"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."

fn spec.clusterChecksRunner.config.volumes.gitRepo.withDirectory

withDirectory(directory)

"directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name."

fn spec.clusterChecksRunner.config.volumes.gitRepo.withRepository

withRepository(repository)

"repository is the URL"

fn spec.clusterChecksRunner.config.volumes.gitRepo.withRevision

withRevision(revision)

"revision is the commit hash for the specified revision."

obj spec.clusterChecksRunner.config.volumes.glusterfs

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

fn spec.clusterChecksRunner.config.volumes.glusterfs.withEndpoints

withEndpoints(endpoints)

"endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.clusterChecksRunner.config.volumes.glusterfs.withPath

withPath(path)

"path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"

fn spec.clusterChecksRunner.config.volumes.glusterfs.withReadOnly

withReadOnly(readOnly)

"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"

obj spec.clusterChecksRunner.config.volumes.hostPath

"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."

fn spec.clusterChecksRunner.config.volumes.hostPath.withPath

withPath(path)

"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"

fn spec.clusterChecksRunner.config.volumes.hostPath.withType

withType(type)

"type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"

obj spec.clusterChecksRunner.config.volumes.iscsi

"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"

fn spec.clusterChecksRunner.config.volumes.iscsi.withChapAuthDiscovery

withChapAuthDiscovery(chapAuthDiscovery)

"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication"

fn spec.clusterChecksRunner.config.volumes.iscsi.withChapAuthSession

withChapAuthSession(chapAuthSession)

"chapAuthSession defines whether support iSCSI Session CHAP authentication"

fn spec.clusterChecksRunner.config.volumes.iscsi.withFsType

withFsType(fsType)

"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterChecksRunner.config.volumes.iscsi.withInitiatorName

withInitiatorName(initiatorName)

"initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection."

fn spec.clusterChecksRunner.config.volumes.iscsi.withIqn

withIqn(iqn)

"iqn is the target iSCSI Qualified Name."

fn spec.clusterChecksRunner.config.volumes.iscsi.withIscsiInterface

withIscsiInterface(iscsiInterface)

"iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp)."

fn spec.clusterChecksRunner.config.volumes.iscsi.withLun

withLun(lun)

"lun represents iSCSI Target Lun number."

fn spec.clusterChecksRunner.config.volumes.iscsi.withPortals

withPortals(portals)

"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

fn spec.clusterChecksRunner.config.volumes.iscsi.withPortalsMixin

withPortalsMixin(portals)

"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.iscsi.withReadOnly

withReadOnly(readOnly)

"readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false."

fn spec.clusterChecksRunner.config.volumes.iscsi.withTargetPortal

withTargetPortal(targetPortal)

"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)."

obj spec.clusterChecksRunner.config.volumes.iscsi.secretRef

"secretRef is the CHAP Secret for iSCSI target and initiator authentication"

fn spec.clusterChecksRunner.config.volumes.iscsi.secretRef.withName

withName(name)

"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?"

obj spec.clusterChecksRunner.config.volumes.nfs

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

fn spec.clusterChecksRunner.config.volumes.nfs.withPath

withPath(path)

"path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

fn spec.clusterChecksRunner.config.volumes.nfs.withReadOnly

withReadOnly(readOnly)

"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"

fn spec.clusterChecksRunner.config.volumes.nfs.withServer

withServer(server)

"server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"

obj spec.clusterChecksRunner.config.volumes.persistentVolumeClaim

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

fn spec.clusterChecksRunner.config.volumes.persistentVolumeClaim.withClaimName

withClaimName(claimName)

"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"

fn spec.clusterChecksRunner.config.volumes.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

"readOnly Will force the ReadOnly setting in VolumeMounts. Default false."

obj spec.clusterChecksRunner.config.volumes.photonPersistentDisk

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

fn spec.clusterChecksRunner.config.volumes.photonPersistentDisk.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.clusterChecksRunner.config.volumes.photonPersistentDisk.withPdID

withPdID(pdID)

"pdID is the ID that identifies Photon Controller persistent disk"

obj spec.clusterChecksRunner.config.volumes.portworxVolume

"portworxVolume represents a portworx volume attached and mounted on kubelets host machine"

fn spec.clusterChecksRunner.config.volumes.portworxVolume.withFsType

withFsType(fsType)

"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."

fn spec.clusterChecksRunner.config.volumes.portworxVolume.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterChecksRunner.config.volumes.portworxVolume.withVolumeID

withVolumeID(volumeID)

"volumeID uniquely identifies a Portworx volume"

obj spec.clusterChecksRunner.config.volumes.projected

"projected items for all in one resources secrets, configmaps, and downward API"

fn spec.clusterChecksRunner.config.volumes.projected.withDefaultMode

withDefaultMode(defaultMode)

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

fn spec.clusterChecksRunner.config.volumes.projected.withSources

withSources(sources)

"sources is the list of volume projections"

fn spec.clusterChecksRunner.config.volumes.projected.withSourcesMixin

withSourcesMixin(sources)

"sources is the list of volume projections"

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.volumes.projected.sources

"sources is the list of volume projections"

obj spec.clusterChecksRunner.config.volumes.projected.sources.configMap

"configMap information about the configMap data to project"

fn spec.clusterChecksRunner.config.volumes.projected.sources.configMap.withItems

withItems(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterChecksRunner.config.volumes.projected.sources.configMap.withItemsMixin

withItemsMixin(items)

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.projected.sources.configMap.withName

withName(name)

"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?"

fn spec.clusterChecksRunner.config.volumes.projected.sources.configMap.withOptional

withOptional(optional)

"optional specify whether the ConfigMap or its keys must be defined"

obj spec.clusterChecksRunner.config.volumes.projected.sources.configMap.items

"items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterChecksRunner.config.volumes.projected.sources.configMap.items.withKey

withKey(key)

"key is the key to project."

fn spec.clusterChecksRunner.config.volumes.projected.sources.configMap.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.clusterChecksRunner.config.volumes.projected.sources.configMap.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI

"downwardAPI information about the downwardAPI data to project"

fn spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.withItems

withItems(items)

"Items is a list of DownwardAPIVolume file"

fn spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.withItemsMixin

withItemsMixin(items)

"Items is a list of DownwardAPIVolume file"

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items

"Items is a list of DownwardAPIVolume file"

fn spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items.withMode

withMode(mode)

"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."

fn spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items.withPath

withPath(path)

"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 '..'"

obj spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items.fieldRef

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

fn spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion

withApiVersion(apiVersion)

"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"."

fn spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items.fieldRef.withFieldPath

withFieldPath(fieldPath)

"Path of the field to select in the specified API version."

obj spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef

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

fn spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName

withContainerName(containerName)

"Container name: required for volumes, optional for env vars"

fn spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor

withDivisor(divisor)

"Specifies the output format of the exposed resources, defaults to \"1\

fn spec.clusterChecksRunner.config.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource

withResource(resource)

"Required: resource to select"

obj spec.clusterChecksRunner.config.volumes.projected.sources.secret

"secret information about the secret data to project"

fn spec.clusterChecksRunner.config.volumes.projected.sources.secret.withItems

withItems(items)

"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterChecksRunner.config.volumes.projected.sources.secret.withItemsMixin

withItemsMixin(items)

"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.projected.sources.secret.withName

withName(name)

"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?"

fn spec.clusterChecksRunner.config.volumes.projected.sources.secret.withOptional

withOptional(optional)

"optional field specify whether the Secret or its key must be defined"

obj spec.clusterChecksRunner.config.volumes.projected.sources.secret.items

"items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterChecksRunner.config.volumes.projected.sources.secret.items.withKey

withKey(key)

"key is the key to project."

fn spec.clusterChecksRunner.config.volumes.projected.sources.secret.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.clusterChecksRunner.config.volumes.projected.sources.secret.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.clusterChecksRunner.config.volumes.projected.sources.serviceAccountToken

"serviceAccountToken is information about the serviceAccountToken data to project"

fn spec.clusterChecksRunner.config.volumes.projected.sources.serviceAccountToken.withAudience

withAudience(audience)

"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."

fn spec.clusterChecksRunner.config.volumes.projected.sources.serviceAccountToken.withExpirationSeconds

withExpirationSeconds(expirationSeconds)

"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."

fn spec.clusterChecksRunner.config.volumes.projected.sources.serviceAccountToken.withPath

withPath(path)

"path is the path relative to the mount point of the file to project the token into."

obj spec.clusterChecksRunner.config.volumes.quobyte

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

fn spec.clusterChecksRunner.config.volumes.quobyte.withGroup

withGroup(group)

"group to map volume access to Default is no group"

fn spec.clusterChecksRunner.config.volumes.quobyte.withReadOnly

withReadOnly(readOnly)

"readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false."

fn spec.clusterChecksRunner.config.volumes.quobyte.withRegistry

withRegistry(registry)

"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"

fn spec.clusterChecksRunner.config.volumes.quobyte.withTenant

withTenant(tenant)

"tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin"

fn spec.clusterChecksRunner.config.volumes.quobyte.withUser

withUser(user)

"user to map volume access to Defaults to serivceaccount user"

fn spec.clusterChecksRunner.config.volumes.quobyte.withVolume

withVolume(volume)

"volume is a string that references an already created Quobyte volume by name."

obj spec.clusterChecksRunner.config.volumes.rbd

"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"

fn spec.clusterChecksRunner.config.volumes.rbd.withFsType

withFsType(fsType)

"fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine"

fn spec.clusterChecksRunner.config.volumes.rbd.withImage

withImage(image)

"image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.clusterChecksRunner.config.volumes.rbd.withKeyring

withKeyring(keyring)

"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"

fn spec.clusterChecksRunner.config.volumes.rbd.withMonitors

withMonitors(monitors)

"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.clusterChecksRunner.config.volumes.rbd.withMonitorsMixin

withMonitorsMixin(monitors)

"monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.rbd.withPool

withPool(pool)

"pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

fn spec.clusterChecksRunner.config.volumes.rbd.withReadOnly

withReadOnly(readOnly)

"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"

fn spec.clusterChecksRunner.config.volumes.rbd.withUser

withUser(user)

"user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"

obj spec.clusterChecksRunner.config.volumes.rbd.secretRef

"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"

fn spec.clusterChecksRunner.config.volumes.rbd.secretRef.withName

withName(name)

"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?"

obj spec.clusterChecksRunner.config.volumes.scaleIO

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

fn spec.clusterChecksRunner.config.volumes.scaleIO.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\"."

fn spec.clusterChecksRunner.config.volumes.scaleIO.withGateway

withGateway(gateway)

"gateway is the host address of the ScaleIO API Gateway."

fn spec.clusterChecksRunner.config.volumes.scaleIO.withProtectionDomain

withProtectionDomain(protectionDomain)

"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage."

fn spec.clusterChecksRunner.config.volumes.scaleIO.withReadOnly

withReadOnly(readOnly)

"readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterChecksRunner.config.volumes.scaleIO.withSslEnabled

withSslEnabled(sslEnabled)

"sslEnabled Flag enable/disable SSL communication with Gateway, default false"

fn spec.clusterChecksRunner.config.volumes.scaleIO.withStorageMode

withStorageMode(storageMode)

"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned."

fn spec.clusterChecksRunner.config.volumes.scaleIO.withStoragePool

withStoragePool(storagePool)

"storagePool is the ScaleIO Storage Pool associated with the protection domain."

fn spec.clusterChecksRunner.config.volumes.scaleIO.withSystem

withSystem(system)

"system is the name of the storage system as configured in ScaleIO."

fn spec.clusterChecksRunner.config.volumes.scaleIO.withVolumeName

withVolumeName(volumeName)

"volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source."

obj spec.clusterChecksRunner.config.volumes.scaleIO.secretRef

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

fn spec.clusterChecksRunner.config.volumes.scaleIO.secretRef.withName

withName(name)

"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?"

obj spec.clusterChecksRunner.config.volumes.secret

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

fn spec.clusterChecksRunner.config.volumes.secret.withDefaultMode

withDefaultMode(defaultMode)

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

fn spec.clusterChecksRunner.config.volumes.secret.withItems

withItems(items)

"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterChecksRunner.config.volumes.secret.withItemsMixin

withItemsMixin(items)

"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.config.volumes.secret.withOptional

withOptional(optional)

"optional field specify whether the Secret or its keys must be defined"

fn spec.clusterChecksRunner.config.volumes.secret.withSecretName

withSecretName(secretName)

"secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"

obj spec.clusterChecksRunner.config.volumes.secret.items

"items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'."

fn spec.clusterChecksRunner.config.volumes.secret.items.withKey

withKey(key)

"key is the key to project."

fn spec.clusterChecksRunner.config.volumes.secret.items.withMode

withMode(mode)

"mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set."

fn spec.clusterChecksRunner.config.volumes.secret.items.withPath

withPath(path)

"path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'."

obj spec.clusterChecksRunner.config.volumes.storageos

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

fn spec.clusterChecksRunner.config.volumes.storageos.withFsType

withFsType(fsType)

"fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.clusterChecksRunner.config.volumes.storageos.withReadOnly

withReadOnly(readOnly)

"readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts."

fn spec.clusterChecksRunner.config.volumes.storageos.withVolumeName

withVolumeName(volumeName)

"volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace."

fn spec.clusterChecksRunner.config.volumes.storageos.withVolumeNamespace

withVolumeNamespace(volumeNamespace)

"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."

obj spec.clusterChecksRunner.config.volumes.storageos.secretRef

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

fn spec.clusterChecksRunner.config.volumes.storageos.secretRef.withName

withName(name)

"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?"

obj spec.clusterChecksRunner.config.volumes.vsphereVolume

"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"

fn spec.clusterChecksRunner.config.volumes.vsphereVolume.withFsType

withFsType(fsType)

"fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified."

fn spec.clusterChecksRunner.config.volumes.vsphereVolume.withStoragePolicyID

withStoragePolicyID(storagePolicyID)

"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."

fn spec.clusterChecksRunner.config.volumes.vsphereVolume.withStoragePolicyName

withStoragePolicyName(storagePolicyName)

"storagePolicyName is the storage Policy Based Management (SPBM) profile name."

fn spec.clusterChecksRunner.config.volumes.vsphereVolume.withVolumePath

withVolumePath(volumePath)

"volumePath is the path that identifies vSphere volume vmdk"

obj spec.clusterChecksRunner.customConfig

"Allow to put custom configuration for the Agent, corresponding to the datadog.yaml config file. See https://docs.datadoghq.com/agent/guide/agent-configuration-files/?tab=agentv6 for more details."

fn spec.clusterChecksRunner.customConfig.withConfigData

withConfigData(configData)

"ConfigData corresponds to the configuration file content."

obj spec.clusterChecksRunner.customConfig.configMap

"Enable to specify a reference to an already existing ConfigMap."

fn spec.clusterChecksRunner.customConfig.configMap.withFileKey

withFileKey(fileKey)

"FileKey corresponds to the key used in the ConfigMap.Data to store the configuration file content."

fn spec.clusterChecksRunner.customConfig.configMap.withName

withName(name)

"The name of source ConfigMap."

obj spec.clusterChecksRunner.image

"The container image of the Datadog Cluster Checks Runner."

fn spec.clusterChecksRunner.image.withJmxEnabled

withJmxEnabled(jmxEnabled)

"Define whether the Agent image should support JMX. To be used if the Name field does not correspond to a full image string."

fn spec.clusterChecksRunner.image.withName

withName(name)

"Define the image to use: Use \"gcr.io/datadoghq/agent:latest\" for Datadog Agent 7. Use \"datadog/dogstatsd:latest\" for standalone Datadog Agent DogStatsD 7. Use \"gcr.io/datadoghq/cluster-agent:latest\" for Datadog Cluster Agent. Use \"agent\" with the registry and tag configurations for /agent:. Use \"cluster-agent\" with the registry and tag configurations for /cluster-agent:. If the name is the full image string—<name>:<tag> or <registry>/<name>:<tag>, then tag, jmxEnabled, and global.registry values are ignored. Otherwise, image string is created by overriding default settings with supplied name, tag, and jmxEnabled values; image string is created using default registry unless global.registry is configured."

fn spec.clusterChecksRunner.image.withPullPolicy

withPullPolicy(pullPolicy)

"The Kubernetes pull policy: Use Always, Never, or IfNotPresent."

fn spec.clusterChecksRunner.image.withPullSecrets

withPullSecrets(pullSecrets)

"It is possible to specify Docker registry credentials. See https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

fn spec.clusterChecksRunner.image.withPullSecretsMixin

withPullSecretsMixin(pullSecrets)

"It is possible to specify Docker registry credentials. See https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.image.withTag

withTag(tag)

"Define the image tag to use. To be used if the Name field does not correspond to a full image string."

obj spec.clusterChecksRunner.image.pullSecrets

"It is possible to specify Docker registry credentials. See https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod"

fn spec.clusterChecksRunner.image.pullSecrets.withName

withName(name)

"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?"

obj spec.clusterChecksRunner.networkPolicy

"Provide Cluster Checks Runner Network Policy configuration."

fn spec.clusterChecksRunner.networkPolicy.withCreate

withCreate(create)

"If true, create a NetworkPolicy for the current agent."

fn spec.clusterChecksRunner.networkPolicy.withDnsSelectorEndpoints

withDnsSelectorEndpoints(dnsSelectorEndpoints)

"Cilium selector of the DNS\u202fserver entity."

fn spec.clusterChecksRunner.networkPolicy.withDnsSelectorEndpointsMixin

withDnsSelectorEndpointsMixin(dnsSelectorEndpoints)

"Cilium selector of the DNS\u202fserver entity."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.networkPolicy.withFlavor

withFlavor(flavor)

"Which network policy to use. Can be kubernetes or cilium."

obj spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints

"Cilium selector of the DNS\u202fserver entity."

fn spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints.withMatchLabels

withMatchLabels(matchLabels)

"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."

fn spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist."

fn spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints.matchExpressions.withValues

withValues(values)

"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."

fn spec.clusterChecksRunner.networkPolicy.dnsSelectorEndpoints.matchExpressions.withValuesMixin

withValuesMixin(values)

"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."

Note: This function appends passed data to existing values

obj spec.clusterChecksRunner.rbac

"RBAC configuration of the Datadog Cluster Checks Runner."

fn spec.clusterChecksRunner.rbac.withCreate

withCreate(create)

"Used to configure RBAC resources creation."

fn spec.clusterChecksRunner.rbac.withServiceAccountName

withServiceAccountName(serviceAccountName)

"Used to set up the service account name to use. Ignored if the field Create is true."

obj spec.clusterChecksRunner.tolerations

"If specified, the Cluster-Checks pod's tolerations."

fn spec.clusterChecksRunner.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.clusterChecksRunner.tolerations.withKey

withKey(key)

"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."

fn spec.clusterChecksRunner.tolerations.withOperator

withOperator(operator)

"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."

fn spec.clusterChecksRunner.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"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."

fn spec.clusterChecksRunner.tolerations.withValue

withValue(value)

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

obj spec.credentials

"Configure the credentials needed to run Agents. If not set, then the credentials set in the DatadogOperator will be used."

fn spec.credentials.withApiKey

withApiKey(apiKey)

"APIKey Set this to your Datadog API key before the Agent runs. See also: https://app.datadoghq.com/account/settings#agent/kubernetes"

fn spec.credentials.withApiKeyExistingSecret

withApiKeyExistingSecret(apiKeyExistingSecret)

"APIKeyExistingSecret is DEPRECATED. In order to pass the API key through an existing secret, please consider \"apiSecret\" instead. If set, this parameter takes precedence over \"apiKey\"."

fn spec.credentials.withAppKey

withAppKey(appKey)

"If you are using clusterAgent.metricsProvider.enabled = true, you must set a Datadog application key for read access to your metrics."

fn spec.credentials.withAppKeyExistingSecret

withAppKeyExistingSecret(appKeyExistingSecret)

"AppKeyExistingSecret is DEPRECATED. In order to pass the APP key through an existing secret, please consider \"appSecret\" instead. If set, this parameter takes precedence over \"appKey\"."

fn spec.credentials.withToken

withToken(token)

"This needs to be at least 32 characters a-zA-z. It is a preshared key between the node agents and the cluster agent."

fn spec.credentials.withUseSecretBackend

withUseSecretBackend(useSecretBackend)

"UseSecretBackend use the Agent secret backend feature for retreiving all credentials needed by the different components: Agent, Cluster, Cluster-Checks. default value is false."

obj spec.credentials.apiSecret

"APISecret Use existing Secret which stores API key instead of creating a new one. If set, this parameter takes precedence over \"apiKey\" and \"apiKeyExistingSecret\"."

fn spec.credentials.apiSecret.withKeyName

withKeyName(keyName)

"KeyName is the key of the secret to use."

fn spec.credentials.apiSecret.withSecretName

withSecretName(secretName)

"SecretName is the name of the secret."

obj spec.credentials.appSecret

"APPSecret Use existing Secret which stores API key instead of creating a new one. If set, this parameter takes precedence over \"apiKey\" and \"appKeyExistingSecret\"."

fn spec.credentials.appSecret.withKeyName

withKeyName(keyName)

"KeyName is the key of the secret to use."

fn spec.credentials.appSecret.withSecretName

withSecretName(secretName)

"SecretName is the name of the secret."

obj spec.features

"Features running on the Agent and Cluster Agent."

obj spec.features.kubeStateMetricsCore

"KubeStateMetricsCore configuration."

fn spec.features.kubeStateMetricsCore.withClusterCheck

withClusterCheck(clusterCheck)

"ClusterCheck configures the Kubernetes State Metrics Core check as a cluster check."

fn spec.features.kubeStateMetricsCore.withEnabled

withEnabled(enabled)

"Enable this to start the Kubernetes State Metrics Core check. Refer to https://docs.datadoghq.com/integrations/kubernetes_state_core"

obj spec.features.kubeStateMetricsCore.conf

"To override the configuration for the default Kubernetes State Metrics Core check. Must point to a ConfigMap containing a valid cluster check configuration."

fn spec.features.kubeStateMetricsCore.conf.withConfigData

withConfigData(configData)

"ConfigData corresponds to the configuration file content."

obj spec.features.kubeStateMetricsCore.conf.configMap

"Enable to specify a reference to an already existing ConfigMap."

fn spec.features.kubeStateMetricsCore.conf.configMap.withFileKey

withFileKey(fileKey)

"FileKey corresponds to the key used in the ConfigMap.Data to store the configuration file content."

fn spec.features.kubeStateMetricsCore.conf.configMap.withName

withName(name)

"The name of source ConfigMap."

obj spec.features.logCollection

"LogCollection configuration."

fn spec.features.logCollection.withContainerCollectUsingFiles

withContainerCollectUsingFiles(containerCollectUsingFiles)

"Collect logs from files in /var/log/pods instead of using the container runtime API. Collecting logs from files is usually the most efficient way of collecting logs. See also: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup Default is true"

fn spec.features.logCollection.withContainerLogsPath

withContainerLogsPath(containerLogsPath)

"Allows log collection from the container log path. Set to a different path if you are not using the Docker runtime. See also: https://docs.datadoghq.com/agent/kubernetes/daemonset_setup/?tab=k8sfile#create-manifest Defaults to /var/lib/docker/containers"

fn spec.features.logCollection.withContainerSymlinksPath

withContainerSymlinksPath(containerSymlinksPath)

"Allows the log collection to use symbolic links in this directory to validate container ID -> pod. Defaults to /var/log/containers"

fn spec.features.logCollection.withEnabled

withEnabled(enabled)

"Enable this option to activate Datadog Agent log collection. See also: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup"

fn spec.features.logCollection.withLogsConfigContainerCollectAll

withLogsConfigContainerCollectAll(logsConfigContainerCollectAll)

"Enable this option to allow log collection for all containers. See also: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup"

fn spec.features.logCollection.withOpenFilesLimit

withOpenFilesLimit(openFilesLimit)

"Sets the maximum number of log files that the Datadog Agent tails. Increasing this limit can increase resource consumption of the Agent. See also: https://docs.datadoghq.com/agent/basic_agent_usage/kubernetes/#log-collection-setup Default is 100"

fn spec.features.logCollection.withPodLogsPath

withPodLogsPath(podLogsPath)

"Allows log collection from pod log path. Defaults to /var/log/pods."

fn spec.features.logCollection.withTempStoragePath

withTempStoragePath(tempStoragePath)

"This path (always mounted from the host) is used by Datadog Agent to store information about processed log files. If the Datadog Agent is restarted, it starts tailing the log files immediately. Default to /var/lib/datadog-agent/logs"

obj spec.features.networkMonitoring

"NetworkMonitoring configuration."

fn spec.features.networkMonitoring.withEnabled

withEnabled(enabled)

obj spec.features.orchestratorExplorer

"OrchestratorExplorer configuration."

fn spec.features.orchestratorExplorer.withAdditionalEndpoints

withAdditionalEndpoints(additionalEndpoints)

"Additional endpoints for shipping the collected data as json in the form of {\"https://process.agent.datadoghq.com\": [\"apikey1\", ...], ...}'."

fn spec.features.orchestratorExplorer.withClusterCheck

withClusterCheck(clusterCheck)

"ClusterCheck configures the Orchestrator Explorer check as a cluster check."

fn spec.features.orchestratorExplorer.withDdUrl

withDdUrl(ddUrl)

"Set this for the Datadog endpoint for the orchestrator explorer"

fn spec.features.orchestratorExplorer.withEnabled

withEnabled(enabled)

"Enable this to activate live Kubernetes monitoring. See also: https://docs.datadoghq.com/infrastructure/livecontainers/#kubernetes-resources"

fn spec.features.orchestratorExplorer.withExtraTags

withExtraTags(extraTags)

"Additional tags for the collected data in the form of a b c Difference to DD_TAGS: this is a cluster agent option that is used to define custom cluster tags"

fn spec.features.orchestratorExplorer.withExtraTagsMixin

withExtraTagsMixin(extraTags)

"Additional tags for the collected data in the form of a b c Difference to DD_TAGS: this is a cluster agent option that is used to define custom cluster tags"

Note: This function appends passed data to existing values

obj spec.features.orchestratorExplorer.conf

"To override the configuration for the default Orchestrator Explorer check. Must point to a ConfigMap containing a valid cluster check configuration."

fn spec.features.orchestratorExplorer.conf.withConfigData

withConfigData(configData)

"ConfigData corresponds to the configuration file content."

obj spec.features.orchestratorExplorer.conf.configMap

"Enable to specify a reference to an already existing ConfigMap."

fn spec.features.orchestratorExplorer.conf.configMap.withFileKey

withFileKey(fileKey)

"FileKey corresponds to the key used in the ConfigMap.Data to store the configuration file content."

fn spec.features.orchestratorExplorer.conf.configMap.withName

withName(name)

"The name of source ConfigMap."

obj spec.features.orchestratorExplorer.scrubbing

"Option to disable scrubbing of sensitive container data (passwords, tokens, etc. )."

fn spec.features.orchestratorExplorer.scrubbing.withContainers

withContainers(containers)

"Deactivate this to stop the scrubbing of sensitive container data (passwords, tokens, etc. )."

obj spec.features.prometheusScrape

"PrometheusScrape configuration."

fn spec.features.prometheusScrape.withAdditionalConfigs

withAdditionalConfigs(additionalConfigs)

"AdditionalConfigs allows adding advanced prometheus check configurations with custom discovery rules."

fn spec.features.prometheusScrape.withEnabled

withEnabled(enabled)

"Enable autodiscovering pods and services exposing prometheus metrics."

fn spec.features.prometheusScrape.withServiceEndpoints

withServiceEndpoints(serviceEndpoints)

"ServiceEndpoints enables generating dedicated checks for service endpoints."