Deployed 636a85d to dev with MkDocs 1.4.2 and mike 1.1.2

dev/404.html

@@ -866,6 +866,8 @@
 
 
 
+
+
 
 
         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
@@ -894,6 +896,20 @@
 
 
 
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/kpops/dev/user/migration-guide/v2-v3/" class="md-nav__link">
+        Migrate from v2 to v3
+      </a>
+    </li>
+
+
+
+
         </ul>
       </nav>
     </li>

dev/developer/auto-generation/index.html

@@ -373,6 +373,11 @@
         Migrate from v1 to v2
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../../user/migration-guide/v2-v3/">
+        Migrate from v2 to v3
+      </a>
+</li>
 </ul>
 </nav>
 </li>
@@ -573,7 +578,7 @@ <h4 id="variables"><a href="https://github.com/bakdata/kpops/tree/main/docs/docs
 <ul>
 <li><code>cli_env_vars.env</code> -- All CLI environment variables in a <code>dotenv</code> file.</li>
 <li><code>cli_env_vars.md</code> -- All CLI environment variables in a table.</li>
-<li><code>config_env_vars.env</code> -- Almost all pipeline config environment variables in a <code>dotenv</code> file. The script checks for each field in <a href="https://github.com/bakdata/kpops/blob/main/kpops/cli/pipeline_config.py"><code>PipelineConfig</code></a> whether it has an <code>env</code> attribute defined. The script is currently unable to visit the classes of fields like <code>topic_name_config</code>, hence any environment variables defined there would remain unknown to it.</li>
+<li><code>config_env_vars.env</code> -- Almost all pipeline config environment variables in a <code>dotenv</code> file. The script checks for each field in <a href="https://github.com/bakdata/kpops/blob/main/kpops/cli/kpops_config.py"><code>PipelineConfig</code></a> whether it has an <code>env</code> attribute defined. The script is currently unable to visit the classes of fields like <code>topic_name_config</code>, hence any environment variables defined there would remain unknown to it.</li>
 <li><code>config_env_vars.env</code> -- Almost all pipeline config environment variables in a table.</li>
 <li><code>variable_substitution.yaml</code> -- A copy of <code>./tests/pipeline/resources/component-type-substitution/pipeline.yaml</code> used as an example of substitution.</li>
 </ul>

dev/developer/formatting/index.html

@@ -372,6 +372,11 @@
         Migrate from v1 to v2
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../../user/migration-guide/v2-v3/">
+        Migrate from v2 to v3
+      </a>
+</li>
 </ul>
 </nav>
 </li>

dev/index.html

@@ -445,6 +445,11 @@ <h1>KPOps Documentation</h1>
         Migrate from v1 to v2
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="user/migration-guide/v2-v3/">
+        Migrate from v2 to v3
+      </a>
+</li>
 </ul>
 </nav>
 </li>

dev/resources/architecture/components-hierarchy/index.html

@@ -368,6 +368,11 @@
         Migrate from v1 to v2
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../../../user/migration-guide/v2-v3/">
+        Migrate from v2 to v3
+      </a>
+</li>
 </ul>
 </nav>
 </li>

dev/resources/examples/defaults/index.html

@@ -371,6 +371,11 @@
         Migrate from v1 to v2
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../../../user/migration-guide/v2-v3/">
+        Migrate from v2 to v3
+      </a>
+</li>
 </ul>
 </nav>
 </li>

dev/resources/examples/pipeline/index.html

@@ -371,6 +371,11 @@
         Migrate from v1 to v2
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../../../user/migration-guide/v2-v3/">
+        Migrate from v2 to v3
+      </a>
+</li>
 </ul>
 </nav>
 </li>

dev/resources/pipeline-components/kafka-app.yaml

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

dev/resources/pipeline-components/pipeline.yaml

@@ -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
@@ -275,7 +275,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:
@@ -346,7 +346,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

dev/resources/pipeline-components/pipeline/index.html

@@ -371,6 +371,11 @@
         Migrate from v1 to v2
       </a>
 </li>
+<li class="md-nav__item">
+<a class="md-nav__link" href="../../../user/migration-guide/v2-v3/">
+        Migrate from v2 to v3
+      </a>
+</li>
 </ul>
 </nav>
 </li>
@@ -911,7 +916,7 @@ <h1 id="pipelineyaml">pipeline.yaml<a class="headerlink" href="#pipelineyaml" ti
 </span><span id="__span-0-49"><a id="__codelineno-0-49" name="__codelineno-0-49"></a><span class="w">  </span><span class="c1"># add the key-value pairs they need.</span>
 </span><span id="__span-0-50"><a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="w">  </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="c1"># required</span>
 </span><span id="__span-0-51"><a id="__codelineno-0-51" name="__codelineno-0-51"></a><span class="w">    </span><span class="nt">streams</span><span class="p">:</span><span class="w"> </span><span class="c1"># required</span>
-</span><span id="__span-0-52"><a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="w">      </span><span class="nt">brokers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${brokers}</span><span class="w"> </span><span class="c1"># required</span>
+</span><span id="__span-0-52"><a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="w">      </span><span class="nt">brokers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${kafka_brokers}</span><span class="w"> </span><span class="c1"># required</span>
 </span><span id="__span-0-53"><a id="__codelineno-0-53" name="__codelineno-0-53"></a><span class="w">      </span><span class="nt">schemaRegistryUrl</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${schema_registry_url}</span>
 </span><span id="__span-0-54"><a id="__codelineno-0-54" name="__codelineno-0-54"></a><span class="w">    </span><span class="nt">nameOverride</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">override-with-this-name</span><span class="w"> </span><span class="c1"># kafka-app-specific</span>
 </span><span id="__span-0-55"><a id="__codelineno-0-55" name="__codelineno-0-55"></a><span class="w">    </span><span class="nt">imageTag</span><span class="p">:</span><span class="w"> </span><span class="s">"1.0.0"</span><span class="w"> </span><span class="c1"># Example values that are shared between streams-app and producer-app</span>
