Skip to content

nfd.v1alpha1.nodeFeatureRule

"NodeFeatureRule resource specifies a configuration for feature-based\ncustomization of node objects, such as node labeling."

Index

Fields

fn new

new(name)

new returns an instance of NodeFeatureRule

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"

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

"Spec defines the rules to be evaluated."

fn spec.withRules

withRules(rules)

"Rules is a list of node customization rules."

fn spec.withRulesMixin

withRulesMixin(rules)

"Rules is a list of node customization rules."

Note: This function appends passed data to existing values

obj spec.rules

"Rules is a list of node customization rules."

fn spec.rules.withAnnotations

withAnnotations(annotations)

"Annotations to create if the rule matches."

fn spec.rules.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to create if the rule matches."

Note: This function appends passed data to existing values

fn spec.rules.withExtendedResources

withExtendedResources(extendedResources)

"ExtendedResources to create if the rule matches."

fn spec.rules.withExtendedResourcesMixin

withExtendedResourcesMixin(extendedResources)

"ExtendedResources to create if the rule matches."

Note: This function appends passed data to existing values

fn spec.rules.withLabels

withLabels(labels)

"Labels to create if the rule matches."

fn spec.rules.withLabelsMixin

withLabelsMixin(labels)

"Labels to create if the rule matches."

Note: This function appends passed data to existing values

fn spec.rules.withLabelsTemplate

withLabelsTemplate(labelsTemplate)

"LabelsTemplate specifies a template to expand for dynamically generating\nmultiple labels. Data (after template expansion) must be keys with an\noptional value ([=]) separated by newlines."

fn spec.rules.withMatchAny

withMatchAny(matchAny)

"MatchAny specifies a list of matchers one of which must match."

fn spec.rules.withMatchAnyMixin

withMatchAnyMixin(matchAny)

"MatchAny specifies a list of matchers one of which must match."

Note: This function appends passed data to existing values

fn spec.rules.withMatchFeatures

withMatchFeatures(matchFeatures)

"MatchFeatures specifies a set of matcher terms all of which must match."

fn spec.rules.withMatchFeaturesMixin

withMatchFeaturesMixin(matchFeatures)

"MatchFeatures specifies a set of matcher terms all of which must match."

Note: This function appends passed data to existing values

fn spec.rules.withName

withName(name)

"Name of the rule."

fn spec.rules.withTaints

withTaints(taints)

"Taints to create if the rule matches."

fn spec.rules.withTaintsMixin

withTaintsMixin(taints)

"Taints to create if the rule matches."

Note: This function appends passed data to existing values

fn spec.rules.withVars

withVars(vars)

"Vars is the variables to store if the rule matches. Variables do not\ndirectly inflict any changes in the node object. However, they can be\nreferenced from other rules enabling more complex rule hierarchies,\nwithout exposing intermediary output values as labels."

fn spec.rules.withVarsMixin

withVarsMixin(vars)

"Vars is the variables to store if the rule matches. Variables do not\ndirectly inflict any changes in the node object. However, they can be\nreferenced from other rules enabling more complex rule hierarchies,\nwithout exposing intermediary output values as labels."

Note: This function appends passed data to existing values

fn spec.rules.withVarsTemplate

withVarsTemplate(varsTemplate)

"VarsTemplate specifies a template to expand for dynamically generating\nmultiple variables. Data (after template expansion) must be keys with an\noptional value ([=]) separated by newlines."

obj spec.rules.matchAny

"MatchAny specifies a list of matchers one of which must match."

fn spec.rules.matchAny.withMatchFeatures

withMatchFeatures(matchFeatures)

"MatchFeatures specifies a set of matcher terms all of which must match."

fn spec.rules.matchAny.withMatchFeaturesMixin

withMatchFeaturesMixin(matchFeatures)

"MatchFeatures specifies a set of matcher terms all of which must match."

Note: This function appends passed data to existing values

obj spec.rules.matchAny.matchFeatures

