Skip to content

Commit

Permalink
copy-paste from backup branch
Browse files Browse the repository at this point in the history
  • Loading branch information
sujuka99 committed Jan 11, 2024
1 parent 26e6893 commit e27b6fb
Show file tree
Hide file tree
Showing 68 changed files with 654 additions and 864 deletions.
6 changes: 1 addition & 5 deletions docs/docs/resources/architecture/components-hierarchy.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
```mermaid
flowchart BT
KubernetesApp --> PipelineComponent
KafkaApp --> PipelineComponent
HelmApp --> KubernetesApp
StreamsBootstrap --> HelmApp
KafkaApp --> HelmApp
StreamsApp --> KafkaApp
StreamsApp --> StreamsBootstrap
ProducerApp --> KafkaApp
ProducerApp --> StreamsBootstrap
KafkaConnector --> PipelineComponent
KafkaSourceConnector --> KafkaConnector
KafkaSinkConnector --> KafkaConnector
click KubernetesApp "/kpops/user/core-concepts/components/kubernetes-app"
click HelmApp "/kpops/user/core-concepts/components/helm-app"
click KafkaApp "/kpops/user/core-concepts/components/kafka-app"
click StreamsBootstrap "/kpops/user/core-concepts/components/streams-bootstrap"
click StreamsApp "/kpops/user/core-concepts/components/streams-app"
click ProducerApp "/kpops/user/core-concepts/components/producer-app"
click KafkaConnector "/kpops/user/core-concepts/components/kafka-connector"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@ helm-app.yaml:
- app-helm-app.yaml
- repo_config-helm-app.yaml
kafka-app.yaml:
- prefix.yaml
- from_.yaml
- to.yaml
- app-kafka-app.yaml
- version-kafka-app.yaml
kafka-connector.yaml:
- prefix.yaml
- from_.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ kpops_components_fields:
- prefix
- from_
- to
- namespace
- app
- repo_config
- version
kafka-connector:
- name
- prefix
Expand Down Expand Up @@ -75,15 +78,6 @@ kpops_components_fields:
- app
- repo_config
- version
streams-bootstrap:
- name
- prefix
- from_
- to
- namespace
- app
- repo_config
- version
kpops_components_inheritance_ref:
helm-app:
bases:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ kafka-app.yaml:
- prefix.yaml
- from_.yaml
- to.yaml
- namespace.yaml
- app-kafka-app.yaml
- repo_config-helm-app.yaml
- version-kafka-app.yaml
kafka-connector.yaml:
- prefix.yaml
- from_.yaml
Expand Down
16 changes: 8 additions & 8 deletions docs/docs/resources/pipeline-components/helm-app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
name: helm-app # required
# Pipeline prefix that will prefix every component name. If you wish to not
# have any prefix you can specify an empty string.
prefix: ${pipeline_name}-
prefix: ${pipeline.name}-
from: # Must not be null
topics: # read from topic
${pipeline_name}-input-topic:
${pipeline.name}-input-topic:
type: input # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra
${pipeline_name}-input-pattern-topic:
${pipeline.name}-input-pattern-topic:
type: pattern # Implied to be an input pattern if `role` is undefined
${pipeline_name}-extra-pattern-topic:
${pipeline.name}-extra-pattern-topic:
type: pattern # Implied to be an extra pattern if `role` is defined
role: some-role
components: # read from specific component
Expand All @@ -28,11 +28,11 @@
# Topic(s) into which the component will write output
to:
topics:
${pipeline_name}-output-topic:
${pipeline.name}-output-topic:
type: output # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined
${pipeline_name}-error-topic:
${pipeline.name}-error-topic:
type: error
# Currently KPOps supports Avro and JSON schemas.
key_schema: key-schema # must implement SchemaProvider to use
Expand Down
32 changes: 22 additions & 10 deletions docs/docs/resources/pipeline-components/kafka-app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
name: kafka-app # required
# Pipeline prefix that will prefix every component name. If you wish to not
# have any prefix you can specify an empty string.
prefix: ${pipeline_name}-
prefix: ${pipeline.name}-
from: # Must not be null
topics: # read from topic
${pipeline_name}-input-topic:
${pipeline.name}-input-topic:
type: input # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra
${pipeline_name}-input-pattern-topic:
${pipeline.name}-input-pattern-topic:
type: pattern # Implied to be an input pattern if `role` is undefined
${pipeline_name}-extra-pattern-topic:
${pipeline.name}-extra-pattern-topic:
type: pattern # Implied to be an extra pattern if `role` is defined
role: some-role
components: # read from specific component
Expand All @@ -29,11 +29,11 @@
# Topic(s) into which the component will write output
to:
topics:
${pipeline_name}-output-topic:
${pipeline.name}-output-topic:
type: output # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined
${pipeline_name}-error-topic:
${pipeline.name}-error-topic:
type: error
# Currently KPOps supports Avro and JSON schemas.
key_schema: key-schema # must implement SchemaProvider to use
Expand All @@ -44,11 +44,23 @@
cleanup.policy: compact
models: # SchemaProvider is initiated with the values given here
model: model
namespace: namespace # required
# `app` can contain application-specific settings, hence the user is free to
# add the key-value pairs they need.
app: # required
streams: # required
brokers: ${kafka_brokers} # required
schemaRegistryUrl: ${schema_registry_url}
brokers: ${config.kafka_brokers} # required
schemaRegistryUrl: ${config.schema_registry.url}
nameOverride: override-with-this-name # kafka-app-specific
imageTag: "1.0.0" # Example values that are shared between streams-app and producer-app
# Helm repository configuration (optional)
# If not set the helm repo add will not be called. Useful when using local Helm charts
repo_config:
repository_name: bakdata-streams-bootstrap # required
url: https://bakdata.github.io/streams-bootstrap/ # required
repo_auth_flags:
username: user
password: pass
ca_file: /home/user/path/to/ca-file
insecure_skip_tls_verify: false
version: "2.12.0" # Helm chart version
16 changes: 8 additions & 8 deletions docs/docs/resources/pipeline-components/kafka-connector.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
name: kafka-connector # required
# Pipeline prefix that will prefix every component name. If you wish to not
# have any prefix you can specify an empty string.
prefix: ${pipeline_name}-
prefix: ${pipeline.name}-
from: # Must not be null
topics: # read from topic
${pipeline_name}-input-topic:
${pipeline.name}-input-topic:
type: input # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra
${pipeline_name}-input-pattern-topic:
${pipeline.name}-input-pattern-topic:
type: pattern # Implied to be an input pattern if `role` is undefined
${pipeline_name}-extra-pattern-topic:
${pipeline.name}-extra-pattern-topic:
type: pattern # Implied to be an extra pattern if `role` is defined
role: some-role
components: # read from specific component
Expand All @@ -27,11 +27,11 @@
# Topic(s) into which the component will write output
to:
topics:
${pipeline_name}-output-topic:
${pipeline.name}-output-topic:
type: output # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined
${pipeline_name}-error-topic:
${pipeline.name}-error-topic:
type: error
# Currently KPOps supports Avro and JSON schemas.
key_schema: key-schema # must implement SchemaProvider to use
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
name: kafka-sink-connector # required
# Pipeline prefix that will prefix every component name. If you wish to not
# have any prefix you can specify an empty string.
prefix: ${pipeline_name}-
prefix: ${pipeline.name}-
from: # Must not be null
topics: # read from topic
${pipeline_name}-input-topic:
${pipeline.name}-input-topic:
type: input # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra
${pipeline_name}-input-pattern-topic:
${pipeline.name}-input-pattern-topic:
type: pattern # Implied to be an input pattern if `role` is undefined
${pipeline_name}-extra-pattern-topic:
${pipeline.name}-extra-pattern-topic:
type: pattern # Implied to be an extra pattern if `role` is defined
role: some-role
components: # read from specific component
Expand All @@ -28,11 +28,11 @@
# Topic(s) into which the component will write output
to:
topics:
${pipeline_name}-output-topic:
${pipeline.name}-output-topic:
type: output # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined
${pipeline_name}-error-topic:
${pipeline.name}-error-topic:
type: error
# Currently KPOps supports Avro and JSON schemas.
key_schema: key-schema # must implement SchemaProvider to use
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
name: kafka-source-connector # required
# Pipeline prefix that will prefix every component name. If you wish to not
# have any prefix you can specify an empty string.
prefix: ${pipeline_name}-
prefix: ${pipeline.name}-
# The source connector has no `from` section
# from:
# Topic(s) into which the component will write output
to:
topics:
${pipeline_name}-output-topic:
${pipeline.name}-output-topic:
type: output # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined
${pipeline_name}-error-topic:
${pipeline.name}-error-topic:
type: error
# Currently KPOps supports Avro and JSON schemas.
key_schema: key-schema # must implement SchemaProvider to use
Expand Down
16 changes: 8 additions & 8 deletions docs/docs/resources/pipeline-components/kubernetes-app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
name: kubernetes-app # required
# Pipeline prefix that will prefix every component name. If you wish to not
# have any prefix you can specify an empty string.
prefix: ${pipeline_name}-
prefix: ${pipeline.name}-
from: # Must not be null
topics: # read from topic
${pipeline_name}-input-topic:
${pipeline.name}-input-topic:
type: input # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra
${pipeline_name}-input-pattern-topic:
${pipeline.name}-input-pattern-topic:
type: pattern # Implied to be an input pattern if `role` is undefined
${pipeline_name}-extra-pattern-topic:
${pipeline.name}-extra-pattern-topic:
type: pattern # Implied to be an extra pattern if `role` is defined
role: some-role
components: # read from specific component
Expand All @@ -28,11 +28,11 @@
# Topic(s) into which the component will write output
to:
topics:
${pipeline_name}-output-topic:
${pipeline.name}-output-topic:
type: output # Implied when role is NOT specified
${pipeline_name}-extra-topic:
${pipeline.name}-extra-topic:
role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined
${pipeline_name}-error-topic:
${pipeline.name}-error-topic:
type: error
# Currently KPOps supports Avro and JSON schemas.
key_schema: key-schema # must implement SchemaProvider to use
Expand Down
Loading

0 comments on commit e27b6fb

Please sign in to comment.