@@ -1137,7 +1142,7 @@ <h1 id="pipelineyaml">pipeline.yaml<a class="headerlink" href="#pipelineyaml" ti
 </span><span id="__span-0-275"><a id="__codelineno-0-275" name="__codelineno-0-275"></a><span class="w">  </span><span class="c1"># https://github.com/bakdata/streams-bootstrap/tree/master/charts/producer-app</span>
 </span><span id="__span-0-276"><a id="__codelineno-0-276" name="__codelineno-0-276"></a><span class="w">  </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="c1"># required</span>
 </span><span id="__span-0-277"><a id="__codelineno-0-277" name="__codelineno-0-277"></a><span class="w">    </span><span class="nt">streams</span><span class="p">:</span><span class="w"> </span><span class="c1"># required, producer-app-specific</span>
-</span><span id="__span-0-278"><a id="__codelineno-0-278" name="__codelineno-0-278"></a><span class="w">      </span><span class="nt">brokers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${brokers}</span><span class="w"> </span><span class="c1"># required</span>
+</span><span id="__span-0-278"><a id="__codelineno-0-278" name="__codelineno-0-278"></a><span class="w">      </span><span class="nt">brokers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${kafka_brokers}</span><span class="w"> </span><span class="c1"># required</span>
 </span><span id="__span-0-279"><a id="__codelineno-0-279" name="__codelineno-0-279"></a><span class="w">      </span><span class="nt">schemaRegistryUrl</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${schema_registry_url}</span>
 </span><span id="__span-0-280"><a id="__codelineno-0-280" name="__codelineno-0-280"></a><span class="w">      </span><span class="nt">outputTopic</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">output_topic</span>
 </span><span id="__span-0-281"><a id="__codelineno-0-281" name="__codelineno-0-281"></a><span class="w">      </span><span class="nt">extraOutputTopics</span><span class="p">:</span>
@@ -1208,7 +1213,7 @@ <h1 id="pipelineyaml">pipeline.yaml<a class="headerlink" href="#pipelineyaml" ti
 </span><span id="__span-0-346"><a id="__codelineno-0-346" name="__codelineno-0-346"></a><span class="w">  </span><span class="nt">app</span><span class="p">:</span><span class="w"> </span><span class="c1"># required</span>
 </span><span id="__span-0-347"><a id="__codelineno-0-347" name="__codelineno-0-347"></a><span class="w">    </span><span class="c1"># Streams Bootstrap streams section</span>
 </span><span id="__span-0-348"><a id="__codelineno-0-348" name="__codelineno-0-348"></a><span class="w">    </span><span class="nt">streams</span><span class="p">:</span><span class="w"> </span><span class="c1"># required, streams-app-specific</span>
-</span><span id="__span-0-349"><a id="__codelineno-0-349" name="__codelineno-0-349"></a><span class="w">      </span><span class="nt">brokers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${brokers}</span><span class="w"> </span><span class="c1"># required</span>
+</span><span id="__span-0-349"><a id="__codelineno-0-349" name="__codelineno-0-349"></a><span class="w">      </span><span class="nt">brokers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${kafka_brokers}</span><span class="w"> </span><span class="c1"># required</span>
 </span><span id="__span-0-350"><a id="__codelineno-0-350" name="__codelineno-0-350"></a><span class="w">      </span><span class="nt">schemaRegistryUrl</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${schema_registry_url}</span>
 </span><span id="__span-0-351"><a id="__codelineno-0-351" name="__codelineno-0-351"></a><span class="w">      </span><span class="nt">inputTopics</span><span class="p">:</span>
 </span><span id="__span-0-352"><a id="__codelineno-0-352" name="__codelineno-0-352"></a><span class="w">        </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">topic1</span>

dev/resources/pipeline-components/producer-app.yaml

@@ -32,7 +32,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:

dev/resources/pipeline-components/sections/app-kafka-app.yaml

@@ -2,7 +2,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

dev/resources/pipeline-components/sections/app-producer-app.yaml

@@ -2,7 +2,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:

dev/resources/pipeline-components/sections/app-streams-app.yaml

@@ -4,7 +4,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

dev/resources/pipeline-components/streams-app.yaml

@@ -51,7 +51,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

dev/resources/pipeline-defaults/defaults-kafka-app.yaml

@@ -7,7 +7,7 @@ kafka-app:
   # 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

dev/resources/pipeline-defaults/defaults-producer-app.yaml

@@ -10,7 +10,7 @@ producer-app:
   # 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:

dev/resources/pipeline-defaults/defaults-streams-app.yaml

@@ -9,7 +9,7 @@ streams-app:
   app: # required
     # Streams Bootstrap streams section
     streams: # required, streams-app-specific
-      brokers: ${brokers} # required
+      brokers: ${kafka_brokers} # required
       schemaRegistryUrl: ${schema_registry_url}
       inputTopics:
         - topic1

dev/resources/pipeline-defaults/defaults.yaml

@@ -7,7 +7,7 @@ kafka-app:
   # 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
@@ -170,7 +170,7 @@ producer-app:
   # 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:
@@ -188,7 +188,7 @@ streams-app:
   app: # required
     # Streams Bootstrap streams section
     streams: # required, streams-app-specific
-      brokers: ${brokers} # required
+      brokers: ${kafka_brokers} # required
       schemaRegistryUrl: ${schema_registry_url}
       inputTopics:
         - topic1