Skip to content

Commit

Permalink
Deployed e4030d3 to main with MkDocs 1.5.3 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Apr 6, 2024
1 parent c0880ba commit 48ae1d6
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion main/examples/full-example/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@
<span class=c1># such as version and network plugin.</span>
<span class=c1>#</span>
<span class=nt>kubernetes</span><span class=p>:</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.27.5</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.28.6</span>
<span class=w> </span><span class=nt>networkPlugin</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">calico</span>
<span class=w> </span><span class=nt>dnsMode</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">coredns</span><span class=w> </span><span class=c1># (36)!</span>
<span class=w> </span><span class=nt>other</span><span class=p>:</span>
Expand Down
2 changes: 1 addition & 1 deletion main/examples/ha-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,6 @@
<span class=w> </span><span class=nt>size</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">512</span>

<span class=nt>kubernetes</span><span class=p>:</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.27.5</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.28.6</span>
</code></pre></div> </details> <h2 id=step-5-applying-the-configuration>Step 5: Applying the configuration<a class=headerlink href=#step-5-applying-the-configuration title="Anchor link">&#128279;&#xFE0E;</a></h2> <p>To deploy a cluster, apply the configuration file:</p> <div class=highlight><pre><span></span><code>kubitect<span class=w> </span>apply<span class=w> </span>--config<span class=w> </span>ha.yaml
</code></pre></div> </div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["content.code.annotate", "navigation.expand", "navigation.indexes", "navigation.instant", "navigation.sections", "navigation.tabs", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.1e8ae164.min.js></script> <script src=../../theme/assets/javascripts/extra.js></script> </body> </html>
2 changes: 1 addition & 1 deletion main/examples/multi-master-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
<span class=w> </span><span class=nt>ip</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">192.168.113.22</span>

<span class=nt>kubernetes</span><span class=p>:</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.27.5</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.28.6</span>
<span class=w> </span><span class=nt>networkPlugin</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">calico</span>
</code></pre></div> </details> <h2 id=step-2-applying-the-configuration>Step 2: Applying the configuration<a class=headerlink href=#step-2-applying-the-configuration title="Anchor link">&#128279;&#xFE0E;</a></h2> <p>To deploy a cluster, apply the configuration file:</p> <div class=highlight><pre><span></span><code>kubitect<span class=w> </span>apply<span class=w> </span>--config<span class=w> </span>multi-master.yaml
</code></pre></div> </div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["content.code.annotate", "navigation.expand", "navigation.indexes", "navigation.instant", "navigation.sections", "navigation.tabs", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.1e8ae164.min.js></script> <script src=../../theme/assets/javascripts/extra.js></script> </body> </html>
2 changes: 1 addition & 1 deletion main/examples/multi-worker-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class=nt>id</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">99</span>

<span class=nt>kubernetes</span><span class=p>:</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.27.5</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.28.6</span>
<span class=w> </span><span class=nt>networkPlugin</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">calico</span>
</code></pre></div> </details> <h2 id=step-2-applying-the-configuration>Step 2: Applying the configuration<a class=headerlink href=#step-2-applying-the-configuration title="Anchor link">&#128279;&#xFE0E;</a></h2> <p>To deploy a cluster, apply the configuration file:</p> <div class=highlight><pre><span></span><code>kubitect<span class=w> </span>apply<span class=w> </span>--config<span class=w> </span>multi-worker.yaml
</code></pre></div> </div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["content.code.annotate", "navigation.expand", "navigation.indexes", "navigation.instant", "navigation.sections", "navigation.tabs", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.1e8ae164.min.js></script> <script src=../../theme/assets/javascripts/extra.js></script> </body> </html>
4 changes: 2 additions & 2 deletions main/examples/rook-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
<span class=w> </span><span class=nt>size</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">32</span>

<span class=nt>kubernetes</span><span class=p>:</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.27.5</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.28.6</span>

<span class=nt>addons</span><span class=p>:</span>
<span class=w> </span><span class=nt>rook</span><span class=p>:</span>
Expand Down Expand Up @@ -159,7 +159,7 @@
<span class=w> </span><span class=nt>size</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">32</span>

<span class=nt>kubernetes</span><span class=p>:</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.27.5</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.28.6</span>

<span class=nt>addons</span><span class=p>:</span>
<span class=w> </span><span class=nt>rook</span><span class=p>:</span>
Expand Down
2 changes: 1 addition & 1 deletion main/examples/single-node-cluster/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<span class=w> </span><span class=nt>ip</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">192.168.113.10</span>

<span class=nt>kubernetes</span><span class=p>:</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.27.5</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.28.6</span>
<span class=w> </span><span class=nt>networkPlugin</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">calico</span>
</code></pre></div> </details> <h2 id=step-2-applying-the-configuration>Step 2: Applying the configuration<a class=headerlink href=#step-2-applying-the-configuration title="Anchor link">&#128279;&#xFE0E;</a></h2> <p>To deploy a cluster, apply the configuration file:</p> <div class=highlight><pre><span></span><code>kubitect<span class=w> </span>apply<span class=w> </span>--config<span class=w> </span>single-node.yaml
</code></pre></div> </div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["content.code.annotate", "navigation.expand", "navigation.indexes", "navigation.instant", "navigation.sections", "navigation.tabs", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.1e8ae164.min.js></script> <script src=../../theme/assets/javascripts/extra.js></script> </body> </html>
4 changes: 2 additions & 2 deletions main/getting-started/getting-started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<span class=w> </span><span class=nt>ip</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">192.168.113.21</span>
<span class=w> </span><span class=nt>ram</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">4</span><span class=w> </span><span class=c1># (8)!</span>
</code></pre></div> <ol> <li> <p>Default properties are applied to all nodes of the same type, which in this case are the master nodes. They are particularly useful to quickly configure multiple nodes of the same type.</p> </li> <li> <p>The amount of RAM allocated to the master nodes (in GiB).</p> </li> <li> <p>The number of virtual CPUs assigned to each master node.</p> </li> <li> <p>The size of the virtual disk attached to each master node (in GiB).</p> </li> <li> <p>A list of master node instances.</p> </li> <li> <p>The instance ID is the <strong>only required field</strong> that must be specified for each instance.</p> </li> <li> <p>A static IP address set for this particular instance. If the <code>ip</code> property is omitted, the node requests a DHCP lease during creation.</p> </li> <li> <p>In this example, the amount of RAM allocated to the worker node instance is set to 4 GiB, which overwrites the default value of 8 GiB.</p> </li> </ol> <h3 id=step-34-kubernetes-properties>Step 3.4 - Kubernetes properties<a class=headerlink href=#step-34-kubernetes-properties title="Anchor link">&#128279;&#xFE0E;</a></h3> <p>The final section of the cluster configuration contains the Kubernetes properties, such as the version and network plugin.</p> <div class=highlight><span class=filename>kubitect.yaml</span><pre><span></span><code><span class=nt>kubernetes</span><span class=p>:</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.27.5</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.28.6</span>
<span class=w> </span><span class=nt>networkPlugin</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">calico</span>
</code></pre></div> <h2 id=step-4-create-the-cluster>Step 4 - Create the cluster<a class=headerlink href=#step-4-create-the-cluster title="Anchor link">&#128279;&#xFE0E;</a></h2> <p>Below is the final configuration for our Kubernetes cluster:</p> <details class=abstract> <summary>Final cluster configuration <i class=click-tip></i></summary> <div class=highlight><span class=filename>kubitect.yaml</span><pre><span></span><code><span class=nt>hosts</span><span class=p>:</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">localhost</span>
Expand Down Expand Up @@ -92,7 +92,7 @@
<span class=w> </span><span class=nt>ram</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">4</span>

<span class=nt>kubernetes</span><span class=p>:</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.27.5</span>
<span class=w> </span><span class=nt>version</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">v1.28.6</span>
<span class=w> </span><span class=nt>networkPlugin</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">calico</span>
</code></pre></div> </details> <p>To create the cluster, <strong>apply the configuration</strong> file to Kubitect: <div class=highlight><pre><span></span><code>kubitect<span class=w> </span>apply<span class=w> </span>--config<span class=w> </span>kubitect.yaml
</code></pre></div></p> <div class="admonition tip"> <p class=admonition-title>Tip</p> <p>If you encounter any issues during the installation process, please refer to the <a href=../other/troubleshooting>troubleshooting</a> page first.</p> </div> <p>After applying the configuration file to Kubitect, a directory for the created Kubernetes cluster is generated and stored in Kubitect's home directory. The default location for the home directory is <code>~/.kubitect</code> and has the following structure.</p> <div class=highlight><pre><span></span><code>~/.kubitect
Expand Down
2 changes: 1 addition & 1 deletion main/search/search_index.json

Large diffs are not rendered by default.

Binary file modified main/sitemap.xml.gz
Binary file not shown.
6 changes: 3 additions & 3 deletions main/user-guide/configuration/cluster-nodes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@
<span class=w> </span><span class=nt>instances</span><span class=p>:</span>
<span class=w> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
</code></pre></div> <ol> <li>If the label value is omitted, <code>null</code> is set as the label value.</li> </ol> <p>The roles of the nodes in a Kubernetes cluster can be viewed using <code>kubectl get nodes</code>.</p> <div class=highlight><pre><span></span><code>NAME STATUS ROLES AGE VERSION
k8s-cluster-master-1 Ready control-plane,master 19m v1.27.5
k8s-cluster-worker-1 Ready node 19m v1.27.5
k8s-cluster-worker-2 Ready node 19m v1.27.5
k8s-cluster-master-1 Ready control-plane,master 19m v1.28.6
k8s-cluster-worker-1 Ready node 19m v1.28.6
k8s-cluster-worker-2 Ready node 19m v1.28.6
</code></pre></div> <h3 id=load-balance-http-requests>Load balance HTTP requests<a class=headerlink href=#load-balance-http-requests title="Anchor link">&#128279;&#xFE0E;</a></h3> <p>Kubitect enables users to define custom port forwarding rules on load balancers. For example, to distribute HTTP and HTTPS requests across all worker nodes, at least one load balancer must be specified and port forwarding must be configured as follows:</p> <div class=highlight><pre><span></span><code><span class=nt>cluster</span><span class=p>:</span>
<span class=w> </span><span class=nt>nodes</span><span class=p>:</span>
<span class=w> </span><span class=nt>loadBalancer</span><span class=p>:</span>
Expand Down
8 changes: 4 additions & 4 deletions main/user-guide/configuration/kubernetes/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion main/user-guide/reference/configuration/index.html

Large diffs are not rendered by default.

0 comments on commit 48ae1d6

Please sign in to comment.