1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Deployed 8dc0177cb2 to master with MkDocs 1.4.2 and mike 1.1.2

This commit is contained in:
GitHub Action 2023-03-24 14:31:29 +00:00
parent a01acf7026
commit ded190c659
15 changed files with 391 additions and 327 deletions

View File

@ -918,7 +918,7 @@
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
<p><code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
<p>IpcRegistrar.__@IpcPrefix@1584</p>
<p>IpcRegistrar.__@IpcPrefix@1590</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p><code>Protected</code> <code>Readonly</code> <strong>extension</strong>: <a href="../Common.LensExtension/"><code>LensExtension</code></a>&lt;<code>LensExtensionDependencies</code>></p>

View File

@ -918,7 +918,7 @@
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
<p><code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
<p>IpcRegistrar.__@IpcPrefix@1584</p>
<p>IpcRegistrar.__@IpcPrefix@1590</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p><code>Protected</code> <code>Readonly</code> <strong>extension</strong>: <a href="../Common.LensExtension/"><code>LensExtension</code></a>&lt;<code>LensExtensionDependencies</code>></p>

View File

@ -1664,6 +1664,8 @@
<hr />
<h3 id="getchildpods">getChildPods<a class="headerlink" href="#getchildpods" title="Permanent link">#</a></h3>
<p><strong>getChildPods</strong>(<code>daemonSet</code>): <a href="../Main.K8sApi.Pod/"><code>Pod</code></a>[]</p>
<p><strong><code>Deprecated</code></strong></p>
<p>Switch to using <code>getPodsByOwnerId</code> directly</p>
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
<table>
<thead>

View File

@ -1672,6 +1672,8 @@
<hr />
<h3 id="getchildpods">getChildPods<a class="headerlink" href="#getchildpods" title="Permanent link">#</a></h3>
<p><strong>getChildPods</strong>(<code>job</code>): <a href="../Main.K8sApi.Pod/"><code>Pod</code></a>[]</p>
<p><strong><code>Deprecated</code></strong></p>
<p>Switch to using <code>getPodsByOwnerId</code> directly</p>
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
<table>
<thead>

View File

@ -1672,6 +1672,8 @@
<hr />
<h3 id="getchildpods">getChildPods<a class="headerlink" href="#getchildpods" title="Permanent link">#</a></h3>
<p><strong>getChildPods</strong>(<code>replicaSet</code>): <a href="../Main.K8sApi.Pod/"><code>Pod</code></a>[]</p>
<p><strong><code>Deprecated</code></strong></p>
<p>Switch to using <code>getPodsByOwnerId</code> directly</p>
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
<table>
<thead>

View File

@ -1664,6 +1664,8 @@
<hr />
<h3 id="getchildpods">getChildPods<a class="headerlink" href="#getchildpods" title="Permanent link">#</a></h3>
<p><strong>getChildPods</strong>(<code>statefulSet</code>): <a href="../Main.K8sApi.Pod/"><code>Pod</code></a>[]</p>
<p><strong><code>Deprecated</code></strong></p>
<p>Switch to using <code>getPodsByOwnerId</code> directly</p>
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
<table>
<thead>

View File

@ -776,7 +776,7 @@
<h3 id="autoregister">autoRegister<a class="headerlink" href="#autoregister" title="Permanent link">#</a></h3>
<p><code>Optional</code> <strong>autoRegister</strong>: <code>boolean</code></p>
<p>If <code>true</code> then on creation of the <code>KubeApi</code>instance a call to <code>apiManager.registerApi</code> will be
made. This is <code>true</code> by default to maintain backwards compatability.</p>
made. This is <code>true</code> by default to maintain backwards compatibility.</p>
<p>Setting this to <code>false</code> might make <code>KubeObject</code>'s details drawer stop working.</p>
<p><strong><code>Default</code></strong></p>
<p>true</p>

View File

