Merge pull request #62 from KCSesh/api-time-slice

feat: add nvidia time-slicing

Author: KCSesh

Cargo.toml

@@ -57,7 +57,7 @@ bottlerocket-template-helper = { path = "./bottlerocket-template-helper", versio
 
 # Settings Models
 bottlerocket-model-derive = { path = "./bottlerocket-settings-models/model-derive", version = "0.1" }
-bottlerocket-modeled-types = { path = "./bottlerocket-settings-models/modeled-types", version = "0.5" }
+bottlerocket-modeled-types = { path = "./bottlerocket-settings-models/modeled-types", version = "0.6" }
 bottlerocket-scalar = { path = "./bottlerocket-settings-models/scalar", version = "0.1" }
 bottlerocket-scalar-derive = { path = "./bottlerocket-settings-models/scalar-derive", version = "0.1" }
 bottlerocket-string-impls-for = { path = "./bottlerocket-settings-models/string-impls-for", version = "0.1" }
@@ -90,6 +90,7 @@ abi_stable = "0.11.3"
 anyhow = "1"
 argh = "0.1"
 base64 = "0.22"
+bounded-integer = "0.5"
 ctor = "0.2"
 darling = "0.20"
 env_logger = "0.11"

bottlerocket-settings-models/CHANGELOG.md

@@ -9,7 +9,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - See [unreleased changes here]
 
-[unreleased changes here]: https://github.com/bottlerocket-os/bottlerocket-settings-sdk/compare/bottlerocket-settings-models-v0.5.0...HEAD
+[unreleased changes here]: https://github.com/bottlerocket-os/bottlerocket-settings-sdk/compare/bottlerocket-settings-models-v0.6.0...HEAD
+
+## [0.6.0] - 2024-10-02
+
+## Model Changes
+
+### Added
+
+- Added nvidia time-slicing to kubernetes device plugins settings extension ([#62])
+
+[#62]: https://github.com/bottlerocket-os/bottlerocket-settings-sdk/pull/62
+
+[0.6.0]: https://github.com/bottlerocket-os/bottlerocket-settings-sdk/compare/bottlerocket-settings-models-v0.6.0...bottlerocket-settings-models-v0.5.0
 
 ## [0.5.0] - 2024-09-10
 

bottlerocket-settings-models/modeled-types/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bottlerocket-modeled-types"
-version = "0.5.0"
+version = "0.6.0"
 authors = []
 license = "Apache-2.0 OR MIT"
 edition = "2021"
@@ -13,6 +13,7 @@ bottlerocket-scalar.workspace = true
 bottlerocket-scalar-derive.workspace = true
 bottlerocket-string-impls-for.workspace = true
 bottlerocket-model-derive.workspace = true
+bounded-integer = { workspace = true, features = ["types", "serde1"]}
 base64.workspace = true
 indexmap = { workspace = true, features = ["serde"] }
 lazy_static.workspace = true

bottlerocket-settings-models/modeled-types/src/kubernetes.rs

@@ -1,6 +1,7 @@
 use super::error;
 use bottlerocket_scalar_derive::Scalar;
 use bottlerocket_string_impls_for::string_impls_for;
+use bounded_integer::BoundedI32;
 use lazy_static::lazy_static;
 use regex::Regex;
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
@@ -20,6 +21,10 @@ use crate::SingleLineString;
 const IMAGE_GC_THRESHOLD_MAX: i32 = 100;
 const IMAGE_GC_THRESHOLD_MIN: i32 = 0;
 
+// Define the bounds for the `time-slicing.replicas` field
+const TIME_SLICING_REPLICAS_MIN: i32 = 2;
+const TIME_SLICING_REPLICAS_MAX: i32 = i32::MAX;
+
 /// KubernetesName represents a string that contains a valid Kubernetes resource name.  It stores
 /// the original string and makes it accessible through standard traits.
 // https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
@@ -1452,6 +1457,8 @@ pub struct NvidiaDevicePluginSettings {
     pass_device_specs: bool,
     device_id_strategy: NvidiaDeviceIdStrategy,
     device_list_strategy: NvidiaDeviceListStrategy,
+    device_sharing_strategy: NvidiaDeviceSharingStrategy,
+    time_slicing: NvidiaTimeSlicingSettings,
 }
 
 #[derive(Debug, Clone, Eq, PartialEq, Hash, Serialize, Deserialize)]
@@ -1468,6 +1475,20 @@ pub enum NvidiaDeviceListStrategy {
     VolumeMounts,
 }
 
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+pub enum NvidiaDeviceSharingStrategy {
+    None,
+    TimeSlicing,
+}
+
+#[model(impl_default = true)]
+pub struct NvidiaTimeSlicingSettings {
+    replicas: BoundedI32<TIME_SLICING_REPLICAS_MIN, TIME_SLICING_REPLICAS_MAX>,
+    rename_by_default: bool,
+    fail_requests_greater_than_one: bool,
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -1483,10 +1504,38 @@ mod tests {
                 pass_device_specs: Some(false),
                 device_id_strategy: Some(NvidiaDeviceIdStrategy::Uuid),
                 device_list_strategy: Some(NvidiaDeviceListStrategy::Envvar),
+                device_sharing_strategy: None,
+                time_slicing: None
+            }
+        );
+        let results = serde_json::to_string(&nvidia_device_plugins).unwrap();
+        assert_eq!(results, test_json);
+    }
+
+    #[test]
+    fn test_serde_nvidia_device_plugins_with_time_slicing() {
+        let test_json = r#"{"pass-device-specs":false,"device-id-strategy":"uuid","device-list-strategy":"envvar","device-sharing-strategy":"time-slicing"}"#;
+        let nvidia_device_plugins: NvidiaDevicePluginSettings =
+            serde_json::from_str(test_json).unwrap();
+        assert_eq!(
+            nvidia_device_plugins,
+            NvidiaDevicePluginSettings {
+                pass_device_specs: Some(false),
+                device_id_strategy: Some(NvidiaDeviceIdStrategy::Uuid),
+                device_list_strategy: Some(NvidiaDeviceListStrategy::Envvar),
+                device_sharing_strategy: Some(NvidiaDeviceSharingStrategy::TimeSlicing),
+                time_slicing: None
             }
         );
 
         let results = serde_json::to_string(&nvidia_device_plugins).unwrap();
         assert_eq!(results, test_json);
     }
+
+    #[test]
+    fn test_invalid_time_slicing_replicas() {
+        let test_json = r#"{"pass-device-specs":false,"device-id-strategy":"uuid","device-list-strategy":"envvar","device-sharing-strategy":"time-slicing","time-slicing":{"replicas":0}}"#;
+        let result: Result<NvidiaDevicePluginSettings, _> = serde_json::from_str(test_json);
+        assert!(result.is_err(), "The JSON should not be parsed successfully as it contains an invalid value for 'replicas'.");
+    }
 }

bottlerocket-settings-models/settings-extensions/kubelet-device-plugins/Cargo.toml

@@ -14,5 +14,8 @@ env_logger.workspace = true
 serde = { workspace = true, features = ["derive"] }
 serde_json.workspace = true
 
+[dev-dependencies]
+bounded-integer = { workspace = true, features = ["types"]}
+
 [lints]
 workspace = true

bottlerocket-settings-models/settings-extensions/kubelet-device-plugins/src/lib.rs

@@ -42,7 +42,11 @@ impl SettingsModel for KubeletDevicePluginsV1 {
 #[cfg(test)]
 mod test {
     use super::*;
-    use bottlerocket_modeled_types::{NvidiaDeviceIdStrategy, NvidiaDeviceListStrategy};
+    use bottlerocket_modeled_types::{
+        NvidiaDeviceIdStrategy, NvidiaDeviceListStrategy, NvidiaDeviceSharingStrategy,
+        NvidiaTimeSlicingSettings,
+    };
+    use bounded_integer::BoundedI32;
 
     #[test]
     fn test_generate_kubelet_device_plugins() {
@@ -55,7 +59,7 @@ mod test {
 
     #[test]
     fn test_serde_kubelet_device_plugins() {
-        let test_json = r#"{"nvidia":{"pass-device-specs":true,"device-id-strategy":"index","device-list-strategy":"volume-mounts"}}"#;
+        let test_json = r#"{"nvidia":{"pass-device-specs":true,"device-id-strategy":"index","device-list-strategy":"volume-mounts","device-sharing-strategy":"time-slicing","time-slicing":{"replicas":2,"rename-by-default":true,"fail-requests-greater-than-one":true}}}"#;
 
         let device_plugins: KubeletDevicePluginsV1 = serde_json::from_str(test_json).unwrap();
         assert_eq!(
@@ -65,6 +69,12 @@ mod test {
                     pass_device_specs: Some(true),
                     device_id_strategy: Some(NvidiaDeviceIdStrategy::Index),
                     device_list_strategy: Some(NvidiaDeviceListStrategy::VolumeMounts),
+                    device_sharing_strategy: Some(NvidiaDeviceSharingStrategy::TimeSlicing),
+                    time_slicing: Some(NvidiaTimeSlicingSettings {
+                        replicas: Some(BoundedI32::new(2).unwrap()),
+                        rename_by_default: Some(true),
+                        fail_requests_greater_than_one: Some(true),
+                    }),
                 }),
             }
         );

bottlerocket-settings-models/settings-models/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bottlerocket-settings-models"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Tom Kirchner <tjk@amazon.com>"]
 license = "Apache-2.0 OR MIT"
 edition = "2021"