From 3a86e04b6d868814f0dfa0ca36b372d055a58308 Mon Sep 17 00:00:00 2001 From: Ivan Yordanov Date: Thu, 11 Jan 2024 15:01:24 +0200 Subject: [PATCH] Update docs for substitution variable usage in v3 (#409) closes #403 --- docs/docs/resources/pipeline-components/kafka-app.yaml | 2 +- docs/docs/resources/pipeline-components/pipeline.yaml | 6 +++--- docs/docs/resources/pipeline-components/producer-app.yaml | 2 +- .../pipeline-components/sections/app-kafka-app.yaml | 2 +- .../pipeline-components/sections/app-producer-app.yaml | 2 +- .../pipeline-components/sections/app-streams-app.yaml | 2 +- docs/docs/resources/pipeline-components/streams-app.yaml | 2 +- .../resources/pipeline-defaults/defaults-kafka-app.yaml | 2 +- .../resources/pipeline-defaults/defaults-producer-app.yaml | 2 +- .../resources/pipeline-defaults/defaults-streams-app.yaml | 2 +- docs/docs/resources/pipeline-defaults/defaults.yaml | 6 +++--- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/docs/resources/pipeline-components/kafka-app.yaml b/docs/docs/resources/pipeline-components/kafka-app.yaml index cdc49ef28..5d5ad0bf6 100644 --- a/docs/docs/resources/pipeline-components/kafka-app.yaml +++ b/docs/docs/resources/pipeline-components/kafka-app.yaml @@ -50,7 +50,7 @@ app: # required streams: # required brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + 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 # Helm repository configuration (optional) diff --git a/docs/docs/resources/pipeline-components/pipeline.yaml b/docs/docs/resources/pipeline-components/pipeline.yaml index 1c6350fbc..4312a2f31 100644 --- a/docs/docs/resources/pipeline-components/pipeline.yaml +++ b/docs/docs/resources/pipeline-components/pipeline.yaml @@ -113,7 +113,7 @@ app: # required streams: # required brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + 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 # Helm repository configuration (optional) @@ -328,7 +328,7 @@ app: # required streams: # required, producer-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} outputTopic: output_topic extraOutputTopics: output_role1: output_topic1 @@ -399,7 +399,7 @@ # Streams Bootstrap streams section streams: # required, streams-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} inputTopics: - topic1 - topic2 diff --git a/docs/docs/resources/pipeline-components/producer-app.yaml b/docs/docs/resources/pipeline-components/producer-app.yaml index 5be3551d8..49f0e4e43 100644 --- a/docs/docs/resources/pipeline-components/producer-app.yaml +++ b/docs/docs/resources/pipeline-components/producer-app.yaml @@ -33,7 +33,7 @@ app: # required streams: # required, producer-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} outputTopic: output_topic extraOutputTopics: output_role1: output_topic1 diff --git a/docs/docs/resources/pipeline-components/sections/app-kafka-app.yaml b/docs/docs/resources/pipeline-components/sections/app-kafka-app.yaml index 73b70c59e..6ea97790d 100644 --- a/docs/docs/resources/pipeline-components/sections/app-kafka-app.yaml +++ b/docs/docs/resources/pipeline-components/sections/app-kafka-app.yaml @@ -3,6 +3,6 @@ app: # required streams: # required brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + 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 diff --git a/docs/docs/resources/pipeline-components/sections/app-producer-app.yaml b/docs/docs/resources/pipeline-components/sections/app-producer-app.yaml index 0cbe04ded..7eef930a9 100644 --- a/docs/docs/resources/pipeline-components/sections/app-producer-app.yaml +++ b/docs/docs/resources/pipeline-components/sections/app-producer-app.yaml @@ -3,7 +3,7 @@ app: # required streams: # required, producer-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} outputTopic: output_topic extraOutputTopics: output_role1: output_topic1 diff --git a/docs/docs/resources/pipeline-components/sections/app-streams-app.yaml b/docs/docs/resources/pipeline-components/sections/app-streams-app.yaml index 1c5f0849f..d57bb22b4 100644 --- a/docs/docs/resources/pipeline-components/sections/app-streams-app.yaml +++ b/docs/docs/resources/pipeline-components/sections/app-streams-app.yaml @@ -5,7 +5,7 @@ # Streams Bootstrap streams section streams: # required, streams-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} inputTopics: - topic1 - topic2 diff --git a/docs/docs/resources/pipeline-components/streams-app.yaml b/docs/docs/resources/pipeline-components/streams-app.yaml index f77edf80c..3f42b6096 100644 --- a/docs/docs/resources/pipeline-components/streams-app.yaml +++ b/docs/docs/resources/pipeline-components/streams-app.yaml @@ -52,7 +52,7 @@ # Streams Bootstrap streams section streams: # required, streams-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} inputTopics: - topic1 - topic2 diff --git a/docs/docs/resources/pipeline-defaults/defaults-kafka-app.yaml b/docs/docs/resources/pipeline-defaults/defaults-kafka-app.yaml index bd6c9e2d9..5d621c7fc 100644 --- a/docs/docs/resources/pipeline-defaults/defaults-kafka-app.yaml +++ b/docs/docs/resources/pipeline-defaults/defaults-kafka-app.yaml @@ -8,7 +8,7 @@ kafka-app: app: # required streams: # required brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + 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 version: "2.12.0" # Helm chart version diff --git a/docs/docs/resources/pipeline-defaults/defaults-producer-app.yaml b/docs/docs/resources/pipeline-defaults/defaults-producer-app.yaml index bfa5521c4..5dbbb6ba6 100644 --- a/docs/docs/resources/pipeline-defaults/defaults-producer-app.yaml +++ b/docs/docs/resources/pipeline-defaults/defaults-producer-app.yaml @@ -11,7 +11,7 @@ producer-app: app: # required streams: # required, producer-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} outputTopic: output_topic extraOutputTopics: output_role1: output_topic1 diff --git a/docs/docs/resources/pipeline-defaults/defaults-streams-app.yaml b/docs/docs/resources/pipeline-defaults/defaults-streams-app.yaml index ae1adab98..15026fe1e 100644 --- a/docs/docs/resources/pipeline-defaults/defaults-streams-app.yaml +++ b/docs/docs/resources/pipeline-defaults/defaults-streams-app.yaml @@ -10,7 +10,7 @@ streams-app: # Streams Bootstrap streams section streams: # required, streams-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} inputTopics: - topic1 - topic2 diff --git a/docs/docs/resources/pipeline-defaults/defaults.yaml b/docs/docs/resources/pipeline-defaults/defaults.yaml index 58b22d3f3..cfa5e275f 100644 --- a/docs/docs/resources/pipeline-defaults/defaults.yaml +++ b/docs/docs/resources/pipeline-defaults/defaults.yaml @@ -29,7 +29,7 @@ kafka-app: app: # required streams: # required brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + 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 version: "2.12.0" # Helm chart version @@ -181,7 +181,7 @@ producer-app: app: # required streams: # required, producer-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} outputTopic: output_topic extraOutputTopics: output_role1: output_topic1 @@ -199,7 +199,7 @@ streams-app: # Streams Bootstrap streams section streams: # required, streams-app-specific brokers: ${kafka_brokers} # required - schemaRegistryUrl: ${schema_registry_url} + schemaRegistryUrl: ${schema_registry.url} inputTopics: - topic1 - topic2