k8s_openapi/v1_30/api/core/v1/
node_affinity.rs

1// Generated from definition io.k8s.api.core.v1.NodeAffinity
2
3/// Node affinity is a group of node affinity scheduling rules.
4#[derive(Clone, Debug, Default, PartialEq)]
5pub struct NodeAffinity {
6    /// 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.
7    pub preferred_during_scheduling_ignored_during_execution: Option<std::vec::Vec<crate::api::core::v1::PreferredSchedulingTerm>>,
8
9    /// 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.
10    pub required_during_scheduling_ignored_during_execution: Option<crate::api::core::v1::NodeSelector>,
11}
12
13impl crate::DeepMerge for NodeAffinity {
14    fn merge_from(&mut self, other: Self) {
15        crate::merge_strategies::list::atomic(&mut self.preferred_during_scheduling_ignored_during_execution, other.preferred_during_scheduling_ignored_during_execution);
16        crate::DeepMerge::merge_from(&mut self.required_during_scheduling_ignored_during_execution, other.required_during_scheduling_ignored_during_execution);
17    }
18}
19
20impl<'de> crate::serde::Deserialize<'de> for NodeAffinity {
21    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
22        #[allow(non_camel_case_types)]
23        enum Field {
24            Key_preferred_during_scheduling_ignored_during_execution,
25            Key_required_during_scheduling_ignored_during_execution,
26            Other,
27        }
28
29        impl<'de> crate::serde::Deserialize<'de> for Field {
30            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
31                struct Visitor;
32
33                impl crate::serde::de::Visitor<'_> for Visitor {
34                    type Value = Field;
35
36                    fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
37                        f.write_str("field identifier")
38                    }
39
40                    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where E: crate::serde::de::Error {
41                        Ok(match v {
42                            "preferredDuringSchedulingIgnoredDuringExecution" => Field::Key_preferred_during_scheduling_ignored_during_execution,
43                            "requiredDuringSchedulingIgnoredDuringExecution" => Field::Key_required_during_scheduling_ignored_during_execution,
44                            _ => Field::Other,
45                        })
46                    }
47                }
48
49                deserializer.deserialize_identifier(Visitor)
50            }
51        }
52
53        struct Visitor;
54
55        impl<'de> crate::serde::de::Visitor<'de> for Visitor {
56            type Value = NodeAffinity;
57
58            fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
59                f.write_str("NodeAffinity")
60            }
61
62            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: crate::serde::de::MapAccess<'de> {
63                let mut value_preferred_during_scheduling_ignored_during_execution: Option<std::vec::Vec<crate::api::core::v1::PreferredSchedulingTerm>> = None;
64                let mut value_required_during_scheduling_ignored_during_execution: Option<crate::api::core::v1::NodeSelector> = None;
65
66                while let Some(key) = crate::serde::de::MapAccess::next_key::<Field>(&mut map)? {
67                    match key {
68                        Field::Key_preferred_during_scheduling_ignored_during_execution => value_preferred_during_scheduling_ignored_during_execution = crate::serde::de::MapAccess::next_value(&mut map)?,
69                        Field::Key_required_during_scheduling_ignored_during_execution => value_required_during_scheduling_ignored_during_execution = crate::serde::de::MapAccess::next_value(&mut map)?,
70                        Field::Other => { let _: crate::serde::de::IgnoredAny = crate::serde::de::MapAccess::next_value(&mut map)?; },
71                    }
72                }
73
74                Ok(NodeAffinity {
75                    preferred_during_scheduling_ignored_during_execution: value_preferred_during_scheduling_ignored_during_execution,
76                    required_during_scheduling_ignored_during_execution: value_required_during_scheduling_ignored_during_execution,
77                })
78            }
79        }
80
81        deserializer.deserialize_struct(
82            "NodeAffinity",
83            &[
84                "preferredDuringSchedulingIgnoredDuringExecution",
85                "requiredDuringSchedulingIgnoredDuringExecution",
86            ],
87            Visitor,
88        )
89    }
90}
91
92impl crate::serde::Serialize for NodeAffinity {
93    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
94        let mut state = serializer.serialize_struct(
95            "NodeAffinity",
96            self.preferred_during_scheduling_ignored_during_execution.as_ref().map_or(0, |_| 1) +
97            self.required_during_scheduling_ignored_during_execution.as_ref().map_or(0, |_| 1),
98        )?;
99        if let Some(value) = &self.preferred_during_scheduling_ignored_during_execution {
100            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "preferredDuringSchedulingIgnoredDuringExecution", value)?;
101        }
102        if let Some(value) = &self.required_during_scheduling_ignored_during_execution {
103            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "requiredDuringSchedulingIgnoredDuringExecution", value)?;
104        }
105        crate::serde::ser::SerializeStruct::end(state)
106    }
107}
108
109#[cfg(feature = "schemars")]
110impl crate::schemars::JsonSchema for NodeAffinity {
111    fn schema_name() -> std::borrow::Cow<'static, str> {
112        "io.k8s.api.core.v1.NodeAffinity".into()
113    }
114
115    fn json_schema(__gen: &mut crate::schemars::SchemaGenerator) -> crate::schemars::Schema {
116        crate::schemars::json_schema!({
117            "description": "Node affinity is a group of node affinity scheduling rules.",
118            "type": "object",
119            "properties": {
120                "preferredDuringSchedulingIgnoredDuringExecution": {
121                    "description": "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.",
122                    "type": "array",
123                    "items": (__gen.subschema_for::<crate::api::core::v1::PreferredSchedulingTerm>()),
124                },
125                "requiredDuringSchedulingIgnoredDuringExecution": ({
126                    let mut schema_obj = __gen.subschema_for::<crate::api::core::v1::NodeSelector>();
127                    schema_obj.ensure_object().insert("description".into(), "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.".into());
128                    schema_obj
129                }),
130            },
131        })
132    }
133}