mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 994208b25a to master with MkDocs 1.2.3 and mike 1.1.2
This commit is contained in:
parent
8bb16b487e
commit
aafb3e9499
@ -904,7 +904,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@44453</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@44526</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>
|
||||
|
||||
@ -1007,7 +1007,7 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@30224</p>
|
||||
<p>LensExtension.__@Disposers@30498</p>
|
||||
<hr />
|
||||
<h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>appMenus</strong>: <code>MenuRegistration</code>[] = <code>[]</code></p>
|
||||
|
||||
@ -792,6 +792,13 @@
|
||||
props
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#ref" class="md-nav__link">
|
||||
ref
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@ -1052,6 +1059,7 @@
|
||||
<li><a href="./#closeonnavigate">closeOnNavigate</a></li>
|
||||
<li><a href="./#context">context</a></li>
|
||||
<li><a href="./#props">props</a></li>
|
||||
<li><a href="./#ref">ref</a></li>
|
||||
<li><a href="./#refs">refs</a></li>
|
||||
<li><a href="./#state">state</a></li>
|
||||
<li><a href="./#contexttype">contextType</a></li>
|
||||
@ -1155,6 +1163,9 @@ Should be used with type annotation or static contextType.</p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p>React.PureComponent.props</p>
|
||||
<hr />
|
||||
<h3 id="ref">ref<a class="headerlink" href="#ref" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>ref</strong>: <code>RefObject</code><<code>HTMLDivElement</code>></p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong>
|
||||
|
||||
@ -904,7 +904,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@44453</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@44526</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>
|
||||
|
||||
@ -1127,7 +1127,7 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@30224</p>
|
||||
<p>LensExtension.__@Disposers@30498</p>
|
||||
<hr />
|
||||
<h3 id="apppreferences">appPreferences<a class="headerlink" href="#apppreferences" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>appPreferences</strong>: <a href="../../interfaces/Common.Types.AppPreferenceRegistration/"><code>AppPreferenceRegistration</code></a>[] = <code>[]</code></p>
|
||||
|
||||
@ -1146,7 +1146,7 @@ These pages are visible in a cluster menu when a cluster is opened.</p>
|
||||
<span class="nx">topBarItems</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="p">{</span>
|
||||
<span class="nx">components</span><span class="o">:</span> <span class="p">{</span>
|
||||
<span class="nx">Item</span><span class="o">:</span> <span class="p">(</span>
|
||||
<span class="nx">Item</span><span class="o">:</span> <span class="p">()</span> <span class="p">=></span> <span class="p">(</span>
|
||||
<span class="o"><</span><span class="nx">Icon</span> <span class="nx">material</span><span class="o">=</span><span class="s2">"favorite"</span> <span class="nx">onClick</span><span class="o">=</span><span class="p">{()</span> <span class="p">=></span> <span class="k">this</span><span class="p">.</span><span class="nx">navigate</span><span class="p">(</span><span class="s2">"/example-page"</span> <span class="o">/></span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">}</span>
|
||||
@ -1169,7 +1169,7 @@ These pages are visible in a cluster menu when a cluster is opened.</p>
|
||||
<span class="nx">statusBarItems</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="p">{</span>
|
||||
<span class="nx">components</span><span class="o">:</span> <span class="p">{</span>
|
||||
<span class="nx">Item</span><span class="o">:</span> <span class="p">(</span>
|
||||
<span class="nx">Item</span><span class="o">:</span> <span class="p">()</span> <span class="p">=></span> <span class="p">(</span>
|
||||
<span class="o"><</span><span class="nx">div</span> <span class="nx">className</span><span class="o">=</span><span class="s2">"flex align-center gaps hover-highlight"</span> <span class="nx">onClick</span><span class="o">=</span><span class="p">{()</span> <span class="p">=></span> <span class="k">this</span><span class="p">.</span><span class="nx">navigate</span><span class="p">(</span><span class="s2">"/example-page"</span><span class="p">)}</span> <span class="o">></span>
|
||||
<span class="o"><</span><span class="nx">Icon</span> <span class="nx">material</span><span class="o">=</span><span class="s2">"favorite"</span> <span class="o">/></span>
|
||||
<span class="o"><</span><span class="err">/div></span>
|
||||
@ -1188,7 +1188,7 @@ These pages are visible in a cluster menu when a cluster is opened.</p>
|
||||
<span class="k">export</span> <span class="k">default</span> <span class="kd">class</span> <span class="nx">ExampleExtension</span> <span class="k">extends</span> <span class="nx">Renderer</span><span class="p">.</span><span class="nx">LensExtension</span> <span class="p">{</span>
|
||||
<span class="nx">kubeWorkloadsOverviewItems</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="p">{</span>
|
||||
<span class="nx">components</span> <span class="o">:</span> <span class="p">{</span>
|
||||
<span class="nx">components</span><span class="o">:</span> <span class="p">{</span>
|
||||
<span class="nx">Details</span><span class="o">:</span> <span class="p">()</span> <span class="p">=></span> <span class="o"><</span><span class="nx">CustomWorkloadsOverviewItem</span> <span class="o">/></span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
@ -1417,7 +1417,7 @@ It configures the status bar item to navigate to the global page upon activation
|
||||
<span class="nx">statusBarItems</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="p">{</span>
|
||||
<span class="nx">components</span><span class="o">:</span> <span class="p">{</span>
|
||||
<span class="nx">Item</span><span class="o">:</span> <span class="p">(</span>
|
||||
<span class="nx">Item</span><span class="o">:</span> <span class="p">()</span> <span class="p">=></span> <span class="p">(</span>
|
||||
<span class="o"><</span><span class="nx">div</span>
|
||||
<span class="nx">className</span><span class="o">=</span><span class="s2">"flex align-center gaps"</span>
|
||||
<span class="nx">onClick</span><span class="o">=</span><span class="p">{()</span> <span class="p">=></span> <span class="k">this</span><span class="p">.</span><span class="nx">navigate</span><span class="p">(</span><span class="s2">"help"</span><span class="p">)}</span>
|
||||
|
||||
@ -742,8 +742,8 @@ It could be applied automatically to a cluster by the extension, or the end-user
|
||||
|
||||
<span class="kd">const</span> <span class="p">{</span>
|
||||
<span class="nx">K8sApi</span><span class="o">:</span> <span class="p">{</span>
|
||||
<span class="nx">ResourceStack</span><span class="p">,</span>
|
||||
<span class="nx">forCluster</span><span class="p">,</span>
|
||||
<span class="nx">ResourceStack</span><span class="p">,</span>
|
||||
<span class="nx">forCluster</span><span class="p">,</span>
|
||||
<span class="nx">Pod</span><span class="p">,</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span> <span class="o">=</span> <span class="nx">Renderer</span><span class="p">;</span>
|
||||
@ -792,11 +792,11 @@ It could be applied automatically to a cluster by the extension, or the end-user
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
<p>The <code>ExampleClusterFeature</code> class constructor takes a <code>Common.Catalog.KubernetesCluster</code> argument.
|
||||
This is the cluster that the resource stack will be applied to, and the constructor instantiates a <code>Renderer.K8sApi.ResourceStack</code> as such.
|
||||
This is the cluster that the resource stack will be applied to, and the constructor instantiates a <code>Renderer.K8sApi.ResourceStack</code> as such.
|
||||
<code>ExampleClusterFeature</code> implements an <code>install()</code> method which simply invokes the <code>kubectlApplyFolder()</code> method of the <code>Renderer.K8sApi.ResourceStack</code> class.
|
||||
<code>kubectlApplyFolder()</code> applies to the cluster all kubernetes resources found in the folder passed to it, in this case <code>../resources</code>.
|
||||
<code>kubectlApplyFolder()</code> applies to the cluster all kubernetes resources found in the folder passed to it, in this case <code>../resources</code>.
|
||||
Similarly, <code>ExampleClusterFeature</code> implements an <code>uninstall()</code> method which simply invokes the <code>kubectlDeleteFolder()</code> method of the <code>Renderer.K8sApi.ResourceStack</code> class.
|
||||
<code>kubectlDeleteFolder()</code> tries to delete from the cluster all kubernetes resources found in the folder passed to it, again in this case <code>../resources</code>. </p>
|
||||
<code>kubectlDeleteFolder()</code> tries to delete from the cluster all kubernetes resources found in the folder passed to it, again in this case <code>../resources</code>.</p>
|
||||
<p><code>ExampleClusterFeature</code> also implements an <code>isInstalled()</code> method, which demonstrates how you can utilize the kubernetes api to inspect the resource stack status.
|
||||
<code>isInstalled()</code> simply tries to find a pod named <code>example-pod</code>, as a way to determine if the pod is already installed.
|
||||
This method can be useful in creating a context-sensitive UI for installing/uninstalling the feature, as demonstrated in the next sample code.</p>
|
||||
@ -906,11 +906,9 @@ The <code>ExampleExtension</code> would look like this:</p>
|
||||
<span class="nx">title</span><span class="o">:</span> <span class="s2">"Example Cluster Feature"</span><span class="p">,</span>
|
||||
<span class="nx">priority</span>: <span class="kt">5</span><span class="p">,</span>
|
||||
<span class="nx">components</span><span class="o">:</span> <span class="p">{</span>
|
||||
<span class="nx">View</span><span class="o">:</span> <span class="p">({</span> <span class="nx">entity</span> <span class="o">=</span> <span class="kc">null</span> <span class="p">}</span><span class="o">:</span> <span class="p">{</span> <span class="nx">entity</span>: <span class="kt">Common.Catalog.KubernetesCluster</span><span class="p">})</span> <span class="p">=></span> <span class="p">{</span>
|
||||
<span class="k">return</span> <span class="p">(</span>
|
||||
<span class="o"><</span><span class="nx">ExampleClusterFeatureSettings</span> <span class="nx">cluster</span><span class="o">=</span><span class="p">{</span><span class="nx">entity</span><span class="p">}</span> <span class="o">/></span>
|
||||
<span class="p">);</span>
|
||||
<span class="p">}</span>
|
||||
<span class="nx">View</span><span class="o">:</span> <span class="p">({</span> <span class="nx">entity</span> <span class="o">=</span> <span class="kc">null</span> <span class="p">}</span><span class="o">:</span> <span class="p">{</span> <span class="nx">entity</span>: <span class="kt">Common.Catalog.KubernetesCluster</span><span class="p">})</span> <span class="p">=></span> <span class="p">(</span>
|
||||
<span class="o"><</span><span class="nx">ExampleClusterFeatureSettings</span> <span class="nx">cluster</span><span class="o">=</span><span class="p">{</span><span class="nx">entity</span><span class="p">}</span> <span class="o">/></span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
<span class="p">];</span>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Binary file not shown.
Loading…
Reference in New Issue
Block a user