Deployed 9b9b8e0d05 to master with MkDocs 1.2.3 and mike 1.1.2

This commit is contained in:
GitHub Action committed 2022-02-10 21:11:12 +00:00
1 parent e826feb554
commit 6d20ddfd30
11 files changed
+976 -15

No files matched your search

@@ -88,7 +88,7 @@
<div data-md-component="skip">
<a href="#class-kubernetescluster" class="md-skip">
<a href="#class-kubernetesclustermetadata-status-spec" class="md-skip">
Skip to content
</a>
@@ -126,7 +126,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Class: KubernetesCluster
Class: KubernetesCluster<Metadata, Status, Spec\>
</span>
</div>
@@ -711,6 +711,13 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#type-parameters" class="md-nav__link">
Type parameters
</a>
</li>
<li class="md-nav__item">
<a href="#hierarchy" class="md-nav__link">
Hierarchy
@@ -931,13 +938,36 @@
<h1 id="class-kubernetescluster">Class: KubernetesCluster<a class="headerlink" href="#class-kubernetescluster" title="Permanent link">#</a></h1>
<h1 id="class-kubernetesclustermetadata-status-spec">Class: KubernetesCluster&lt;Metadata, Status, Spec><a class="headerlink" href="#class-kubernetesclustermetadata-status-spec" title="Permanent link">#</a></h1>
<p><a href="../../modules/Common/">Common</a>.<a href="../../modules/Common.Catalog/">Catalog</a>.KubernetesCluster</p>
<p>Copyright (c) OpenLens Authors. All rights reserved.
Licensed under MIT License. See LICENSE in root directory for more information.</p>
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>Metadata</code></td>
<td align="left">extends <a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a><a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a></td>
</tr>
<tr>
<td align="left"><code>Status</code></td>
<td align="left">extends <a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a><a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a></td>
</tr>
<tr>
<td align="left"><code>Spec</code></td>
<td align="left">extends <a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a><a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a></td>
</tr>
</tbody>
</table>
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
<ul>
<li><a href="../Common.Catalog.CatalogEntity/"><code>CatalogEntity</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>></li>
<li><a href="../Common.Catalog.CatalogEntity/"><code>CatalogEntity</code></a>&lt;<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></li>
</ul>
<p>↳ <strong><code>KubernetesCluster</code></strong></p>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
@@ -970,7 +1000,30 @@ Licensed under MIT License. See LICENSE in root directory for more information.<
</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>
<p>• <strong>new KubernetesCluster</strong>(<code>__namedParameters</code>)</p>
<p>• <strong>new KubernetesCluster</strong>&lt;<code>Metadata</code>, <code>Status</code>, <code>Spec</code>>(<code>__namedParameters</code>)</p>
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" 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>Metadata</code></td>
<td align="left">extends <a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a><a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a></td>
</tr>
<tr>
<td align="left"><code>Status</code></td>
<td align="left">extends <a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a><a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a></td>
</tr>
<tr>
<td align="left"><code>Spec</code></td>
<td align="left">extends <a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a>&lt;<code>Spec</code>><a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a></td>
</tr>
</tbody>
</table>
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
<table>
<thead>
@@ -982,7 +1035,7 @@ Licensed under MIT License. See LICENSE in root directory for more information.<
<tbody>
<tr>
<td align="left"><code>__namedParameters</code></td>
<td align="left"><a href="../../interfaces/Common.Catalog.CatalogEntityData/"><code>CatalogEntityData</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>></td>
<td align="left"><a href="../../interfaces/Common.Catalog.CatalogEntityData/"><code>CatalogEntityData</code></a>&lt;<code>Metadata</code>, <code>Status</code>, <code>Spec</code>></td>
</tr>
</tbody>
</table>
@@ -1002,17 +1055,17 @@ Licensed under MIT License. See LICENSE in root directory for more information.<
<p><a href="../Common.Catalog.CatalogEntity/">CatalogEntity</a>.<a href="../Common.Catalog.CatalogEntity/#kind">kind</a></p>
<hr />
<h3 id="metadata">metadata<a class="headerlink" href="#metadata" title="Permanent link">#</a></h3>
<p>• <strong>metadata</strong>: <a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a></p>
<p>• <strong>metadata</strong>: <code>Metadata</code></p>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<p><a href="../Common.Catalog.CatalogEntity/">CatalogEntity</a>.<a href="../Common.Catalog.CatalogEntity/#metadata">metadata</a></p>
<hr />
<h3 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">#</a></h3>
<p>• <strong>spec</strong>: <a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a></p>
<p>• <strong>spec</strong>: <code>Spec</code></p>
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
<p><a href="../Common.Catalog.CatalogEntity/">CatalogEntity</a>.<a href="../Common.Catalog.CatalogEntity/#spec">spec</a></p>
<hr />
<h3 id="status">status<a class="headerlink" href="#status" title="Permanent link">#</a></h3>
<p>• <strong>status</strong>: <a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a></p>
<p>• <strong>status</strong>: <code>Status</code></p>
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
<p><a href="../Common.Catalog.CatalogEntity/">CatalogEntity</a>.<a href="../Common.Catalog.CatalogEntity/#status">status</a></p>
<hr />
@@ -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@47005</p>
<p>IpcRegistrar.__@IpcPrefix@47023</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code></p>
@@ -834,6 +834,13 @@
protocolHandlers
</a>
</li>
<li class="md-nav__item">
<a href="#terminalshellenvmodifier" class="md-nav__link">
terminalShellEnvModifier
</a>
</li>
<li class="md-nav__item">
@@ -1007,6 +1014,7 @@
<li><a href="./#manifest">manifest</a></li>
<li><a href="./#manifestpath">manifestPath</a></li>
<li><a href="./#protocolhandlers">protocolHandlers</a></li>
<li><a href="./#terminalshellenvmodifier">terminalShellEnvModifier</a></li>
<li><a href="./#traymenus">trayMenus</a></li>
</ul>
<h3 id="accessors">Accessors<a class="headerlink" href="#accessors" title="Permanent link">#</a></h3>
@@ -1083,6 +1091,16 @@
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
<p>LensExtension.protocolHandlers</p>
<hr />
<h3 id="terminalshellenvmodifier">terminalShellEnvModifier<a class="headerlink" href="#terminalshellenvmodifier" title="Permanent link">#</a></h3>
<p>• <code>Optional</code> <strong>terminalShellEnvModifier</strong>: <a href="../../modules/Common.Types/#shellenvmodifier"><code>ShellEnvModifier</code></a></p>
<p>implement this to modify the shell environment that Lens terminals are opened with. The ShellEnvModifier type has the signature</p>
<p>(ctx: ShellEnvContext, env: Record<string, string | undefined>) =&gt; Record<string, string | undefined></p>
<p><strong><code>param</code></strong> the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get
cluster-specific information that can be made available in the shell environment by the implementation of terminalShellEnvModifier</p>
<p><strong><code>param</code></strong> the current shell environment that the terminal will be opened with. The implementation should modify this as desired.</p>
<p><strong><code>returns</code></strong> the modified shell environment that the terminal will be opened with. The implementation must return env as passed in, if it
does not modify the shell environment</p>
<hr />
<h3 id="traymenus">trayMenus<a class="headerlink" href="#traymenus" title="Permanent link">#</a></h3>
<p>• <strong>trayMenus</strong>: <code>TrayMenuRegistration</code>[] = <code>[]</code></p>
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
@@ -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@47005</p>
<p>IpcRegistrar.__@IpcPrefix@47023</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code></p>
@@ -896,7 +896,7 @@
<tbody>
<tr>
<td align="left"><code>cluster</code></td>
<td align="left"><a href="../Common.Catalog.KubernetesCluster/"><code>KubernetesCluster</code></a></td>
<td align="left"><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>></td>
</tr>
<tr>
<td align="left"><code>name</code></td>
@@ -906,7 +906,7 @@
</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></p>
<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>
@@ -1420,7 +1420,7 @@ called when the extension is created within a cluster frame.</p>
<tbody>
<tr>
<td align="left"><code>cluster</code></td>
<td align="left"><a href="../Common.Catalog.KubernetesCluster/"><code>KubernetesCluster</code></a></td>
<td align="left"><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>></td>
</tr>
</tbody>
</table>