@ -789,7 +789,7 @@
<h1 id="interface-ignoredkubeapioptions">Interface: IgnoredKubeApiOptions<a class="headerlink" href="#interface-ignoredkubeapioptions" title="Permanent link">#</a></h1>
<p><a href="../../modules/Main/">Main</a>.<a href="../../modules/Main.K8sApi/">K8sApi</a>.IgnoredKubeApiOptions</p>
<p><strong><code>Deprecated</code></strong></p>
<p>This type is only present for backwards compatable typescript support</p>
<p>This type is only present for backwards compatible typescript support</p>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
<ul>

View File

@ -776,7 +776,7 @@
<h3 id="autoregister">autoRegister<a class="headerlink" href="#autoregister" title="Permanent link">#</a></h3>
<p><code>Optional</code> <strong>autoRegister</strong>: <code>boolean</code></p>
<p>If <code>true</code> then on creation of the <code>KubeApi</code>instance a call to <code>apiManager.registerApi</code> will be
made. This is <code>true</code> by default to maintain backwards compatability.</p>
made. This is <code>true</code> by default to maintain backwards compatibility.</p>
<p>Setting this to <code>false</code> might make <code>KubeObject</code>'s details drawer stop working.</p>
<p><strong><code>Default</code></strong></p>
<p>true</p>

View File

@ -789,7 +789,7 @@
<h1 id="interface-ignoredkubeapioptions">Interface: IgnoredKubeApiOptions<a class="headerlink" href="#interface-ignoredkubeapioptions" title="Permanent link">#</a></h1>
<p><a href="../../modules/Renderer/">Renderer</a>.<a href="../../modules/Renderer.K8sApi/">K8sApi</a>.IgnoredKubeApiOptions</p>
<p><strong><code>Deprecated</code></strong></p>
<p>This type is only present for backwards compatable typescript support</p>
<p>This type is only present for backwards compatible typescript support</p>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
<ul>

View File

@ -959,6 +959,13 @@
forRemoteCluster
</a>
</li>
<li class="md-nav__item">
<a href="#getpodsbyownerid" class="md-nav__link">
getPodsByOwnerId
</a>
</li>
<li class="md-nav__item">
@ -1077,6 +1084,7 @@
<li><a href="./#createresourcestack">createResourceStack</a></li>
<li><a href="./#forcluster">forCluster</a></li>
<li><a href="./#forremotecluster">forRemoteCluster</a></li>
<li><a href="./#getpodsbyownerid">getPodsByOwnerId</a></li>
<li><a href="./#isallowedresource">isAllowedResource</a></li>
</ul>
<h2 id="type-aliases_1">Type Aliases<a class="headerlink" href="#type-aliases_1" title="Permanent link">#</a></h2>
@ -1542,11 +1550,31 @@
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
<p><code>KubeApi</code>&lt;<code>Object</code>, <a href="./#kubejsonapidatafor"><code>KubeJsonApiDataFor</code></a>&lt;<code>Object</code>>></p>
<hr />
<h3 id="getpodsbyownerid">getPodsByOwnerId<a class="headerlink" href="#getpodsbyownerid" title="Permanent link">#</a></h3>
<p><strong>getPodsByOwnerId</strong>(<code>ownerId</code>): <a href="../../classes/Main.K8sApi.Pod/"><code>Pod</code></a>[]</p>
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" 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>ownerId</code></td>
<td align="left"><code>string</code></td>
</tr>
</tbody>
</table>
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
<p><a href="../../classes/Main.K8sApi.Pod/"><code>Pod</code></a>[]</p>
<hr />
<h3 id="isallowedresource">isAllowedResource<a class="headerlink" href="#isallowedresource" title="Permanent link">#</a></h3>
<p><strong>isAllowedResource</strong>(<code>...args</code>): <code>boolean</code></p>
<p><strong><code>Deprecated</code></strong></p>
<p>This function never works</p>
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
@ -1561,7 +1589,7 @@
</tr>
</tbody>
</table>
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
<p><code>boolean</code></p>
<p>false</p>

View File