"MatchFeatures specifies a set of matcher terms all of which must match."

fn spec.rules.matchAny.matchFeatures.withFeature

withFeature(feature)

"Feature is the name of the feature set to match against."

fn spec.rules.matchAny.matchFeatures.withMatchExpressions

withMatchExpressions(matchExpressions)

"MatchExpressions is the set of per-element expressions evaluated. These\nmatch against the value of the specified elements."

fn spec.rules.matchAny.matchFeatures.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"MatchExpressions is the set of per-element expressions evaluated. These\nmatch against the value of the specified elements."

Note: This function appends passed data to existing values

obj spec.rules.matchAny.matchFeatures.matchName

"MatchName in an expression that is matched against the name of each\nelement in the feature set."

fn spec.rules.matchAny.matchFeatures.matchName.withOp

withOp(op)

"Op is the operator to be applied."

fn spec.rules.matchAny.matchFeatures.matchName.withValue

withValue(value)

"Value is the list of values that the operand evaluates the input\nagainst. Value should be empty if the operator is Exists, DoesNotExist,\nIsTrue or IsFalse. Value should contain exactly one element if the\noperator is Gt or Lt and exactly two elements if the operator is GtLt.\nIn other cases Value should contain at least one element."

fn spec.rules.matchAny.matchFeatures.matchName.withValueMixin

withValueMixin(value)

"Value is the list of values that the operand evaluates the input\nagainst. Value should be empty if the operator is Exists, DoesNotExist,\nIsTrue or IsFalse. Value should contain exactly one element if the\noperator is Gt or Lt and exactly two elements if the operator is GtLt.\nIn other cases Value should contain at least one element."

Note: This function appends passed data to existing values

obj spec.rules.matchFeatures

"MatchFeatures specifies a set of matcher terms all of which must match."

fn spec.rules.matchFeatures.withFeature

withFeature(feature)

"Feature is the name of the feature set to match against."

fn spec.rules.matchFeatures.withMatchExpressions

withMatchExpressions(matchExpressions)

"MatchExpressions is the set of per-element expressions evaluated. These\nmatch against the value of the specified elements."

fn spec.rules.matchFeatures.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"MatchExpressions is the set of per-element expressions evaluated. These\nmatch against the value of the specified elements."

Note: This function appends passed data to existing values

obj spec.rules.matchFeatures.matchName

"MatchName in an expression that is matched against the name of each\nelement in the feature set."

fn spec.rules.matchFeatures.matchName.withOp

withOp(op)

"Op is the operator to be applied."

fn spec.rules.matchFeatures.matchName.withValue

withValue(value)

"Value is the list of values that the operand evaluates the input\nagainst. Value should be empty if the operator is Exists, DoesNotExist,\nIsTrue or IsFalse. Value should contain exactly one element if the\noperator is Gt or Lt and exactly two elements if the operator is GtLt.\nIn other cases Value should contain at least one element."

fn spec.rules.matchFeatures.matchName.withValueMixin

withValueMixin(value)

"Value is the list of values that the operand evaluates the input\nagainst. Value should be empty if the operator is Exists, DoesNotExist,\nIsTrue or IsFalse. Value should contain exactly one element if the\noperator is Gt or Lt and exactly two elements if the operator is GtLt.\nIn other cases Value should contain at least one element."

Note: This function appends passed data to existing values

obj spec.rules.taints

"Taints to create if the rule matches."

fn spec.rules.taints.withEffect

withEffect(effect)

"Required. The effect of the taint on pods\nthat do not tolerate the taint.\nValid effects are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.rules.taints.withKey

withKey(key)

"Required. The taint key to be applied to a node."

fn spec.rules.taints.withTimeAdded

withTimeAdded(timeAdded)

"TimeAdded represents the time at which the taint was added.\nIt is only written for NoExecute taints."

fn spec.rules.taints.withValue

withValue(value)

"The taint value corresponding to the taint key."