flatten enum and re-name fields

Author: adwk67

crates/stackable-operator/crds/DummyCluster.yaml

@@ -76,11 +76,6 @@ spec:
                 description: A validated domain name type conforming to RFC 1123, so e.g. not an IP address
                 type: string
               gitSync:
-                anyOf:
-                - required:
-                  - credentialsSecret
-                - required:
-                  - sshSecret
                 properties:
                   branch:
                     default: main
@@ -89,16 +84,34 @@ spec:
 
                       Since git-sync v4.x.x this field is mapped to the flag `--ref`.
                     type: string
-                  credentialsSecret:
-                    description: |-
-                      The name of the Secret used to access the repository if it is not public.
+                  credentials:
+                    anyOf:
+                    - required:
+                      - basicAuthSecretName
+                    - required:
+                      - sshPrivateKeySecretName
+                    description: An optional secret used for git access.
+                    nullable: true
+                    properties:
+                      basicAuthSecretName:
+                        description: |-
+                          The name of the Secret used to access the repository via Basic Authentication if it is not public.
 
-                      The referenced Secret must include two fields: `user` and `password`.
-                      The `password` field can either be an actual password (not recommended) or a GitHub token,
-                      as described in the git-sync [documentation].
+                          The referenced Secret must include two fields: `user` and `password`.
+                          The `password` field can either be an actual password (not recommended) or a GitHub token,
+                          as described in the git-sync [documentation].
 
-                      [documentation]: https://github.com/kubernetes/git-sync/tree/v4.2.4?tab=readme-ov-file#manual
-                    type: string
+                          [documentation]: https://github.com/kubernetes/git-sync/tree/v4.2.4?tab=readme-ov-file#manual
+                        type: string
+                      sshPrivateKeySecretName:
+                        description: |-
+                          The name of the Secret used for SSH access to the repository.
+
+                          The referenced Secret must include two fields: `key` and `knownHosts`.
+
+                          [documentation]: https://github.com/kubernetes/git-sync/tree/v4.2.4?tab=readme-ov-file#manual
+                        type: string
+                    type: object
                   depth:
                     default: 1
                     description: The depth of syncing, i.e. the number of commits to clone; defaults to 1.
@@ -129,14 +142,6 @@ spec:
                     description: 'The git repository URL that will be cloned, for example: `https://github.com/stackabletech/airflow-operator` or `ssh://git@github.com:stackable-airflow/dags.git`.'
                     format: uri
                     type: string
-                  sshSecret:
-                    description: |-
-                      The name of the Secret used for SSH access to the repository.
-
-                      The referenced Secret must include two fields: `key` and `knownHosts`.
-
-                      [documentation]: https://github.com/kubernetes/git-sync/tree/v4.2.4?tab=readme-ov-file#manual
-                    type: string
                   wait:
                     default: 20s
                     description: |-

crates/stackable-operator/src/crd/git_sync/mod.rs

@@ -55,36 +55,36 @@ pub mod versioned {
         #[serde(default)]
         pub git_sync_conf: BTreeMap<String, String>,
 
-        #[serde(flatten)]
-        pub access_secret: Option<AccessSecret>,
+        /// An optional secret used for git access.
+        pub credentials: Option<Credentials>,
     }
 
     #[derive(strum::Display, Clone, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
     #[serde(untagged)]
     #[serde(rename_all = "camelCase")]
     #[schemars(rename_all = "camelCase")]
