NodeProfile
NodeProfile custom resource schema.
The NodeProfile CRD holds reusable direct-workload policy: expose behavior, image pull
defaults, primary-container resources, scheduling, persistence, and probes. Nodes reference
profiles explicitly via profileRef. Device privilege, capabilities, and other kind-owned
container requirements are not profile policy; they come from the imported package's plan.
Readiness first requires the device application container to be running; an image- or
definition-declared healthcheck translates into Kubernetes startup/readiness probes that must
pass. A running image without a healthcheck provides process-level readiness only; configure an
image healthcheck or an explicit TCP/SSH probe when application readiness matters. With
statusProbes.enabled, TCP/SSH checks execute inside each Node's device container against that
node's management address, so grouped members are probed individually (per-node settings via
nodeProbeConfigurations).
NodeProfile
SPEC
NodeProfileSpec is the spec for a NodeProfile resource.
-
Deployment holds device workload settings.
-
Persistence enables persistence of the containerlab working directory.
-
ClaimSize is the size of the PVC for this topology -- if not provided this defaults to 512Mi. If provided, the string value must be a valid kubernetes storage requests style string. Note the claim size cannot be made smaller once created, but it can be expanded. If you need to make the claim smaller you must delete the topology (or the node from the topology) and re-add it.
-
Enabled indicates whether package-planned persistent artifacts are placed in a mounted PVC.
-
Reclaim controls the claim's lifetime relative to its Node. "Delete" (the default) owner-references the claim to the Node, so deleting the Node garbage-collects the claim and its data. "Retain" leaves the claim in place when the Node is deleted; an equivalent recreated Node adopts the retained claim and boots from its preserved state. Retained claims that are no longer wanted must be deleted by hand.
enum: "Delete", "Retain" -
StorageClassName is the storage class to set in the PVC -- if not provided this will be left empty which will end up using your default storage class. Note that currently we assume you have (as default) or provide a dynamically provisionable storage class, hence no selector.
-
-
-
Expose holds configurations relevant to how Nodes using this profile are exposed.
-
DisableAutoExpose disables automatic exposure of the default port list.
-
ExposeType configures the Service type used for exposing Nodes.
enum: "None", "ClusterIP", "Headless", "LoadBalancer" -
UseNodeMgmtIpv4Address assigns a Node's management IPv4 address, pinned or allocated, as its LoadBalancerIP. It takes precedence over UseNodeMgmtIpv6Address.
-
UseNodeMgmtIpv6Address assigns a Node's management IPv6 address, pinned or allocated, as its LoadBalancerIP.
-
-
ImagePull holds configurations relevant to how device Pods handle pulling images.
-
Policy is the default Kubernetes pull policy for application containers whose flattened Node definition does not explicitly declare one.
enum: "IfNotPresent", "Always", "Never" -
PullSecrets provides same-namespace Docker-config Secrets to the kubelet through Pod.spec.imagePullSecrets. Credentials are not mounted into application containers.
-
-
Mgmt holds shared direct management-overlay allocation policy.
-
Disabled disables management allocation and the c9s management overlay. Kubernetes Pod networking and declared links remain active; explicit management addresses must be omitted.
-
IPv4Gw is the IPv4 management gateway.
-
IPv4Range is the IPv4 allocation range within IPv4Subnet.
-
IPv4Subnet is the IPv4 management subnet.
-
IPv6Gw is the IPv6 management gateway.
-
IPv6Range is the IPv6 allocation range within IPv6Subnet.
-
IPv6Subnet is the IPv6 management subnet.
-
-
Resources holds the Kubernetes resource requirements for device Pods.
-
Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.
This field depends on the DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
-
ResourceClaim references one entry in PodSpec.ResourceClaims.
-
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
-
Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.
-
-
-
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
-
Schema for additional map entries.
-
-
-
Scheduling holds device Pod scheduling settings.
-
Affinity sets the affinity rules that will be configured on all direct device Pods using this scheduling policy. This supports node affinity, pod affinity, and pod anti-affinity.
-
Describes node affinity scheduling rules for the pod.
-
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.
-
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
-
A node selector term, associated with the corresponding weight.
-
A list of node selector requirements by node's labels.
-
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
The label key that the selector applies to.
-
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
-
An array of string values. If the operator 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.
-
-
-
A list of node selector requirements by node's fields.
-
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
The label key that the selector applies to.
-
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
-
An array of string values. If the operator 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.
-
-
-
-
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
format: int32
-
-
-
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.
-
Required. A list of node selector terms. The terms are ORed.
-
A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
-
A list of node selector requirements by node's labels.
-
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
The label key that the selector applies to.
-
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
-
An array of string values. If the operator 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.
-
-
-
A list of node selector requirements by node's fields.
-
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
The label key that the selector applies to.
-
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
-
An array of string values. If the operator 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.
-
-
-
-
-
-
-
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
-
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.
-
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
-
Required. A pod affinity term, associated with the corresponding weight.
-
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
key is the label key that the selector applies to.
-
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-
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.
-
-
-
-
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelectoraskey in (value)to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. -
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelectoraskey notin (value)to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -
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.
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
key is the label key that the selector applies to.
-
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-
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.
-
-
-
-
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".
-
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.
-
-
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
-
-
-
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.
-
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running
-
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
key is the label key that the selector applies to.
-
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-
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.
-
-
-
-
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelectoraskey in (value)to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. -
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelectoraskey notin (value)to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -
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.
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
key is the label key that the selector applies to.
-
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-
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.
-
-
-
-
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".
-
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.
-
-
-
-
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
-
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 subtracting "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
-
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
-
Required. A pod affinity term, associated with the corresponding weight.
-
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
key is the label key that the selector applies to.
-
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-
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.
-
-
-
-
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelectoraskey in (value)to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. -
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelectoraskey notin (value)to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -
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.
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
key is the label key that the selector applies to.
-
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-
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.
-
-
-
-
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".
-
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.
-
-
weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
format: int32
-
-
-
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.
-
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running
-
A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
key is the label key that the selector applies to.
-
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-
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.
-
-
-
-
MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelectoraskey in (value)to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. -
MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with
labelSelectoraskey notin (value)to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. -
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.
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
key is the label key that the selector applies to.
-
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-
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.
-
-
-
-
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".
-
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.
-
-
-
-
-
Tolerations is a list of Tolerations that will be set on the device pod spec.
-
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .
-
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
-
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.
-
Operator represents a key's relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).
-
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
format: int64 -
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
-
-
-
-
StatusProbes holds the configurations used to check and report Node status.
-
Enabled sets the status probes to enabled (or obviously disabled). A Node that has previously started but later fails its readiness check remains running and is reported not ready. A Node that never passes its startup check is restarted after its startup allowance expires.
default: true -
ExcludedNodes is a set of nodes to be excluded from status probe checking. It may be desirable to exclude some node(s) from status checking due to them not having an easy way for clabernetes to check the state of the node. The node names here should match the name of the nodes in the containerlab sub-topology.
-
NodeProbeConfigurations is a map of node specific probe configurations -- if you only need a simple ssh or tcp connect style setup that works on all node types in the topology you can ignore this and just configure ProbeConfiguration.
-
ProbeConfiguration holds optional application-specific probes for a (containerlab) node in a Topology. If both styles are configured, both and the generic device-container readiness must succeed in order to report healthy.
-
StartupSeconds is the total amount of seconds to allow for the node to start. This defaults to roughly 15 minutes to account for slow-to-boot nodes. The allowance must include time for the kubelet to pull the image and boot the device. A larger value does not delay fast nodes because the readiness probe takes over as soon as startup succeeds.
-
-
ProbeConfiguration is the default probe configuration for the Topology.
-
StartupSeconds is the total amount of seconds to allow for the node to start. This defaults to roughly 15 minutes to account for slow-to-boot nodes. The allowance must include time for the kubelet to pull the image and boot the device. A larger value does not delay fast nodes because the readiness probe takes over as soon as startup succeeds.
-
STATUS
NodeProfileStatus is the status for a NodeProfile resource.