Version the git_sync structure as v1alpha1

Author: siegfriedweber

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

@@ -0,0 +1,58 @@
+//! GitSync structure for CRDs
+
+use std::{collections::BTreeMap, path::PathBuf};
+
+use schemars::{self, JsonSchema};
+use serde::{Deserialize, Serialize};
+
+use crate::{time::Duration, versioned::versioned};
+
+mod v1alpha1_impl;
+
+#[versioned(version(name = "v1alpha1"))]
+pub mod versioned {
+    pub mod v1alpha1 {
+        pub use v1alpha1_impl::{Error, GitSyncResources};
+    }
+
+    #[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Eq, Serialize)]
+    #[serde(rename_all = "camelCase")]
+    pub struct GitSync {
+        /// The git repository URL that will be cloned, for example: `https://github.com/stackabletech/airflow-operator`.
+        pub repo: String,
+
+        /// The branch to clone; defaults to `main`.
+        ///
+        /// Since git-sync v4.x.x this field is mapped to the flag `--ref`.
+        #[serde(default = "GitSync::default_branch")]
+        pub branch: String,
+
+        /// The location of the DAG folder, relative to the synced repository root.
+        ///
+        /// It can optionally start with `/`, however, no trailing slash is recommended.
+        /// An empty string (``) or slash (`/`) corresponds to the root folder in Git.
+        #[serde(default = "GitSync::default_git_folder")]
+        pub git_folder: PathBuf,
+
+        /// The depth of syncing, i.e. the number of commits to clone; defaults to 1.
+        #[serde(default = "GitSync::default_depth")]
+        pub depth: u32,
+
+        /// The synchronization interval, e.g. `20s` or `5m`; defaults to `20s`.
+        ///
+        /// Since git-sync v4.x.x this field is mapped to the flag `--period`.
+        #[serde(default = "GitSync::default_wait")]
+        pub wait: Duration,
+
+        /// The name of the Secret used to access the repository if it is not public.
+        /// This should include two fields: `user` and `password`.
+        /// The `password` field can either be an actual password (not recommended) or a GitHub token,
+        /// as described [here](https://github.com/kubernetes/git-sync/tree/v4.2.4?tab=readme-ov-file#manual).
+        pub credentials_secret: Option<String>,
+
+        /// A map of optional configuration settings that are listed in the [git-sync documentation](https://github.com/kubernetes/git-sync/tree/v4.2.4?tab=readme-ov-file#manual).
+        /// Read the [git sync example](DOCS_BASE_URL_PLACEHOLDER/airflow/usage-guide/mounting-dags#_example).
+        #[serde(default)]
+        pub git_sync_conf: BTreeMap<String, String>,
+    }
+}

crates/stackable-operator/src/git_sync/framework.rs renamed to crates/stackable-operator/src/crd/git_sync/v1alpha1_impl.rs

@@ -6,13 +6,14 @@ use k8s_openapi::api::core::v1::{
 use snafu::{ResultExt, Snafu};
 use strum::{EnumDiscriminants, IntoStaticStr};
 
-use super::spec::GitSync;
 use crate::{
     builder::pod::{
         container::ContainerBuilder, resources::ResourceRequirementsBuilder, volume::VolumeBuilder,
     },
     commons::product_image_selection::ResolvedProductImage,
+    crd::git_sync::v1alpha1::GitSync,
     product_config_utils::insert_or_update_env_vars,
+    time::Duration,
     utils::COMMON_BASH_TRAP_FUNCTIONS,
 };
 
@@ -37,6 +38,24 @@ pub enum Error {
     },
 }
 
+impl GitSync {
+    pub(crate) fn default_branch() -> String {
+        "main".to_string()
+    }
+
+    pub(crate) fn default_git_folder() -> PathBuf {
+        PathBuf::from("/")
+    }
+
+    pub(crate) fn default_depth() -> u32 {
+        1
+    }
+
+    pub(crate) fn default_wait() -> Duration {
+        Duration::from_secs(20)
+    }
+}
+
 /// Kubernetes resources generated from `GitSync` specifications which should be added to the Pod.
 #[derive(Default)]
 pub struct GitSyncResources {

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

@@ -5,6 +5,7 @@ use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 pub mod authentication;
+pub mod git_sync;
 pub mod listener;
 pub mod s3;
 

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

@@ -15,7 +15,6 @@ pub mod config;
 pub mod constants;
 pub mod cpu;
 pub mod crd;
-pub mod git_sync;
 pub mod helm;
 pub mod iter;
 pub mod kvp;