Skip to content

Commit

Permalink
Deployed d8337ca to dev with MkDocs 1.5.3 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
bakdata-bot committed Nov 2, 2023
1 parent 9791856 commit 863d374
Show file tree
Hide file tree
Showing 64 changed files with 4,948 additions and 9,140 deletions.
217 changes: 83 additions & 134 deletions dev/404.html

Large diffs are not rendered by default.

263 changes: 98 additions & 165 deletions dev/developer/auto-generation/index.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

217 changes: 83 additions & 134 deletions dev/index.html

Large diffs are not rendered by default.

239 changes: 95 additions & 144 deletions dev/resources/architecture/components-hierarchy/index.html

Large diffs are not rendered by default.

217 changes: 83 additions & 134 deletions dev/resources/examples/defaults/index.html

Large diffs are not rendered by default.

217 changes: 83 additions & 134 deletions dev/resources/examples/pipeline/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
helm-app.yaml:
- app-helm-app.yaml
- repo_config-helm-app.yaml
kafka-app.yaml:
- app-kafka-app.yaml
- version-kafka-app.yaml
Expand All @@ -20,8 +23,6 @@ kubernetes-app.yaml:
- to.yaml
- namespace.yaml
- app-kubernetes-app.yaml
- repo_config-kubernetes-app.yaml
- version.yaml
producer-app.yaml:
- from_-producer-app.yaml
- app-producer-app.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
kpops_components_fields:
helm-app:
- name
- prefix
- from_
- to
- namespace
- app
- repo_config
- version
kafka-app:
- name
- prefix
Expand Down Expand Up @@ -46,8 +55,6 @@ kpops_components_fields:
- to
- namespace
- app
- repo_config
- version
pipeline-component:
- name
- prefix
Expand All @@ -72,7 +79,8 @@ kpops_components_fields:
- repo_config
- version
kpops_components_inheritance_ref:
kafka-app: kubernetes-app
helm-app: kubernetes-app
kafka-app: helm-app
kafka-connector: pipeline-component
kafka-sink-connector: kafka-connector
kafka-source-connector: kafka-connector
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
helm-app.yaml:
- prefix.yaml
- from_.yaml
- to.yaml
- namespace.yaml
- app-helm-app.yaml
- repo_config-helm-app.yaml
- version.yaml
kafka-app.yaml:
- prefix.yaml
- from_.yaml
- to.yaml
- namespace.yaml
- app-kafka-app.yaml
- repo_config-kubernetes-app.yaml
- repo_config-helm-app.yaml
- version-kafka-app.yaml
kafka-connector.yaml:
- prefix.yaml
Expand Down Expand Up @@ -40,21 +48,19 @@ kubernetes-app.yaml:
- to.yaml
- namespace.yaml
- app-kubernetes-app.yaml
- repo_config-kubernetes-app.yaml
- version.yaml
producer-app.yaml:
- prefix.yaml
- from_-producer-app.yaml
- to.yaml
- namespace.yaml
- app-producer-app.yaml
- repo_config-kubernetes-app.yaml
- repo_config-helm-app.yaml
- version-kafka-app.yaml
streams-app.yaml:
- prefix.yaml
- from_.yaml
- to.yaml
- namespace.yaml
- app-streams-app.yaml
- repo_config-kubernetes-app.yaml
- repo_config-helm-app.yaml
- version-kafka-app.yaml
3 changes: 3 additions & 0 deletions dev/resources/pipeline-components/headers/helm-app.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Kubernetes app managed through Helm with an associated Helm chart
- type: helm-app
name: helm-app # required
63 changes: 63 additions & 0 deletions dev/resources/pipeline-components/helm-app.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Kubernetes app managed through Helm with an associated Helm chart
- type: helm-app
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}-
from: # Must not be null
topics: # read from topic
${pipeline_name}-input-topic:
type: input # Implied when role is NOT specified
${pipeline_name}-extra-topic:
role: topic-role # Implies `type` to be extra
${pipeline_name}-input-pattern-topic:
type: pattern # Implied to be an input pattern if `role` is undefined
${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
account-producer:
type: output # Implied when role is NOT specified
other-producer:
role: some-role # Implies `type` to be extra
component-as-input-pattern:
type: pattern # Implied to be an input pattern if `role` is undefined
component-as-extra-pattern:
type: pattern # Implied to be an extra pattern if `role` is defined
role: some-role
# Topic(s) into which the component will write output
to:
topics:
${pipeline_name}-output-topic:
type: output # Implied when role is NOT specified
${pipeline_name}-extra-topic:
role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined
${pipeline_name}-error-topic:
type: error
# Currently KPOps supports Avro and JSON schemas.
key_schema: key-schema # must implement SchemaProvider to use
value_schema: value-schema
partitions_count: 1
replication_factor: 1
configs: # https://kafka.apache.org/documentation/#topicconfigs
cleanup.policy: compact
models: # SchemaProvider is initiated with the values given here
model: model
namespace: namespace # required
# `app` contains application-specific settings, hence it does not have a rigid
# structure. The fields below are just an example.
app: # required
image: exampleImage # Example
debug: false # Example
commandLine: {} # Example
# 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: "1.0.0" # Helm chart version
2 changes: 1 addition & 1 deletion dev/resources/pipeline-components/kafka-app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
# add the key-value pairs they need.
app: # required
streams: # required
brokers: ${brokers} # required
brokers: ${kafka_brokers} # required
schemaRegistryUrl: ${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
Expand Down
11 changes: 0 additions & 11 deletions dev/resources/pipeline-components/kubernetes-app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,3 @@
image: exampleImage # Example
debug: false # Example
commandLine: {} # Example
# 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: "1.0.0" # Helm chart version
80 changes: 66 additions & 14 deletions dev/resources/pipeline-components/pipeline.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,66 @@
# Kubernetes app managed through Helm with an associated Helm chart
- type: helm-app
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}-
from: # Must not be null
topics: # read from topic
${pipeline_name}-input-topic:
type: input # Implied when role is NOT specified
${pipeline_name}-extra-topic:
role: topic-role # Implies `type` to be extra
${pipeline_name}-input-pattern-topic:
type: pattern # Implied to be an input pattern if `role` is undefined
${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
account-producer:
type: output # Implied when role is NOT specified
other-producer:
role: some-role # Implies `type` to be extra
component-as-input-pattern:
type: pattern # Implied to be an input pattern if `role` is undefined
component-as-extra-pattern:
type: pattern # Implied to be an extra pattern if `role` is defined
role: some-role
# Topic(s) into which the component will write output
to:
topics:
${pipeline_name}-output-topic:
type: output # Implied when role is NOT specified
${pipeline_name}-extra-topic:
role: topic-role # Implies `type` to be extra; Will throw an error if `type` is defined
${pipeline_name}-error-topic:
type: error
# Currently KPOps supports Avro and JSON schemas.
key_schema: key-schema # must implement SchemaProvider to use
value_schema: value-schema
partitions_count: 1
replication_factor: 1
configs: # https://kafka.apache.org/documentation/#topicconfigs
cleanup.policy: compact
models: # SchemaProvider is initiated with the values given here
model: model
namespace: namespace # required
# `app` contains application-specific settings, hence it does not have a rigid
# structure. The fields below are just an example.
app: # required
image: exampleImage # Example
debug: false # Example
commandLine: {} # Example
# 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: "1.0.0" # Helm chart version
# Base component for Kafka-based components.
# Producer or streaming apps should inherit from this class.
- type: kafka-app # required
Expand Down Expand Up @@ -49,7 +112,7 @@
# add the key-value pairs they need.
app: # required
streams: # required
brokers: ${brokers} # required
brokers: ${kafka_brokers} # required
schemaRegistryUrl: ${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
Expand Down Expand Up @@ -230,17 +293,6 @@
image: exampleImage # Example
debug: false # Example
commandLine: {} # Example
# 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: "1.0.0" # Helm chart version
# Holds configuration to use as values for the streams bootstrap producer-app Helm
# chart.
# More documentation on ProducerApp:
Expand Down Expand Up @@ -275,7 +327,7 @@
# https://github.com/bakdata/streams-bootstrap/tree/master/charts/producer-app
app: # required
streams: # required, producer-app-specific
brokers: ${brokers} # required
brokers: ${kafka_brokers} # required
schemaRegistryUrl: ${schema_registry_url}
outputTopic: output_topic
extraOutputTopics:
Expand Down Expand Up @@ -346,7 +398,7 @@
app: # required
# Streams Bootstrap streams section
streams: # required, streams-app-specific
brokers: ${brokers} # required
brokers: ${kafka_brokers} # required
schemaRegistryUrl: ${schema_registry_url}
inputTopics:
- topic1
Expand Down
Loading

0 comments on commit 863d374

Please sign in to comment.