Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hide operation_mode from KPOps config #571

Merged
merged 5 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/docs/resources/variables/config_env_vars.env
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/docs/resources/variables/config_env_vars.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
62 changes: 38 additions & 24 deletions docs/docs/schema/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down Expand Up @@ -212,7 +203,11 @@
"type": "boolean"
},
"helm_config": {
"$ref": "#/$defs/HelmConfig",
"allOf": [
{
"$ref": "#/$defs/HelmConfig"
}
],
"default": {
"api_version": null,
"context": null,
Expand All @@ -221,7 +216,11 @@
"description": "Global flags for Helm."
},
"helm_diff_config": {
"$ref": "#/$defs/HelmDiffConfig",
"allOf": [
{
"$ref": "#/$defs/HelmDiffConfig"
}
],
"default": {
"ignore": []
},
Expand All @@ -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": ".",
Expand All @@ -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": [
Expand All @@ -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": [
Expand Down
Loading