[Draft] Add new setting: eviction-hard #1341
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -437,3 +437,120 @@ mod test_kubernetes_bootstrap_token { | |
| } | ||
| } | ||
| } | ||
|
|
||
| // =^..^= =^..^= =^..^= =^..^= =^..^= =^..^= =^..^= =^..^= =^..^= | ||
|
|
||
| /// EvictionHardKey represents a string that contains a valid Kubernetes eviction hard | ||
| /// signal. There are few valid eviction hard signals [memory.available], [nodefs.available], | ||
|
There was a problem hiding this comment. nit: Rather than naming the currently available values, let's just point to the relevant k8s page so if more are added or if they change, we don't need to remember to update this comment.
|
||
| /// [imagefs.available], and [nodefs.inodesFree]. | ||
| /// https://kubernetes.io/docs/tasks/administer-cluster/out-of-resource/ | ||
|
|
||
|
|
||
| #[derive(Debug, Clone, Eq, PartialEq, Hash)] | ||
| pub struct EvictionHardKey { | ||
| inner: String, | ||
| } | ||
|
|
||
| impl TryFrom<&str> for EvictionHardKey { | ||
| type Error = error::Error; | ||
|
|
||
| fn try_from(input: &str) -> Result<Self, Self::Error> { | ||
| let evitionsignal = vec![ | ||
|
There was a problem hiding this comment. we can also use enum here for example: https://github.com/bottlerocket-os/bottlerocket/blob/develop/sources/models/src/modeled_types/ecs.rs#L189 There was a problem hiding this comment. I was trying to use enum to handle this part; however, I think enum could be not that efficient and clear there because too many works on dealing with variables which contains dots like There was a problem hiding this comment. Another plus to just having it as an enum is being able to reuse it elsewhere (e.g. in your tests) for matching/validation etc. I also wonder if we even need any of the traits here for converting to/from strings if There was a problem hiding this comment. @gthao313 I think the rename attributes you mentioned above should allow us to use an enum. If so, that's probably the preferred route as other folks mentioned. |
||
| "memory.available","nodefs.available", | ||
| "nodefs.inodesFree","imagefs.available", | ||
| "imagefs.inodesFree","pid.available" | ||
| ]; | ||
|
|
||
| ensure!( | ||
| evitionsignal.contains(&input), | ||
| error::InvalideEvictionHard { | ||
| input, | ||
| msg: format!("must be one of designated signals"), | ||
| } | ||
| ); | ||
|
|
||
| Ok(EvictionHardKey { | ||
| inner: input.to_string(), | ||
| }) | ||
| } | ||
| } | ||
| string_impls_for!(EvictionHardKey, "EvictionHardKey"); | ||
|
|
||
| #[cfg(test)] | ||
| mod test_kubernetes_eviction_hard_key { | ||
| use super::EvictionHardKey; | ||
| use std::convert::TryFrom; | ||
|
|
||
| #[test] | ||
| fn good_eviction_hard_key() { | ||
| for ok in &[ | ||
| "memory.available", | ||
| "nodefs.available", | ||
| "nodefs.inodesFree", | ||
| "imagefs.available", | ||
| "imagefs.inodesFree", | ||
| "pid.available", | ||
| ] { | ||
| EvictionHardKey::try_from(*ok).unwrap(); | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn bad_eviction_hard_key() { | ||
| for err in &["", "storage.available", ".bad", "bad.", &"a".repeat(64)] { | ||
| EvictionHardKey::try_from(*err).unwrap_err(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // =^..^= =^..^= =^..^= =^..^= =^..^= =^..^= =^..^= =^..^= =^..^= | ||
|
|
||
| /// EvictionHardValue represents a string that contains a valid Kubernetes eviction threshold quantity | ||
| /// An eviction threshold can be expressed as Gi/Mi or a percentage using the % token | ||
|
There was a problem hiding this comment. Same down here - let's just point to the docs rather than reiterating them. |
||
| /// https://kubernetes.io/docs/tasks/administer-cluster/out-of-resource/ | ||
|
|
||
|
|
||
| #[derive(Debug, Clone, Eq, PartialEq, Hash)] | ||
| pub struct EvictionHardValue { | ||
| inner: String, | ||
| } | ||
|
|
||
| impl TryFrom<&str> for EvictionHardValue { | ||
| type Error = error::Error; | ||
|
|
||
| fn try_from(input: &str) -> Result<Self, Self::Error> { | ||
|
|
||
| ensure!( | ||
| input.ends_with("Gi") || input.ends_with("Mi") || input.ends_with("%"), | ||
|
There was a problem hiding this comment. Let's make sure that these are the only values that are possible ( |
||
| error::InvalideEvictionHard { | ||
| input, | ||
| msg: format!("must be ends with Gi, Mi, or %"), | ||
|
|
||
| } | ||
| ); | ||
|
|
||
| Ok(EvictionHardValue { | ||
| inner: input.to_string(), | ||
| }) | ||
| } | ||
| } | ||
| string_impls_for!(EvictionHardValue, "EvictionHardValue"); | ||
|
|
||
| #[cfg(test)] | ||
| mod test_kubernetes_eviction_hard_value { | ||
| use super::EvictionHardValue; | ||
| use std::convert::TryFrom; | ||
|
|
||
| #[test] | ||
| fn good_eviction_hard_value() { | ||
| for ok in &["10Gi", "500Mi", "30%"] { | ||
| EvictionHardValue::try_from(*ok).unwrap(); | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn bad_eviction_hard_value() { | ||
| for err in &["", "bad", "100", &"a".repeat(64)] { | ||
| EvictionHardValue::try_from(*err).unwrap_err(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll fix this indent.