-    pub enum AccessSecret {
-        Credentials {
-            /// The name of the Secret used to access the repository if it is not public.
+    pub enum Credentials {
+        BasicAuth {
+            /// The name of the Secret used to access the repository via Basic Authentication if it is not public.
             ///
             /// The referenced Secret must include two fields: `user` and `password`.
             /// The `password` field can either be an actual password (not recommended) or a GitHub token,
             /// as described in the git-sync [documentation].
             ///
             /// [documentation]: https://github.com/kubernetes/git-sync/tree/v4.2.4?tab=readme-ov-file#manual
-            #[serde(rename = "credentialsSecret")]
-            #[schemars(rename = "credentialsSecret")]
-            credentials_secret: String,
+            #[serde(rename = "basicAuthSecretName")]
+            #[schemars(rename = "basicAuthSecretName")]
+            basic_auth_secret_name: String,
         },
         Ssh {
             /// The name of the Secret used for SSH access to the repository.
             ///
             /// The referenced Secret must include two fields: `key` and `knownHosts`.
             ///
             /// [documentation]: https://github.com/kubernetes/git-sync/tree/v4.2.4?tab=readme-ov-file#manual
-            #[serde(rename = "sshSecret")]
-            #[schemars(rename = "sshSecret")]
-            ssh_secret: String,
+            #[serde(rename = "sshPrivateKeySecretName")]
+            #[schemars(rename = "sshPrivateKeySecretName")]
+            ssh_private_key_secret_name: String,
         },
     }
 }

crates/stackable-operator/src/crd/git_sync/v1alpha1_impl.rs

@@ -14,7 +14,7 @@ use crate::{
         volume::{VolumeBuilder, VolumeMountBuilder},
     },
     commons::product_image_selection::ResolvedProductImage,
-    crd::git_sync::v1alpha1::{AccessSecret, GitSync},
+    crd::git_sync::v1alpha1::{Credentials, GitSync},
     product_config_utils::insert_or_update_env_vars,
     product_logging::{
         framework::capture_shell_output,
@@ -119,20 +119,22 @@ impl GitSyncResources {
         for (i, git_sync) in git_syncs.iter().enumerate() {
             let mut env_vars = vec![];
 
-            if let Some(AccessSecret::Credentials { credentials_secret }) = &git_sync.access_secret
+            if let Some(Credentials::BasicAuth {
+                basic_auth_secret_name,
+            }) = &git_sync.credentials
             {
                 env_vars.push(GitSyncResources::env_var_from_secret(
                     "GITSYNC_USERNAME",
-                    credentials_secret,
+                    basic_auth_secret_name,
                     "user",
                 ));
                 env_vars.push(GitSyncResources::env_var_from_secret(
                     "GITSYNC_PASSWORD",
-                    credentials_secret,
+                    basic_auth_secret_name,
                     "password",
                 ));
             }
-            if matches!(git_sync.access_secret, Some(AccessSecret::Ssh { .. })) {
+            if matches!(git_sync.credentials, Some(Credentials::Ssh { .. })) {
                 env_vars.push(EnvVar {
                     name: "GITSYNC_SSH_KEY_FILE".to_owned(),
                     value: Some(format!("{SSH_MOUNT_PATH_PREFIX}-{i}/key").to_owned()),
@@ -167,7 +169,7 @@ impl GitSyncResources {
 
             git_sync_container_volume_mounts.extend_from_slice(extra_volume_mounts);
 
-            if matches!(git_sync.access_secret, Some(AccessSecret::Ssh { .. })) {
+            if matches!(git_sync.credentials, Some(Credentials::Ssh { .. })) {
                 let ssh_mount_path = format!("{SSH_MOUNT_PATH_PREFIX}-{i}");
                 let ssh_volume_name = format!("{SSH_VOLUME_NAME_PREFIX}-{i}");
 
@@ -222,11 +224,14 @@ impl GitSyncResources {
                 .push(git_content_volume_mount);
             resources.git_content_folders.push(git_content_folder);
 
-            if let Some(AccessSecret::Ssh { ssh_secret }) = &git_sync.access_secret {
+            if let Some(Credentials::Ssh {
+                ssh_private_key_secret_name,
+            }) = &git_sync.credentials
+            {
                 let ssh_volume_name = format!("{SSH_VOLUME_NAME_PREFIX}-{i}");
 
                 let ssh_secret_volume = VolumeBuilder::new(&ssh_volume_name)
-                    .with_secret(ssh_secret, false)
+                    .with_secret(ssh_private_key_secret_name, false)
                     .build();
                 resources.git_ssh_volumes.push(ssh_secret_volume);
             }
@@ -460,7 +465,8 @@ mod tests {
             gitFolder: ""
             depth: 3
             wait: 1m
-            credentialsSecret: git-credentials
+            credentials:
+              basicAuthSecretName: git-credentials
             gitSyncConf:
               --rev: HEAD
               --git-config: http.sslCAInfo:/tmp/ca-cert/ca.crt
@@ -930,7 +936,8 @@ name: content-from-git-2
             gitFolder: ""
             depth: 3
             wait: 1m
-            sshSecret: git-sync-ssh
+            credentials:
+              sshPrivateKeySecretName: git-sync-ssh
             gitSyncConf:
               --rev: HEAD
               --git-config: http.sslCAInfo:/tmp/ca-cert/ca.crt