Skip to content
This repository has been archived by the owner on Jun 25, 2024. It is now read-only.

Commit

Permalink
Deployed 9b56e74 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Oct 26, 2023
1 parent fb640a5 commit 8cc8384
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 38 deletions.
70 changes: 45 additions & 25 deletions contributing/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -677,6 +677,13 @@
<nav class="md-nav" aria-label="Running kuttl tests">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#requirements" class="md-nav__link">
Requirements
</a>

</li>

<li class="md-nav__item">
<a href="#from-install_yamls" class="md-nav__link">
From install_yamls
Expand Down Expand Up @@ -833,6 +840,13 @@
<nav class="md-nav" aria-label="Running kuttl tests">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#requirements" class="md-nav__link">
Requirements
</a>

</li>

<li class="md-nav__item">
<a href="#from-install_yamls" class="md-nav__link">
From install_yamls
Expand Down Expand Up @@ -911,20 +925,22 @@ <h2 id="getting-started">Getting Started<a class="headerlink" href="#getting-sta
cluster-info</code> shows).</p>
<h3 id="running-on-the-cluster">Running on the cluster<a class="headerlink" href="#running-on-the-cluster" title="Permanent link">#</a></h3>
<ol>
<li>Install Instances of Custom Resources:</li>
</ol>
<li>
<p>Install Instances of Custom Resources:</p>
<div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>apply<span class="w"> </span>-f<span class="w"> </span>config/samples/
</code></pre></div>
<ol>
<li>Build and push your image to the location specified by <code>IMG</code>:</li>
</ol>
</li>
<li>
<p>Build and push your image to the location specified by <code>IMG</code>:</p>
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>docker-build<span class="w"> </span>docker-push<span class="w"> </span><span class="nv">IMG</span><span class="o">=</span>&lt;some-registry&gt;/dataplane-operator:tag
</code></pre></div>
<ol>
<li>Deploy the controller to the cluster with the image specified by <code>IMG</code>:</li>
</ol>
</li>
<li>
<p>Deploy the controller to the cluster with the image specified by <code>IMG</code>:</p>
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>deploy<span class="w"> </span><span class="nv">IMG</span><span class="o">=</span>&lt;some-registry&gt;/dataplane-operator:tag
</code></pre></div>
</li>
</ol>
<h3 id="uninstall-crds">Uninstall CRDs<a class="headerlink" href="#uninstall-crds" title="Permanent link">#</a></h3>
<p>To delete the CRDs from the cluster:</p>
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>uninstall
Expand All @@ -940,15 +956,17 @@ <h3 id="how-it-works">How it works<a class="headerlink" href="#how-it-works" tit
until the desired state is reached on the cluster</p>
<h3 id="test-it-out">Test It Out<a class="headerlink" href="#test-it-out" title="Permanent link">#</a></h3>
<ol>
<li>Install the CRDs into the cluster:</li>
</ol>
<li>
<p>Install the CRDs into the cluster:</p>
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>install
</code></pre></div>
<ol>
<li>Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):</li>
</ol>
</li>
<li>
<p>Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):</p>
<div class="highlight"><pre><span></span><code>make<span class="w"> </span>run
</code></pre></div>
</li>
</ol>
<p><strong>NOTE:</strong> You can also run this in one step by running: <code>make install run</code></p>
<h3 id="modifying-the-api-definitions">Modifying the API definitions<a class="headerlink" href="#modifying-the-api-definitions" title="Permanent link">#</a></h3>
<p>If you are editing the API definitions, generate the manifests such as CRs or CRDs using:</p>
Expand All @@ -968,12 +986,13 @@ <h2 id="testing">Testing<a class="headerlink" href="#testing" title="Permanent l
<a href="https://github.com/openstack-k8s-operators/dataplane-operator/tree/main/tests/functional"><code>tests/functional</code></a>
directory in dataplane-operator.</p>
<h3 id="running-kuttl-tests">Running kuttl tests<a class="headerlink" href="#running-kuttl-tests" title="Permanent link">#</a></h3>
<p>The kuttl tests require a running cluster with
<a href="https://github.com/openstack-k8s-operators/openstack-ansibleee-operator">openstack-ansibleee-operator</a>
running in the cluster.</p>
<p>kuttl tests are under the
<a href="https://github.com/openstack-k8s-operators/dataplane-operator/tree/main/tests/kuttl/tests">'tests/kuttl/tests'</a>
in dataplane-operator.</p>
<h4 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">#</a></h4>
<p>The kuttl tests require a running cluster with
<a href="https://github.com/openstack-k8s-operators/openstack-ansibleee-operator">openstack-ansibleee-operator</a>, <a href="https://github.com/openstack-k8s-operators/openstack-baremetal-operator">openstack-baremetal-operator</a> and <a href="https://github.com/openstack-k8s-operators/infra-operator">infra-operator</a>
running in the cluster.</p>
<h4 id="from-install_yamls">From install_yamls<a class="headerlink" href="#from-install_yamls" title="Permanent link">#</a></h4>
<p>The kuttl tests are run from the
<a href="https://github.com/openstack-k8s-operators/install_yamls">install_yamls</a>
Expand All @@ -986,7 +1005,8 @@ <h4 id="from-install_yamls">From install_yamls<a class="headerlink" href="#from-
make<span class="w"> </span>dataplane_kuttl
</code></pre></div>
<h4 id="from-dataplane-operator">From dataplane-operator<a class="headerlink" href="#from-dataplane-operator" title="Permanent link">#</a></h4>
<p>The kuttl tests can also be run directly from the dataplane-operator checkout.
<p>The kuttl tests can also be run directly from the dataplane-operator checkout but
you need the operators listed under <a href="#requirements">Requirements</a>
When running from a dataplane-operator checkout, <code>kubectl-kuttl</code> must be
installed. The <code>kubectl-kuttl</code> command can be installed from
<a href="https://github.com/kudobuilder/kuttl/releases">kuttl releases</a>, or using the
Expand All @@ -1009,33 +1029,33 @@ <h4 id="from-dataplane-operator">From dataplane-operator<a class="headerlink" hr
<h2 id="contributing-to-documentation">Contributing to documentation<a class="headerlink" href="#contributing-to-documentation" title="Permanent link">#</a></h2>
<h3 id="rendering-documentation-locally">Rendering documentation locally<a class="headerlink" href="#rendering-documentation-locally" title="Permanent link">#</a></h3>
<p>Install docs build requirements into virtualenv:</p>
<div class="highlight"><pre><span></span><code>python3 -m venv local/docs-venv
source local/docs-venv/bin/activate
pip install -r docs/doc_requirements.txt
<div class="highlight"><pre><span></span><code>python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>local/docs-venv
<span class="nb">source</span><span class="w"> </span>local/docs-venv/bin/activate
pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>docs/doc_requirements.txt
</code></pre></div>
<p>Serve docs site on localhost:</p>
<div class="highlight"><pre><span></span><code>mkdocs serve
<div class="highlight"><pre><span></span><code>mkdocs<span class="w"> </span>serve
</code></pre></div>
<p>Click the link it outputs. As you save changes to files modified in your editor,
the browser will automatically show the new content.</p>
<h3 id="create-or-edit-diagrams">Create or edit diagrams<a class="headerlink" href="#create-or-edit-diagrams" title="Permanent link">#</a></h3>
<p>Create a <code>puml</code> file inside <code>docs/diagrams/src</code></p>
<div class="highlight"><pre><span></span><code>touch docs/diagrams/src/demo.puml
<div class="highlight"><pre><span></span><code>touch<span class="w"> </span>docs/diagrams/src/demo.puml
</code></pre></div>
<p>Check the PlantUML syntax here: <a href="https://plantuml.com/deployment-diagram">https://plantuml.com/deployment-diagram</a></p>
<p>Serve docs site on localhost:</p>
<div class="highlight"><pre><span></span><code>mkdocs serve
<div class="highlight"><pre><span></span><code>mkdocs<span class="w"> </span>serve
</code></pre></div>
<p>Add the yielded <code>svg</code> into the desired <code>.md</code> file</p>
<div class="highlight"><pre><span></span><code>![Diagram demo](diagrams/out/demo.svg &quot;Diagram demo&quot;)
<div class="highlight"><pre><span></span><code>![<span class="nt">Diagram demo</span>](<span class="na">diagrams/out/edpm.svg &quot;Diagram EDPM&quot;</span>)
</code></pre></div>

<hr>
<div class="md-source-file">
<small>

Last update:
2023-07-04
2023-10-26

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,62 +2,62 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/architecture/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/common_configurations/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/composable_services/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/contributing/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/deploying/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/design/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/inheritance/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/interacting_with_ansible/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/openstack_dataplanedeployment/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/openstack_dataplanenodeset/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://openstack-k8s-operators.github.io/dataplane-operator/openstack_dataplaneservice/</loc>
<lastmod>2023-10-25</lastmod>
<lastmod>2023-10-26</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit 8cc8384

Please sign in to comment.