Generate docs for HelmApp

docs/docs/resources/pipeline-components/dependencies/defaults_pipeline_component_dependencies.yaml

@@ -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
@@ -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

docs/docs/resources/pipeline-components/dependencies/kpops_structure.yaml

@@ -1,4 +1,13 @@
 kpops_components_fields:
+  helm-app:
+  - name
+  - prefix
+  - from_
+  - to
+  - namespace
+  - app
+  - repo_config
+  - version
   kafka-app:
   - name
   - prefix
@@ -46,8 +55,6 @@ kpops_components_fields:
   - to
   - namespace
   - app
-  - repo_config
-  - version
   pipeline-component:
   - name
   - prefix
@@ -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

docs/docs/resources/pipeline-components/dependencies/pipeline_component_dependencies.yaml

@@ -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
@@ -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

docs/docs/resources/pipeline-components/headers/helm-app.yaml

@@ -0,0 +1,3 @@
+# Kubernetes apps managed through Helm with an associated Helm chart
+- type: helm-app
+  name: helm-app # required

docs/docs/resources/pipeline-components/helm-app.yaml

@@ -0,0 +1,63 @@
+# Kubernetes apps 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

docs/docs/resources/pipeline-components/kubernetes-app.yaml

@@ -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

docs/docs/resources/pipeline-components/pipeline.yaml

@@ -1,3 +1,66 @@
+# Kubernetes apps 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
@@ -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:

docs/docs/resources/pipeline-components/sections/app-helm-app.yaml

@@ -0,0 +1,6 @@
+  # `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

docs/docs/resources/pipeline-defaults/defaults-helm-app.yaml

@@ -0,0 +1,21 @@
+# Kubernetes apps managed through Helm with an associated Helm chart
+#
+# Parent of: KafkaApp
+# Child of: KubernetesApp
+helm-app:
+  # `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

docs/docs/resources/pipeline-defaults/defaults-kubernetes-app.yaml

@@ -1,6 +1,6 @@
 # Base Kubernetes App
 #
-# Parent of: KafkaApp
+# Parent of: HelmApp
 # Child of: PipelineComponent
 kubernetes-app:
   # Pipeline prefix that will prefix every component name. If you wish to not
@@ -52,14 +52,3 @@ kubernetes-app:
     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

docs/docs/resources/pipeline-defaults/defaults.yaml

@@ -1,3 +1,24 @@
+# Kubernetes apps managed through Helm with an associated Helm chart
+#
+# Parent of: KafkaApp
+# Child of: KubernetesApp
+helm-app:
+  # `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
 # Base component for Kafka-based components.
 #
 # Parent of: ProducerApp, StreamsApp
@@ -95,7 +116,7 @@ kafka-source-connector:
   offset_topic: offset_topic
 # Base Kubernetes App
 #
-# Parent of: KafkaApp
+# Parent of: HelmApp
 # Child of: PipelineComponent
 kubernetes-app:
   # Pipeline prefix that will prefix every component name. If you wish to not
@@ -147,17 +168,6 @@ kubernetes-app:
     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.
 #

docs/docs/resources/pipeline-defaults/headers/defaults-helm-app.yaml

@@ -0,0 +1,5 @@
+# Kubernetes apps managed through Helm with an associated Helm chart
+#
+# Parent of: KafkaApp
+# Child of: KubernetesApp
+helm-app:

docs/docs/resources/pipeline-defaults/headers/defaults-kubernetes-app.yaml

@@ -1,5 +1,5 @@
 # Base Kubernetes App
 #
-# Parent of: KafkaApp
+# Parent of: HelmApp
 # Child of: PipelineComponent
 kubernetes-app: