Hide operation_mode from KPOps config (#571)

bakdata · Dec 20, 2024 · ecc8f62 · ecc8f62
1 parent ccda83e
commit ecc8f62
Show file tree

Hide file tree

Showing 13 changed files with 1,082 additions and 1,185 deletions.
diff --git a/docs/docs/resources/variables/config_env_vars.env b/docs/docs/resources/variables/config_env_vars.env
@@ -58,9 +58,9 @@ KPOPS_HELM_DIFF_CONFIG__IGNORE # No default value, required
 # Whether to retain clean up jobs in the cluster or uninstall the,
 # after completion.
 KPOPS_RETAIN_CLEAN_JOBS=False
-# operation_mode
-# The operation mode of KPOps (managed, manifest, argo).
-KPOPS_OPERATION_MODE=managed
 # strimzi_topic
 # Configuration for Strimzi Kafka Topics.
 KPOPS_STRIMZI_TOPIC # No default value, not required
+# operation_mode
+# The operation mode of KPOps (managed, manifest, argo).
+KPOPS_OPERATION_MODE=managed
diff --git a/docs/docs/resources/variables/config_env_vars.md b/docs/docs/resources/variables/config_env_vars.md
@@ -19,5 +19,5 @@ These variables take precedence over the settings in `config.yaml`. Variables ma
 |KPOPS_HELM_CONFIG__API_VERSION                    |                                        |False   |Kubernetes API version used for `Capabilities.APIVersions`                        |helm_config.api_version                    |
 |KPOPS_HELM_DIFF_CONFIG__IGNORE                    |                                        |True    |Set of keys that should not be checked.                                           |helm_diff_config.ignore                    |
 |KPOPS_RETAIN_CLEAN_JOBS                           |False                                   |False   |Whether to retain clean up jobs in the cluster or uninstall the, after completion.|retain_clean_jobs                          |
-|KPOPS_OPERATION_MODE                              |managed                                 |False   |The operation mode of KPOps (managed, manifest, argo).                            |operation_mode                             |
 |KPOPS_STRIMZI_TOPIC                               |                                        |False   |Configuration for Strimzi Kafka Topics.                                           |strimzi_topic                              |
+|KPOPS_OPERATION_MODE                              |managed                                 |False   |The operation mode of KPOps (managed, manifest, argo).                            |operation_mode                             |
diff --git a/docs/docs/schema/config.json b/docs/docs/schema/config.json
@@ -118,15 +118,6 @@
             "title": "KafkaRestConfig",
             "type": "object"
         },
-        "OperationMode": {
-            "enum": [
-                "argo",
-                "manifest",
-                "managed"
-            ],
-            "title": "OperationMode",
-            "type": "string"
-        },
         "SchemaRegistryConfig": {
             "additionalProperties": false,
             "description": "Configuration for Schema Registry.",
@@ -212,7 +203,11 @@
             "type": "boolean"
         },
         "helm_config": {
-            "$ref": "#/$defs/HelmConfig",
+            "allOf": [
+                {
+                    "$ref": "#/$defs/HelmConfig"
+                }
+            ],
             "default": {
                 "api_version": null,
                 "context": null,
@@ -221,7 +216,11 @@
             "description": "Global flags for Helm."
         },
         "helm_diff_config": {
-            "$ref": "#/$defs/HelmDiffConfig",
+            "allOf": [
+                {
+                    "$ref": "#/$defs/HelmDiffConfig"
+                }
+            ],
             "default": {
                 "ignore": []
             },
@@ -236,23 +235,28 @@
             "type": "string"
         },
         "kafka_connect": {
-            "$ref": "#/$defs/KafkaConnectConfig",
+            "allOf": [
+                {
+                    "$ref": "#/$defs/KafkaConnectConfig"
+                }
+            ],
             "default": {
                 "timeout": 30,
                 "url": "http://localhost:8083/"
-            }
+            },
+            "description": "Configuration for Kafka Connect."
         },
         "kafka_rest": {
-            "$ref": "#/$defs/KafkaRestConfig",
+            "allOf": [
+                {
+                    "$ref": "#/$defs/KafkaRestConfig"
+                }
+            ],
             "default": {
                 "timeout": 30,
                 "url": "http://localhost:8082/"
-            }
-        },
-        "operation_mode": {
-            "$ref": "#/$defs/OperationMode",
-            "default": "managed",
-            "description": "The operation mode of KPOps (managed, manifest, argo)."
+            },
+            "description": "Configuration for Kafka REST Proxy."
         },
         "pipeline_base_dir": {
             "default": ".",
@@ -268,12 +272,17 @@
             "type": "boolean"
         },
         "schema_registry": {
-            "$ref": "#/$defs/SchemaRegistryConfig",
+            "allOf": [
+                {
+                    "$ref": "#/$defs/SchemaRegistryConfig"
+                }
+            ],
             "default": {
                 "enabled": false,
                 "timeout": 30,
                 "url": "http://localhost:8081/"
-            }
+            },
+            "description": "Configuration for Schema Registry."
         },
         "strimzi_topic": {
             "anyOf": [
@@ -288,11 +297,16 @@
             "description": "Configuration for Strimzi Kafka Topics."
         },
         "topic_name_config": {
-            "$ref": "#/$defs/TopicNameConfig",
+            "allOf": [
+                {
+                    "$ref": "#/$defs/TopicNameConfig"
+                }
+            ],
             "default": {
                 "default_error_topic_name": "${pipeline.name}-${component.name}-error",
                 "default_output_topic_name": "${pipeline.name}-${component.name}"
-            }
+            },
+            "description": "Configure the topic name variables you can use in the pipeline definition."
         }
     },
     "required": [