reworked crd change following decision

Author: adwk67

deploy/helm/airflow-operator/crds/crds.yaml

@@ -591,10 +591,16 @@ spec:
                           - repo
                         type: object
                       type: array
-                    dbInit:
-                      default: true
-                      description: Whether to execute the database initialization routines (a combination of database initialization, upgrade and migration depending on the Airflow version). Defaults to true to be backwward compatible.
-                      type: boolean
+                    databaseInitialization:
+                      default:
+                        enabled: true
+                      description: 'Whether to execute the database initialization routines (a combination of database initialization, upgrade and migration depending on the Airflow version). Defaults to true to be (techincally) backwards-compatible but also safe. WARNING: setting this to false is *unsupported* as subsequent updates to the Airflow cluster may result in broken behaviour due to inconsistent metadata! Do not change the default unless you know what you are doing!'
+                      properties:
+                        enabled:
+                          default: true
+                          description: Whether to execute the database initialization routines (a combination of database initialization, upgrade and migration depending on the Airflow version). Defaults to true to be backwward compatible.
+                          type: boolean
+                      type: object
                     exposeConfig:
                       default: false
                       description: for internal use only - not for production use.

docs/modules/airflow/pages/usage-guide/db-init.adoc

@@ -1,5 +1,5 @@
 = Database initialization
-:description: Configure Airflow DB start-up.
+:description: Configure Airflow Database start-up.
 
 By default, Airflow will run database initialization routines (checking and/or creating the metadata schema and creating an admin user) on start-up.
 These are idempotent and can be run every time as the overhead is minimal.
@@ -14,9 +14,13 @@ metadata:
   name: airflow
 spec:
   clusterConfig:
-    dbInit: false  # <1>
+    databaseInitialization:
+      enabled: false  # <1>
 ----
-<1> Turn off the initialization routine by setting `dbInit` to `false`
+<1> Turn off the initialization routine by setting `databaseInitialization.enabled` to `false`
 
-NOTE: The field `dbInit` is `true` by default to be backwards-compatible.
+NOTE: The field `databaseInitialization.enabled` is `true` by default to be backwards-compatible.
 A fresh Airflow cluster cannot be created with this field set to `false` as this results in missing metadata in the Airflow database.
+
+WARNING: Setting `databaseInitialization.enabled` to `false` is an unsupported operation as subsequent updates to a running Airflow cluster can result in broken behaviour due to inconsistent metadata.
+Only set `databaseInitialization.enabled` to `false` if you know what you are doing!

rust/operator-binary/src/crd/mod.rs

@@ -251,9 +251,11 @@ pub mod versioned {
         #[serde(default)]
         pub load_examples: bool,
 
-        /// Whether to execute the database initialization routines (a combination of database initialization, upgrade and migration depending on the Airflow version). Defaults to true to be backwward compatible.
-        #[serde(default = "default_db_init")]
-        pub db_init: bool,
+        /// Whether to execute the database initialization routines (a combination of database initialization, upgrade and migration depending on the Airflow version). Defaults to true to be (techincally) backwards-compatible but also safe.
+        /// WARNING: setting this to false is *unsupported* as subsequent updates to the Airflow cluster may result in broken behaviour due to inconsistent metadata!
+        /// Do not change the default unless you know what you are doing!
+        #[serde(default)]
+        pub database_initialization: DatabaseInitializationConfig,
 
         /// Name of the Vector aggregator [discovery ConfigMap](DOCS_BASE_URL_PLACEHOLDER/concepts/service_discovery).
         /// It must contain the key `ADDRESS` with the address of the Vector aggregator.
@@ -285,7 +287,23 @@ pub mod versioned {
     }
 }
 
-fn default_db_init() -> bool {
+#[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct DatabaseInitializationConfig {
+    /// Whether to execute the database initialization routines (a combination of database initialization, upgrade and migration depending on the Airflow version). Defaults to true to be backwward compatible.
+    #[serde(default = "default_db_init")]
+    pub enabled: bool,
+}
+
+impl Default for DatabaseInitializationConfig {
+    fn default() -> Self {
+        Self {
+            enabled: default_db_init(),
+        }
+    }
+}
+
+pub fn default_db_init() -> bool {
     true
 }
 
@@ -585,7 +603,7 @@ impl AirflowRole {
                     ]);
                 }
                 AirflowRole::Scheduler => {
-                    if airflow.spec.cluster_config.db_init {
+                    if airflow.spec.cluster_config.database_initialization.enabled {
                         tracing::info!("Database initialization...");
                         command.extend(vec![
                             "airflow db migrate".to_string(),
@@ -626,7 +644,7 @@ impl AirflowRole {
                     ]);
                 }
                 AirflowRole::Scheduler => {
-                    if airflow.spec.cluster_config.db_init {
+                    if airflow.spec.cluster_config.database_initialization.enabled {
                         tracing::info!("Database initialization...");
                         command.extend(vec![
                             // Database initialization is limited to the scheduler, see https://github.com/stackabletech/airflow-operator/issues/259
@@ -1008,6 +1026,6 @@ mod tests {
         assert!(cluster.spec.cluster_config.load_examples);
         assert!(cluster.spec.cluster_config.expose_config);
         // defaults to true
-        assert!(cluster.spec.cluster_config.db_init);
+        assert!(cluster.spec.cluster_config.database_initialization.enabled);
     }
 }

tests/templates/kuttl/cluster-operation/30-restart-airflow.yaml.j2

@@ -25,7 +25,8 @@ spec:
     vectorAggregatorConfigMapName: vector-aggregator-discovery
 {% endif %}
     credentialsSecret: test-airflow-credentials
-    dbInit: false
+    databaseInitialization:
+      enabled: false
   webservers:
     roleConfig:
       listenerClass: external-unstable