Add types for DaemonSetName and DeploymentName

Author: siegfriedweber

crates/stackable-operator/src/v2/role_group_utils.rs

@@ -3,7 +3,9 @@ use std::str::FromStr;
 use sha2::{Digest, Sha256};
 
 use super::types::{
-    kubernetes::{ConfigMapName, ListenerName, ServiceName, StatefulSetName},
+    kubernetes::{
+        ConfigMapName, DaemonSetName, DeploymentName, ListenerName, ServiceName, StatefulSetName,
+    },
     operator::{ClusterName, RoleGroupName, RoleName},
 };
 use crate::attributed_string_type;
@@ -145,6 +147,31 @@ impl ResourceNames {
             .expect("should be a valid ConfigMap name")
     }
 
+    pub fn daemon_set_name(&self) -> DaemonSetName {
+        // compile-time checks
+        const _: () = assert!(
+            QualifiedRoleGroupName::MAX_LENGTH <= DaemonSetName::MAX_LENGTH,
+            "The string `<qualified_role_group_name>` must not exceed the limit of DaemonSet names."
+        );
+        let _ = QualifiedRoleGroupName::IS_RFC_1123_SUBDOMAIN_NAME;
+
+        DaemonSetName::from_str(self.qualified_role_group_name().as_ref())
+            .expect("should be a valid DaemonSet name")
+    }
+
+    pub fn deployment_name(&self) -> DeploymentName {
+        // compile-time checks
+        const _: () = assert!(
+            QualifiedRoleGroupName::MAX_LENGTH <= DeploymentName::MAX_LENGTH,
+            "The string `<qualified_role_group_name>` must not exceed the limit of Deployment \
+            names."
+        );
+        let _ = QualifiedRoleGroupName::IS_RFC_1123_LABEL_NAME;
+
+        DeploymentName::from_str(self.qualified_role_group_name().as_ref())
+            .expect("should be a valid Deployment name")
+    }
+
     pub fn stateful_set_name(&self) -> StatefulSetName {
         // compile-time checks
         const _: () = assert!(
@@ -209,7 +236,10 @@ mod tests {
     use super::{ClusterName, RoleGroupName, RoleName};
     use crate::v2::{
         role_group_utils::{QualifiedRoleGroupName, ResourceNames},
-        types::kubernetes::{ConfigMapName, ListenerName, ServiceName, StatefulSetName},
+        types::kubernetes::{
+            ConfigMapName, DaemonSetName, DeploymentName, ListenerName, ServiceName,
+            StatefulSetName,
+        },
     };
 
     #[test]
@@ -230,6 +260,14 @@ mod tests {
             ConfigMapName::from_str_unsafe("test-cluster-data-nodes-ssd-storage"),
             resource_names.role_group_config_map()
         );
+        assert_eq!(
+            DaemonSetName::from_str_unsafe("test-cluster-data-nodes-ssd-storage"),
+            resource_names.daemon_set_name()
+        );
+        assert_eq!(
+            DeploymentName::from_str_unsafe("test-cluster-data-nodes-ssd-storage"),
+            resource_names.deployment_name()
+        );
         assert_eq!(
             StatefulSetName::from_str_unsafe("test-cluster-data-nodes-ssd-storage"),
             resource_names.stateful_set_name()

crates/stackable-operator/src/v2/types/kubernetes.rs

@@ -41,6 +41,24 @@ attributed_string_type! {
     is_rfc_1123_dns_subdomain_name
 }
 
+attributed_string_type! {
+    DaemonSetName,
+    "The name of a DaemonSet",
+    "secret-operator-csi-node-driver",
+    is_rfc_1123_dns_subdomain_name
+}
+
+attributed_string_type! {
+    DeploymentName,
+    "The name of a Deployment",
+    "nginx",
+    // The name of a Deployment must be a lowercase RFC 1123 DNS subdomain name. But the name is
+    // also used in Pod names and hostnames. Therefore, Kubernetes recommends to use only RFC 1123
+    // label names which are a subset of subdomain names (63 characters instead of 253) to avoid
+    // surprising behavior.
+    is_rfc_1123_label_name
+}
+
 attributed_string_type! {
     Hostname,
     "A hostname",
@@ -163,9 +181,10 @@ attributed_string_type! {
 #[cfg(test)]
 mod tests {
     use super::{
-        ClusterRoleName, ConfigMapKey, ConfigMapName, ContainerName, Hostname, ListenerClassName,
-        ListenerName, NamespaceName, PersistentVolumeClaimName, RoleBindingName, SecretClassName,
-        SecretKey, SecretName, ServiceAccountName, ServiceName, StatefulSetName, Uid, VolumeName,
+        ClusterRoleName, ConfigMapKey, ConfigMapName, ContainerName, DaemonSetName, DeploymentName,
+        Hostname, ListenerClassName, ListenerName, NamespaceName, PersistentVolumeClaimName,
+        RoleBindingName, SecretClassName, SecretKey, SecretName, ServiceAccountName, ServiceName,
+        StatefulSetName, Uid, VolumeName,
     };
 
     #[test]
@@ -174,6 +193,8 @@ mod tests {
         ConfigMapKey::test_example();
         ContainerName::test_example();
         ClusterRoleName::test_example();
+        DaemonSetName::test_example();
+        DeploymentName::test_example();
         Hostname::test_example();
         ListenerName::test_example();
         ListenerClassName::test_example();