Skip to content

Commit

Permalink
Deployed 3770a8e 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
bakdata-bot committed Nov 25, 2024
1 parent 27e7c55 commit df1ec92
Show file tree
Hide file tree
Showing 6 changed files with 316 additions and 268 deletions.
464 changes: 240 additions & 224 deletions dev/developer/api/index.html
View file

Large diffs are not rendered by default.

Binary file modified dev/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion dev/search/search_index.json
View file

Large diffs are not rendered by default.

82 changes: 41 additions & 41 deletions dev/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,207 +2,207 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://bakdata.github.io/kpops/dev/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/developer/api/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/developer/auto-generation/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/developer/contributing/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/developer/getting-started/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/resources/architecture/components-hierarchy/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/resources/examples/defaults/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/resources/examples/pipeline/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/resources/pipeline-components/pipeline/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/resources/pipeline-defaults/defaults/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/resources/variables/cli_env_vars/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/resources/variables/config_env_vars/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/changelog/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/what-is-kpops/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/config/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/defaults/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/components/helm-app/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/components/kafka-connector/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/components/kafka-sink-connector/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/components/kafka-source-connector/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/components/kubernetes-app/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/components/overview/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/components/producer-app/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/components/streams-app/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/components/streams-bootstrap/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/variables/environment_variables/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/core-concepts/variables/substitution/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/examples/atm-fraud-pipeline/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/getting-started/quick-start/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/getting-started/setup/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/getting-started/teardown/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/migration-guide/v1-v2/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/migration-guide/v2-v3/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/migration-guide/v3-v4/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/migration-guide/v4-v5/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/migration-guide/v5-v6/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/migration-guide/v6-v7/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/migration-guide/v7-v8/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/references/cli-commands/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/references/editor-integration/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://bakdata.github.io/kpops/dev/user/references/ci-integration/github-actions/</loc>
<lastmod>2024-10-29</lastmod>
<lastmod>2024-11-25</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified dev/sitemap.xml.gz
View file
Binary file not shown.
36 changes: 34 additions & 2 deletions dev/user/references/cli-commands/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1418,6 +1418,13 @@
kpops manifest
</a>

</li>

<li class="md-nav__item">
<a href="#kpops-patch" class="md-nav__link">
kpops patch
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1799,6 +1806,13 @@
kpops manifest
</a>

</li>

<li class="md-nav__item">
<a href="#kpops-patch" class="md-nav__link">
kpops patch
</a>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1852,6 +1866,7 @@ <h1 id="cli-usage">CLI Usage<a class="headerlink" href="#cli-usage" title="Perma
<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>patch</code>: Render final resource representation</li>
<li><code>reset</code>: Reset pipeline steps</li>
<li><code>schema</code>: Generate JSON schema.</li>
</ul>
Expand Down Expand Up @@ -1970,10 +1985,27 @@ <h2 id="kpops-manifest"><code>kpops manifest</code><a class="headerlink" href="#
<li><code>--verbose / --no-verbose</code>: Enable verbose printing [default: no-verbose]</li>
<li><code>--help</code>: Show this message and exit.</li>
</ul>
<h2 id="kpops-patch"><code>kpops patch</code><a class="headerlink" href="#kpops-patch" 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-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>patch<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>--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>--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-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>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>
Expand All @@ -1995,7 +2027,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-9-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-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>
Expand Down

0 comments on commit df1ec92

Please sign in to comment.