@ -1525,6 +1525,13 @@
forRemoteCluster
</a>
</li>
<li class="md-nav__item">
<a href="#getpodsbyownerid" class="md-nav__link">
getPodsByOwnerId
</a>
</li>
<li class="md-nav__item">
@ -1725,6 +1732,7 @@
<li><a href="./#createresourcestack">createResourceStack</a></li>
<li><a href="./#forcluster">forCluster</a></li>
<li><a href="./#forremotecluster">forRemoteCluster</a></li>
<li><a href="./#getpodsbyownerid">getPodsByOwnerId</a></li>
<li><a href="./#isallowedresource">isAllowedResource</a></li>
<li><a href="./#requestmetrics-1">requestMetrics</a></li>
</ul>
@ -2379,9 +2387,29 @@
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
<p><code>KubeApi</code>&lt;<code>Object</code>, <a href="../Main.K8sApi/#kubejsonapidatafor"><code>KubeJsonApiDataFor</code></a>&lt;<code>Object</code>>></p>
<hr />
<h3 id="getpodsbyownerid">getPodsByOwnerId<a class="headerlink" href="#getpodsbyownerid" title="Permanent link">#</a></h3>
<p><strong>getPodsByOwnerId</strong>(<code>ownerId</code>): <a href="../../classes/Main.K8sApi.Pod/"><code>Pod</code></a>[]</p>
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" 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>ownerId</code></td>
<td align="left"><code>string</code></td>
</tr>
</tbody>
</table>
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
<p><a href="../../classes/Main.K8sApi.Pod/"><code>Pod</code></a>[]</p>
<hr />
<h3 id="isallowedresource">isAllowedResource<a class="headerlink" href="#isallowedresource" title="Permanent link">#</a></h3>
<p><strong>isAllowedResource</strong>(<code>resources</code>): <code>boolean</code></p>
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
@ -2396,12 +2424,12 @@
</tr>
</tbody>
</table>
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
<p><code>boolean</code></p>
<hr />
<h3 id="requestmetrics_1">requestMetrics<a class="headerlink" href="#requestmetrics_1" title="Permanent link">#</a></h3>
<p><strong>requestMetrics</strong>(<code>query</code>, <code>params?</code>): <code>Promise</code>&lt;<a href="../../interfaces/Renderer.K8sApi.MetricData/"><code>MetricData</code></a>></p>
<h4 id="parameters_12">Parameters<a class="headerlink" href="#parameters_12" title="Permanent link">#</a></h4>
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
@ -2420,10 +2448,10 @@
</tr>
</tbody>
</table>
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<a href="../../interfaces/Renderer.K8sApi.MetricData/"><code>MetricData</code></a>></p>
<p><strong>requestMetrics</strong>(<code>query</code>, <code>params?</code>): <code>Promise</code>&lt;<a href="../../interfaces/Renderer.K8sApi.MetricData/"><code>MetricData</code></a>[]></p>
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
@ -2442,7 +2470,7 @@
</tr>
</tbody>
</table>
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<a href="../../interfaces/Renderer.K8sApi.MetricData/"><code>MetricData</code></a>[]></p>
<p><strong>requestMetrics</strong>&lt;<code>Keys</code>>(<code>query</code>, <code>params?</code>): <code>Promise</code>&lt;<code>Record</code>&lt;<code>Keys</code>, <a href="../../interfaces/Renderer.K8sApi.MetricData/"><code>MetricData</code></a>>></p>
<h4 id="type-parameters_6">Type parameters<a class="headerlink" href="#type-parameters_6" title="Permanent link">#</a></h4>
@ -2460,7 +2488,7 @@
</tr>
</tbody>
</table>
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
<h4 id="parameters_15">Parameters<a class="headerlink" href="#parameters_15" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
@ -2479,7 +2507,7 @@
</tr>
</tbody>
</table>
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>Record</code>&lt;<code>Keys</code>, <a href="../../interfaces/Renderer.K8sApi.MetricData/"><code>MetricData</code></a>>></p>

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load Diff

Binary file not shown.