defaults.yaml files¶Shared defaults for ATM Fraud Pipeline and Word-count Pipeline
kubernetes-app:
+ namespace: ${NAMESPACE}
-kubernetes-app:
- namespace: ${NAMESPACE}
-
-kafka-app:
- app:
- streams:
- brokers: ${config.kafka_brokers}
- schemaRegistryUrl: ${config.schema_registry.url}
- optimizeLeaveGroupBehavior: false
-
-producer-app:
- to:
- topics:
- ${output_topic_name}:
- partitions_count: 3
-
-streams-app:
- app:
- labels:
- pipeline: ${pipeline.name}
- streams:
- optimizeLeaveGroupBehavior: false
- to:
- topics:
- ${error_topic_name}:
- type: error
- partitions_count: 1
- ${output_topic_name}:
- partitions_count: 3
-Auto generation happens mostly with pre-commit hooks. You can find the pre-commit configuration here. These pre-commit hooks call different Python scripts to auto generate code for the documentation.
cli_env_vars.env -- All CLI environment variables in a dotenv file.cli_env_vars.md -- All CLI environment variables in a table.config_env_vars.env -- Almost all pipeline config environment variables in a dotenv file. The script checks for each field in KpopsConfig whether it has an env attribute defined. The script is currently unable to visit the classes of fields like topic_name_config, hence any environment variables defined there would remain unknown to it.config_env_vars.env -- Almost all pipeline config environment variables in a table.variable_substitution.yaml -- A copy of ./tests/pipeline/resources/component-type-substitution/pipeline.yaml used as an example of substitution.Generated by typer-cli from the code in main.py. It is called with Python's subprocess module.
Generates example pipeline.yaml and defaults.yaml for each individual component, stores them and also concatenates them into 1 big pipeline definition and 1 big pipeline defaults definition.
User input
headers/*\\.yaml -- The top of each example. Includes a description comment, type and name. The headers for pipeline.yaml reside in the pipeline-components dir and the defaults.yaml headers reside in the pipeline-defaults dir. The names of the files must be equal to the respective component type.sections/*\\.yaml -- Each YAML file contains a single section (component attribute) definition. The intention is to keep the minimal set of definitions there from which any component definition can be built. The names of the files must be equal to the respective component type and the attribute name. The sections are used for both defaults.yaml and pipeline.yaml generation and reside in the pipeline-components dir.Generated
pipeline-components/dependencies/* Cached information about KPOps componentspipeline_component_dependencies.yaml -- Specifies per component which files in the sections dir should be used for the pipeline.yaml generation.defaults_pipeline_component_dependencies.yaml -- Specifies per component which files in the sections dir should be used for the defaults.yaml generation.kpops_structure.yaml -- Specifies the inheritance hierarchy of the components and what sections exist in each component.pipeline-components/*\\.yaml -- All single-component pipeline definitions and one big (complete) pipeline.yaml that contains all of them.pipeline-defaults/*\\.yaml -- All single-component defaults definitions and one big (complete) defaults.yaml that contains all of them.Welcome! We are glad to have you visit our contributing guide!
If you find any bugs or have suggestions for improvements, please open an issue and optionally a pull request (PR). In the case of a PR, we would appreciate it if you preface it with an issue outlining your goal and means of achieving it.
"}, {"location": "developer/contributing/#style", "title": "Style", "text": "We advise that you stick to our pre-commit hooks for code linting, formatting, and auto-generation of documentation. After you install them using poetry run pre-commit install they're triggered automatically during git commit. Additionally, you can manually invoke them with poetry run pre-commit run -a. In order for dprint to work, you have to manually install it locally. It will work in the CI, so it is also possible to manually carry out formatting changes flagged by dprint in the CI and skip installing it locally.
To ensure a consistent Python code style, we use Ruff for both linting and formatting. The official docs contain a guide on editor integration.
Our configuration can be found in KPOps' top-level pyproject.toml.
To ensure a consistent markdown style, we use dprint's Markdown code formatter. Our configuration can be found here.
"}, {"location": "developer/contributing/#css", "title": "CSS", "text": "To ensure a consistent CSS style, we use the malva dprint's plugin. Our configuration can be found here.
"}, {"location": "developer/contributing/#toml", "title": "TOML", "text": "To ensure a consistent TOML style, we use dprint's TOML code formatter. Our configuration can be found here.
"}, {"location": "developer/getting-started/", "title": "Getting started", "text": "Welcome! We are glad to have you visit our developer guide! If you find any bugs or have suggestions for improvements, please open an issue and optionally a pull request (PR). In the case of a PR, we would appreciate it if you preface it with an issue outlining your goal and means of achieving it.
Find more about our code-style or insights into KPOps' code base here in our developer guide.
Work in progress
The developer guide is still under construction. If you have a question left unanswered here, feel free to ask it by opening an issue.
"}, {"location": "user/changelog/", "title": "Changelog", "text": ""}, {"location": "user/changelog/#300-release-date-2024-01-17", "title": "3.0.0 - Release Date: [2024-01-17]", "text": ""}, {"location": "user/changelog/#breaking-changes", "title": "\ud83c\udfd7\ufe0f Breaking changes", "text": "Move GitHub action to repository root - #356
Make Kafka REST Proxy & Kafka Connect hosts default and improve Schema Registry config - #354
Create HelmApp component - #370
Change substitution variables separator to . - #388
Refactor pipeline generator & representation - #392
Define custom components module & pipeline base dir globally - #387
Use hash and trim long Helm release names instead of only trimming - #390
Refactor generate template for Python API usage - #380
Namespace substitution vars - #408
Refactor streams-bootstrap cleanup jobs as individual HelmApp - #398
Refactor Kafka Connector resetter as individual HelmApp - #400
Fix wrong Helm release name character limit - #418
Allow overriding config files - #391
Generate defaults schema - #402
Fix missing component type in pipeline schema - #401
Fix enrichment of nested Pydantic BaseModel - #415
Fix wrong Helm release name character limit - #418
Update release workflow template to support custom changelog file path - #421
Make Kafka REST Proxy & Kafka Connect hosts default and improve Schema Registry config - #354
Migrate to Pydantic v2 - #347
Refactor pipeline generator & representation - #392
Use hash and trim long Helm release names instead of only trimming - #390
Refactor Helm nameOverride - #397
Mark component type as computed Pydantic field - #399
Refactor generate template for Python API usage - #380
Support multiple inheritance for doc generation - #406
Refactor streams-bootstrap cleanup jobs as individual HelmApp - #398
Refactor Kafka Connector resetter as individual HelmApp - #400
Move GitHub action to repository root - #356
Create HelmApp component - #370
Update docs for substitution variable usage in v3 - #409
Support multiple inheritance for doc generation - #406
Update docs for v3 - #416
Update tests resources - #417
Summarize all breaking changes in diffs at the top of the migration guide - #419
Replace black with ruff - #365
Add toml formatter to dprint - #386
Add malva to dprint - #385
Update KPOps runner with the new options - #395
Fix KPOps action to get package from testPyPI - #396
KPOps 3.0 - #420
Fix early exit upon Helm exit code 1 - #376
Fix docs setup page list indentation - #377
Migrate deprecated mkdocs-material-extensions - #378
Fix docs setup page list indentation - #377
Exclude resources from docs search - #371
Fix environment variables documentation generation - #362
Introduce ruff - #363
Print details on connector name mismatch error - #369
Enable transparent OS environment lookups from internal environment - #368
Refactor component prefix & name - #326
Remove unnecessary condition during inflate - #328
--template flag is set - #350Add dprint as the markdown formatter - #337
Publish pre-release docs for PRs & main branch - #339
Align docs colours - #345
Add version dropdown to the documentation - #336
Break the documentation down into smaller subsection - #329
Remove camel case conversion of internal models - #308
Derive component type automatically from class name - #309
Refactor input/output types - #232
v2 - #321
Automatically support schema generation for custom components - #307
Derive component type automatically from class name - #309
Add KPOps Runner GitHub Action to the documentation - #325
Remove :type and :rtype from docstrings - #324
Modularize and autogenerate examples for the documentation - #267
Update the variable documentation - #266
--set-file flag - #311Refactor Helm wrapper and add --set-file flag - #311
Set default for ToSection topics - #313
Annotate types for ToSection models mapping - #315
Order PipelineComponent fields - #290
Migrate requests to httpx - #302
Refactor CLI using dtyper - #306
Update Black - #294
Fix vulnerability in mkdocs-material - #295
Move breaking changes section upper in the change log config - #287
Update codeowners - #281
Reactivate Windows CI - #255
Downgrade Poetry version on the Windows CI pipeline - #286
Set ANSI theme for output of kpops generate - #289
Create workflow to lint CI - #260
Fix update docs when releasing - #261
Rename change log message for uncategorized issues - #262
helm repo update <repo-name> for Helm >3.7 - #239add --namespace option to Helm template command - #237
Add missing type annotation for Pydantic attributes - #238
Fix helm version check - #242
Fix Helm Version Check - #244
Fix import from external module - #256
Remove enable option from helm diff - #235
Refactor variable substitution - #198
Add background to docs home page - #236
Update Poetry version in CI - #247
Add pip cache in KPOps runner action - #249
Check types using Pyright - #251
Remove MyPy - #252
Disable broken Windows CI temporarily - #253
Update release and publish workflows - #254
Fix release & publish workflows - #257
With a couple of easy commands in the shell, and a pipeline.yaml of under 30 lines, KPOps can not only deploy a Kafka pipeline1 to a Kubernetes cluster, but also reset, clean or destroy it!
- type: producer-app\n name: data-producer\n app:\n image: bakdata/kpops-demo-sentence-producer\n\n- type: streams-app\n name: word-counter\n to:\n topics:\n ${output_topic_name}:\n type: output\n configs:\n cleanup.policy: compact\n app:\n image: bakdata/kpops-demo-word-count-app\n replicaCount: 1\n\n- type: kafka-sink-connector\n name: redis-sink-connector\n app:\n connector.class: com.github.jcustenborder.kafka.connect.redis.RedisSinkConnector\n redis.hosts: redis-headless:6379\n redis.database: 0\n tasks.max: 1\n key.converter: org.apache.kafka.connect.storage.StringConverter\n value.converter: org.apache.kafka.connect.storage.StringConverter\nA Kafka pipeline can consist of consecutive streaming applications, producers, and connectors.\u00a0\u21a9
KPOps reads its global configuration that is unrelated to a pipeline's components from config.yaml.
Consider enabling KPOps' editor integration feature to enjoy the benefits of autocompletion and validation when configuring your pipeline.
To learn about any of the available settings, take a look at the example below.
config.yaml # CONFIGURATION\n#\n# The path to the folder containing the defaults.yaml file and the environment\n# defaults files.\ndefaults_path: .\n# Custom Python module defining project-specific KPOps components\ncomponents_module: null\n# Base directory to the pipelines (default is current working directory)\npipeline_base_dir: .\n# The Kafka brokers address.\n# REQUIRED\nkafka_brokers: \"http://broker1:9092,http://broker2:9092\"\n# The name of the defaults file and the prefix of the defaults environment file.\ndefaults_filename_prefix: defaults\n# Configure the topic name variables you can use in the pipeline definition.\ntopic_name_config: \n # Configures the value for the variable ${output_topic_name}\n default_output_topic_name: ${pipeline.name}-${component.name}\n # Configures the value for the variable ${error_topic_name}\n default_error_topic_name: ${pipeline.name}-${component.name}-error\n# Configuration for Schema Registry.\nschema_registry:\n # Whether the Schema Registry handler should be initialized.\n enabled: false\n # Address of the Schema Registry.\n url: \"http://localhost:8081\"\n# Configuration for the Kafka REST Proxy.\nkafka_rest:\n # Address of the Kafka REST Proxy.\n url: \"http://localhost:8082\"\n# Configuration for Kafka Connect.\nkafka_connect:\n # Address of Kafka Connect.\n url: \"http://localhost:8083\"\n# The timeout in seconds that specifies when actions like deletion or deploy\n# timeout.\ntimeout: 300\n# Flag for `helm upgrade --install`.\n# Create the release namespace if not present.\ncreate_namespace: false\n# Global flags for Helm.\nhelm_config:\n # Name of kubeconfig context (`--kube-context`)\n context: name\n # Run Helm in Debug mode.\n debug: false\n # Kubernetes API version used for Capabilities.APIVersions\n api_version: null\n# Configure Helm Diff.\nhelm_diff_config: \n # Set of keys that should not be checked.\n ignore:\n - name\n - imageTag\n# Whether to retain clean up jobs in the cluster or uninstall the, after\n# completion.\nretain_clean_jobs: false\nEnvironment-specific pipeline definitions
Similarly to defaults, it is possible to have an unlimited amount of additional environment-specific pipeline definitions. The naming convention is the same: add a suffix of the form _{environment} to the filename.
KPOps has a very efficient way of dealing with repeating settings which manifests as defaults.yaml. This file provides the user with the power to set defaults for any and all components, thus omitting the need to repeat the same settings in pipeline.yaml.
See real-world examples for defaults.
An important mechanic of KPOps is that defaults set for a component apply to all components that inherit from it.
It is possible, although not recommended, to add settings that are specific to a component's subclass. An example would be configuring offset_topic under kafka-connector instead of kafka-source-connector.
It is possible to set specific defaults for each environment by adding files called defaults_{environment}.yaml to the defaults folder at defaults_path. The defaults are loaded based on the currently set environment.
It is important to note that defaults_{environment}.yaml overrides only the settings that are explicitly set to be different from the ones in the base defaults file.
Tip
defaults is the default value of defaults_filename_prefix. Together with defaults_path and environment it can be changed in config.yaml
The defaults codeblocks in this section contain the full set of settings that are specific to the component. If a setting already exists in a parent config, it will not be included in the child's.
defaults.yaml # Base Kubernetes App\n#\n# Parent of: HelmApp\n# Child of: PipelineComponent\nkubernetes-app:\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example.\n app: # required\n image: exampleImage # Example\n debug: false # Example\n commandLine: {} # Example\ndefaults.yaml # Base component for Kafka-based components.\n#\n# Parent of: ProducerApp, StreamsApp\n# Child of: KubernetesApp\nkafka-app:\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` can contain application-specific settings, hence the user is free to\n # add the key-value pairs they need.\n app: # required\n streams: # required\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n nameOverride: override-with-this-name # kafka-app-specific\n imageTag: \"1.0.0\" # Example values that are shared between streams-app and producer-app\ndefaults.yaml # StreamsApp component that configures a streams bootstrap app.\n#\n# Child of: KafkaApp\n# More documentation on StreamsApp: https://github.com/bakdata/streams-bootstrap\nstreams-app:\n # No arbitrary keys are allowed under `app`here\n # Allowed configs:\n # https://github.com/bakdata/streams-bootstrap/tree/master/charts/streams-app\n app: # required\n # Streams Bootstrap streams section\n streams: # required, streams-app-specific\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n inputTopics:\n - topic1\n - topic2\n outputTopic: output-topic\n inputPattern: input-pattern\n extraInputTopics:\n input_role1:\n - input_topic1\n - input_topic2\n input_role2:\n - input_topic3\n - input_topic4\n extraInputPatterns:\n pattern_role1: input_pattern1\n extraOutputTopics:\n output_role1: output_topic1\n output_role2: output_topic2\n errorTopic: error-topic\n config:\n my.streams.config: my.value\n nameOverride: override-with-this-name # streams-app-specific\n autoscaling: # streams-app-specific\n consumerGroup: consumer-group # required\n lagThreshold: 0 # Average target value to trigger scaling actions.\n enabled: false # Whether to enable auto-scaling using KEDA.\n # This is the interval to check each trigger on.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#pollinginterval\n pollingInterval: 30\n # The period to wait after the last trigger reported active before scaling\n # the resource back to 0. https://keda.sh/docs/2.9/concepts/scaling-deployments/#cooldownperiod\n cooldownPeriod: 300\n # The offset reset policy for the consumer if the the consumer group is\n # not yet subscribed to a partition.\n offsetResetPolicy: earliest\n # This setting is passed to the HPA definition that KEDA will create for a\n # given resource and holds the maximum number of replicas of the target resouce.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#maxreplicacount\n maxReplicas: 1\n # Minimum number of replicas KEDA will scale the resource down to.\n # https://keda.sh/docs/2.7/concepts/scaling-deployments/#minreplicacount\n minReplicas: 0\n # If this property is set, KEDA will scale the resource down to this\n # number of replicas.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#idlereplicacount\n idleReplicas: 0\n topics: # List of auto-generated Kafka Streams topics used by the streams app.\n - topic1\n - topic2\ndefaults.yaml \ndefaults.yaml # Kafka connector\n#\n# Parent of: KafkaSinkConnector, KafkaSourceConnector\n# Child of: PipelineComponent\nkafka-connector:\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example. Extensive documentation on\n # connectors: https://kafka.apache.org/documentation/#connectconfigs\n app: # required\n tasks.max: 1\n # Overriding Kafka Connect Resetter Helm values. E.g. to override the\n # Image Tag etc.\n resetter_values:\n imageTag: \"1.2.3\"\ndefaults.yaml # Kafka source connector\n#\n# Child of: KafkaConnector\nkafka-source-connector:\n # The source connector has no `from` section\n # from:\n # offset.storage.topic\n # https://kafka.apache.org/documentation/#connect_running\n offset_topic: offset_topic\ndefaults.yaml # Kafka sink connector\n#\n# Child of: KafkaConnector\nkafka-sink-connector:\n # No settings differ from `kafka-connector`\nCan be used to deploy any app in Kubernetes using Helm, for example, a REST service that serves Kafka data.
"}, {"location": "user/core-concepts/components/helm-app/#configuration", "title": "Configuration", "text": "pipeline.yaml # Kubernetes app managed through Helm with an associated Helm chart\n- type: helm-app\n name: helm-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example.\n app: # required\n image: exampleImage # Example\n debug: false # Example\n commandLine: {} # Example\n # Helm repository configuration (optional)\n # If not set the helm repo add will not be called. Useful when using local Helm charts\n repo_config:\n repository_name: bakdata-streams-bootstrap # required\n url: https://bakdata.github.io/streams-bootstrap/ # required\n repo_auth_flags:\n username: user\n password: pass\n ca_file: /home/user/path/to/ca-file\n insecure_skip_tls_verify: false\n version: \"1.0.0\" # Helm chart version\nDeploy using Helm.
"}, {"location": "user/core-concepts/components/helm-app/#destroy", "title": "destroy", "text": "Uninstall Helm release.
"}, {"location": "user/core-concepts/components/helm-app/#reset", "title": "reset", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/helm-app/#clean", "title": "clean", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kafka-app/", "title": "KafkaApp", "text": "Subclass of HelmApp.
"}, {"location": "user/core-concepts/components/kafka-app/#usage", "title": "Usage", "text": "pipeline.yaml as the component can be defined as either a StreamsApp or a ProducerAppdefaults.yamlpipeline.yaml # Base component for Kafka-based components.\n# Producer or streaming apps should inherit from this class.\n- type: kafka-app # required\n name: kafka-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` can contain application-specific settings, hence the user is free to\n # add the key-value pairs they need.\n app: # required\n streams: # required\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n nameOverride: override-with-this-name # kafka-app-specific\n imageTag: \"1.0.0\" # Example values that are shared between streams-app and producer-app\nIn addition to HelmApp's deploy:
Uninstall Helm release.
"}, {"location": "user/core-concepts/components/kafka-app/#reset", "title": "reset", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kafka-app/#clean", "title": "clean", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kafka-connector/", "title": "KafkaConnector", "text": "KafkaConnector is a component that deploys Kafka Connectors. Since a connector cannot be different from sink or source it is not recommended to use KafkaConnector for deployment in pipeline.yaml. Instead, KafkaConnector should be used in defaults.yaml to set defaults for all connectors in the pipeline as they can share some common settings.
Subclass of KafkaConnector.
"}, {"location": "user/core-concepts/components/kafka-sink-connector/#usage", "title": "Usage", "text": "Lets other systems pull data from Apache Kafka.
"}, {"location": "user/core-concepts/components/kafka-sink-connector/#configuration", "title": "Configuration", "text": "pipeline.yaml # Kafka sink connector\n- type: kafka-sink-connector\n name: kafka-sink-connector # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example. Extensive documentation on\n # connectors: https://kafka.apache.org/documentation/#connectconfigs\n app: # required\n tasks.max: 1\n # Overriding Kafka Connect Resetter Helm values. E.g. to override the\n # Image Tag etc.\n resetter_values:\n imageTag: \"1.2.3\"\nThe associated sink connector is removed from the Kafka Connect cluster.
"}, {"location": "user/core-concepts/components/kafka-sink-connector/#reset", "title": "reset", "text": "Reset the consumer group offsets using bakdata's sink resetter.
"}, {"location": "user/core-concepts/components/kafka-sink-connector/#clean", "title": "clean", "text": "Subclass of KafkaConnector.
"}, {"location": "user/core-concepts/components/kafka-source-connector/#usage", "title": "Usage", "text": "Manages source connectors in your Kafka Connect cluster.
"}, {"location": "user/core-concepts/components/kafka-source-connector/#configuration", "title": "Configuration", "text": "pipeline.yaml # Kafka source connector\n- type: kafka-source-connector # required\n name: kafka-source-connector # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n # The source connector has no `from` section\n # from:\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example. Extensive documentation on\n # connectors: https://kafka.apache.org/documentation/#connectconfigs\n app: # required\n tasks.max: 1\n # Overriding Kafka Connect Resetter Helm values. E.g. to override the\n # Image Tag etc.\n resetter_values:\n imageTag: \"1.2.3\"\n # offset.storage.topic\n # https://kafka.apache.org/documentation/#connect_running\n offset_topic: offset_topic\nRemove the source connector from the Kafka Connect cluster.
"}, {"location": "user/core-concepts/components/kafka-source-connector/#reset", "title": "reset", "text": "Delete state associated with the connector using bakdata's sink resetter.
"}, {"location": "user/core-concepts/components/kafka-source-connector/#clean", "title": "clean", "text": "Can be used to create components for any Kubernetes app.
"}, {"location": "user/core-concepts/components/kubernetes-app/#configuration", "title": "Configuration", "text": "pipeline.yaml # Base Kubernetes App\n- type: kubernetes-app\n name: kubernetes-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example.\n app: # required\n image: exampleImage # Example\n debug: false # Example\n commandLine: {} # Example\nDo nothing.
"}, {"location": "user/core-concepts/components/kubernetes-app/#destroy", "title": "destroy", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kubernetes-app/#reset", "title": "reset", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kubernetes-app/#clean", "title": "clean", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/overview/", "title": "Overview", "text": "This section explains the different components of KPOps, their usage and configuration in the pipeline definition pipeline.yaml.
flowchart BT\n KubernetesApp --> PipelineComponent\n KafkaApp --> PipelineComponent\n HelmApp --> KubernetesApp\n StreamsBootstrap --> HelmApp\n StreamsApp --> KafkaApp\n StreamsApp --> StreamsBootstrap\n ProducerApp --> KafkaApp\n ProducerApp --> StreamsBootstrap\n KafkaConnector --> PipelineComponent\n KafkaSourceConnector --> KafkaConnector\n KafkaSinkConnector --> KafkaConnector\n\n click KubernetesApp \"/kpops/user/core-concepts/components/kubernetes-app\"\n click HelmApp \"/kpops/user/core-concepts/components/helm-app\"\n click KafkaApp \"/kpops/user/core-concepts/components/kafka-app\"\n click StreamsBootstrap \"/kpops/user/core-concepts/components/streams-bootstrap\"\n click StreamsApp \"/kpops/user/core-concepts/components/streams-app\"\n click ProducerApp \"/kpops/user/core-concepts/components/producer-app\"\n click KafkaConnector \"/kpops/user/core-concepts/components/kafka-connector\"\n click KafkaSourceConnector \"/kpops/user/core-concepts/components/kafka-source-connector\"\n click KafkaSinkConnector \"/kpops/user/core-concepts/components/kafka-sink-connector\"KPOps component hierarchy
"}, {"location": "user/core-concepts/components/producer-app/", "title": "ProducerApp", "text": "Subclass of KafkaApp and StreamsBootstrap.
"}, {"location": "user/core-concepts/components/producer-app/#usage", "title": "Usage", "text": "Configures a streams-bootstrap Kafka producer app
"}, {"location": "user/core-concepts/components/producer-app/#configuration", "title": "Configuration", "text": "pipeline.yaml # Holds configuration to use as values for the streams bootstrap producer-app Helm\n# chart.\n# More documentation on ProducerApp:\n# https://github.com/bakdata/streams-bootstrap\n- type: producer-app\n name: producer-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n # from: # While the producer-app does inherit from kafka-app, it does not need a\n # `from` section, hence it does not support it.\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # Allowed configs:\n # https://github.com/bakdata/streams-bootstrap/tree/master/charts/producer-app\n app: # required\n streams: # required, producer-app-specific\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n outputTopic: output_topic\n extraOutputTopics:\n output_role1: output_topic1\n output_role2: output_topic2\n nameOverride: override-with-this-name # kafka-app-specific\n # Helm repository configuration (optional)\n # If not set the helm repo add will not be called. Useful when using local Helm charts\n repo_config:\n repository_name: bakdata-streams-bootstrap # required\n url: https://bakdata.github.io/streams-bootstrap/ # required\n repo_auth_flags:\n username: user\n password: pass\n ca_file: /home/user/path/to/ca-file\n insecure_skip_tls_verify: false\n version: \"2.12.0\" # Helm chart version\nIn addition to KubernetesApp's deploy:
Uninstall Helm release.
"}, {"location": "user/core-concepts/components/producer-app/#reset", "title": "reset", "text": "Do nothing, producers are stateless.
"}, {"location": "user/core-concepts/components/producer-app/#clean", "title": "clean", "text": "Subclass of KafkaApp and StreamsBootstrap.
"}, {"location": "user/core-concepts/components/streams-app/#usage", "title": "Usage", "text": "Configures a streams-bootstrap Kafka Streams app
"}, {"location": "user/core-concepts/components/streams-app/#configuration", "title": "Configuration", "text": "pipeline.yaml # StreamsApp component that configures a streams bootstrap app.\n# More documentation on StreamsApp: https://github.com/bakdata/streams-bootstrap\n- type: streams-app # required\n name: streams-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # No arbitrary keys are allowed under `app`here\n # Allowed configs:\n # https://github.com/bakdata/streams-bootstrap/tree/master/charts/streams-app\n app: # required\n # Streams Bootstrap streams section\n streams: # required, streams-app-specific\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n inputTopics:\n - topic1\n - topic2\n outputTopic: output-topic\n inputPattern: input-pattern\n extraInputTopics:\n input_role1:\n - input_topic1\n - input_topic2\n input_role2:\n - input_topic3\n - input_topic4\n extraInputPatterns:\n pattern_role1: input_pattern1\n extraOutputTopics:\n output_role1: output_topic1\n output_role2: output_topic2\n errorTopic: error-topic\n config:\n my.streams.config: my.value\n nameOverride: override-with-this-name # streams-app-specific\n autoscaling: # streams-app-specific\n consumerGroup: consumer-group # required\n lagThreshold: 0 # Average target value to trigger scaling actions.\n enabled: false # Whether to enable auto-scaling using KEDA.\n # This is the interval to check each trigger on.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#pollinginterval\n pollingInterval: 30\n # The period to wait after the last trigger reported active before scaling\n # the resource back to 0. https://keda.sh/docs/2.9/concepts/scaling-deployments/#cooldownperiod\n cooldownPeriod: 300\n # The offset reset policy for the consumer if the the consumer group is\n # not yet subscribed to a partition.\n offsetResetPolicy: earliest\n # This setting is passed to the HPA definition that KEDA will create for a\n # given resource and holds the maximum number of replicas of the target resouce.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#maxreplicacount\n maxReplicas: 1\n # Minimum number of replicas KEDA will scale the resource down to.\n # https://keda.sh/docs/2.7/concepts/scaling-deployments/#minreplicacount\n minReplicas: 0\n # If this property is set, KEDA will scale the resource down to this\n # number of replicas.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#idlereplicacount\n idleReplicas: 0\n topics: # List of auto-generated Kafka Streams topics used by the streams app.\n - topic1\n - topic2\n # Helm repository configuration (optional)\n # If not set the helm repo add will not be called. Useful when using local Helm charts\n repo_config:\n repository_name: bakdata-streams-bootstrap # required\n url: https://bakdata.github.io/streams-bootstrap/ # required\n repo_auth_flags:\n username: user\n password: pass\n ca_file: /home/user/path/to/ca-file\n insecure_skip_tls_verify: false\n version: \"2.12.0\" # Helm chart version\nIn addition to KubernetesApp's deploy:
Uninstall Helm release.
"}, {"location": "user/core-concepts/components/streams-app/#reset", "title": "reset", "text": "Similar to reset with to additional steps:
Subclass of HelmApp.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#usage", "title": "Usage", "text": "Configures a Helm app with streams-bootstrap Helm charts.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#operations", "title": "Operations", "text": ""}, {"location": "user/core-concepts/components/streams-bootstrap/#deploy", "title": "deploy", "text": "Deploy using Helm.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#destroy", "title": "destroy", "text": "Uninstall Helm release.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#reset", "title": "reset", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#clean", "title": "clean", "text": "Do nothing.
"}, {"location": "user/core-concepts/variables/environment_variables/", "title": "Environment variables", "text": "Environment variables can be set by using the export command in Linux or the set command in Windows.
dotenv files
KPOps currently supports .env files only for variables related to the config. Full support for .env files is on the roadmap. One of the possible ways to use one and export the contents manually is with the following command: export $(xargs < .env). This would work in bash suppose there are no spaces inside the values.
These variables are a lower priority alternative to the settings in config.yaml. Variables marked as required can instead be set in the global config.
config.yaml defaults_path KPOPS_COMPONENTS_MODULE False Custom Python module defining project-specific KPOps components components_module KPOPS_PIPELINE_BASE_DIR . False Base directory to the pipelines (default is current working directory) pipeline_base_dir KPOPS_KAFKA_BROKERS True The comma separated Kafka brokers address. kafka_brokers KPOPS_DEFAULTS_FILENAME_PREFIX defaults False The name of the defaults file and the prefix of the defaults environment file. defaults_filename_prefix KPOPS_TOPIC_NAME_CONFIG__DEFAULT_OUTPUT_TOPIC_NAME ${pipeline.name}-${component.name} False Configures the value for the variable ${output_topic_name} topic_name_config.default_output_topic_name KPOPS_TOPIC_NAME_CONFIG__DEFAULT_ERROR_TOPIC_NAME ${pipeline.name}-${component.name}-error False Configures the value for the variable ${error_topic_name} topic_name_config.default_error_topic_name KPOPS_SCHEMA_REGISTRY__ENABLED False False Whether the Schema Registry handler should be initialized. schema_registry.enabled KPOPS_SCHEMA_REGISTRY__URL http://localhost:8081/ False Address of the Schema Registry. schema_registry.url KPOPS_KAFKA_REST__URL http://localhost:8082/ False Address of the Kafka REST Proxy. kafka_rest.url KPOPS_KAFKA_CONNECT__URL http://localhost:8083/ False Address of Kafka Connect. kafka_connect.url KPOPS_TIMEOUT 300 False The timeout in seconds that specifies when actions like deletion or deploy timeout. timeout KPOPS_CREATE_NAMESPACE False False Flag for helm upgrade --install. Create the release namespace if not present. create_namespace KPOPS_HELM_CONFIG__CONTEXT False Name of kubeconfig context (--kube-context) helm_config.context KPOPS_HELM_CONFIG__DEBUG False False Run Helm in Debug mode helm_config.debug 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 config_env_vars.env Exhaustive list of all config-related environment variables# Global config environment variables\n#\n# The default setup is shown. These variables are a lower priority\n# alternative to the settings in `config.yaml`. Variables marked as\n# required can instead be set in the global config.\n#\n# defaults_path\n# The path to the folder containing the defaults.yaml file and the\n# environment defaults files. Paths can either be absolute or relative\n# to `config.yaml`\nKPOPS_DEFAULTS_PATH=.\n# components_module\n# Custom Python module defining project-specific KPOps components\nKPOPS_COMPONENTS_MODULE # No default value, not required\n# pipeline_base_dir\n# Base directory to the pipelines (default is current working\n# directory)\nKPOPS_PIPELINE_BASE_DIR=.\n# kafka_brokers\n# The comma separated Kafka brokers address.\nKPOPS_KAFKA_BROKERS # No default value, required\n# defaults_filename_prefix\n# The name of the defaults file and the prefix of the defaults\n# environment file.\nKPOPS_DEFAULTS_FILENAME_PREFIX=defaults\n# topic_name_config.default_output_topic_name\n# Configures the value for the variable ${output_topic_name}\nKPOPS_TOPIC_NAME_CONFIG__DEFAULT_OUTPUT_TOPIC_NAME=${pipeline.name}-${component.name}\n# topic_name_config.default_error_topic_name\n# Configures the value for the variable ${error_topic_name}\nKPOPS_TOPIC_NAME_CONFIG__DEFAULT_ERROR_TOPIC_NAME=${pipeline.name}-${component.name}-error\n# schema_registry.enabled\n# Whether the Schema Registry handler should be initialized.\nKPOPS_SCHEMA_REGISTRY__ENABLED=False\n# schema_registry.url\n# Address of the Schema Registry.\nKPOPS_SCHEMA_REGISTRY__URL=http://localhost:8081/\n# kafka_rest.url\n# Address of the Kafka REST Proxy.\nKPOPS_KAFKA_REST__URL=http://localhost:8082/\n# kafka_connect.url\n# Address of Kafka Connect.\nKPOPS_KAFKA_CONNECT__URL=http://localhost:8083/\n# timeout\n# The timeout in seconds that specifies when actions like deletion or\n# deploy timeout.\nKPOPS_TIMEOUT=300\n# create_namespace\n# Flag for `helm upgrade --install`. Create the release namespace if\n# not present.\nKPOPS_CREATE_NAMESPACE=False\n# helm_config.context\n# Name of kubeconfig context (`--kube-context`)\nKPOPS_HELM_CONFIG__CONTEXT # No default value, not required\n# helm_config.debug\n# Run Helm in Debug mode\nKPOPS_HELM_CONFIG__DEBUG=False\n# helm_config.api_version\n# Kubernetes API version used for Capabilities.APIVersions\nKPOPS_HELM_CONFIG__API_VERSION # No default value, not required\n# helm_diff_config.ignore\n# Set of keys that should not be checked.\nKPOPS_HELM_DIFF_CONFIG__IGNORE # No default value, required\n# retain_clean_jobs\n# Whether to retain clean up jobs in the cluster or uninstall the,\n# after completion.\nKPOPS_RETAIN_CLEAN_JOBS=False\nThese variables are a lower priority alternative to the commands' flags. If a variable is set, the corresponding flag does not have to be specified in commands. Variables marked as required can instead be set as flags.
Name Default Value Required Description KPOPS_CONFIG_PATH . False Path to the dir containing config.yaml files KPOPS_DEFAULT_PATH False Path to defaults folder KPOPS_DOTENV_PATH False Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. KPOPS_ENVIRONMENT False The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). KPOPS_PIPELINE_PATH True Path to YAML with pipeline definition KPOPS_PIPELINE_STEPS False Comma separated list of steps to apply the command on cli_env_vars.env Exhaustive list of all cli-related environment variables# CLI Environment variables\n#\n# The default setup is shown. These variables are a lower priority\n# alternative to the commands' flags. If a variable is set, the\n# corresponding flag does not have to be specified in commands.\n# Variables marked as required can instead be set as flags.\n#\n# Path to the dir containing config.yaml files\nKPOPS_CONFIG_PATH=.\n# Path to defaults folder\nKPOPS_DEFAULT_PATH # No default value, not required\n# Path to dotenv file. Multiple files can be provided. The files will\n# be loaded in order, with each file overriding the previous one.\nKPOPS_DOTENV_PATH # No default value, not required\n# The environment you want to generate and deploy the pipeline to.\n# Suffix your environment files with this value (e.g.\n# defaults_development.yaml for environment=development).\nKPOPS_ENVIRONMENT # No default value, not required\n# Path to YAML with pipeline definition\nKPOPS_PIPELINE_PATH # No default value, required\n# Comma separated list of steps to apply the command on\nKPOPS_PIPELINE_STEPS # No default value, not required\nKPOps supports the usage of placeholders and environment variables in pipeline definition and defaults.
"}, {"location": "user/core-concepts/variables/substitution/#component-specific-variables", "title": "Component-specific variables", "text": "These variables can be used in a component's definition to refer to any of its attributes, including ones that the user has defined in the defaults.
All of them are prefixed with component. and follow the following form: component.{attribute_name}. If the attribute itself contains attributes, they can be referred to like this: component.{attribute_name}.{subattribute_name}.
- type: scheduled-producer\n app:\n labels:\n app_type: \"${component.type}\"\n app_name: \"${component.name}\"\n app_schedule: \"${component.app.schedule}\"\n commandLine:\n FAKE_ARG: \"fake-arg-value\"\n schedule: \"30 3/8 * * *\"\n- type: converter\n app:\n commandLine:\n CONVERT_XML: true\n resources:\n limits:\n memory: 2G\n requests:\n memory: 2G\n- type: filter\n name: \"filter-app\"\n app:\n labels:\n app_type: \"${component.type}\"\n app_name: \"${component.name}\"\n app_resources_requests_memory: \"${component.app.resources.requests.memory}\"\n ${component.type}: \"${component.app.labels.app_name}-${component.app.labels.app_type}\"\n test_placeholder_in_placeholder: \"${component.app.labels.${component.type}}\"\n commandLine:\n TYPE: \"nothing\"\n resources:\n requests:\n memory: 3G\n replicaCount: 4\n autoscaling:\n minReplicas: 4\n maxReplicas: 4\nThese variables include all fields in the config and refer to the pipeline configuration that is independent of the components.
All such variables are prefixed with config. and are of the same form as the component-specific variables.
Info
error_topic_name is an alias for config.topic_name_config.default_error_topic_name output_topic_name is an alias for config.topic_name_config.default_output_topic_name
Environment variables such as $PATH can be used in the pipeline definition and defaults without any transformation following the form ${ENV_VAR_NAME}. This, of course, includes variables like the ones relevant to the KPOps cli that are exported by the user.
See all KPOps environment variables
"}, {"location": "user/core-concepts/variables/substitution/#pipeline-name-variables", "title": "Pipeline name variables", "text": "These are special variables that refer to the name and path of a pipeline.
${pipeline.name}: Concatenated path of the parent directory where pipeline.yaml is defined in. For instance, ./data/pipelines/v1/pipeline.yaml, here the value for the variable would be data-pipelines-v1.
${pipeline_name_<level>}: Similar to the previous variable, each <level> contains a part of the path to the pipeline.yaml file. Consider the previous example, ${pipeline_name_0} would be data, ${pipeline_name_1} would be pipelines, and ${pipeline_name_2} equals to v1.
ATM fraud is a demo pipeline for ATM fraud detection. The original by Confluent is written in KSQL and outlined in this blogpost. The one used in this example is re-built from scratch using bakdata's streams-bootstrap library.
Completed all steps in the setup.
"}, {"location": "user/examples/atm-fraud-pipeline/#setup-and-deployment", "title": "Setup and deployment", "text": ""}, {"location": "user/examples/atm-fraud-pipeline/#postgresql", "title": "PostgreSQL", "text": "Deploy PostgreSQL using the Bitnami Helm chart: Add the helm repository:
helm repo add bitnami https://charts.bitnami.com/bitnami && \\\nhelm repo update\nInstall the PostgreSQL with helm:
helm upgrade --install -f ./postgresql.yaml \\\n--namespace kpops \\\npostgresql bitnami/postgresql\npostgresql.yaml) auth:\n database: app_db \n enablePostgresUser: true\n password: AppPassword\n postgresPassword: StrongPassword\n username: app1\nprimary:\n persistence:\n enabled: false\n existingClaim: postgresql-data-claim\nvolumePermissions:\n enabled: true\nBefore we deploy the pipeline, we need to forward the ports of kafka-rest-proxy and kafka-connect. Run the following commands in two different terminals.
kubectl port-forward --namespace kpops service/k8kafka-cp-rest 8082:8082\nkubectl port-forward --namespace kpops service/k8kafka-cp-kafka-connect 8083:8083\nExport environment variables in your terminal:
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nDeploy the pipeline
poetry run kpops deploy ./examples/bakdata/atm-fraud-detection/pipeline.yaml \\\n--pipeline-base-dir ./examples \\\n--config ./examples/bakdata/atm-fraud-detection/config.yaml \\\n--execute\nNote
You can use the --dry-run flag instead of the --execute flag and check the logs if your pipeline will be deployed correctly.
You can use the Streams Explorer to see the deployed pipeline. To do so, port-forward the service in a separate terminal session using the command below:
kubectl port-forward -n kpops service/streams-explorer 8080:8080\nAfter that open http://localhost:8080 in your browser. You should be able to see pipeline shown in the image below:
An overview of ATM fraud pipeline shown in Streams Explorer
Attention
Kafka Connect needs some time to set up the connector. Moreover, Streams Explorer needs a while to scrape the information from Kafka connect. Therefore, it might take a bit until you see the whole graph.
"}, {"location": "user/examples/atm-fraud-pipeline/#teardown-resources", "title": "Teardown resources", "text": ""}, {"location": "user/examples/atm-fraud-pipeline/#postrgresql", "title": "PostrgreSQL", "text": "PostgreSQL can be uninstalled by running the following command:
helm --namespace kpops uninstall postgresql\nExport environment variables in your terminal.
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nRemove the pipeline
poetry run kpops clean ./examples/bakdata/atm-fraud-detection/pipeline.yaml \\\n--pipeline-base-dir ./examples \\\n--config ./examples/bakdata/atm-fraud-detection/config.yaml \\\n--verbose \\\n--execute\nNote
You can use the --dry-run flag instead of the --execute flag and check the logs if your pipeline will be destroyed correctly.
Attention
If you face any issues destroying this example see Teardown for manual deletion.
"}, {"location": "user/examples/atm-fraud-pipeline/#common-errors", "title": "Common errors", "text": "deploy fails:clean.deploy --dry-run to avoid havig to clean again. If an error is dropped, start over from step 1.deploy.clean fails:clean.clean fails, follow the steps in teardown.Word-count is a demo pipeline consisting of a producer producing words to Kafka, a Kafka streams app counting the number of times each word occurs, and finally a Redis database into which the words are exported.
"}, {"location": "user/getting-started/quick-start/#what-this-will-demonstrate", "title": "What this will demonstrate", "text": "Completed all steps in the setup.
"}, {"location": "user/getting-started/quick-start/#setup-and-deployment", "title": "Setup and deployment", "text": ""}, {"location": "user/getting-started/quick-start/#redis", "title": "Redis", "text": "Deploy Redis using the Bitnami Helm chart: Add the Helm repository:
helm repo add bitnami https://charts.bitnami.com/bitnami && \\\nhelm repo update\nInstall Redis with Helm:
helm upgrade --install -f ./values-redis.yaml \\\n--namespace kpops \\\nredis bitnami/redis\nvalues-redis.yaml) architecture: standalone\nauth:\n enabled: false\nmaster:\n count: 1\n configuration: \"databases 1\"\nimage:\n tag: 7.0.8\nBefore we deploy the pipeline, we need to forward the ports of kafka-rest-proxy and kafka-connect. Run the following commands in two different terminals.
kubectl port-forward --namespace kpops service/k8kafka-cp-rest 8082:8082\nkubectl port-forward --namespace kpops service/k8kafka-cp-kafka-connect 8083:8083\nClone the kpops-examples repository and cd into the directory.
Install KPOps pip install -r requirements.txt.
Export environment variables in your terminal:
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nDeploy the pipeline
kpops deploy word-count/pipeline.yaml \\\n--defaults word-count/defaults.yaml \\\n--execute\nNote
You can use the --dry-run flag instead of the --execute flag and check the logs if your pipeline will be deployed correctly.
You can use the Streams Explorer to inspect the deployed pipeline. To do so, port-forward the service in a separate terminal session using the command below:
kubectl port-forward -n kpops service/streams-explorer 8080:8080\nAfter that open http://localhost:8080 in your browser.
You should be able to see pipeline shown in the image below:
An overview of Word-count pipeline shown in Streams Explorer
Attention
Kafka Connect needs some time to set up the connector. Moreover, Streams Explorer needs a while to scrape the information from Kafka Connect. Therefore, it might take a bit until you see the whole graph.
"}, {"location": "user/getting-started/quick-start/#teardown-resources", "title": "Teardown resources", "text": ""}, {"location": "user/getting-started/quick-start/#redis_1", "title": "Redis", "text": "Redis can be uninstalled by running the following command:
helm --namespace kpops uninstall redis\nExport environment variables in your terminal.
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nRemove the pipeline
kpops clean word-count/pipeline.yaml \\\n--defaults word-count/defaults.yaml \\\n--verbose \\\n--execute\nNote
You can use the --dry-run flag instead of the --execute flag and check the logs if your pipeline will be destroyed correctly.
Attention
If you face any issues destroying this example see Teardown for manual deletion.
"}, {"location": "user/getting-started/quick-start/#common-errors", "title": "Common errors", "text": "deploy fails:clean.deploy --dry-run to avoid having to clean again. If an error is dropped, start over from step 1.deploy.clean fails:clean.clean fails, follow the steps in teardown.In this part, you will set up KPOps. This includes:
If you don't have access to an existing Kubernetes cluster, this section will guide you through creating a local cluster. We recommend the lightweight Kubernetes distribution k3s for this. k3d is a wrapper around k3s in Docker that lets you get started fast.
You can install k3d with its installation script:
wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/v5.4.6/install.sh | bash\nFor other ways of installing k3d, you can have a look at their installation guide.
The Kafka deployment needs a modified Docker image. In that case the image is built and pushed to a Docker registry that holds it. If you do not have access to an existing Docker registry, you can use k3d's Docker registry:
k3d registry create kpops-registry.localhost --port 12345\nNow you can create a new cluster called kpops that uses the previously created Docker registry:
k3d cluster create kpops --k3s-arg \"--no-deploy=traefik@server:*\" --registry-use k3d-kpops-registry.localhost:12345\nNote
Creating a new k3d cluster automatically configures kubectl to connect to the local cluster by modifying your ~/.kube/config. In case you manually set the KUBECONFIG variable or don't want k3d to modify your config, k3d offers many other options.
You can check the cluster status with kubectl get pods -n kube-system. If all returned elements have a STATUS of Running or Completed, then the cluster is up and running.
Kafka is an open-source data streaming platform. More information about Kafka can be found in the documentation. To deploy Kafka, this guide uses Confluent's Helm chart.
To allow connectivity to other systems Kafka Connect needs to be extended with drivers. You can install a JDBC driver for Kafka Connect by creating a new Docker image:
Create a Dockerfile with the following content:
FROM confluentinc/cp-kafka-connect:7.1.3\n\nRUN confluent-hub install --no-prompt confluentinc/kafka-connect-jdbc:10.6.0\nBuild and push the modified image to your private Docker registry:
docker build . --tag localhost:12345/kafka-connect-jdbc:7.1.3 && \\\ndocker push localhost:12345/kafka-connect-jdbc:7.1.3\nDetailed instructions on building, tagging and pushing a docker image can be found in Docker docs.
Add Confluent's Helm chart repository and update the index:
helm repo add confluentinc https://confluentinc.github.io/cp-helm-charts/ && \nhelm repo update\nInstall Kafka, Zookeeper, Confluent's Schema Registry, Kafka Rest Proxy, and Kafka Connect. A single Helm chart installs all five components. Below you can find an example for the --values ./kafka.yaml file configuring the deployment accordingly. Deploy the services:
helm upgrade \\\n --install \\\n --version 0.6.1 \\\n --values ./kafka.yaml \\\n --namespace kpops \\\n --create-namespace \\\n --wait \\\n k8kafka confluentinc/cp-helm-charts\nkafka.yaml) An example value configuration for Confluent's Helm chart. This configuration deploys a single Kafka Broker, a Schema Registry, Zookeeper, Kafka Rest Proxy, and Kafka Connect with minimal resources.
cp-zookeeper:\n enabled: true\n servers: 1\n imageTag: 7.1.3\n heapOptions: \"-Xms124M -Xmx124M\"\n overrideGroupId: k8kafka\n fullnameOverride: \"k8kafka-cp-zookeeper\"\n resources:\n requests:\n cpu: 50m\n memory: 0.2G\n limits:\n cpu: 250m\n memory: 0.2G\n prometheus:\n jmx:\n enabled: false\n\ncp-kafka:\n enabled: true\n brokers: 1\n imageTag: 7.1.3\n podManagementPolicy: Parallel\n configurationOverrides:\n \"auto.create.topics.enable\": false\n \"offsets.topic.replication.factor\": 1\n \"transaction.state.log.replication.factor\": 1\n \"transaction.state.log.min.isr\": 1\n \"confluent.metrics.reporter.topic.replicas\": 1\n resources:\n requests:\n cpu: 50m\n memory: 0.5G\n limits:\n cpu: 250m\n memory: 0.5G\n prometheus:\n jmx:\n enabled: false\n persistence:\n enabled: false\n\ncp-schema-registry:\n enabled: true\n imageTag: 7.1.3\n fullnameOverride: \"k8kafka-cp-schema-registry\"\n overrideGroupId: k8kafka\n kafka:\n bootstrapServers: \"PLAINTEXT://k8kafka-cp-kafka-headless:9092\"\n resources:\n requests:\n cpu: 50m\n memory: 0.25G\n limits:\n cpu: 250m\n memory: 0.25G\n prometheus:\n jmx:\n enabled: false\n\ncp-kafka-connect:\n enabled: true\n replicaCount: 1\n image: k3d-kpops-registry.localhost:12345/kafka-connect-jdbc\n imageTag: 7.1.3\n fullnameOverride: \"k8kafka-cp-kafka-connect\"\n overrideGroupId: k8kafka\n kafka:\n bootstrapServers: \"PLAINTEXT://k8kafka-cp-kafka-headless:9092\"\n heapOptions: \"-Xms256M -Xmx256M\"\n resources:\n requests:\n cpu: 500m\n memory: 0.25G\n limits:\n cpu: 500m\n memory: 0.25G\n configurationOverrides:\n \"consumer.max.poll.records\": \"10\"\n \"consumer.max.poll.interval.ms\": \"900000\"\n \"config.storage.replication.factor\": \"1\"\n \"offset.storage.replication.factor\": \"1\"\n \"status.storage.replication.factor\": \"1\"\n cp-schema-registry:\n url: http://k8kafka-cp-schema-registry:8081\n prometheus:\n jmx:\n enabled: false\n\ncp-kafka-rest:\n enabled: true\n imageTag: 7.1.3\n fullnameOverride: \"k8kafka-cp-rest\"\n heapOptions: \"-Xms256M -Xmx256M\"\n resources:\n requests:\n cpu: 50m\n memory: 0.25G\n limits:\n cpu: 250m\n memory: 0.5G\n prometheus:\n jmx:\n enabled: false\n\ncp-ksql-server:\n enabled: false\ncp-control-center:\n enabled: false\nStreams Explorer allows examining Apache Kafka data pipelines in a Kubernetes cluster including the inspection of schemas and monitoring of metrics. First, add the Helm repository:
helm repo add streams-explorer https://bakdata.github.io/streams-explorer && \\\nhelm repo update\nBelow you can find an example for the --values ./streams-explorer.yaml file configuring the deployment accordingly. Now, deploy the service:
helm upgrade \\\n --install \\\n --version 0.2.3 \\\n --values ./streams-explorer.yaml \\\n --namespace kpops \\\n streams-explorer streams-explorer/streams-explorer\nstreams-explorer.yaml) An example value configuration for Steams Explorer Helm chart.
imageTag: \"v2.1.2\"\nconfig:\n K8S__deployment__cluster: true\n SCHEMAREGISTRY__url: http://k8kafka-cp-schema-registry.kpops.svc.cluster.local:8081\n KAFKACONNECT__url: http://k8kafka-cp-kafka-connect.kpops.svc.cluster.local:8083\nresources:\n requests:\n cpu: 200m\n memory: 300Mi\n limits:\n cpu: 200m\n memory: 300Mi\nNow we will check if all the pods are running in our namespace. You can list all pods in the namespace with this command:
kubectl --namespace kpops get pods\nThen you should see the following output in your terminal:
NAME READY STATUS RESTARTS AGE\nk8kafka-cp-kafka-connect-8fc7d544f-8pjnt 1/1 Running 0 15m\nk8kafka-cp-zookeeper-0 1/1 Running 0 15m\nk8kafka-cp-kafka-0 1/1 Running 0 15m\nk8kafka-cp-schema-registry-588f8c65db-jdwbq 1/1 Running 0 15m\nk8kafka-cp-rest-6bbfd7b645-nwkf8 1/1 Running 0 15m\nstreams-explorer-54db878c67-s8wbz 1/1 Running 0 15m\nPay attention to the STATUS row. The pods should have a status of Running.
KPOps comes as a PyPI package. You can install it with pip:
pip install kpops\ndestroy: Removes Kubernetes resources.reset: Runs destroy, resets the states of Kafka Streams apps and resets offsets to zero.clean: Runs reset and removes all Kafka resources.The kpops CLI can be used to destroy a pipeline that was previously deployed with KPOps. In case that doesn't work, the pipeline can always be taken down manually with helm (see section Infrastructure).
Export environment variables.
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nNavigate to the examples folder. Replace the <name-of-the-example-directory> with the example you want to tear down. For example the atm-fraud-detection.
Remove the pipeline
# Uncomment 1 line to either destroy, reset or clean.\n\n# poetry run kpops destroy <name-of-the-example-directory>/pipeline.yaml \\\n# poetry run kpops reset <name-of-the-example-directory>/pipeline.yaml \\\n# poetry run kpops clean <name-of-the-example-directory>/pipeline.yaml \\\n--config <name-of-the-example-directory>/config.yaml \\\n--execute\nDelete namespace:
kubectl delete namespace kpops\nNote
In case kpops destroy is not working one can uninstall the pipeline services one by one. This is equivalent to running kpops destroy. In case a clean uninstall (like the one kpops clean does) is needed, one needs to also delete the topics and schemas created by deployment of the pipeline.
Delete local cluster:
k3d cluster delete kpops\nDelete local registry:
k3d registry delete k3d-kpops-registry.localhost\nKPOps automatically infers the component type from the class name. Therefore, the type and schema_type attributes can be removed from your custom components. By convention the type would be the lower, and kebab cased name of the class.
class MyCoolStreamApp(StreamsApp):\n- type = \"my-cool-stream-app\"\n+ ...\nBecause of this new convention producer has been renamed to producer-app. This must be addressed in your pipeline.yaml and defaults.yaml.
- producer:\n+ producer-app:\n app:\n streams:\n outputTopic: output_topic\n extraOutputTopics:\n output_role1: output_topic1\n output_role2: output_topic2\nIn the to section these have changed:
outputrole is set, type is inferred to be extraerror needs to be defined explicitly to:\n topics:\n ${pipeline_name}-topic-1:\n- type: extra\n role: \"role-1\"\n ...\n ${pipeline_name}-topic-2:\n- type: output\n ...\n ${pipeline_name}-topic-3:\n type: error\n ...\nIn the from section these have changed:
inputinput-pattern type is replaced by patternrole is set, type is inferred to be extrarole is set, type is explicitly set to pattern, this would be inferred type extra-pattern from:\n topics:\n ${pipeline_name}-input-topic:\n- type: input\n ...\n ${pipeline_name}-extra-topic:\n- type: extra\n role: topic-role\n ...\n ${pipeline_name}-input-pattern-topic:\n- type: input-pattern\n+ type: pattern\n ...\n ${pipeline_name}-extra-pattern-topic:\n- type: extra-pattern\n+ type: pattern\n role: some-role\n ...\nAll the internal KPOps models are now snake_case, and only Helm/Kubernetes values require camel casing. You can find an example of a pipeline.yaml in the following. Notice that the app section here remains untouched.
...\ntype: streams-app\n name: streams-app\n namespace: namespace\n app:\n streams:\n brokers: ${brokers}\n schemaRegistryUrl: ${schema_registry_url}\n autoscaling:\n consumerGroup: consumer-group\n lagThreshold: 0\n enabled: false\n pollingInterval: 30\n\n to:\n topics:\n ${pipeline_name}-output-topic:\n type: error\n- keySchema: key-schema\n+ key_schema: key-schema\n- valueSchema: value-schema\n+ value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs:\n cleanup.policy: compact\n models:\n model: model\n prefix: ${pipeline_name}-\n- repoConfig:\n+ repo_config:\n- repositoryName: bakdata-streams-bootstrap\n+ repository_name: bakdata-streams-bootstrap\n url: https://bakdata.github.io/streams-bootstrap/\n- repoAuthFlags:\n+ repo_auth_flags:\n username: user\n password: pass\n ca_file: /home/user/path/to/ca-file\n insecure_skip_tls_verify: false\n version: \"1.0.4\"\n...\nIf you are using the KubernetesApp class to define your own Kubernetes resource to deploy, the abstract function get_helm_chart that returns the chart for deploying the app using Helm is now a Python property and renamed to helm_chart.
class MyCoolApp(KubernetesApp):\n\n+ @property\n @override\n- def get_helm_chart(self) -> str:\n+ def helm_chart(self) -> str:\n return \"./charts/charts-folder\"\nSince you can pass a comma separated string of broker address, the broker field in KPOps is now plural. The pluralization has affected multiple areas:
"}, {"location": "user/migration-guide/v1-v2/#configyaml", "title": "config.yaml", "text": " environment: development\n- broker: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n+ brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n kafka_connect_host: \"http://localhost:8083\"\n kafka_rest_host: \"http://localhost:8082\"\n schema_registry_url: \"http://localhost:8081\"\nThe variable is now called brokers.
...\n app:\n streams:\n- brokers: ${broker}\n+ brokers: ${brokers}\n schemaRegistryUrl: ${schema_registry_url}\n nameOverride: override-with-this-name\n imageTag: \"1.0.0\"\n...\nPreviously, if you set the environment variable KPOPS_KAFKA_BROKER, you need to replace that now with KPOPS_KAFKA_BROKERS.
Jump to the summary
"}, {"location": "user/migration-guide/v2-v3/#use-hash-and-trim-long-helm-release-names-instead-of-only-trimming", "title": "Use hash and trim long Helm release names instead of only trimming", "text": "KPOps handles long (more than 53 characters) Helm releases names differently. Helm will not find your (long) old release names anymore. Therefore, it is recommended that you should once destroy your pipeline with KPOps v2 to remove old Helm release names. After a clean destroy, re-deploy your pipeline with the KPOps v3.
For example if you have a component with the Helm release name example-component-name-too-long-fake-fakefakefakefakefake. The new release name will shorten the original name to 53 characters and then replace the last 6 characters of the trimmed name with the first 5 characters of the result of SHA-1(helm_release_name).
example-component-name-too-long-fake-fakefakef-0a7fc ----> 53 chars\n---------------------------------------------- -----\n ^Shortened helm_release_name ^first 5 characters of SHA1(helm_release_name)\nAll Helm-specific parts of the built-in KubernetesApp have been extracted to a new child component that is more appropriately named HelmApp. It has to be renamed in your existing pipeline defintions and custom components module.
-- type: kubernetes-app\n+- type: helm-app\n name: foo\n- from kpops.components import KubernetesApp\n+ from kpops.components import HelmApp\n\n\n- class CustomHelmApp(KubernetesApp):\n+ class CustomHelmApp(HelmApp):\n ...\nPreviously the default KafkaApp component configured the streams-bootstrap Helm Charts. Now, this component is no longer tied to Helm (or Kubernetes). Instead, there is a new StreamsBootstrap component that configures the Helm Chart repository for the components that use it, e.g. StreamsApp and ProducerApp. If you are using non-default values for the Helm Chart repository or version, it has to be updated as shown below.
kafka-app:\n app:\n streams: ...\n\n+ streams-bootstrap:\n repo_config: ...\n version: ...\nInternally, the Kafka Connector resetter is now its own standard HelmApp, removing a lot of the shared code. It is configured using the resetter_namespace (formerly namespace) and resetter_values attributes.
kafka-connector:\n- namespace: my-namespace\n+ resetter_namespace: my-namespace\nThe breaking changes target the config.yaml file:
The schema_registry_url is replaced with schema_registry.url (default http://localhost:8081) and schema_registry.enabled (default false).
kafka_rest_host is renamed to kafka_rest.url (default http://localhost:8082).
kafka_connect_host is replaced with kafka_connect.url (default http://localhost:8083).
brokers is renamed to kafka_brokers.
The environment variable names of these config fields changed respectively. Please refer to the environment variables documentation page to see the newest changes.
"}, {"location": "user/migration-guide/v2-v3/#configyaml", "title": "config.yaml", "text": " environment: development\n- brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n- kafka_rest_host: \"http://my-custom-rest.url:8082\"\n- kafka_connect_host: \"http://my-custom-connect.url:8083\"\n- schema_registry_url: \"http://my-custom-sr.url:8081\"\n+ kafka_brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n+ kafka_rest:\n+ url: \"http://my-custom-rest.url:8082\"\n+ kafka_connect:\n+ url: \"http://my-custom-connect.url:8083\"\n+ schema_registry:\n+ enabled: true\n+ url: \"http://my-custom-sr.url:8081\"\nThe variable is now called kafka_brokers.
...\n app:\n streams:\n- brokers: ${brokers}\n+ brokers: ${kafka_brokers}\n schemaRegistryUrl: ${schema_registry_url}\n nameOverride: override-with-this-name\n imageTag: \"1.0.0\"\n...\nWarning
The previous CLI parameters have been removed.
The options for a custom components_module and pipeline_base_dir are now global settings, defined in config.yaml.
kafka_brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n environment: development\n+ components_module: components\n+ pipeline_base_dir: pipelines\nThe location of the GitHub action has changed, and it's now available directly as bakdata/kpops.
You'll need to change it in your GitHub CI workflows.
steps:\n - name: kpops deploy\n- uses: bakdata/kpops/actions/kpops-runner@main\n+ uses: bakdata/kpops@main\n with:\n command: deploy --execute\n # ...\nSpecifying the environment is no longer mandatory. If not defined, only the global files will be used.
environment is no longer specified in config.yaml. Instead, it can be either set via the CLI flag --environment or with the environment variable KPOPS_ENVIRONMENT.
The --config flag in the CLI now points to the directory that contains config*.yaml files. The files to be used are resolved based on the provided (or not) environment.
- environment: development\n kafka_brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n schema_registry:\n enabled: true\n url: \"http://my-custom-sr.url:8081\"\n.", "text": "The delimiter in the substitution variables is changed to ..
steps:\n - type: scheduled-producer\n app:\n labels:\n- app_type: \"${component_type}\"\n- app_name: \"${component_name}\"\n- app_schedule: \"${component_app_schedule}\"\n+ app_type: \"${component.type}\"\n+ app_name: \"${component.name}\"\n+ app_schedule: \"${component.app.schedule}\"\ntopic_name_config:\n- default_error_topic_name: \"${pipeline_name}-${component_name}-dead-letter-topic\"\n- default_output_topic_name: \"${pipeline_name}-${component_name}-topic\"\n+ default_error_topic_name: \"${pipeline_name}-${component.name}-dead-letter-topic\"\n+ default_output_topic_name: \"${pipeline_name}-${component.name}-topic\"\nThe template method of every pipeline component has been renamed to manifest as it is no longer strictly tied to Helm template. Instead, it can be used to render the final resources of a component, such as Kubernetes manifests.
There is also a new kpops manifest command replacing the existing kpops generate --template flag.
If you're using this functionality in your custom components, it needs to be updated.
from kpops.components.base_components.models.resource import Resource\n\n @override\n- def template(self) -> None:\n+ def manifest(self) -> Resource:\n \"\"\"Render final component resources, e.g. Kubernetes manifests.\"\"\"\n return [] # list of manifests\nThe global configuration variables are now namespaced under the config key, such as ${config.kafka_brokers}, ${config.schema_registry.url}. Same with pipeline variables, e.g. ${pipeline_name} \u2192 ${pipeline.name}. This would make it more uniform with the existing ${component.<key>} variables.
name: kafka-app\n- prefix: ${pipeline_name}-\n+ prefix: ${pipeline.name}-\n app:\n streams:\n- brokers: ${kafka_brokers}\n- schemaRegistryUrl: ${schema_registry.url}\n+ brokers: ${config.kafka_brokers}\n+ schemaRegistryUrl: ${config.schema_registry.url}\nWarning
Helm will not find your (long) old release names anymore.
defaults.yaml kafka-app:\n app:\n streams: ...\n\n+ streams-bootstrap:\n repo_config: ...\n version: ...\n- - type: kubernetes-app\n+ - type: helm-app\n ...\n - type: kafka-app\n app:\n- brokers: ${brokers}\n+ brokers: ${config.kafka_brokers}\n labels:\n- app_schedule: \"${component_app_schedule}\"\n+ app_schedule: \"${component.app.schedule}\"\n ...\n - type: kafka-connector\n- namespace: my-namespace\n+ resetter_namespace: my-namespace\n ...\n- environment: development\n\n+ components_module: components\n\n+ pipeline_base_dir: pipelines\n\n- brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n+ kafka_brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n\n- kafka_rest_host: \"http://my-custom-rest.url:8082\"\n+ kafka_rest:\n+ url: \"http://my-custom-rest.url:8082\"\n\n- kafka_connect_host: \"http://my-custom-connect.url:8083\"\n+ kafka_connect:\n+ url: \"http://my-custom-connect.url:8083\"\n\n- schema_registry_url: \"http://my-custom-sr.url:8081\"\n+ schema_registry:\n+ enabled: true\n+ url: \"http://my-custom-sr.url:8081\"\n\n topic_name_config:\n- default_error_topic_name: \"${pipeline_name}-${component_name}-dead-letter-topic\"\n+ default_error_topic_name: \"${pipeline.name}-${component.name}-dead-letter-topic\"\n ...\n- from kpops.components import KubernetesApp\n+ from kpops.components import HelmApp\n+ from kpops.components.base_components.models.resource import Resource\n\n- class CustomHelmApp(KubernetesApp):\n+ class CustomHelmApp(HelmApp):\n\n @override\n- def template(self) -> None:\n+ def manifest(self) -> Resource:\n \"\"\"Render final component resources, e.g. Kubernetes manifests.\"\"\"\n return [] # list of manifests\n ...\n steps:\n - name: ...\n- uses: bakdata/kpops/actions/kpops-runner@main\n+ uses: bakdata/kpops@main\n ...\nUsage:
$ kpops [OPTIONS] COMMAND [ARGS]...\nOptions:
-V, --version: Print KPOps version--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.Commands:
clean: Clean pipeline stepsdeploy: Deploy pipeline stepsdestroy: Destroy pipeline stepsgenerate: Generate enriched pipeline representationmanifest: Render final resource representationreset: Reset pipeline stepsschema: Generate JSON schema.kpops clean", "text": "Clean pipeline steps
Usage:
$ kpops clean [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops deploy", "text": "Deploy pipeline steps
Usage:
$ kpops deploy [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops destroy", "text": "Destroy pipeline steps
Usage:
$ kpops destroy [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops generate", "text": "Enrich pipeline steps with defaults. The enriched pipeline is used for all KPOps operations (deploy, destroy, ...).
Usage:
$ kpops generate [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--output / --no-output: Enable output printing [default: output]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops manifest", "text": "In addition to generate, render final resource representation for each pipeline step, e.g. Kubernetes manifests.
Usage:
$ kpops manifest [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--output / --no-output: Enable output printing [default: output]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops reset", "text": "Reset pipeline steps
Usage:
$ kpops reset [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops schema", "text": "Generate JSON schema.
The schemas can be used to enable support for KPOps files in a text editor.
Usage:
$ kpops schema [OPTIONS] SCOPE:{pipeline|defaults|config}\nArguments:
SCOPE:{pipeline|defaults|config}: Scope of the generated schemapipeline: Schema of PipelineComponents. Includes the built-in KPOps components by default. To include custom components, provide components module in config.\n\nconfig: Schema of KpopsConfig. [required]\nOptions:
--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--include-stock-components / --no-include-stock-components: Include the built-in KPOps components. [default: include-stock-components]--help: Show this message and exit.KPOps provides JSON schemas that enable autocompletion and validation for all YAML files that the user must work with.
"}, {"location": "user/references/editor-integration/#supported-files", "title": "Supported files", "text": "pipeline.yamldefaults.yamlconfig.yamlsettings.json {\n \"yaml.schemas\": {\n \"https://bakdata.github.io/kpops/3.0/schema/pipeline.json\": [\n \"pipeline.yaml\",\n \"pipeline_*.yaml\"\n ],\n \"https://bakdata.github.io/kpops/3.0/schema/defaults.json\": [\n \"defaults.yaml\",\n \"defaults_*.yaml\"\n ],\n \"https://bakdata.github.io/kpops/3.0/schema/config.json\": [\n \"config.yaml\",\n \"config_*.yaml\"\n ]\n }\n}\nAdvanced usage
It is possible to generate schemas with the kpops schema command. Useful for including custom components or when using a pre-release version of KPOps.
We provided a GitHub composite action bakdata/kpops that installs and executes KPOps commands with the given parameters.
steps:\n # ...\n # This step is useful for debugging reasons\n - name: Generate Kafka pipeline\n uses: bakdata/kpops@main\n with:\n command: generate\n working-directory: home/my-kpops-root-dir\n pipeline: pipelines/my-pipeline-file.yaml\n kpops-version: 1.2.3\n\n # It is possible to use a pre-release KPOps version from TestPyPI https://test.pypi.org/project/kpops/#history\n - name: Deploy Kafka pipeline\n uses: bakdata/kpops@main\n with:\n command: deploy --execute\n working-directory: home/my-kpops-root-dir\n pipeline: pipelines/my-pipeline-file.yaml\n kpops-version: 1.2.5.dev20230707132709\n # ...\nAuto generation happens mostly with pre-commit hooks. You can find the pre-commit configuration here. These pre-commit hooks call different Python scripts to auto generate code for the documentation.
cli_env_vars.env -- All CLI environment variables in a dotenv file.cli_env_vars.md -- All CLI environment variables in a table.config_env_vars.env -- Almost all pipeline config environment variables in a dotenv file. The script checks for each field in KpopsConfig whether it has an env attribute defined. The script is currently unable to visit the classes of fields like topic_name_config, hence any environment variables defined there would remain unknown to it.config_env_vars.env -- Almost all pipeline config environment variables in a table.variable_substitution.yaml -- A copy of ./tests/pipeline/resources/component-type-substitution/pipeline.yaml used as an example of substitution.Generated by typer-cli from the code in main.py. It is called with Python's subprocess module.
Generates example pipeline.yaml and defaults.yaml for each individual component, stores them and also concatenates them into 1 big pipeline definition and 1 big pipeline defaults definition.
User input
headers/*\\.yaml -- The top of each example. Includes a description comment, type and name. The headers for pipeline.yaml reside in the pipeline-components dir and the defaults.yaml headers reside in the pipeline-defaults dir. The names of the files must be equal to the respective component type.sections/*\\.yaml -- Each YAML file contains a single section (component attribute) definition. The intention is to keep the minimal set of definitions there from which any component definition can be built. The names of the files must be equal to the respective component type and the attribute name. The sections are used for both defaults.yaml and pipeline.yaml generation and reside in the pipeline-components dir.Generated
pipeline-components/dependencies/* Cached information about KPOps componentspipeline_component_dependencies.yaml -- Specifies per component which files in the sections dir should be used for the pipeline.yaml generation.defaults_pipeline_component_dependencies.yaml -- Specifies per component which files in the sections dir should be used for the defaults.yaml generation.kpops_structure.yaml -- Specifies the inheritance hierarchy of the components and what sections exist in each component.pipeline-components/*\\.yaml -- All single-component pipeline definitions and one big (complete) pipeline.yaml that contains all of them.pipeline-defaults/*\\.yaml -- All single-component defaults definitions and one big (complete) defaults.yaml that contains all of them.Welcome! We are glad to have you visit our contributing guide!
If you find any bugs or have suggestions for improvements, please open an issue and optionally a pull request (PR). In the case of a PR, we would appreciate it if you preface it with an issue outlining your goal and means of achieving it.
"}, {"location": "developer/contributing/#style", "title": "Style", "text": "We advise that you stick to our pre-commit hooks for code linting, formatting, and auto-generation of documentation. After you install them using poetry run pre-commit install they're triggered automatically during git commit. Additionally, you can manually invoke them with poetry run pre-commit run -a. In order for dprint to work, you have to manually install it locally. It will work in the CI, so it is also possible to manually carry out formatting changes flagged by dprint in the CI and skip installing it locally.
To ensure a consistent Python code style, we use Ruff for both linting and formatting. The official docs contain a guide on editor integration.
Our configuration can be found in KPOps' top-level pyproject.toml.
To ensure a consistent markdown style, we use dprint's Markdown code formatter. Our configuration can be found here.
"}, {"location": "developer/contributing/#css", "title": "CSS", "text": "To ensure a consistent CSS style, we use the malva dprint's plugin. Our configuration can be found here.
"}, {"location": "developer/contributing/#toml", "title": "TOML", "text": "To ensure a consistent TOML style, we use dprint's TOML code formatter. Our configuration can be found here.
"}, {"location": "developer/getting-started/", "title": "Getting started", "text": "Welcome! We are glad to have you visit our developer guide! If you find any bugs or have suggestions for improvements, please open an issue and optionally a pull request (PR). In the case of a PR, we would appreciate it if you preface it with an issue outlining your goal and means of achieving it.
Find more about our code-style or insights into KPOps' code base here in our developer guide.
Work in progress
The developer guide is still under construction. If you have a question left unanswered here, feel free to ask it by opening an issue.
"}, {"location": "user/changelog/", "title": "Changelog", "text": ""}, {"location": "user/changelog/#300-release-date-2024-01-17", "title": "3.0.0 - Release Date: [2024-01-17]", "text": ""}, {"location": "user/changelog/#breaking-changes", "title": "\ud83c\udfd7\ufe0f Breaking changes", "text": "Move GitHub action to repository root - #356
Make Kafka REST Proxy & Kafka Connect hosts default and improve Schema Registry config - #354
Create HelmApp component - #370
Change substitution variables separator to . - #388
Refactor pipeline generator & representation - #392
Define custom components module & pipeline base dir globally - #387
Use hash and trim long Helm release names instead of only trimming - #390
Refactor generate template for Python API usage - #380
Namespace substitution vars - #408
Refactor streams-bootstrap cleanup jobs as individual HelmApp - #398
Refactor Kafka Connector resetter as individual HelmApp - #400
Fix wrong Helm release name character limit - #418
Allow overriding config files - #391
Generate defaults schema - #402
Fix missing component type in pipeline schema - #401
Fix enrichment of nested Pydantic BaseModel - #415
Fix wrong Helm release name character limit - #418
Update release workflow template to support custom changelog file path - #421
Make Kafka REST Proxy & Kafka Connect hosts default and improve Schema Registry config - #354
Migrate to Pydantic v2 - #347
Refactor pipeline generator & representation - #392
Use hash and trim long Helm release names instead of only trimming - #390
Refactor Helm nameOverride - #397
Mark component type as computed Pydantic field - #399
Refactor generate template for Python API usage - #380
Support multiple inheritance for doc generation - #406
Refactor streams-bootstrap cleanup jobs as individual HelmApp - #398
Refactor Kafka Connector resetter as individual HelmApp - #400
Move GitHub action to repository root - #356
Create HelmApp component - #370
Update docs for substitution variable usage in v3 - #409
Support multiple inheritance for doc generation - #406
Update docs for v3 - #416
Update tests resources - #417
Summarize all breaking changes in diffs at the top of the migration guide - #419
Replace black with ruff - #365
Add toml formatter to dprint - #386
Add malva to dprint - #385
Update KPOps runner with the new options - #395
Fix KPOps action to get package from testPyPI - #396
KPOps 3.0 - #420
Fix early exit upon Helm exit code 1 - #376
Fix docs setup page list indentation - #377
Migrate deprecated mkdocs-material-extensions - #378
Fix docs setup page list indentation - #377
Exclude resources from docs search - #371
Fix environment variables documentation generation - #362
Introduce ruff - #363
Print details on connector name mismatch error - #369
Enable transparent OS environment lookups from internal environment - #368
Refactor component prefix & name - #326
Remove unnecessary condition during inflate - #328
--template flag is set - #350Add dprint as the markdown formatter - #337
Publish pre-release docs for PRs & main branch - #339
Align docs colours - #345
Add version dropdown to the documentation - #336
Break the documentation down into smaller subsection - #329
Remove camel case conversion of internal models - #308
Derive component type automatically from class name - #309
Refactor input/output types - #232
v2 - #321
Automatically support schema generation for custom components - #307
Derive component type automatically from class name - #309
Add KPOps Runner GitHub Action to the documentation - #325
Remove :type and :rtype from docstrings - #324
Modularize and autogenerate examples for the documentation - #267
Update the variable documentation - #266
--set-file flag - #311Refactor Helm wrapper and add --set-file flag - #311
Set default for ToSection topics - #313
Annotate types for ToSection models mapping - #315
Order PipelineComponent fields - #290
Migrate requests to httpx - #302
Refactor CLI using dtyper - #306
Update Black - #294
Fix vulnerability in mkdocs-material - #295
Move breaking changes section upper in the change log config - #287
Update codeowners - #281
Reactivate Windows CI - #255
Downgrade Poetry version on the Windows CI pipeline - #286
Set ANSI theme for output of kpops generate - #289
Create workflow to lint CI - #260
Fix update docs when releasing - #261
Rename change log message for uncategorized issues - #262
helm repo update <repo-name> for Helm >3.7 - #239add --namespace option to Helm template command - #237
Add missing type annotation for Pydantic attributes - #238
Fix helm version check - #242
Fix Helm Version Check - #244
Fix import from external module - #256
Remove enable option from helm diff - #235
Refactor variable substitution - #198
Add background to docs home page - #236
Update Poetry version in CI - #247
Add pip cache in KPOps runner action - #249
Check types using Pyright - #251
Remove MyPy - #252
Disable broken Windows CI temporarily - #253
Update release and publish workflows - #254
Fix release & publish workflows - #257
With a couple of easy commands in the shell, and a pipeline.yaml of under 30 lines, KPOps can not only deploy a Kafka pipeline1 to a Kubernetes cluster, but also reset, clean or destroy it!
- type: producer-app\n name: data-producer\n app:\n image: bakdata/kpops-demo-sentence-producer\n\n- type: streams-app\n name: word-counter\n to:\n topics:\n ${output_topic_name}:\n type: output\n configs:\n cleanup.policy: compact\n app:\n image: bakdata/kpops-demo-word-count-app\n replicaCount: 1\n\n- type: kafka-sink-connector\n name: redis-sink-connector\n app:\n connector.class: com.github.jcustenborder.kafka.connect.redis.RedisSinkConnector\n redis.hosts: redis-headless:6379\n redis.database: 0\n tasks.max: 1\n key.converter: org.apache.kafka.connect.storage.StringConverter\n value.converter: org.apache.kafka.connect.storage.StringConverter\nA Kafka pipeline can consist of consecutive streaming applications, producers, and connectors.\u00a0\u21a9
KPOps reads its global configuration that is unrelated to a pipeline's components from config.yaml.
Consider enabling KPOps' editor integration feature to enjoy the benefits of autocompletion and validation when configuring your pipeline.
To learn about any of the available settings, take a look at the example below.
config.yaml # CONFIGURATION\n#\n# The path to the folder containing the defaults.yaml file and the environment\n# defaults files.\ndefaults_path: .\n# Custom Python module defining project-specific KPOps components\ncomponents_module: null\n# Base directory to the pipelines (default is current working directory)\npipeline_base_dir: .\n# The Kafka brokers address.\n# REQUIRED\nkafka_brokers: \"http://broker1:9092,http://broker2:9092\"\n# The name of the defaults file and the prefix of the defaults environment file.\ndefaults_filename_prefix: defaults\n# Configure the topic name variables you can use in the pipeline definition.\ntopic_name_config: \n # Configures the value for the variable ${output_topic_name}\n default_output_topic_name: ${pipeline.name}-${component.name}\n # Configures the value for the variable ${error_topic_name}\n default_error_topic_name: ${pipeline.name}-${component.name}-error\n# Configuration for Schema Registry.\nschema_registry:\n # Whether the Schema Registry handler should be initialized.\n enabled: false\n # Address of the Schema Registry.\n url: \"http://localhost:8081\"\n# Configuration for the Kafka REST Proxy.\nkafka_rest:\n # Address of the Kafka REST Proxy.\n url: \"http://localhost:8082\"\n# Configuration for Kafka Connect.\nkafka_connect:\n # Address of Kafka Connect.\n url: \"http://localhost:8083\"\n# The timeout in seconds that specifies when actions like deletion or deploy\n# timeout.\ntimeout: 300\n# Flag for `helm upgrade --install`.\n# Create the release namespace if not present.\ncreate_namespace: false\n# Global flags for Helm.\nhelm_config:\n # Name of kubeconfig context (`--kube-context`)\n context: name\n # Run Helm in Debug mode.\n debug: false\n # Kubernetes API version used for Capabilities.APIVersions\n api_version: null\n# Configure Helm Diff.\nhelm_diff_config: \n # Set of keys that should not be checked.\n ignore:\n - name\n - imageTag\n# Whether to retain clean up jobs in the cluster or uninstall the, after\n# completion.\nretain_clean_jobs: false\nEnvironment-specific pipeline definitions
Similarly to defaults, it is possible to have an unlimited amount of additional environment-specific pipeline definitions. The naming convention is the same: add a suffix of the form _{environment} to the filename.
KPOps has a very efficient way of dealing with repeating settings which manifests as defaults.yaml. This file provides the user with the power to set defaults for any and all components, thus omitting the need to repeat the same settings in pipeline.yaml.
See real-world examples for defaults.
An important mechanic of KPOps is that defaults set for a component apply to all components that inherit from it.
It is possible, although not recommended, to add settings that are specific to a component's subclass. An example would be configuring offset_topic under kafka-connector instead of kafka-source-connector.
It is possible to set specific defaults for each environment by adding files called defaults_{environment}.yaml to the defaults folder at defaults_path. The defaults are loaded based on the currently set environment.
It is important to note that defaults_{environment}.yaml overrides only the settings that are explicitly set to be different from the ones in the base defaults file.
Tip
defaults is the default value of defaults_filename_prefix. Together with defaults_path and environment it can be changed in config.yaml
The defaults codeblocks in this section contain the full set of settings that are specific to the component. If a setting already exists in a parent config, it will not be included in the child's.
defaults.yaml # Base Kubernetes App\n#\n# Parent of: HelmApp\n# Child of: PipelineComponent\nkubernetes-app:\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example.\n app: # required\n image: exampleImage # Example\n debug: false # Example\n commandLine: {} # Example\ndefaults.yaml # Base component for Kafka-based components.\n#\n# Parent of: ProducerApp, StreamsApp\n# Child of: KubernetesApp\nkafka-app:\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` can contain application-specific settings, hence the user is free to\n # add the key-value pairs they need.\n app: # required\n streams: # required\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n nameOverride: override-with-this-name # kafka-app-specific\n imageTag: \"1.0.0\" # Example values that are shared between streams-app and producer-app\ndefaults.yaml # StreamsApp component that configures a streams bootstrap app.\n#\n# Child of: KafkaApp\n# More documentation on StreamsApp: https://github.com/bakdata/streams-bootstrap\nstreams-app:\n # No arbitrary keys are allowed under `app`here\n # Allowed configs:\n # https://github.com/bakdata/streams-bootstrap/tree/master/charts/streams-app\n app: # required\n # Streams Bootstrap streams section\n streams: # required, streams-app-specific\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n inputTopics:\n - topic1\n - topic2\n outputTopic: output-topic\n inputPattern: input-pattern\n extraInputTopics:\n input_role1:\n - input_topic1\n - input_topic2\n input_role2:\n - input_topic3\n - input_topic4\n extraInputPatterns:\n pattern_role1: input_pattern1\n extraOutputTopics:\n output_role1: output_topic1\n output_role2: output_topic2\n errorTopic: error-topic\n config:\n my.streams.config: my.value\n nameOverride: override-with-this-name # streams-app-specific\n autoscaling: # streams-app-specific\n consumerGroup: consumer-group # required\n lagThreshold: 0 # Average target value to trigger scaling actions.\n enabled: false # Whether to enable auto-scaling using KEDA.\n # This is the interval to check each trigger on.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#pollinginterval\n pollingInterval: 30\n # The period to wait after the last trigger reported active before scaling\n # the resource back to 0. https://keda.sh/docs/2.9/concepts/scaling-deployments/#cooldownperiod\n cooldownPeriod: 300\n # The offset reset policy for the consumer if the the consumer group is\n # not yet subscribed to a partition.\n offsetResetPolicy: earliest\n # This setting is passed to the HPA definition that KEDA will create for a\n # given resource and holds the maximum number of replicas of the target resouce.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#maxreplicacount\n maxReplicas: 1\n # Minimum number of replicas KEDA will scale the resource down to.\n # https://keda.sh/docs/2.7/concepts/scaling-deployments/#minreplicacount\n minReplicas: 0\n # If this property is set, KEDA will scale the resource down to this\n # number of replicas.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#idlereplicacount\n idleReplicas: 0\n topics: # List of auto-generated Kafka Streams topics used by the streams app.\n - topic1\n - topic2\ndefaults.yaml \ndefaults.yaml # Kafka connector\n#\n# Parent of: KafkaSinkConnector, KafkaSourceConnector\n# Child of: PipelineComponent\nkafka-connector:\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example. Extensive documentation on\n # connectors: https://kafka.apache.org/documentation/#connectconfigs\n app: # required\n tasks.max: 1\n # Overriding Kafka Connect Resetter Helm values. E.g. to override the\n # Image Tag etc.\n resetter_values:\n imageTag: \"1.2.3\"\ndefaults.yaml # Kafka source connector\n#\n# Child of: KafkaConnector\nkafka-source-connector:\n # The source connector has no `from` section\n # from:\n # offset.storage.topic\n # https://kafka.apache.org/documentation/#connect_running\n offset_topic: offset_topic\ndefaults.yaml # Kafka sink connector\n#\n# Child of: KafkaConnector\nkafka-sink-connector:\n # No settings differ from `kafka-connector`\nCan be used to deploy any app in Kubernetes using Helm, for example, a REST service that serves Kafka data.
"}, {"location": "user/core-concepts/components/helm-app/#configuration", "title": "Configuration", "text": "pipeline.yaml # Kubernetes app managed through Helm with an associated Helm chart\n- type: helm-app\n name: helm-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example.\n app: # required\n image: exampleImage # Example\n debug: false # Example\n commandLine: {} # Example\n # Helm repository configuration (optional)\n # If not set the helm repo add will not be called. Useful when using local Helm charts\n repo_config:\n repository_name: bakdata-streams-bootstrap # required\n url: https://bakdata.github.io/streams-bootstrap/ # required\n repo_auth_flags:\n username: user\n password: pass\n ca_file: /home/user/path/to/ca-file\n insecure_skip_tls_verify: false\n version: \"1.0.0\" # Helm chart version\nDeploy using Helm.
"}, {"location": "user/core-concepts/components/helm-app/#destroy", "title": "destroy", "text": "Uninstall Helm release.
"}, {"location": "user/core-concepts/components/helm-app/#reset", "title": "reset", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/helm-app/#clean", "title": "clean", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kafka-app/", "title": "KafkaApp", "text": "Subclass of HelmApp.
"}, {"location": "user/core-concepts/components/kafka-app/#usage", "title": "Usage", "text": "pipeline.yaml as the component can be defined as either a StreamsApp or a ProducerAppdefaults.yamlpipeline.yaml # Base component for Kafka-based components.\n# Producer or streaming apps should inherit from this class.\n- type: kafka-app # required\n name: kafka-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` can contain application-specific settings, hence the user is free to\n # add the key-value pairs they need.\n app: # required\n streams: # required\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n nameOverride: override-with-this-name # kafka-app-specific\n imageTag: \"1.0.0\" # Example values that are shared between streams-app and producer-app\nIn addition to HelmApp's deploy:
Uninstall Helm release.
"}, {"location": "user/core-concepts/components/kafka-app/#reset", "title": "reset", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kafka-app/#clean", "title": "clean", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kafka-connector/", "title": "KafkaConnector", "text": "KafkaConnector is a component that deploys Kafka Connectors. Since a connector cannot be different from sink or source it is not recommended to use KafkaConnector for deployment in pipeline.yaml. Instead, KafkaConnector should be used in defaults.yaml to set defaults for all connectors in the pipeline as they can share some common settings.
Subclass of KafkaConnector.
"}, {"location": "user/core-concepts/components/kafka-sink-connector/#usage", "title": "Usage", "text": "Lets other systems pull data from Apache Kafka.
"}, {"location": "user/core-concepts/components/kafka-sink-connector/#configuration", "title": "Configuration", "text": "pipeline.yaml # Kafka sink connector\n- type: kafka-sink-connector\n name: kafka-sink-connector # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example. Extensive documentation on\n # connectors: https://kafka.apache.org/documentation/#connectconfigs\n app: # required\n tasks.max: 1\n # Overriding Kafka Connect Resetter Helm values. E.g. to override the\n # Image Tag etc.\n resetter_values:\n imageTag: \"1.2.3\"\nThe associated sink connector is removed from the Kafka Connect cluster.
"}, {"location": "user/core-concepts/components/kafka-sink-connector/#reset", "title": "reset", "text": "Reset the consumer group offsets using bakdata's sink resetter.
"}, {"location": "user/core-concepts/components/kafka-sink-connector/#clean", "title": "clean", "text": "Subclass of KafkaConnector.
"}, {"location": "user/core-concepts/components/kafka-source-connector/#usage", "title": "Usage", "text": "Manages source connectors in your Kafka Connect cluster.
"}, {"location": "user/core-concepts/components/kafka-source-connector/#configuration", "title": "Configuration", "text": "pipeline.yaml # Kafka source connector\n- type: kafka-source-connector # required\n name: kafka-source-connector # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n # The source connector has no `from` section\n # from:\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example. Extensive documentation on\n # connectors: https://kafka.apache.org/documentation/#connectconfigs\n app: # required\n tasks.max: 1\n # Overriding Kafka Connect Resetter Helm values. E.g. to override the\n # Image Tag etc.\n resetter_values:\n imageTag: \"1.2.3\"\n # offset.storage.topic\n # https://kafka.apache.org/documentation/#connect_running\n offset_topic: offset_topic\nRemove the source connector from the Kafka Connect cluster.
"}, {"location": "user/core-concepts/components/kafka-source-connector/#reset", "title": "reset", "text": "Delete state associated with the connector using bakdata's sink resetter.
"}, {"location": "user/core-concepts/components/kafka-source-connector/#clean", "title": "clean", "text": "Can be used to create components for any Kubernetes app.
"}, {"location": "user/core-concepts/components/kubernetes-app/#configuration", "title": "Configuration", "text": "pipeline.yaml # Base Kubernetes App\n- type: kubernetes-app\n name: kubernetes-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # `app` contains application-specific settings, hence it does not have a rigid\n # structure. The fields below are just an example.\n app: # required\n image: exampleImage # Example\n debug: false # Example\n commandLine: {} # Example\nDo nothing.
"}, {"location": "user/core-concepts/components/kubernetes-app/#destroy", "title": "destroy", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kubernetes-app/#reset", "title": "reset", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/kubernetes-app/#clean", "title": "clean", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/overview/", "title": "Overview", "text": "This section explains the different components of KPOps, their usage and configuration in the pipeline definition pipeline.yaml.
flowchart BT\n KubernetesApp --> PipelineComponent\n KafkaApp --> PipelineComponent\n HelmApp --> KubernetesApp\n StreamsBootstrap --> HelmApp\n StreamsApp --> KafkaApp\n StreamsApp --> StreamsBootstrap\n ProducerApp --> KafkaApp\n ProducerApp --> StreamsBootstrap\n KafkaConnector --> PipelineComponent\n KafkaSourceConnector --> KafkaConnector\n KafkaSinkConnector --> KafkaConnector\n\n click KubernetesApp \"/kpops/user/core-concepts/components/kubernetes-app\"\n click HelmApp \"/kpops/user/core-concepts/components/helm-app\"\n click KafkaApp \"/kpops/user/core-concepts/components/kafka-app\"\n click StreamsBootstrap \"/kpops/user/core-concepts/components/streams-bootstrap\"\n click StreamsApp \"/kpops/user/core-concepts/components/streams-app\"\n click ProducerApp \"/kpops/user/core-concepts/components/producer-app\"\n click KafkaConnector \"/kpops/user/core-concepts/components/kafka-connector\"\n click KafkaSourceConnector \"/kpops/user/core-concepts/components/kafka-source-connector\"\n click KafkaSinkConnector \"/kpops/user/core-concepts/components/kafka-sink-connector\"KPOps component hierarchy
"}, {"location": "user/core-concepts/components/producer-app/", "title": "ProducerApp", "text": "Subclass of KafkaApp and StreamsBootstrap.
"}, {"location": "user/core-concepts/components/producer-app/#usage", "title": "Usage", "text": "Configures a streams-bootstrap Kafka producer app
"}, {"location": "user/core-concepts/components/producer-app/#configuration", "title": "Configuration", "text": "pipeline.yaml # Holds configuration to use as values for the streams bootstrap producer-app Helm\n# chart.\n# More documentation on ProducerApp:\n# https://github.com/bakdata/streams-bootstrap\n- type: producer-app\n name: producer-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n # from: # While the producer-app does inherit from kafka-app, it does not need a\n # `from` section, hence it does not support it.\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # Allowed configs:\n # https://github.com/bakdata/streams-bootstrap/tree/master/charts/producer-app\n app: # required\n streams: # required, producer-app-specific\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n outputTopic: output_topic\n extraOutputTopics:\n output_role1: output_topic1\n output_role2: output_topic2\n nameOverride: override-with-this-name # kafka-app-specific\n # Helm repository configuration (optional)\n # If not set the helm repo add will not be called. Useful when using local Helm charts\n repo_config:\n repository_name: bakdata-streams-bootstrap # required\n url: https://bakdata.github.io/streams-bootstrap/ # required\n repo_auth_flags:\n username: user\n password: pass\n ca_file: /home/user/path/to/ca-file\n insecure_skip_tls_verify: false\n version: \"2.12.0\" # Helm chart version\nIn addition to KubernetesApp's deploy:
Uninstall Helm release.
"}, {"location": "user/core-concepts/components/producer-app/#reset", "title": "reset", "text": "Do nothing, producers are stateless.
"}, {"location": "user/core-concepts/components/producer-app/#clean", "title": "clean", "text": "Subclass of KafkaApp and StreamsBootstrap.
"}, {"location": "user/core-concepts/components/streams-app/#usage", "title": "Usage", "text": "Configures a streams-bootstrap Kafka Streams app
"}, {"location": "user/core-concepts/components/streams-app/#configuration", "title": "Configuration", "text": "pipeline.yaml # StreamsApp component that configures a streams bootstrap app.\n# More documentation on StreamsApp: https://github.com/bakdata/streams-bootstrap\n- type: streams-app # required\n name: streams-app # required\n # Pipeline prefix that will prefix every component name. If you wish to not\n # have any prefix you can specify an empty string.\n prefix: ${pipeline.name}-\n from: # Must not be null\n topics: # read from topic\n ${pipeline.name}-input-topic:\n type: input # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra\n ${pipeline.name}-input-pattern-topic:\n type: pattern # Implied to be an input pattern if `role` is undefined\n ${pipeline.name}-extra-pattern-topic:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n components: # read from specific component\n account-producer:\n type: output # Implied when role is NOT specified\n other-producer:\n role: some-role # Implies `type` to be extra\n component-as-input-pattern:\n type: pattern # Implied to be an input pattern if `role` is undefined\n component-as-extra-pattern:\n type: pattern # Implied to be an extra pattern if `role` is defined\n role: some-role\n # Topic(s) into which the component will write output\n to:\n topics:\n ${pipeline.name}-output-topic:\n type: output # Implied when role is NOT specified\n ${pipeline.name}-extra-topic:\n role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined\n ${pipeline.name}-error-topic:\n type: error\n # Currently KPOps supports Avro and JSON schemas.\n key_schema: key-schema # must implement SchemaProvider to use\n value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs: # https://kafka.apache.org/documentation/#topicconfigs\n cleanup.policy: compact\n models: # SchemaProvider is initiated with the values given here\n model: model\n namespace: namespace # required\n # No arbitrary keys are allowed under `app`here\n # Allowed configs:\n # https://github.com/bakdata/streams-bootstrap/tree/master/charts/streams-app\n app: # required\n # Streams Bootstrap streams section\n streams: # required, streams-app-specific\n brokers: ${config.kafka_brokers} # required\n schemaRegistryUrl: ${config.schema_registry.url}\n inputTopics:\n - topic1\n - topic2\n outputTopic: output-topic\n inputPattern: input-pattern\n extraInputTopics:\n input_role1:\n - input_topic1\n - input_topic2\n input_role2:\n - input_topic3\n - input_topic4\n extraInputPatterns:\n pattern_role1: input_pattern1\n extraOutputTopics:\n output_role1: output_topic1\n output_role2: output_topic2\n errorTopic: error-topic\n config:\n my.streams.config: my.value\n nameOverride: override-with-this-name # streams-app-specific\n autoscaling: # streams-app-specific\n consumerGroup: consumer-group # required\n lagThreshold: 0 # Average target value to trigger scaling actions.\n enabled: false # Whether to enable auto-scaling using KEDA.\n # This is the interval to check each trigger on.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#pollinginterval\n pollingInterval: 30\n # The period to wait after the last trigger reported active before scaling\n # the resource back to 0. https://keda.sh/docs/2.9/concepts/scaling-deployments/#cooldownperiod\n cooldownPeriod: 300\n # The offset reset policy for the consumer if the the consumer group is\n # not yet subscribed to a partition.\n offsetResetPolicy: earliest\n # This setting is passed to the HPA definition that KEDA will create for a\n # given resource and holds the maximum number of replicas of the target resouce.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#maxreplicacount\n maxReplicas: 1\n # Minimum number of replicas KEDA will scale the resource down to.\n # https://keda.sh/docs/2.7/concepts/scaling-deployments/#minreplicacount\n minReplicas: 0\n # If this property is set, KEDA will scale the resource down to this\n # number of replicas.\n # https://keda.sh/docs/2.9/concepts/scaling-deployments/#idlereplicacount\n idleReplicas: 0\n topics: # List of auto-generated Kafka Streams topics used by the streams app.\n - topic1\n - topic2\n # Helm repository configuration (optional)\n # If not set the helm repo add will not be called. Useful when using local Helm charts\n repo_config:\n repository_name: bakdata-streams-bootstrap # required\n url: https://bakdata.github.io/streams-bootstrap/ # required\n repo_auth_flags:\n username: user\n password: pass\n ca_file: /home/user/path/to/ca-file\n insecure_skip_tls_verify: false\n version: \"2.12.0\" # Helm chart version\nIn addition to KubernetesApp's deploy:
Uninstall Helm release.
"}, {"location": "user/core-concepts/components/streams-app/#reset", "title": "reset", "text": "Similar to reset with to additional steps:
Subclass of HelmApp.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#usage", "title": "Usage", "text": "Configures a Helm app with streams-bootstrap Helm charts.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#operations", "title": "Operations", "text": ""}, {"location": "user/core-concepts/components/streams-bootstrap/#deploy", "title": "deploy", "text": "Deploy using Helm.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#destroy", "title": "destroy", "text": "Uninstall Helm release.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#reset", "title": "reset", "text": "Do nothing.
"}, {"location": "user/core-concepts/components/streams-bootstrap/#clean", "title": "clean", "text": "Do nothing.
"}, {"location": "user/core-concepts/variables/environment_variables/", "title": "Environment variables", "text": "Environment variables can be set by using the export command in Linux or the set command in Windows.
dotenv files
KPOps currently supports .env files only for variables related to the config. Full support for .env files is on the roadmap. One of the possible ways to use one and export the contents manually is with the following command: export $(xargs < .env). This would work in bash suppose there are no spaces inside the values.
These variables are a lower priority alternative to the settings in config.yaml. Variables marked as required can instead be set in the global config.
config.yaml defaults_path KPOPS_COMPONENTS_MODULE False Custom Python module defining project-specific KPOps components components_module KPOPS_PIPELINE_BASE_DIR . False Base directory to the pipelines (default is current working directory) pipeline_base_dir KPOPS_KAFKA_BROKERS True The comma separated Kafka brokers address. kafka_brokers KPOPS_DEFAULTS_FILENAME_PREFIX defaults False The name of the defaults file and the prefix of the defaults environment file. defaults_filename_prefix KPOPS_TOPIC_NAME_CONFIG__DEFAULT_OUTPUT_TOPIC_NAME ${pipeline.name}-${component.name} False Configures the value for the variable ${output_topic_name} topic_name_config.default_output_topic_name KPOPS_TOPIC_NAME_CONFIG__DEFAULT_ERROR_TOPIC_NAME ${pipeline.name}-${component.name}-error False Configures the value for the variable ${error_topic_name} topic_name_config.default_error_topic_name KPOPS_SCHEMA_REGISTRY__ENABLED False False Whether the Schema Registry handler should be initialized. schema_registry.enabled KPOPS_SCHEMA_REGISTRY__URL http://localhost:8081/ False Address of the Schema Registry. schema_registry.url KPOPS_KAFKA_REST__URL http://localhost:8082/ False Address of the Kafka REST Proxy. kafka_rest.url KPOPS_KAFKA_CONNECT__URL http://localhost:8083/ False Address of Kafka Connect. kafka_connect.url KPOPS_TIMEOUT 300 False The timeout in seconds that specifies when actions like deletion or deploy timeout. timeout KPOPS_CREATE_NAMESPACE False False Flag for helm upgrade --install. Create the release namespace if not present. create_namespace KPOPS_HELM_CONFIG__CONTEXT False Name of kubeconfig context (--kube-context) helm_config.context KPOPS_HELM_CONFIG__DEBUG False False Run Helm in Debug mode helm_config.debug 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 config_env_vars.env Exhaustive list of all config-related environment variables# Global config environment variables\n#\n# The default setup is shown. These variables are a lower priority\n# alternative to the settings in `config.yaml`. Variables marked as\n# required can instead be set in the global config.\n#\n# defaults_path\n# The path to the folder containing the defaults.yaml file and the\n# environment defaults files. Paths can either be absolute or relative\n# to `config.yaml`\nKPOPS_DEFAULTS_PATH=.\n# components_module\n# Custom Python module defining project-specific KPOps components\nKPOPS_COMPONENTS_MODULE # No default value, not required\n# pipeline_base_dir\n# Base directory to the pipelines (default is current working\n# directory)\nKPOPS_PIPELINE_BASE_DIR=.\n# kafka_brokers\n# The comma separated Kafka brokers address.\nKPOPS_KAFKA_BROKERS # No default value, required\n# defaults_filename_prefix\n# The name of the defaults file and the prefix of the defaults\n# environment file.\nKPOPS_DEFAULTS_FILENAME_PREFIX=defaults\n# topic_name_config.default_output_topic_name\n# Configures the value for the variable ${output_topic_name}\nKPOPS_TOPIC_NAME_CONFIG__DEFAULT_OUTPUT_TOPIC_NAME=${pipeline.name}-${component.name}\n# topic_name_config.default_error_topic_name\n# Configures the value for the variable ${error_topic_name}\nKPOPS_TOPIC_NAME_CONFIG__DEFAULT_ERROR_TOPIC_NAME=${pipeline.name}-${component.name}-error\n# schema_registry.enabled\n# Whether the Schema Registry handler should be initialized.\nKPOPS_SCHEMA_REGISTRY__ENABLED=False\n# schema_registry.url\n# Address of the Schema Registry.\nKPOPS_SCHEMA_REGISTRY__URL=http://localhost:8081/\n# kafka_rest.url\n# Address of the Kafka REST Proxy.\nKPOPS_KAFKA_REST__URL=http://localhost:8082/\n# kafka_connect.url\n# Address of Kafka Connect.\nKPOPS_KAFKA_CONNECT__URL=http://localhost:8083/\n# timeout\n# The timeout in seconds that specifies when actions like deletion or\n# deploy timeout.\nKPOPS_TIMEOUT=300\n# create_namespace\n# Flag for `helm upgrade --install`. Create the release namespace if\n# not present.\nKPOPS_CREATE_NAMESPACE=False\n# helm_config.context\n# Name of kubeconfig context (`--kube-context`)\nKPOPS_HELM_CONFIG__CONTEXT # No default value, not required\n# helm_config.debug\n# Run Helm in Debug mode\nKPOPS_HELM_CONFIG__DEBUG=False\n# helm_config.api_version\n# Kubernetes API version used for Capabilities.APIVersions\nKPOPS_HELM_CONFIG__API_VERSION # No default value, not required\n# helm_diff_config.ignore\n# Set of keys that should not be checked.\nKPOPS_HELM_DIFF_CONFIG__IGNORE # No default value, required\n# retain_clean_jobs\n# Whether to retain clean up jobs in the cluster or uninstall the,\n# after completion.\nKPOPS_RETAIN_CLEAN_JOBS=False\nThese variables are a lower priority alternative to the commands' flags. If a variable is set, the corresponding flag does not have to be specified in commands. Variables marked as required can instead be set as flags.
Name Default Value Required Description KPOPS_CONFIG_PATH . False Path to the dir containing config.yaml files KPOPS_DEFAULT_PATH False Path to defaults folder KPOPS_DOTENV_PATH False Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. KPOPS_ENVIRONMENT False The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). KPOPS_PIPELINE_PATH True Path to YAML with pipeline definition KPOPS_PIPELINE_STEPS False Comma separated list of steps to apply the command on cli_env_vars.env Exhaustive list of all cli-related environment variables# CLI Environment variables\n#\n# The default setup is shown. These variables are a lower priority\n# alternative to the commands' flags. If a variable is set, the\n# corresponding flag does not have to be specified in commands.\n# Variables marked as required can instead be set as flags.\n#\n# Path to the dir containing config.yaml files\nKPOPS_CONFIG_PATH=.\n# Path to defaults folder\nKPOPS_DEFAULT_PATH # No default value, not required\n# Path to dotenv file. Multiple files can be provided. The files will\n# be loaded in order, with each file overriding the previous one.\nKPOPS_DOTENV_PATH # No default value, not required\n# The environment you want to generate and deploy the pipeline to.\n# Suffix your environment files with this value (e.g.\n# defaults_development.yaml for environment=development).\nKPOPS_ENVIRONMENT # No default value, not required\n# Path to YAML with pipeline definition\nKPOPS_PIPELINE_PATH # No default value, required\n# Comma separated list of steps to apply the command on\nKPOPS_PIPELINE_STEPS # No default value, not required\nKPOps supports the usage of placeholders and environment variables in pipeline definition and defaults.
"}, {"location": "user/core-concepts/variables/substitution/#component-specific-variables", "title": "Component-specific variables", "text": "These variables can be used in a component's definition to refer to any of its attributes, including ones that the user has defined in the defaults.
All of them are prefixed with component. and follow the following form: component.{attribute_name}. If the attribute itself contains attributes, they can be referred to like this: component.{attribute_name}.{subattribute_name}.
- type: scheduled-producer\n app:\n labels:\n app_type: \"${component.type}\"\n app_name: \"${component.name}\"\n app_schedule: \"${component.app.schedule}\"\n commandLine:\n FAKE_ARG: \"fake-arg-value\"\n schedule: \"30 3/8 * * *\"\n- type: converter\n app:\n commandLine:\n CONVERT_XML: true\n resources:\n limits:\n memory: 2G\n requests:\n memory: 2G\n- type: filter\n name: \"filter-app\"\n app:\n labels:\n app_type: \"${component.type}\"\n app_name: \"${component.name}\"\n app_resources_requests_memory: \"${component.app.resources.requests.memory}\"\n ${component.type}: \"${component.app.labels.app_name}-${component.app.labels.app_type}\"\n test_placeholder_in_placeholder: \"${component.app.labels.${component.type}}\"\n commandLine:\n TYPE: \"nothing\"\n resources:\n requests:\n memory: 3G\n replicaCount: 4\n autoscaling:\n minReplicas: 4\n maxReplicas: 4\nThese variables include all fields in the config and refer to the pipeline configuration that is independent of the components.
All such variables are prefixed with config. and are of the same form as the component-specific variables.
Info
error_topic_name is an alias for config.topic_name_config.default_error_topic_name output_topic_name is an alias for config.topic_name_config.default_output_topic_name
Environment variables such as $PATH can be used in the pipeline definition and defaults without any transformation following the form ${ENV_VAR_NAME}. This, of course, includes variables like the ones relevant to the KPOps cli that are exported by the user.
See all KPOps environment variables
"}, {"location": "user/core-concepts/variables/substitution/#pipeline-name-variables", "title": "Pipeline name variables", "text": "These are special variables that refer to the name and path of a pipeline.
${pipeline.name}: Concatenated path of the parent directory where pipeline.yaml is defined in. For instance, ./data/pipelines/v1/pipeline.yaml, here the value for the variable would be data-pipelines-v1.
${pipeline_name_<level>}: Similar to the previous variable, each <level> contains a part of the path to the pipeline.yaml file. Consider the previous example, ${pipeline_name_0} would be data, ${pipeline_name_1} would be pipelines, and ${pipeline_name_2} equals to v1.
ATM fraud is a demo pipeline for ATM fraud detection. The original by Confluent is written in KSQL and outlined in this blogpost. The one used in this example is re-built from scratch using bakdata's streams-bootstrap library.
Completed all steps in the setup.
"}, {"location": "user/examples/atm-fraud-pipeline/#setup-and-deployment", "title": "Setup and deployment", "text": ""}, {"location": "user/examples/atm-fraud-pipeline/#postgresql", "title": "PostgreSQL", "text": "Deploy PostgreSQL using the Bitnami Helm chart: Add the helm repository:
helm repo add bitnami https://charts.bitnami.com/bitnami && \\\nhelm repo update\nInstall the PostgreSQL with helm:
helm upgrade --install -f ./postgresql.yaml \\\n--namespace kpops \\\npostgresql bitnami/postgresql\npostgresql.yaml) auth:\n database: app_db\n enablePostgresUser: true\n password: AppPassword\n postgresPassword: StrongPassword\n username: app1\nprimary:\n persistence:\n enabled: false\n existingClaim: postgresql-data-claim\nvolumePermissions:\n enabled: true\nBefore we deploy the pipeline, we need to forward the ports of kafka-rest-proxy and kafka-connect. Run the following commands in two different terminals.
kubectl port-forward --namespace kpops service/k8kafka-cp-rest 8082:8082\nkubectl port-forward --namespace kpops service/k8kafka-cp-kafka-connect 8083:8083\nClone the kpops-examples repository and cd into the directory.
Install KPOps pip install -r requirements.txt.
Export environment variables in your terminal:
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nDeploy the pipeline
kpops deploy atm-fraud/pipeline.yaml --execute\nNote
You can use the --dry-run flag instead of the --execute flag and check the logs if your pipeline will be deployed correctly.
You can use the Streams Explorer to see the deployed pipeline. To do so, port-forward the service in a separate terminal session using the command below:
kubectl port-forward -n kpops service/streams-explorer 8080:8080\nAfter that open http://localhost:8080 in your browser. You should be able to see pipeline shown in the image below:
An overview of ATM fraud pipeline shown in Streams Explorer
Attention
Kafka Connect needs some time to set up the connector. Moreover, Streams Explorer needs a while to scrape the information from Kafka connect. Therefore, it might take a bit until you see the whole graph.
"}, {"location": "user/examples/atm-fraud-pipeline/#teardown-resources", "title": "Teardown resources", "text": ""}, {"location": "user/examples/atm-fraud-pipeline/#postrgresql", "title": "PostrgreSQL", "text": "PostgreSQL can be uninstalled by running the following command:
helm --namespace kpops uninstall postgresql\nExport environment variables in your terminal.
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nRemove the pipeline
kpops clean atm-fraud/pipeline.yaml --verbose --execute\nNote
You can use the --dry-run flag instead of the --execute flag and check the logs if your pipeline will be destroyed correctly.
Attention
If you face any issues destroying this example see Teardown for manual deletion.
"}, {"location": "user/examples/atm-fraud-pipeline/#common-errors", "title": "Common errors", "text": "deploy fails:clean.deploy --dry-run to avoid havig to clean again. If an error is dropped, start over from step 1.deploy.clean fails:clean.clean fails, follow the steps in teardown.Word-count is a demo pipeline consisting of a producer producing words to Kafka, a Kafka streams app counting the number of times each word occurs, and finally a Redis database into which the words are exported.
"}, {"location": "user/getting-started/quick-start/#what-this-will-demonstrate", "title": "What this will demonstrate", "text": "Completed all steps in the setup.
"}, {"location": "user/getting-started/quick-start/#setup-and-deployment", "title": "Setup and deployment", "text": ""}, {"location": "user/getting-started/quick-start/#redis", "title": "Redis", "text": "Deploy Redis using the Bitnami Helm chart: Add the Helm repository:
helm repo add bitnami https://charts.bitnami.com/bitnami && \\\nhelm repo update\nInstall Redis with Helm:
helm upgrade --install -f ./values-redis.yaml \\\n--namespace kpops \\\nredis bitnami/redis\nvalues-redis.yaml) architecture: standalone\nauth:\n enabled: false\nmaster:\n count: 1\n configuration: \"databases 1\"\nimage:\n tag: 7.0.8\nBefore we deploy the pipeline, we need to forward the ports of kafka-rest-proxy and kafka-connect. Run the following commands in two different terminals.
kubectl port-forward --namespace kpops service/k8kafka-cp-rest 8082:8082\nkubectl port-forward --namespace kpops service/k8kafka-cp-kafka-connect 8083:8083\nClone the kpops-examples repository and cd into the directory.
Install KPOps pip install -r requirements.txt.
Export environment variables in your terminal:
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nDeploy the pipeline
kpops deploy word-count/pipeline.yaml --execute\nNote
You can use the --dry-run flag instead of the --execute flag and check the logs if your pipeline will be deployed correctly.
You can use the Streams Explorer to inspect the deployed pipeline. To do so, port-forward the service in a separate terminal session using the command below:
kubectl port-forward -n kpops service/streams-explorer 8080:8080\nAfter that open http://localhost:8080 in your browser.
You should be able to see pipeline shown in the image below:
An overview of Word-count pipeline shown in Streams Explorer
Attention
Kafka Connect needs some time to set up the connector. Moreover, Streams Explorer needs a while to scrape the information from Kafka Connect. Therefore, it might take a bit until you see the whole graph.
"}, {"location": "user/getting-started/quick-start/#teardown-resources", "title": "Teardown resources", "text": ""}, {"location": "user/getting-started/quick-start/#redis_1", "title": "Redis", "text": "Redis can be uninstalled by running the following command:
helm --namespace kpops uninstall redis\nExport environment variables in your terminal.
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nRemove the pipeline
kpops clean word-count/pipeline.yaml --verbose --execute\nNote
You can use the --dry-run flag instead of the --execute flag and check the logs if your pipeline will be destroyed correctly.
Attention
If you face any issues destroying this example see Teardown for manual deletion.
"}, {"location": "user/getting-started/quick-start/#common-errors", "title": "Common errors", "text": "deploy fails:clean.deploy --dry-run to avoid having to clean again. If an error is dropped, start over from step 1.deploy.clean fails:clean.clean fails, follow the steps in teardown.In this part, you will set up KPOps. This includes:
If you don't have access to an existing Kubernetes cluster, this section will guide you through creating a local cluster. We recommend the lightweight Kubernetes distribution k3s for this. k3d is a wrapper around k3s in Docker that lets you get started fast.
You can install k3d with its installation script:
wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/v5.4.6/install.sh | bash\nFor other ways of installing k3d, you can have a look at their installation guide.
The Kafka deployment needs a modified Docker image. In that case the image is built and pushed to a Docker registry that holds it. If you do not have access to an existing Docker registry, you can use k3d's Docker registry:
k3d registry create kpops-registry.localhost --port 12345\nNow you can create a new cluster called kpops that uses the previously created Docker registry:
k3d cluster create kpops --k3s-arg \"--no-deploy=traefik@server:*\" --registry-use k3d-kpops-registry.localhost:12345\nNote
Creating a new k3d cluster automatically configures kubectl to connect to the local cluster by modifying your ~/.kube/config. In case you manually set the KUBECONFIG variable or don't want k3d to modify your config, k3d offers many other options.
You can check the cluster status with kubectl get pods -n kube-system. If all returned elements have a STATUS of Running or Completed, then the cluster is up and running.
Kafka is an open-source data streaming platform. More information about Kafka can be found in the documentation. To deploy Kafka, this guide uses Confluent's Helm chart.
To allow connectivity to other systems Kafka Connect needs to be extended with drivers. You can install a JDBC driver for Kafka Connect by creating a new Docker image:
Create a Dockerfile with the following content:
FROM confluentinc/cp-kafka-connect:7.1.3\n\nRUN confluent-hub install --no-prompt confluentinc/kafka-connect-jdbc:10.6.0\nBuild and push the modified image to your private Docker registry:
docker build . --tag localhost:12345/kafka-connect-jdbc:7.1.3 && \\\ndocker push localhost:12345/kafka-connect-jdbc:7.1.3\nDetailed instructions on building, tagging and pushing a docker image can be found in Docker docs.
Add Confluent's Helm chart repository and update the index:
helm repo add confluentinc https://confluentinc.github.io/cp-helm-charts/ && \nhelm repo update\nInstall Kafka, Zookeeper, Confluent's Schema Registry, Kafka Rest Proxy, and Kafka Connect. A single Helm chart installs all five components. Below you can find an example for the --values ./kafka.yaml file configuring the deployment accordingly. Deploy the services:
helm upgrade \\\n --install \\\n --version 0.6.1 \\\n --values ./kafka.yaml \\\n --namespace kpops \\\n --create-namespace \\\n --wait \\\n k8kafka confluentinc/cp-helm-charts\nkafka.yaml) An example value configuration for Confluent's Helm chart. This configuration deploys a single Kafka Broker, a Schema Registry, Zookeeper, Kafka Rest Proxy, and Kafka Connect with minimal resources.
cp-zookeeper:\n enabled: true\n servers: 1\n imageTag: 7.1.3\n heapOptions: \"-Xms124M -Xmx124M\"\n overrideGroupId: k8kafka\n fullnameOverride: \"k8kafka-cp-zookeeper\"\n resources:\n requests:\n cpu: 50m\n memory: 0.2G\n limits:\n cpu: 250m\n memory: 0.2G\n prometheus:\n jmx:\n enabled: false\n\ncp-kafka:\n enabled: true\n brokers: 1\n imageTag: 7.1.3\n podManagementPolicy: Parallel\n configurationOverrides:\n \"auto.create.topics.enable\": false\n \"offsets.topic.replication.factor\": 1\n \"transaction.state.log.replication.factor\": 1\n \"transaction.state.log.min.isr\": 1\n \"confluent.metrics.reporter.topic.replicas\": 1\n resources:\n requests:\n cpu: 50m\n memory: 0.5G\n limits:\n cpu: 250m\n memory: 0.5G\n prometheus:\n jmx:\n enabled: false\n persistence:\n enabled: false\n\ncp-schema-registry:\n enabled: true\n imageTag: 7.1.3\n fullnameOverride: \"k8kafka-cp-schema-registry\"\n overrideGroupId: k8kafka\n kafka:\n bootstrapServers: \"PLAINTEXT://k8kafka-cp-kafka-headless:9092\"\n resources:\n requests:\n cpu: 50m\n memory: 0.25G\n limits:\n cpu: 250m\n memory: 0.25G\n prometheus:\n jmx:\n enabled: false\n\ncp-kafka-connect:\n enabled: true\n replicaCount: 1\n image: k3d-kpops-registry.localhost:12345/kafka-connect-jdbc\n imageTag: 7.1.3\n fullnameOverride: \"k8kafka-cp-kafka-connect\"\n overrideGroupId: k8kafka\n kafka:\n bootstrapServers: \"PLAINTEXT://k8kafka-cp-kafka-headless:9092\"\n heapOptions: \"-Xms256M -Xmx256M\"\n resources:\n requests:\n cpu: 500m\n memory: 0.25G\n limits:\n cpu: 500m\n memory: 0.25G\n configurationOverrides:\n \"consumer.max.poll.records\": \"10\"\n \"consumer.max.poll.interval.ms\": \"900000\"\n \"config.storage.replication.factor\": \"1\"\n \"offset.storage.replication.factor\": \"1\"\n \"status.storage.replication.factor\": \"1\"\n cp-schema-registry:\n url: http://k8kafka-cp-schema-registry:8081\n prometheus:\n jmx:\n enabled: false\n\ncp-kafka-rest:\n enabled: true\n imageTag: 7.1.3\n fullnameOverride: \"k8kafka-cp-rest\"\n heapOptions: \"-Xms256M -Xmx256M\"\n resources:\n requests:\n cpu: 50m\n memory: 0.25G\n limits:\n cpu: 250m\n memory: 0.5G\n prometheus:\n jmx:\n enabled: false\n\ncp-ksql-server:\n enabled: false\ncp-control-center:\n enabled: false\nStreams Explorer allows examining Apache Kafka data pipelines in a Kubernetes cluster including the inspection of schemas and monitoring of metrics. First, add the Helm repository:
helm repo add streams-explorer https://bakdata.github.io/streams-explorer && \\\nhelm repo update\nBelow you can find an example for the --values ./streams-explorer.yaml file configuring the deployment accordingly. Now, deploy the service:
helm upgrade \\\n --install \\\n --version 0.2.3 \\\n --values ./streams-explorer.yaml \\\n --namespace kpops \\\n streams-explorer streams-explorer/streams-explorer\nstreams-explorer.yaml) An example value configuration for Steams Explorer Helm chart.
imageTag: \"v2.1.2\"\nconfig:\n K8S__deployment__cluster: true\n SCHEMAREGISTRY__url: http://k8kafka-cp-schema-registry.kpops.svc.cluster.local:8081\n KAFKACONNECT__url: http://k8kafka-cp-kafka-connect.kpops.svc.cluster.local:8083\nresources:\n requests:\n cpu: 200m\n memory: 300Mi\n limits:\n cpu: 200m\n memory: 300Mi\nNow we will check if all the pods are running in our namespace. You can list all pods in the namespace with this command:
kubectl --namespace kpops get pods\nThen you should see the following output in your terminal:
NAME READY STATUS RESTARTS AGE\nk8kafka-cp-kafka-connect-8fc7d544f-8pjnt 1/1 Running 0 15m\nk8kafka-cp-zookeeper-0 1/1 Running 0 15m\nk8kafka-cp-kafka-0 1/1 Running 0 15m\nk8kafka-cp-schema-registry-588f8c65db-jdwbq 1/1 Running 0 15m\nk8kafka-cp-rest-6bbfd7b645-nwkf8 1/1 Running 0 15m\nstreams-explorer-54db878c67-s8wbz 1/1 Running 0 15m\nPay attention to the STATUS row. The pods should have a status of Running.
KPOps comes as a PyPI package. You can install it with pip:
pip install kpops\ndestroy: Removes Kubernetes resources.reset: Runs destroy, resets the states of Kafka Streams apps and resets offsets to zero.clean: Runs reset and removes all Kafka resources.The kpops CLI can be used to destroy a pipeline that was previously deployed with KPOps. In case that doesn't work, the pipeline can always be taken down manually with helm (see section Infrastructure).
Export environment variables.
export DOCKER_REGISTRY=bakdata && \\\nexport NAMESPACE=kpops\nNavigate to the examples folder. Replace the <name-of-the-example-directory> with the example you want to tear down. For example the atm-fraud-detection.
Remove the pipeline
# Uncomment 1 line to either destroy, reset or clean.\n\n# poetry run kpops destroy <name-of-the-example-directory>/pipeline.yaml \\\n# poetry run kpops reset <name-of-the-example-directory>/pipeline.yaml \\\n# poetry run kpops clean <name-of-the-example-directory>/pipeline.yaml \\\n--config <name-of-the-example-directory>/config.yaml \\\n--execute\nDelete namespace:
kubectl delete namespace kpops\nNote
In case kpops destroy is not working one can uninstall the pipeline services one by one. This is equivalent to running kpops destroy. In case a clean uninstall (like the one kpops clean does) is needed, one needs to also delete the topics and schemas created by deployment of the pipeline.
Delete local cluster:
k3d cluster delete kpops\nDelete local registry:
k3d registry delete k3d-kpops-registry.localhost\nKPOps automatically infers the component type from the class name. Therefore, the type and schema_type attributes can be removed from your custom components. By convention the type would be the lower, and kebab cased name of the class.
class MyCoolStreamApp(StreamsApp):\n- type = \"my-cool-stream-app\"\n+ ...\nBecause of this new convention producer has been renamed to producer-app. This must be addressed in your pipeline.yaml and defaults.yaml.
- producer:\n+ producer-app:\n app:\n streams:\n outputTopic: output_topic\n extraOutputTopics:\n output_role1: output_topic1\n output_role2: output_topic2\nIn the to section these have changed:
outputrole is set, type is inferred to be extraerror needs to be defined explicitly to:\n topics:\n ${pipeline_name}-topic-1:\n- type: extra\n role: \"role-1\"\n ...\n ${pipeline_name}-topic-2:\n- type: output\n ...\n ${pipeline_name}-topic-3:\n type: error\n ...\nIn the from section these have changed:
inputinput-pattern type is replaced by patternrole is set, type is inferred to be extrarole is set, type is explicitly set to pattern, this would be inferred type extra-pattern from:\n topics:\n ${pipeline_name}-input-topic:\n- type: input\n ...\n ${pipeline_name}-extra-topic:\n- type: extra\n role: topic-role\n ...\n ${pipeline_name}-input-pattern-topic:\n- type: input-pattern\n+ type: pattern\n ...\n ${pipeline_name}-extra-pattern-topic:\n- type: extra-pattern\n+ type: pattern\n role: some-role\n ...\nAll the internal KPOps models are now snake_case, and only Helm/Kubernetes values require camel casing. You can find an example of a pipeline.yaml in the following. Notice that the app section here remains untouched.
...\ntype: streams-app\n name: streams-app\n namespace: namespace\n app:\n streams:\n brokers: ${brokers}\n schemaRegistryUrl: ${schema_registry_url}\n autoscaling:\n consumerGroup: consumer-group\n lagThreshold: 0\n enabled: false\n pollingInterval: 30\n\n to:\n topics:\n ${pipeline_name}-output-topic:\n type: error\n- keySchema: key-schema\n+ key_schema: key-schema\n- valueSchema: value-schema\n+ value_schema: value-schema\n partitions_count: 1\n replication_factor: 1\n configs:\n cleanup.policy: compact\n models:\n model: model\n prefix: ${pipeline_name}-\n- repoConfig:\n+ repo_config:\n- repositoryName: bakdata-streams-bootstrap\n+ repository_name: bakdata-streams-bootstrap\n url: https://bakdata.github.io/streams-bootstrap/\n- repoAuthFlags:\n+ repo_auth_flags:\n username: user\n password: pass\n ca_file: /home/user/path/to/ca-file\n insecure_skip_tls_verify: false\n version: \"1.0.4\"\n...\nIf you are using the KubernetesApp class to define your own Kubernetes resource to deploy, the abstract function get_helm_chart that returns the chart for deploying the app using Helm is now a Python property and renamed to helm_chart.
class MyCoolApp(KubernetesApp):\n\n+ @property\n @override\n- def get_helm_chart(self) -> str:\n+ def helm_chart(self) -> str:\n return \"./charts/charts-folder\"\nSince you can pass a comma separated string of broker address, the broker field in KPOps is now plural. The pluralization has affected multiple areas:
"}, {"location": "user/migration-guide/v1-v2/#configyaml", "title": "config.yaml", "text": " environment: development\n- broker: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n+ brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n kafka_connect_host: \"http://localhost:8083\"\n kafka_rest_host: \"http://localhost:8082\"\n schema_registry_url: \"http://localhost:8081\"\nThe variable is now called brokers.
...\n app:\n streams:\n- brokers: ${broker}\n+ brokers: ${brokers}\n schemaRegistryUrl: ${schema_registry_url}\n nameOverride: override-with-this-name\n imageTag: \"1.0.0\"\n...\nPreviously, if you set the environment variable KPOPS_KAFKA_BROKER, you need to replace that now with KPOPS_KAFKA_BROKERS.
Jump to the summary
"}, {"location": "user/migration-guide/v2-v3/#use-hash-and-trim-long-helm-release-names-instead-of-only-trimming", "title": "Use hash and trim long Helm release names instead of only trimming", "text": "KPOps handles long (more than 53 characters) Helm releases names differently. Helm will not find your (long) old release names anymore. Therefore, it is recommended that you should once destroy your pipeline with KPOps v2 to remove old Helm release names. After a clean destroy, re-deploy your pipeline with the KPOps v3.
For example if you have a component with the Helm release name example-component-name-too-long-fake-fakefakefakefakefake. The new release name will shorten the original name to 53 characters and then replace the last 6 characters of the trimmed name with the first 5 characters of the result of SHA-1(helm_release_name).
example-component-name-too-long-fake-fakefakef-0a7fc ----> 53 chars\n---------------------------------------------- -----\n ^Shortened helm_release_name ^first 5 characters of SHA1(helm_release_name)\nAll Helm-specific parts of the built-in KubernetesApp have been extracted to a new child component that is more appropriately named HelmApp. It has to be renamed in your existing pipeline defintions and custom components module.
-- type: kubernetes-app\n+- type: helm-app\n name: foo\n- from kpops.components import KubernetesApp\n+ from kpops.components import HelmApp\n\n\n- class CustomHelmApp(KubernetesApp):\n+ class CustomHelmApp(HelmApp):\n ...\nPreviously the default KafkaApp component configured the streams-bootstrap Helm Charts. Now, this component is no longer tied to Helm (or Kubernetes). Instead, there is a new StreamsBootstrap component that configures the Helm Chart repository for the components that use it, e.g. StreamsApp and ProducerApp. If you are using non-default values for the Helm Chart repository or version, it has to be updated as shown below.
kafka-app:\n app:\n streams: ...\n\n+ streams-bootstrap:\n repo_config: ...\n version: ...\nInternally, the Kafka Connector resetter is now its own standard HelmApp, removing a lot of the shared code. It is configured using the resetter_namespace (formerly namespace) and resetter_values attributes.
kafka-connector:\n- namespace: my-namespace\n+ resetter_namespace: my-namespace\nThe breaking changes target the config.yaml file:
The schema_registry_url is replaced with schema_registry.url (default http://localhost:8081) and schema_registry.enabled (default false).
kafka_rest_host is renamed to kafka_rest.url (default http://localhost:8082).
kafka_connect_host is replaced with kafka_connect.url (default http://localhost:8083).
brokers is renamed to kafka_brokers.
The environment variable names of these config fields changed respectively. Please refer to the environment variables documentation page to see the newest changes.
"}, {"location": "user/migration-guide/v2-v3/#configyaml", "title": "config.yaml", "text": " environment: development\n- brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n- kafka_rest_host: \"http://my-custom-rest.url:8082\"\n- kafka_connect_host: \"http://my-custom-connect.url:8083\"\n- schema_registry_url: \"http://my-custom-sr.url:8081\"\n+ kafka_brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n+ kafka_rest:\n+ url: \"http://my-custom-rest.url:8082\"\n+ kafka_connect:\n+ url: \"http://my-custom-connect.url:8083\"\n+ schema_registry:\n+ enabled: true\n+ url: \"http://my-custom-sr.url:8081\"\nThe variable is now called kafka_brokers.
...\n app:\n streams:\n- brokers: ${brokers}\n+ brokers: ${kafka_brokers}\n schemaRegistryUrl: ${schema_registry_url}\n nameOverride: override-with-this-name\n imageTag: \"1.0.0\"\n...\nWarning
The previous CLI parameters have been removed.
The options for a custom components_module and pipeline_base_dir are now global settings, defined in config.yaml.
kafka_brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n environment: development\n+ components_module: components\n+ pipeline_base_dir: pipelines\nThe location of the GitHub action has changed, and it's now available directly as bakdata/kpops.
You'll need to change it in your GitHub CI workflows.
steps:\n - name: kpops deploy\n- uses: bakdata/kpops/actions/kpops-runner@main\n+ uses: bakdata/kpops@main\n with:\n command: deploy --execute\n # ...\nSpecifying the environment is no longer mandatory. If not defined, only the global files will be used.
environment is no longer specified in config.yaml. Instead, it can be either set via the CLI flag --environment or with the environment variable KPOPS_ENVIRONMENT.
The --config flag in the CLI now points to the directory that contains config*.yaml files. The files to be used are resolved based on the provided (or not) environment.
- environment: development\n kafka_brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n schema_registry:\n enabled: true\n url: \"http://my-custom-sr.url:8081\"\n.", "text": "The delimiter in the substitution variables is changed to ..
steps:\n - type: scheduled-producer\n app:\n labels:\n- app_type: \"${component_type}\"\n- app_name: \"${component_name}\"\n- app_schedule: \"${component_app_schedule}\"\n+ app_type: \"${component.type}\"\n+ app_name: \"${component.name}\"\n+ app_schedule: \"${component.app.schedule}\"\ntopic_name_config:\n- default_error_topic_name: \"${pipeline_name}-${component_name}-dead-letter-topic\"\n- default_output_topic_name: \"${pipeline_name}-${component_name}-topic\"\n+ default_error_topic_name: \"${pipeline_name}-${component.name}-dead-letter-topic\"\n+ default_output_topic_name: \"${pipeline_name}-${component.name}-topic\"\nThe template method of every pipeline component has been renamed to manifest as it is no longer strictly tied to Helm template. Instead, it can be used to render the final resources of a component, such as Kubernetes manifests.
There is also a new kpops manifest command replacing the existing kpops generate --template flag.
If you're using this functionality in your custom components, it needs to be updated.
from kpops.components.base_components.models.resource import Resource\n\n @override\n- def template(self) -> None:\n+ def manifest(self) -> Resource:\n \"\"\"Render final component resources, e.g. Kubernetes manifests.\"\"\"\n return [] # list of manifests\nThe global configuration variables are now namespaced under the config key, such as ${config.kafka_brokers}, ${config.schema_registry.url}. Same with pipeline variables, e.g. ${pipeline_name} \u2192 ${pipeline.name}. This would make it more uniform with the existing ${component.<key>} variables.
name: kafka-app\n- prefix: ${pipeline_name}-\n+ prefix: ${pipeline.name}-\n app:\n streams:\n- brokers: ${kafka_brokers}\n- schemaRegistryUrl: ${schema_registry.url}\n+ brokers: ${config.kafka_brokers}\n+ schemaRegistryUrl: ${config.schema_registry.url}\nWarning
Helm will not find your (long) old release names anymore.
defaults.yaml kafka-app:\n app:\n streams: ...\n\n+ streams-bootstrap:\n repo_config: ...\n version: ...\n- - type: kubernetes-app\n+ - type: helm-app\n ...\n - type: kafka-app\n app:\n- brokers: ${brokers}\n+ brokers: ${config.kafka_brokers}\n labels:\n- app_schedule: \"${component_app_schedule}\"\n+ app_schedule: \"${component.app.schedule}\"\n ...\n - type: kafka-connector\n- namespace: my-namespace\n+ resetter_namespace: my-namespace\n ...\n- environment: development\n\n+ components_module: components\n\n+ pipeline_base_dir: pipelines\n\n- brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n+ kafka_brokers: \"http://k8kafka-cp-kafka-headless.kpops.svc.cluster.local:9092\"\n\n- kafka_rest_host: \"http://my-custom-rest.url:8082\"\n+ kafka_rest:\n+ url: \"http://my-custom-rest.url:8082\"\n\n- kafka_connect_host: \"http://my-custom-connect.url:8083\"\n+ kafka_connect:\n+ url: \"http://my-custom-connect.url:8083\"\n\n- schema_registry_url: \"http://my-custom-sr.url:8081\"\n+ schema_registry:\n+ enabled: true\n+ url: \"http://my-custom-sr.url:8081\"\n\n topic_name_config:\n- default_error_topic_name: \"${pipeline_name}-${component_name}-dead-letter-topic\"\n+ default_error_topic_name: \"${pipeline.name}-${component.name}-dead-letter-topic\"\n ...\n- from kpops.components import KubernetesApp\n+ from kpops.components import HelmApp\n+ from kpops.components.base_components.models.resource import Resource\n\n- class CustomHelmApp(KubernetesApp):\n+ class CustomHelmApp(HelmApp):\n\n @override\n- def template(self) -> None:\n+ def manifest(self) -> Resource:\n \"\"\"Render final component resources, e.g. Kubernetes manifests.\"\"\"\n return [] # list of manifests\n ...\n steps:\n - name: ...\n- uses: bakdata/kpops/actions/kpops-runner@main\n+ uses: bakdata/kpops@main\n ...\nUsage:
$ kpops [OPTIONS] COMMAND [ARGS]...\nOptions:
-V, --version: Print KPOps version--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.Commands:
clean: Clean pipeline stepsdeploy: Deploy pipeline stepsdestroy: Destroy pipeline stepsgenerate: Generate enriched pipeline representationmanifest: Render final resource representationreset: Reset pipeline stepsschema: Generate JSON schema.kpops clean", "text": "Clean pipeline steps
Usage:
$ kpops clean [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops deploy", "text": "Deploy pipeline steps
Usage:
$ kpops deploy [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops destroy", "text": "Destroy pipeline steps
Usage:
$ kpops destroy [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops generate", "text": "Enrich pipeline steps with defaults. The enriched pipeline is used for all KPOps operations (deploy, destroy, ...).
Usage:
$ kpops generate [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--output / --no-output: Enable output printing [default: output]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops manifest", "text": "In addition to generate, render final resource representation for each pipeline step, e.g. Kubernetes manifests.
Usage:
$ kpops manifest [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--output / --no-output: Enable output printing [default: output]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops reset", "text": "Reset pipeline steps
Usage:
$ kpops reset [OPTIONS] PIPELINE_PATH\nArguments:
PIPELINE_PATH: Path to YAML with pipeline definition [env var: KPOPS_PIPELINE_PATH;required]Options:
--dotenv FILE: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one. [env var: KPOPS_DOTENV_PATH]--defaults DIRECTORY: Path to defaults folder [env var: KPOPS_DEFAULT_PATH]--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--steps TEXT: Comma separated list of steps to apply the command on [env var: KPOPS_PIPELINE_STEPS]--filter-type [include|exclude]: Whether the --steps option should include/exclude the steps [default: include]--environment TEXT: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development). [env var: KPOPS_ENVIRONMENT]--dry-run / --execute: Whether to dry run the command or execute it [default: dry-run]--verbose / --no-verbose: Enable verbose printing [default: no-verbose]--help: Show this message and exit.kpops schema", "text": "Generate JSON schema.
The schemas can be used to enable support for KPOps files in a text editor.
Usage:
$ kpops schema [OPTIONS] SCOPE:{pipeline|defaults|config}\nArguments:
SCOPE:{pipeline|defaults|config}: Scope of the generated schemapipeline: Schema of PipelineComponents. Includes the built-in KPOps components by default. To include custom components, provide components module in config.\n\nconfig: Schema of KpopsConfig. [required]\nOptions:
--config DIRECTORY: Path to the dir containing config.yaml files [env var: KPOPS_CONFIG_PATH; default: .]--include-stock-components / --no-include-stock-components: Include the built-in KPOps components. [default: include-stock-components]--help: Show this message and exit.KPOps provides JSON schemas that enable autocompletion and validation for all YAML files that the user must work with.
"}, {"location": "user/references/editor-integration/#supported-files", "title": "Supported files", "text": "pipeline.yamldefaults.yamlconfig.yamlsettings.json {\n \"yaml.schemas\": {\n \"https://bakdata.github.io/kpops/3.0/schema/pipeline.json\": [\n \"pipeline.yaml\",\n \"pipeline_*.yaml\"\n ],\n \"https://bakdata.github.io/kpops/3.0/schema/defaults.json\": [\n \"defaults.yaml\",\n \"defaults_*.yaml\"\n ],\n \"https://bakdata.github.io/kpops/3.0/schema/config.json\": [\n \"config.yaml\",\n \"config_*.yaml\"\n ]\n }\n}\nAdvanced usage
It is possible to generate schemas with the kpops schema command. Useful for including custom components or when using a pre-release version of KPOps.
We provided a GitHub composite action bakdata/kpops that installs and executes KPOps commands with the given parameters.
steps:\n # ...\n # This step is useful for debugging reasons\n - name: Generate Kafka pipeline\n uses: bakdata/kpops@main\n with:\n command: generate\n working-directory: home/my-kpops-root-dir\n pipeline: pipelines/my-pipeline-file.yaml\n kpops-version: 1.2.3\n\n # It is possible to use a pre-release KPOps version from TestPyPI https://test.pypi.org/project/kpops/#history\n - name: Deploy Kafka pipeline\n uses: bakdata/kpops@main\n with:\n command: deploy --execute\n working-directory: home/my-kpops-root-dir\n pipeline: pipelines/my-pipeline-file.yaml\n kpops-version: 1.2.5.dev20230707132709\n # ...\nauth:
- database: app_db
+ database: app_db
enablePostgresUser: true
password: AppPassword
postgresPassword: StrongPassword
@@ -1885,6 +1885,12 @@ Deploying the ATM fraud dete
-
+
Clone the kpops-examples repository and cd into the directory.
+
+-
+
Install KPOps pip install -r requirements.txt.
+
+-
Export environment variables in your terminal: