Deployed 0c62a53 to dev with MkDocs 1.5.3 and mike 1.1.2

bakdata · Dec 4, 2024 · 7f9135c · 7f9135c
1 parent da21710
commit 7f9135c
Show file tree

Hide file tree

Showing 13 changed files with 452 additions and 614 deletions.
diff --git a/dev/developer/api/index.html b/dev/developer/api/index.html
diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/resources/variables/cli_env_vars.env b/dev/resources/variables/cli_env_vars.env
@@ -14,6 +14,8 @@ KPOPS_DOTENV_PATH # No default value, not required
 # Suffix your environment files with this value (e.g.
 # defaults_development.yaml for environment=development).
 KPOPS_ENVIRONMENT # No default value, not required
+# How KPOps should operate.
+KPOPS_OPERATION_MODE=managed
 # Paths to dir containing 'pipeline.yaml' or files named
 # 'pipeline.yaml'.
 KPOPS_PIPELINE_PATHS # No default value, required

diff --git a/dev/resources/variables/cli_env_vars/index.html b/dev/resources/variables/cli_env_vars/index.html
@@ -1688,6 +1688,12 @@ <h1>Cli env vars</h1>
 <td>The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development).</td>
 </tr>
 <tr>
+<td>KPOPS_OPERATION_MODE</td>
+<td>managed</td>
+<td>False</td>
+<td>How KPOps should operate.</td>
+</tr>
+<tr>
 <td>KPOPS_PIPELINE_PATHS</td>
 <td></td>
 <td>True</td>

diff --git a/dev/resources/variables/config_env_vars.env b/dev/resources/variables/config_env_vars.env
@@ -58,3 +58,6 @@ KPOPS_HELM_DIFF_CONFIG__IGNORE # No default value, required
 # Whether to retain clean up jobs in the cluster or uninstall the,
 # after completion.
 KPOPS_RETAIN_CLEAN_JOBS=False
+# operation_mode
+# The operation mode of KPOps (managed, manifest, argo).
+KPOPS_OPERATION_MODE=managed
diff --git a/dev/resources/variables/config_env_vars/index.html b/dev/resources/variables/config_env_vars/index.html
@@ -1789,6 +1789,13 @@ <h1>Config env vars</h1>
 <td>Whether to retain clean up jobs in the cluster or uninstall the, after completion.</td>
 <td>retain_clean_jobs</td>
 </tr>
+<tr>
+<td>KPOPS_OPERATION_MODE</td>
+<td>managed</td>
+<td>False</td>
+<td>The operation mode of KPOps (managed, manifest, argo).</td>
+<td>operation_mode</td>
+</tr>
 </tbody>
 </table>
 

diff --git a/dev/schema/config.json b/dev/schema/config.json
@@ -118,6 +118,15 @@
             "title": "KafkaRestConfig",
             "type": "object"
         },
+        "OperationMode": {
+            "enum": [
+                "argo",
+                "manifest",
+                "managed"
+            ],
+            "title": "OperationMode",
+            "type": "string"
+        },
         "SchemaRegistryConfig": {
             "additionalProperties": false,
             "description": "Configuration for Schema Registry.",
@@ -239,6 +248,15 @@
             },
             "description": "Configuration for Kafka REST Proxy."
         },
+        "operation_mode": {
+            "allOf": [
+                {
+                    "$ref": "#/$defs/OperationMode"
+                }
+            ],
+            "default": "managed",
+            "description": "The operation mode of KPOps (managed, manifest, argo)."
+        },
         "pipeline_base_dir": {
             "default": ".",
             "description": "Base directory to the pipelines (default is current working directory)",

diff --git a/dev/schema/defaults.json b/dev/schema/defaults.json
@@ -459,22 +459,7 @@
         "KafkaConnectorConfig": {
             "additionalProperties": true,
             "additional_properties": {
-                "type": {
-                    "anyOf": [
-                        {
-                            "type": "string"
-                        },
-                        {
-                            "type": "boolean"
-                        },
-                        {
-                            "type": "integer"
-                        },
-                        {
-                            "type": "number"
-                        }
-                    ]
-                }
+                "type": "string"
             },
             "description": "Settings specific to Kafka Connectors.",
             "properties": {

diff --git a/dev/schema/pipeline.json b/dev/schema/pipeline.json
@@ -285,22 +285,7 @@
         "KafkaConnectorConfig": {
             "additionalProperties": true,
             "additional_properties": {
-                "type": {
-                    "anyOf": [
-                        {
-                            "type": "string"
-                        },
-                        {
-                            "type": "boolean"
-                        },
-                        {
-                            "type": "integer"
-                        },
-                        {
-                            "type": "number"
-                        }
-                    ]
-                }
+                "type": "string"
             },
             "description": "Settings specific to Kafka Connectors.",
             "properties": {

diff --git a/dev/search/search_index.json b/dev/search/search_index.json
diff --git a/dev/sitemap.xml.gz b/dev/sitemap.xml.gz
diff --git a/dev/user/core-concepts/variables/environment_variables/index.html b/dev/user/core-concepts/variables/environment_variables/index.html
@@ -1893,6 +1893,13 @@ <h2 id="config">Config<a class="headerlink" href="#config" title="Permanent link
 <td>Whether to retain clean up jobs in the cluster or uninstall the, after completion.</td>
 <td>retain_clean_jobs</td>
 </tr>
+<tr>
+<td>KPOPS_OPERATION_MODE</td>
+<td>managed</td>
+<td>False</td>
+<td>The operation mode of KPOps (managed, manifest, argo).</td>
+<td>operation_mode</td>
+</tr>
 </tbody>
 </table>
 <!-- dprint-ignore-start -->
@@ -1958,7 +1965,10 @@ <h2 id="config">Config<a class="headerlink" href="#config" title="Permanent link
 <span class="normal"><a href="#__codelineno-0-57">57</a></span>
 <span class="normal"><a href="#__codelineno-0-58">58</a></span>
 <span class="normal"><a href="#__codelineno-0-59">59</a></span>
-<span class="normal"><a href="#__codelineno-0-60">60</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="c1"># Global config environment variables</span>
+<span class="normal"><a href="#__codelineno-0-60">60</a></span>
+<span class="normal"><a href="#__codelineno-0-61">61</a></span>
+<span class="normal"><a href="#__codelineno-0-62">62</a></span>
+<span class="normal"><a href="#__codelineno-0-63">63</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="c1"># Global config environment variables</span>
 </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a><span class="c1">#</span>
 </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a><span class="c1"># The default setup is shown. These variables take precedence over the</span>
 </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a><span class="c1"># settings in `config.yaml`. Variables marked as required can instead</span>
@@ -2018,6 +2028,9 @@ <h2 id="config">Config<a class="headerlink" href="#config" title="Permanent link
 </span><span id="__span-0-58"><a id="__codelineno-0-58" name="__codelineno-0-58"></a><span class="c1"># Whether to retain clean up jobs in the cluster or uninstall the,</span>
 </span><span id="__span-0-59"><a id="__codelineno-0-59" name="__codelineno-0-59"></a><span class="c1"># after completion.</span>
 </span><span id="__span-0-60"><a id="__codelineno-0-60" name="__codelineno-0-60"></a><span class="n">KPOPS_RETAIN_CLEAN_JOBS</span><span class="o">=</span><span class="kc">False</span>
+</span><span id="__span-0-61"><a id="__codelineno-0-61" name="__codelineno-0-61"></a><span class="c1"># operation_mode</span>
+</span><span id="__span-0-62"><a id="__codelineno-0-62" name="__codelineno-0-62"></a><span class="c1"># The operation mode of KPOps (managed, manifest, argo).</span>
+</span><span id="__span-0-63"><a id="__codelineno-0-63" name="__codelineno-0-63"></a><span class="n">KPOPS_OPERATION_MODE</span><span class="o">=</span><span class="n">managed</span>
 </span></code></pre></div></td></tr></table></div>
 </details>
 <!-- dprint-ignore-end -->
@@ -2053,6 +2066,12 @@ <h2 id="cli">CLI<a class="headerlink" href="#cli" title="Permanent link">&para;<
 <td>The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development).</td>
 </tr>
 <tr>
+<td>KPOPS_OPERATION_MODE</td>
+<td>managed</td>
+<td>False</td>
+<td>How KPOps should operate.</td>
+</tr>
+<tr>
 <td>KPOPS_PIPELINE_PATHS</td>
 <td></td>
 <td>True</td>
@@ -2090,7 +2109,9 @@ <h2 id="cli">CLI<a class="headerlink" href="#cli" title="Permanent link">&para;<
 <span class="normal"><a href="#__codelineno-1-18">18</a></span>
 <span class="normal"><a href="#__codelineno-1-19">19</a></span>
 <span class="normal"><a href="#__codelineno-1-20">20</a></span>
-<span class="normal"><a href="#__codelineno-1-21">21</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a><span class="c1"># CLI Environment variables</span>
+<span class="normal"><a href="#__codelineno-1-21">21</a></span>
+<span class="normal"><a href="#__codelineno-1-22">22</a></span>
+<span class="normal"><a href="#__codelineno-1-23">23</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a><span class="c1"># CLI Environment variables</span>
 </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a><span class="c1">#</span>
 </span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3"></a><span class="c1"># The default setup is shown. These variables take precedence over the</span>
 </span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4"></a><span class="c1"># commands&#39; flags. If a variable is set, the corresponding flag does</span>
@@ -2106,11 +2127,13 @@ <h2 id="cli">CLI<a class="headerlink" href="#cli" title="Permanent link">&para;<
 </span><span id="__span-1-14"><a id="__codelineno-1-14" name="__codelineno-1-14"></a><span class="c1"># Suffix your environment files with this value (e.g.</span>
 </span><span id="__span-1-15"><a id="__codelineno-1-15" name="__codelineno-1-15"></a><span class="c1"># defaults_development.yaml for environment=development).</span>
 </span><span id="__span-1-16"><a id="__codelineno-1-16" name="__codelineno-1-16"></a><span class="n">KPOPS_ENVIRONMENT</span> <span class="c1"># No default value, not required</span>
-</span><span id="__span-1-17"><a id="__codelineno-1-17" name="__codelineno-1-17"></a><span class="c1"># Paths to dir containing &#39;pipeline.yaml&#39; or files named</span>
-</span><span id="__span-1-18"><a id="__codelineno-1-18" name="__codelineno-1-18"></a><span class="c1"># &#39;pipeline.yaml&#39;.</span>
-</span><span id="__span-1-19"><a id="__codelineno-1-19" name="__codelineno-1-19"></a><span class="n">KPOPS_PIPELINE_PATHS</span> <span class="c1"># No default value, required</span>
-</span><span id="__span-1-20"><a id="__codelineno-1-20" name="__codelineno-1-20"></a><span class="c1"># Comma separated list of steps to apply the command on</span>
-</span><span id="__span-1-21"><a id="__codelineno-1-21" name="__codelineno-1-21"></a><span class="n">KPOPS_PIPELINE_STEPS</span> <span class="c1"># No default value, not required</span>
+</span><span id="__span-1-17"><a id="__codelineno-1-17" name="__codelineno-1-17"></a><span class="c1"># How KPOps should operate.</span>
+</span><span id="__span-1-18"><a id="__codelineno-1-18" name="__codelineno-1-18"></a><span class="n">KPOPS_OPERATION_MODE</span><span class="o">=</span><span class="n">managed</span>
+</span><span id="__span-1-19"><a id="__codelineno-1-19" name="__codelineno-1-19"></a><span class="c1"># Paths to dir containing &#39;pipeline.yaml&#39; or files named</span>
+</span><span id="__span-1-20"><a id="__codelineno-1-20" name="__codelineno-1-20"></a><span class="c1"># &#39;pipeline.yaml&#39;.</span>
+</span><span id="__span-1-21"><a id="__codelineno-1-21" name="__codelineno-1-21"></a><span class="n">KPOPS_PIPELINE_PATHS</span> <span class="c1"># No default value, required</span>
+</span><span id="__span-1-22"><a id="__codelineno-1-22" name="__codelineno-1-22"></a><span class="c1"># Comma separated list of steps to apply the command on</span>
+</span><span id="__span-1-23"><a id="__codelineno-1-23" name="__codelineno-1-23"></a><span class="n">KPOPS_PIPELINE_STEPS</span> <span class="c1"># No default value, not required</span>
 </span></code></pre></div></td></tr></table></div>
 </details>
 <!-- dprint-ignore-end -->

diff --git a/dev/user/references/cli-commands/index.html b/dev/user/references/cli-commands/index.html
@@ -1411,13 +1411,6 @@
     kpops init
   </a>
 
-</li>
-
-        <li class="md-nav__item">
-  <a href="#kpops-manifest" class="md-nav__link">
-    kpops manifest
-  </a>
-
 </li>
 
         <li class="md-nav__item">
@@ -1792,13 +1785,6 @@
     kpops init
   </a>
 
-</li>
-
-        <li class="md-nav__item">
-  <a href="#kpops-manifest" class="md-nav__link">
-    kpops manifest
-  </a>
-
 </li>
 
         <li class="md-nav__item">
@@ -1851,7 +1837,6 @@ <h1 id="cli-usage">CLI Usage<a class="headerlink" href="#cli-usage" title="Perma
 <li><code>destroy</code>: Destroy pipeline steps</li>
 <li><code>generate</code>: Generate enriched pipeline representation</li>
 <li><code>init</code>: Initialize a new KPOps project.</li>
-<li><code>manifest</code>: Render final resource representation</li>
 <li><code>reset</code>: Reset pipeline steps</li>
 <li><code>schema</code>: Generate JSON schema.</li>
 </ul>
@@ -1895,6 +1880,7 @@ <h2 id="kpops-deploy"><code>kpops deploy</code><a class="headerlink" href="#kpop
 <li><code>--dry-run / --execute</code>: Whether to dry run the command or execute it  [default: dry-run]</li>
 <li><code>--verbose / --no-verbose</code>: Enable verbose printing  [default: no-verbose]</li>
 <li><code>--parallel / --no-parallel</code>: Enable or disable parallel execution of pipeline steps. If enabled, multiple steps can be processed concurrently. If disabled, steps will be processed sequentially.  [default: no-parallel]</li>
+<li><code>--operation-mode [argo|manifest|managed]</code>: How KPOps should operate.  [env var: KPOPS_OPERATION_MODE; default: managed]</li>
 <li><code>--help</code>: Show this message and exit.</li>
 </ul>
 <h2 id="kpops-destroy"><code>kpops destroy</code><a class="headerlink" href="#kpops-destroy" title="Permanent link">&para;</a></h2>
@@ -1948,32 +1934,13 @@ <h2 id="kpops-init"><code>kpops init</code><a class="headerlink" href="#kpops-in
 </ul>
 <p><strong>Options</strong>:</p>
 <ul>
-<li><code>--config-include-opt / --no-config-include-opt</code>: Whether to include non-required settings in the generated 'config.yaml'  [default: no-config-include-opt]</li>
-<li><code>--help</code>: Show this message and exit.</li>
-</ul>
-<h2 id="kpops-manifest"><code>kpops manifest</code><a class="headerlink" href="#kpops-manifest" title="Permanent link">&para;</a></h2>
-<p>In addition to generate, render final resource representation for each pipeline step, e.g. Kubernetes manifests.</p>
-<p><strong>Usage</strong>:</p>
-<div class="language-console highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-6-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1"></a><span class="gp">$ </span>kpops<span class="w"> </span>manifest<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>PIPELINE_PATHS...
-</span></code></pre></div></td></tr></table></div>
-<p><strong>Arguments</strong>:</p>
-<ul>
-<li><code>PIPELINE_PATHS...</code>: Paths to dir containing 'pipeline.yaml' or files named 'pipeline.yaml'.  [env var: KPOPS_PIPELINE_PATHS;required]</li>
-</ul>
-<p><strong>Options</strong>:</p>
-<ul>
-<li><code>--dotenv FILE</code>: Path to dotenv file. Multiple files can be provided. The files will be loaded in order, with each file overriding the previous one.  [env var: KPOPS_DOTENV_PATH]</li>
-<li><code>--config DIRECTORY</code>: Path to the dir containing config.yaml files  [env var: KPOPS_CONFIG_PATH; default: .]</li>
-<li><code>--steps TEXT</code>: Comma separated list of steps to apply the command on  [env var: KPOPS_PIPELINE_STEPS]</li>
-<li><code>--filter-type [include|exclude]</code>: Whether the --steps option should include/exclude the steps  [default: include]</li>
-<li><code>--environment TEXT</code>: The environment you want to generate and deploy the pipeline to. Suffix your environment files with this value (e.g. defaults_development.yaml for environment=development).   [env var: KPOPS_ENVIRONMENT]</li>
-<li><code>--verbose / --no-verbose</code>: Enable verbose printing  [default: no-verbose]</li>
+<li><code>--config-include-optional / --no-config-include-optional</code>: Whether to include non-required settings in the generated 'config.yaml'  [default: no-config-include-optional]</li>
 <li><code>--help</code>: Show this message and exit.</li>
 </ul>
 <h2 id="kpops-reset"><code>kpops reset</code><a class="headerlink" href="#kpops-reset" title="Permanent link">&para;</a></h2>
 <p>Reset pipeline steps</p>
 <p><strong>Usage</strong>:</p>
-<div class="language-console highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-7-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1"></a><span class="gp">$ </span>kpops<span class="w"> </span>reset<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>PIPELINE_PATHS...
+<div class="language-console highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-6-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1"></a><span class="gp">$ </span>kpops<span class="w"> </span>reset<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>PIPELINE_PATHS...
 </span></code></pre></div></td></tr></table></div>
 <p><strong>Arguments</strong>:</p>
 <ul>
@@ -1995,7 +1962,7 @@ <h2 id="kpops-schema"><code>kpops schema</code><a class="headerlink" href="#kpop
 <p>Generate JSON schema.</p>
 <p>The schemas can be used to enable support for KPOps files in a text editor.</p>
 <p><strong>Usage</strong>:</p>
-<div class="language-console highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-8-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1"></a><span class="gp">$ </span>kpops<span class="w"> </span>schema<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>SCOPE:<span class="o">{</span>pipeline<span class="p">|</span>defaults<span class="p">|</span>config<span class="o">}</span>
+<div class="language-console highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-7-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1"></a><span class="gp">$ </span>kpops<span class="w"> </span>schema<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>SCOPE:<span class="o">{</span>pipeline<span class="p">|</span>defaults<span class="p">|</span>config<span class="o">}</span>
 </span></code></pre></div></td></tr></table></div>
 <p><strong>Arguments</strong>:</p>
 <ul>