Deployed 6142aad5ab to master with MkDocs 1.4.2 and mike 1.1.2

This commit is contained in:
GitHub Action committed 2022-11-24 13:56:56 +00:00
1 parent 29ad65d151
commit 8018ca9b4d
11 files changed
+1416 -526

No files matched your search

@@ -711,6 +711,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#implements" class="md-nav__link">
Implements
</a>
</li>
<li class="md-nav__item">
<a href="#table-of-contents" class="md-nav__link">
Table of contents
@@ -724,13 +731,6 @@
Constructors
</a>
</li>
<li class="md-nav__item">
<a href="#properties" class="md-nav__link">
Properties
</a>
</li>
<li class="md-nav__item">
@@ -763,33 +763,6 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#properties_1" class="md-nav__link">
Properties
</a>
<nav class="md-nav" aria-label="Properties">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#cluster" class="md-nav__link">
cluster
</a>
</li>
<li class="md-nav__item">
<a href="#name" class="md-nav__link">
name
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -800,27 +773,6 @@
<nav class="md-nav" aria-label="Methods">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#appendkubectlargs" class="md-nav__link">
appendKubectlArgs
</a>
</li>
<li class="md-nav__item">
<a href="#applyresources" class="md-nav__link">
applyResources
</a>
</li>
<li class="md-nav__item">
<a href="#deleteresources" class="md-nav__link">
deleteResources
</a>
</li>
<li class="md-nav__item">
<a href="#kubectlapplyfolder" class="md-nav__link">
kubectlApplyFolder
@@ -833,13 +785,6 @@
kubectlDeleteFolder
</a>
</li>
<li class="md-nav__item">
<a href="#rendertemplates" class="md-nav__link">
renderTemplates
</a>
</li>
</ul>
@@ -863,24 +808,21 @@
<h1 id="class-resourcestack">Class: ResourceStack<a class="headerlink" href="#class-resourcestack" title="Permanent link">#</a></h1>
<p><a href="../../modules/Renderer/">Renderer</a>.<a href="../../modules/Renderer.K8sApi/">K8sApi</a>.ResourceStack</p>
<p><strong><code>Deprecated</code></strong></p>
<p>Switch to using <code>Common.createResourceStack</code> instead</p>
<h2 id="implements">Implements<a class="headerlink" href="#implements" title="Permanent link">#</a></h2>
<ul>
<li><code>ResourceApplyingStack</code></li>
</ul>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#constructor">constructor</a></li>
</ul>
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#cluster">cluster</a></li>
<li><a href="./#name">name</a></li>
</ul>
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
<ul>
<li><a href="./#appendkubectlargs">appendKubectlArgs</a></li>
<li><a href="./#applyresources">applyResources</a></li>
<li><a href="./#deleteresources">deleteResources</a></li>
<li><a href="./#kubectlapplyfolder">kubectlApplyFolder</a></li>
<li><a href="./#kubectldeletefolder">kubectlDeleteFolder</a></li>
<li><a href="./#rendertemplates">renderTemplates</a></li>
</ul>
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
@@ -904,15 +846,9 @@
</tr>
</tbody>
</table>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="cluster">cluster<a class="headerlink" href="#cluster" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>cluster</strong>: <a href="../Common.Catalog.KubernetesCluster/"><code>KubernetesCluster</code></a>&lt;<a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a>></p>
<hr />
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>name</strong>: <code>string</code></p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="appendkubectlargs">appendKubectlArgs<a class="headerlink" href="#appendkubectlargs" title="Permanent link">#</a></h3>
<p>▸ <code>Protected</code> <strong>appendKubectlArgs</strong>(<code>kubectlArgs</code>): <code>string</code>[]</p>
<h3 id="kubectlapplyfolder">kubectlApplyFolder<a class="headerlink" href="#kubectlapplyfolder" title="Permanent link">#</a></h3>
<p>▸ <strong>kubectlApplyFolder</strong>(<code>folderPath</code>, <code>templateContext?</code>, <code>extraArgs?</code>): <code>Promise</code>&lt;<code>string</code>></p>
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
<table>
<thead>
@@ -923,16 +859,26 @@
</thead>
<tbody>
<tr>
<td align="left"><code>kubectlArgs</code></td>
<td align="left"><code>folderPath</code></td>
<td align="left"><code>string</code></td>
</tr>
<tr>
<td align="left"><code>templateContext?</code></td>
<td align="left"><code>any</code></td>
</tr>
<tr>
<td align="left"><code>extraArgs?</code></td>
<td align="left"><code>string</code>[]</td>
</tr>
</tbody>
</table>
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
<p><code>string</code>[]</p>
<p><code>Promise</code>&lt;<code>string</code>></p>
<h4 id="implementation-of">Implementation of<a class="headerlink" href="#implementation-of" title="Permanent link">#</a></h4>
<p>ResourceApplyingStack.kubectlApplyFolder</p>
<hr />
<h3 id="applyresources">applyResources<a class="headerlink" href="#applyresources" title="Permanent link">#</a></h3>
<p>▸ <code>Protected</code> <strong>applyResources</strong>(<code>resources</code>, <code>extraArgs?</code>): <code>Promise</code>&lt;<code>string</code>></p>
<h3 id="kubectldeletefolder">kubectlDeleteFolder<a class="headerlink" href="#kubectldeletefolder" title="Permanent link">#</a></h3>
<p>▸ <strong>kubectlDeleteFolder</strong>(<code>folderPath</code>, <code>templateContext?</code>, <code>extraArgs?</code>): <code>Promise</code>&lt;<code>string</code>></p>
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
<table>
<thead>
@@ -943,8 +889,12 @@
</thead>
<tbody>
<tr>
<td align="left"><code>resources</code></td>
<td align="left"><code>string</code>[]</td>
<td align="left"><code>folderPath</code></td>
<td align="left"><code>string</code></td>
</tr>
<tr>
<td align="left"><code>templateContext?</code></td>
<td align="left"><code>any</code></td>
</tr>
<tr>
<td align="left"><code>extraArgs?</code></td>
@@ -954,118 +904,8 @@
</table>
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>string</code>></p>
<hr />
<h3 id="deleteresources">deleteResources<a class="headerlink" href="#deleteresources" title="Permanent link">#</a></h3>
<p>▸ <code>Protected</code> <strong>deleteResources</strong>(<code>resources</code>, <code>extraArgs?</code>): <code>Promise</code>&lt;<code>string</code>></p>
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>resources</code></td>
<td align="left"><code>string</code>[]</td>
</tr>
<tr>
<td align="left"><code>extraArgs?</code></td>
<td align="left"><code>string</code>[]</td>
</tr>
</tbody>
</table>
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>string</code>></p>
<hr />
<h3 id="kubectlapplyfolder">kubectlApplyFolder<a class="headerlink" href="#kubectlapplyfolder" title="Permanent link">#</a></h3>
<p>▸ <strong>kubectlApplyFolder</strong>(<code>folderPath</code>, <code>templateContext?</code>, <code>extraArgs?</code>): <code>Promise</code>&lt;<code>string</code>></p>
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>folderPath</code></td>
<td align="left"><code>string</code></td>
<td align="left">folder path that is searched for files defining kubernetes resources.</td>
</tr>
<tr>
<td align="left"><code>templateContext?</code></td>
<td align="left"><code>any</code></td>
<td align="left">sets the template parameters that are to be applied to any templated kubernetes resources that are to be applied.</td>
</tr>
<tr>
<td align="left"><code>extraArgs?</code></td>
<td align="left"><code>string</code>[]</td>
<td align="left">-</td>
</tr>
</tbody>
</table>
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>string</code>></p>
<hr />
<h3 id="kubectldeletefolder">kubectlDeleteFolder<a class="headerlink" href="#kubectldeletefolder" title="Permanent link">#</a></h3>
<p>▸ <strong>kubectlDeleteFolder</strong>(<code>folderPath</code>, <code>templateContext?</code>, <code>extraArgs?</code>): <code>Promise</code>&lt;<code>string</code>></p>
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>folderPath</code></td>
<td align="left"><code>string</code></td>
<td align="left">folder path that is searched for files defining kubernetes resources.</td>
</tr>
<tr>
<td align="left"><code>templateContext?</code></td>
<td align="left"><code>any</code></td>
<td align="left">sets the template parameters that are to be applied to any templated kubernetes resources that are to be applied.</td>
</tr>
<tr>
<td align="left"><code>extraArgs?</code></td>
<td align="left"><code>string</code>[]</td>
<td align="left">-</td>
</tr>
</tbody>
</table>
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>string</code>></p>
<hr />
<h3 id="rendertemplates">renderTemplates<a class="headerlink" href="#rendertemplates" title="Permanent link">#</a></h3>
<p>▸ <code>Protected</code> <strong>renderTemplates</strong>(<code>folderPath</code>, <code>templateContext</code>): <code>Promise</code>&lt;<code>string</code>[]></p>
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>folderPath</code></td>
<td align="left"><code>string</code></td>
</tr>
<tr>
<td align="left"><code>templateContext</code></td>
<td align="left"><code>any</code></td>
</tr>
</tbody>
</table>
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>string</code>[]></p>
<h4 id="implementation-of_1">Implementation of<a class="headerlink" href="#implementation-of_1" title="Permanent link">#</a></h4>
<p>ResourceApplyingStack.kubectlDeleteFolder</p>