hendrik/lens
1
0 Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Deployed 49935a7306 to master with MkDocs 1.2.1 and mike 1.0.1

Browse Source
This commit is contained in:
GitHub Action committed 2021-06-18 15:41:36 +00:00
1 parent 7779bd34a6
commit b99c4052b5
272 files changed
+10372 -324
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

master/extensions/guides/renderer-extension/index.html
+166 -271
View File
@@ -88,7 +88,7 @@
<div data-md-component="skip">
<a href="#renderer-extension" class="md-skip">
<a href="#renderer-extension-wip" class="md-skip">
Skip to content
</a>
@@ -532,11 +532,11 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#lensrendererextension-class" class="md-nav__link">
LensRendererExtension Class
<a href="#rendererlensextension-class" class="md-nav__link">
Renderer.LensExtension Class
</a>
<nav class="md-nav" aria-label="LensRendererExtension Class">
<nav class="md-nav" aria-label="Renderer.LensExtension Class">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -568,15 +568,8 @@
</li>
<li class="md-nav__item">
<a href="#globalpagemenus" class="md-nav__link">
globalPageMenus
</a>
</li>
<li class="md-nav__item">
<a href="#clusterfeatures" class="md-nav__link">
clusterFeatures
<a href="#welcomemenus" class="md-nav__link">
welcomeMenus
</a>
</li>
@@ -586,6 +579,13 @@
appPreferences
</a>
</li>
<li class="md-nav__item">
<a href="#topbaritems" class="md-nav__link">
topBarItems
</a>
</li>
<li class="md-nav__item">
@@ -607,6 +607,48 @@
kubeObjectDetailItems
</a>
</li>
<li class="md-nav__item">
<a href="#kubeobjectstatustexts" class="md-nav__link">
kubeObjectStatusTexts
</a>
</li>
<li class="md-nav__item">
<a href="#kubeworkloadsoverviewitems" class="md-nav__link">
kubeWorkloadsOverviewItems
</a>
</li>
<li class="md-nav__item">
<a href="#entitysettings" class="md-nav__link">
entitySettings
</a>
</li>
<li class="md-nav__item">
<a href="#catalogentitydetailitems" class="md-nav__link">
catalogEntityDetailItems
</a>
</li>
<li class="md-nav__item">
<a href="#commandpalettecommands" class="md-nav__link">
commandPaletteCommands
</a>
</li>
<li class="md-nav__item">
<a href="#protocolhandlers" class="md-nav__link">
protocolHandlers
</a>
</li>
</ul>
@@ -628,6 +670,34 @@
<li class="md-nav__item">
<a href="../catalog/" class="md-nav__link">
Catalog
</a>
</li>
<li class="md-nav__item">
<a href="../resource-stack/" class="md-nav__link">
Resource Stack
</a>
</li>
<li class="md-nav__item">
<a href="../stores/" class="md-nav__link">
Stores
@@ -788,11 +858,11 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#lensrendererextension-class" class="md-nav__link">
LensRendererExtension Class
<a href="#rendererlensextension-class" class="md-nav__link">
Renderer.LensExtension Class
</a>
<nav class="md-nav" aria-label="LensRendererExtension Class">
<nav class="md-nav" aria-label="Renderer.LensExtension Class">
<ul class="md-nav__list">
<li class="md-nav__item">
@@ -824,15 +894,8 @@
</li>
<li class="md-nav__item">
<a href="#globalpagemenus" class="md-nav__link">
globalPageMenus
</a>
</li>
<li class="md-nav__item">
<a href="#clusterfeatures" class="md-nav__link">
clusterFeatures
<a href="#welcomemenus" class="md-nav__link">
welcomeMenus
</a>
</li>
@@ -842,6 +905,13 @@
appPreferences
</a>
</li>
<li class="md-nav__item">
<a href="#topbaritems" class="md-nav__link">
topBarItems
</a>
</li>
<li class="md-nav__item">
@@ -863,6 +933,48 @@
kubeObjectDetailItems
</a>
</li>
<li class="md-nav__item">
<a href="#kubeobjectstatustexts" class="md-nav__link">
kubeObjectStatusTexts
</a>
</li>
<li class="md-nav__item">
<a href="#kubeworkloadsoverviewitems" class="md-nav__link">
kubeWorkloadsOverviewItems
</a>
</li>
<li class="md-nav__item">
<a href="#entitysettings" class="md-nav__link">
entitySettings
</a>
</li>
<li class="md-nav__item">
<a href="#catalogentitydetailitems" class="md-nav__link">
catalogEntityDetailItems
</a>
</li>
<li class="md-nav__item">
<a href="#commandpalettecommands" class="md-nav__link">
commandPaletteCommands
</a>
</li>
<li class="md-nav__item">
<a href="#protocolhandlers" class="md-nav__link">
protocolHandlers
</a>
</li>
</ul>
@@ -884,25 +996,38 @@
<h1 id="renderer-extension">Renderer Extension<a class="headerlink" href="#renderer-extension" title="Permanent link">#</a></h1>
<h1 id="renderer-extension-wip">Renderer Extension (WIP)<a class="headerlink" href="#renderer-extension-wip" title="Permanent link">#</a></h1>
<p>The Renderer Extension API is the interface to Lens's renderer process.
Lens runs in both the main and renderer processes.
The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, and run custom code in Lens's renderer process.</p>
The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, protocol handlers, and command palette commands, as well as run custom code in Lens's renderer process.</p>
<p>The custom Lens UI elements that you can add include:</p>
<ul>
<li><a href="#clusterpages">Cluster pages</a></li>
<li><a href="#clusterpagemenus">Cluster page menus</a></li>
<li><a href="#globalpages">Global pages</a></li>
<li><a href="#globalpagemenus">Global page menus</a></li>
<li><a href="#welcomemenus">Welcome menus</a></li>
<li><a href="#apppreferences">App preferences</a></li>
<li><a href="#topbaritems">Top bar items</a></li>
<li><a href="#statusbaritems">Status bar items</a></li>
<li><a href="#kubeobjectmenuitems">KubeObject menu items</a></li>
<li><a href="#kubeobjectdetailitems">KubeObject detail items</a></li>
<li><a href="#kubeobjectstatustexts">KubeObject status texts</a></li>
<li><a href="#kubeworkloadsoverviewitems">Kube workloads overview items</a></li>
</ul>
<p>as well as catalog-related UI elements:</p>
<ul>
<li><a href="#entitysettings">Entity settings</a></li>
<li><a href="#catalogentitydetailitems">Catalog entity detail items</a></li>
</ul>
<p>All UI elements are based on React components.</p>
<h2 id="lensrendererextension-class"><code>LensRendererExtension</code> Class<a class="headerlink" href="#lensrendererextension-class" title="Permanent link">#</a></h2>
<p>Finally, you can also add commands and protocol handlers:</p>
<ul>
<li><a href="#commandpalettecommands">Command palette commands</a></li>
<li><a href="../protocol-handlers/">protocol handlers</a></li>
</ul>
<h2 id="rendererlensextension-class"><code>Renderer.LensExtension</code> Class<a class="headerlink" href="#rendererlensextension-class" title="Permanent link">#</a></h2>
<h3 id="onactivate-and-ondeactivate-methods"><code>onActivate()</code> and <code>onDeactivate()</code> Methods<a class="headerlink" href="#onactivate-and-ondeactivate-methods" title="Permanent link">#</a></h3>
<p>To create a renderer extension, extend the <code>LensRendererExtension</code> class:</p>
<p>To create a renderer extension, extend the <code>Renderer.LensExtension</code> class:</p>
<div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Renderer</span> <span class="p">}</span> <span class="k">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span><span class="p">;</span>
<span class="k">export</span> <span class="k">default</span> <span class="kd">class</span> <span class="nx">ExampleExtensionMain</span> <span class="k">extends</span> <span class="nx">Renderer</span><span class="p">.</span><span class="nx">LensExtension</span> <span class="p">{</span>
@@ -1162,245 +1287,7 @@ Global pages can be made available in the following ways:</p>
<li>To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see <a href="#statusbaritems"><code>statusBarItems</code></a>.</li>
<li>To add global pages to the left side menu, see <a href="#globalpagemenus"><code>globalPageMenus</code></a>.</li>
</ul>
<h3 id="globalpagemenus"><code>globalPageMenus</code><a class="headerlink" href="#globalpagemenus" title="Permanent link">#</a></h3>
<p><code>globalPageMenus</code> allows you to add global page menu items to the left nav.</p>
<p>By expanding on the above example, you can add a global page menu item to the <code>HelpExtension</code> definition:</p>
<div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Renderer</span> <span class="p">}</span> <span class="k">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span><span class="p">;</span>
<span class="k">import</span> <span class="p">{</span> <span class="nx">HelpIcon</span><span class="p">,</span> <span class="nx">HelpPage</span> <span class="p">}</span> <span class="k">from</span> <span class="s2">&quot;./page&quot;</span>
<span class="k">import</span> <span class="nx">React</span> <span class="k">from</span> <span class="s2">&quot;react&quot;</span>
<span class="k">export</span> <span class="k">default</span> <span class="kd">class</span> <span class="nx">HelpExtension</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">globalPages</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">{</span>
<span class="nx">id</span><span class="o">:</span> <span class="s2">&quot;help&quot;</span><span class="p">,</span>
<span class="nx">components</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">Page</span><span class="o">:</span> <span class="p">()</span> <span class="o">=&gt;</span> <span class="o">&lt;</span><span class="nx">HelpPage</span> <span class="nx">extension</span><span class="o">=</span><span class="p">{</span><span class="k">this</span><span class="p">}</span><span class="o">/&gt;</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">];</span>
<span class="nx">globalPageMenus</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">{</span>
<span class="nx">target</span><span class="o">:</span> <span class="p">{</span> <span class="nx">pageId</span><span class="o">:</span> <span class="s2">&quot;help&quot;</span> <span class="p">},</span>
<span class="nx">title</span><span class="o">:</span> <span class="s2">&quot;Help&quot;</span><span class="p">,</span>
<span class="nx">components</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">Icon</span>: <span class="kt">HelpIcon</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">];</span>
<span class="p">}</span>
</code></pre></div>
<p><code>globalPageMenus</code> is an array of objects that satisfy the <code>PageMenuRegistration</code> interface.
This element defines how the global page menu item will appear and what it will do when you click it.
The properties of the <code>globalPageMenus</code> array objects are defined as follows:</p>
<ul>
<li><code>target</code> links to the relevant global page using <code>pageId</code>.</li>
<li><code>pageId</code> takes the value of the relevant global page's <code>id</code> property.</li>
<li><code>title</code> sets the name of the global page menu item that will display as a tooltip in the left nav.</li>
<li><code>components</code> is used to set an icon that appears in the left nav.</li>
</ul>
<p>The above example creates a "Help" icon menu item.
When users click the icon, the Lens UI will display the contents of <code>ExamplePage</code>.</p>
<p>This example requires the definition of another React-based component, <code>HelpIcon</code>.
Update <code>page.tsx</code> from the example above with the <code>HelpIcon</code> definition, as follows:</p>
<div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Renderer</span> <span class="p">}</span> <span class="k">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span><span class="p">;</span>
<span class="k">import</span> <span class="nx">React</span> <span class="k">from</span> <span class="s2">&quot;react&quot;</span>
<span class="kd">type</span> <span class="nx">IconProps</span> <span class="o">=</span> <span class="nx">Renderer</span><span class="p">.</span><span class="nx">Component</span><span class="p">.</span><span class="nx">IconProps</span><span class="p">;</span>
<span class="kd">const</span> <span class="p">{</span>
<span class="nx">Component</span><span class="o">:</span> <span class="p">{</span> <span class="nx">Icon</span> <span class="p">},</span>
<span class="p">}</span> <span class="o">=</span> <span class="nx">Renderer</span><span class="p">;</span>
<span class="k">export</span> <span class="kd">function</span> <span class="nx">HelpIcon</span><span class="p">(</span><span class="nx">props</span>: <span class="kt">IconProps</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">&lt;</span><span class="nx">Icon</span> <span class="p">{...</span><span class="nx">props</span><span class="p">}</span> <span class="nx">material</span><span class="o">=</span><span class="s2">&quot;help&quot;</span><span class="o">/&gt;</span>
<span class="p">}</span>
<span class="k">export</span> <span class="kd">class</span> <span class="nx">HelpPage</span> <span class="k">extends</span> <span class="nx">React</span><span class="p">.</span><span class="nx">Component</span><span class="o">&lt;</span><span class="p">{</span> <span class="nx">extension</span>: <span class="kt">Renderer.LensExtension</span> <span class="p">}</span><span class="o">&gt;</span> <span class="p">{</span>
<span class="nx">render</span><span class="p">()</span> <span class="p">{</span>
<span class="k">return</span> <span class="p">(</span>
<span class="o">&lt;</span><span class="nx">div</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="nx">p</span><span class="o">&gt;</span><span class="nx">Help</span><span class="o">&lt;</span><span class="err">/p&gt;</span>
<span class="o">&lt;</span><span class="err">/div&gt;</span>
<span class="p">)</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<p>Lens includes various built-in components available for extension developers to use.
One of these is the <code>Renderer.Component.Icon</code>, introduced in <code>HelpIcon</code>, which you can use to access any of the <a href="https://material.io/resources/icons/">icons</a> available at <a href="https://material.io">Material Design</a>.
The property that <code>Renderer.Component.Icon</code> uses is defined as follows:</p>
<ul>
<li><code>material</code> takes the name of the icon you want to use.</li>
</ul>
<p>This is what the example will look like, including how the menu item will appear in the left nav:</p>
<p><img alt="globalPageMenus" src="../images/globalpagemenus.png" /></p>
<h3 id="clusterfeatures"><code>clusterFeatures</code><a class="headerlink" href="#clusterfeatures" title="Permanent link">#</a></h3>
<p>Cluster features are Kubernetes resources that can be applied to and managed within the active cluster.
They can be installed and uninstalled by the Lens user from the cluster <strong>Settings</strong> page.</p>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>To access the cluster <strong>Settings</strong> page, right-click the relevant cluster in the left side menu and click <strong>Settings</strong>.</p>
</div>
<p>The following example shows how to add a cluster feature as part of a <code>LensRendererExtension</code>:</p>
<div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Renderer</span> <span class="p">}</span> <span class="k">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span>
<span class="k">import</span> <span class="p">{</span> <span class="nx">ExampleFeature</span> <span class="p">}</span> <span class="k">from</span> <span class="s2">&quot;./src/example-feature&quot;</span>
<span class="k">import</span> <span class="nx">React</span> <span class="k">from</span> <span class="s2">&quot;react&quot;</span>
<span class="k">export</span> <span class="k">default</span> <span class="kd">class</span> <span class="nx">ExampleFeatureExtension</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">clusterFeatures</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">{</span>
<span class="nx">title</span><span class="o">:</span> <span class="s2">&quot;Example Feature&quot;</span><span class="p">,</span>
<span class="nx">components</span><span class="o">:</span> <span class="p">{</span>
<span class="nx">Description</span><span class="o">:</span> <span class="p">()</span> <span class="o">=&gt;</span> <span class="p">{</span>
<span class="k">return</span> <span class="p">(</span>
<span class="o">&lt;</span><span class="nx">span</span><span class="o">&gt;</span>
<span class="nx">Enable</span> <span class="nx">an</span> <span class="nx">example</span> <span class="nx">feature</span><span class="p">.</span>
<span class="o">&lt;</span><span class="err">/span&gt;</span>
<span class="p">)</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="nx">feature</span>: <span class="kt">new</span> <span class="nx">ExampleFeature</span><span class="p">()</span>
<span class="p">}</span>
<span class="p">];</span>
<span class="p">}</span>
</code></pre></div>
<p>The properties of the <code>clusterFeatures</code> array objects are defined as follows:</p>
<ul>
<li><code>title</code> and <code>components.Description</code> provide content that appears on the cluster settings page, in the <strong>Features</strong> section.</li>
<li><code>feature</code> specifies an instance which extends the abstract class <code>ClusterFeature.Feature</code>, and specifically implements the following methods:</li>
</ul>
<div class="highlight"><pre><span></span><code> <span class="k">abstract</span> <span class="nx">install</span><span class="p">(</span><span class="nx">cluster</span>: <span class="kt">Cluster</span><span class="p">)</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="k">void</span><span class="o">&gt;</span><span class="p">;</span>
<span class="k">abstract</span> <span class="nx">upgrade</span><span class="p">(</span><span class="nx">cluster</span>: <span class="kt">Cluster</span><span class="p">)</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="k">void</span><span class="o">&gt;</span><span class="p">;</span>
<span class="k">abstract</span> <span class="nx">uninstall</span><span class="p">(</span><span class="nx">cluster</span>: <span class="kt">Cluster</span><span class="p">)</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="k">void</span><span class="o">&gt;</span><span class="p">;</span>
<span class="k">abstract</span> <span class="nx">updateStatus</span><span class="p">(</span><span class="nx">cluster</span>: <span class="kt">Cluster</span><span class="p">)</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="nx">ClusterFeatureStatus</span><span class="o">&gt;</span><span class="p">;</span>
</code></pre></div>
<p>The four methods listed above are defined as follows:</p>
<ul>
<li>
<p>The <code>install()</code> method installs Kubernetes resources using the <code>applyResources()</code> method, or by directly accessing the <a href="../../api/">Kubernetes API</a>.
This method is typically called when a user indicates that they want to install the feature (i.e., by clicking <strong>Install</strong> for the feature in the cluster settings page).</p>
</li>
<li>
<p>The <code>upgrade()</code> method upgrades the Kubernetes resources already installed, if they are relevant to the feature.
This method is typically called when a user indicates that they want to upgrade the feature (i.e., by clicking <strong>Upgrade</strong> for the feature in the cluster settings page).</p>
</li>
<li>
<p>The <code>uninstall()</code> method uninstalls Kubernetes resources using the <a href="../../api/">Kubernetes API</a>.
This method is typically called when a user indicates that they want to uninstall the feature (i.e., by clicking <strong>Uninstall</strong> for the feature in the cluster settings page).</p>
</li>
<li>
<p>The <code>updateStatus()</code> method provides the current status information in the <code>status</code> field of the <code>ClusterFeature.Feature</code> parent class.
Lens periodically calls this method to determine details about the feature's current status.
The implementation of this method should uninstall Kubernetes resources using the Kubernetes api (<code>K8sApi</code>)
Consider using the following properties with <code>updateStatus()</code>:</p>
<ul>
<li>
<p><code>status.currentVersion</code> and <code>status.latestVersion</code> may be displayed by Lens in the feature's description.</p>
</li>
<li>
<p><code>status.installed</code> should be set to <code>true</code> if the feature is installed, and <code>false</code> otherwise.</p>
</li>
<li>
<p><code>status.canUpgrade</code> is set according to a rule meant to determine whether the feature can be upgraded.
This rule can involve <code>status.currentVersion</code> and <code>status.latestVersion</code>, if desired.</p>
</li>
</ul>
</li>
</ul>
<p>The following shows a very simple implementation of a <code>ClusterFeature</code>:</p>
<div class="highlight"><pre><span></span><code><span class="k">import</span> <span class="p">{</span> <span class="nx">Renderer</span><span class="p">,</span> <span class="nx">Common</span> <span class="p">}</span> <span class="k">from</span> <span class="s2">&quot;@k8slens/extensions&quot;</span><span class="p">;</span>
<span class="k">import</span> <span class="o">*</span> <span class="kr">as</span> <span class="nx">path</span> <span class="k">from</span> <span class="s2">&quot;path&quot;</span><span class="p">;</span>
<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">StorageClass</span><span class="p">,</span>
<span class="nx">Namespace</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>
<span class="kd">type</span> <span class="nx">ResourceStack</span> <span class="o">=</span> <span class="nx">Renderer</span><span class="p">.</span><span class="nx">K8sApi</span><span class="p">.</span><span class="nx">ResourceStack</span><span class="p">;</span>
<span class="kd">type</span> <span class="nx">Pod</span> <span class="o">=</span> <span class="nx">Renderer</span><span class="p">.</span><span class="nx">K8sApi</span><span class="p">.</span><span class="nx">Pod</span><span class="p">;</span>
<span class="kd">type</span> <span class="nx">KubernetesCluster</span> <span class="o">=</span> <span class="nx">Common</span><span class="p">.</span><span class="nx">Catalog</span><span class="p">.</span><span class="nx">KubernetesCluster</span><span class="p">;</span>
<span class="k">export</span> <span class="kd">interface</span> <span class="nx">MetricsStatus</span> <span class="p">{</span>
<span class="nx">installed</span>: <span class="kt">boolean</span><span class="p">;</span>
<span class="nx">canUpgrade</span>: <span class="kt">boolean</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">export</span> <span class="kd">class</span> <span class="nx">ExampleFeature</span> <span class="p">{</span>
<span class="k">protected</span> <span class="nx">stack</span>: <span class="kt">ResourceStack</span><span class="p">;</span>
<span class="kr">constructor</span><span class="p">(</span><span class="k">protected</span> <span class="nx">cluster</span>: <span class="kt">KubernetesCluster</span><span class="p">)</span> <span class="p">{</span>
<span class="k">this</span><span class="p">.</span><span class="nx">stack</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">ResourceStack</span><span class="p">(</span><span class="nx">cluster</span><span class="p">,</span> <span class="k">this</span><span class="p">.</span><span class="nx">name</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">install</span><span class="p">()</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="kt">string</span><span class="o">&gt;</span> <span class="p">{</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">stack</span><span class="p">.</span><span class="nx">kubectlApplyFolder</span><span class="p">(</span><span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">__dirname</span><span class="p">,</span> <span class="s2">&quot;../resources/&quot;</span><span class="p">));</span>
<span class="p">}</span>
<span class="nx">upgrade</span><span class="p">()</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="kt">string</span><span class="o">&gt;</span> <span class="p">{</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">install</span><span class="p">(</span><span class="nx">config</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">async</span> <span class="nx">getStatus</span><span class="p">()</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="nx">MetricsStatus</span><span class="o">&gt;</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">status</span>: <span class="kt">MetricsStatus</span> <span class="o">=</span> <span class="p">{</span> <span class="nx">installed</span>: <span class="kt">false</span><span class="p">,</span> <span class="nx">canUpgrade</span>: <span class="kt">false</span><span class="p">};</span>
<span class="k">try</span> <span class="p">{</span>
<span class="kd">const</span> <span class="nx">pod</span> <span class="o">=</span> <span class="nx">forCluster</span><span class="p">(</span><span class="nx">cluster</span><span class="p">,</span> <span class="nx">Pod</span><span class="p">);</span>
<span class="kd">const</span> <span class="nx">examplePod</span> <span class="o">=</span> <span class="k">await</span> <span class="nx">pod</span><span class="p">.</span><span class="nx">get</span><span class="p">({</span><span class="nx">name</span><span class="o">:</span> <span class="s2">&quot;example-pod&quot;</span><span class="p">,</span> <span class="nx">namespace</span><span class="o">:</span> <span class="s2">&quot;default&quot;</span><span class="p">});</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">examplePod</span><span class="o">?</span><span class="p">.</span><span class="nx">kind</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">status</span><span class="p">.</span><span class="nx">installed</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
<span class="nx">status</span><span class="p">.</span><span class="nx">currentVersion</span> <span class="o">=</span> <span class="nx">examplePod</span><span class="p">.</span><span class="nx">spec</span><span class="p">.</span><span class="nx">containers</span><span class="p">[</span><span class="mf">0</span><span class="p">].</span><span class="nx">image</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s2">&quot;:&quot;</span><span class="p">)[</span><span class="mf">1</span><span class="p">];</span>
<span class="nx">status</span><span class="p">.</span><span class="nx">canUpgrade</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span> <span class="c1">// a real implementation would perform a check here that is relevant to the specific feature</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="nx">status</span><span class="p">.</span><span class="nx">installed</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="nx">status</span><span class="p">.</span><span class="nx">canUpgrade</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span> <span class="k">catch</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="o">?</span><span class="p">.</span><span class="nx">error</span><span class="o">?</span><span class="p">.</span><span class="nx">code</span> <span class="o">===</span> <span class="mf">404</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">status</span><span class="p">.</span><span class="nx">installed</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="nx">status</span><span class="p">.</span><span class="nx">canUpgrade</span> <span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">return</span> <span class="nx">status</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">async</span> <span class="nx">uninstall</span><span class="p">()</span><span class="o">:</span> <span class="nx">Promise</span><span class="o">&lt;</span><span class="kt">string</span><span class="o">&gt;</span> <span class="p">{</span>
<span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">stack</span><span class="p">.</span><span class="nx">kubectlDeleteFolder</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">resourceFolder</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<p>This example implements the <code>install()</code> method by invoking the helper <code>applyResources()</code> method.
<code>applyResources()</code> tries to apply all resources read from all files found in the folder path provided.
In this case the folder path is the <code>../resources</code> subfolder relative to the current source code's folder.
The file <code>../resources/example-pod.yml</code> could contain:</p>
<div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">v1</span>
<span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Pod</span>
<span class="nt">metadata</span><span class="p">:</span>
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-pod</span>
<span class="nt">spec</span><span class="p">:</span>
<span class="nt">containers</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">example-pod</span>
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">nginx</span>
</code></pre></div>
<p>The example above implements the four methods as follows:</p>
<ul>
<li>
<p>It implements <code>upgrade()</code> by invoking the <code>install()</code> method.
Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps.</p>
</li>
<li>
<p>It implements <code>uninstall()</code> by utilizing the <a href="../../api/">Kubernetes API</a> which Lens provides to delete the <code>example-pod</code> applied by the <code>install()</code> method.</p>
</li>
<li>
<p>It implements <code>updateStatus()</code> by using the <a href="../../api/">Kubernetes API</a> which Lens provides to determine whether the <code>example-pod</code> is installed, what version is associated with it, and whether it can be upgraded.
The implementation determines what the status is for a specific cluster feature.</p>
</li>
</ul>
<h3 id="welcomemenus"><code>welcomeMenus</code><a class="headerlink" href="#welcomemenus" title="Permanent link">#</a></h3>
<h3 id="apppreferences"><code>appPreferences</code><a class="headerlink" href="#apppreferences" title="Permanent link">#</a></h3>
<p>The Lens <strong>Preferences</strong> page is a built-in global page.
You can use Lens extensions to add custom preferences to the Preferences page, providing a single location for users to configure global options.</p>
@@ -1501,6 +1388,7 @@ Alternatively, you can use React's state management, though <code>mobx</code> is
<p>Note that you can manage an extension's state data using an <code>ExtensionStore</code> object, which conveniently handles persistence and synchronization.
To simplify this guide, the example above defines a <code>preference</code> field in the <code>ExampleRendererExtension</code> class definition to hold the extension's state.
However, we recommend that you manage your extension's state data using <a href="../stores#extensionstore"><code>ExtensionStore</code></a>.</p>
<h3 id="topbaritems"><code>topBarItems</code><a class="headerlink" href="#topbaritems" title="Permanent link">#</a></h3>
<h3 id="statusbaritems"><code>statusBarItems</code><a class="headerlink" href="#statusbaritems" title="Permanent link">#</a></h3>
<p>The status bar is the blue strip along the bottom of the Lens UI.
<code>statusBarItems</code> are <code>React.ReactNode</code> types.
@@ -1785,6 +1673,13 @@ Construct the table using the <code>Renderer.Component.Table</code> and related
<p>For each pod the name, age, and status are obtained using the <code>Renderer.K8sApi.Pod</code> methods.
The table is constructed using the <code>Renderer.Component.Table</code> and related elements.
See <a href="https://docs.k8slens.dev/latest/extensions/api/modules/_renderer_api_components_/">Component documentation</a> for further details.</p>
<h3 id="kubeobjectstatustexts"><code>kubeObjectStatusTexts</code><a class="headerlink" href="#kubeobjectstatustexts" title="Permanent link">#</a></h3>
<h3 id="kubeworkloadsoverviewitems"><code>kubeWorkloadsOverviewItems</code><a class="headerlink" href="#kubeworkloadsoverviewitems" title="Permanent link">#</a></h3>
<h3 id="entitysettings"><code>entitySettings</code><a class="headerlink" href="#entitysettings" title="Permanent link">#</a></h3>
<h3 id="catalogentitydetailitems"><code>catalogEntityDetailItems</code><a class="headerlink" href="#catalogentitydetailitems" title="Permanent link">#</a></h3>
<h3 id="commandpalettecommands"><code>commandPaletteCommands</code><a class="headerlink" href="#commandpalettecommands" title="Permanent link">#</a></h3>
<h3 id="protocolhandlers"><code>protocolHandlers</code><a class="headerlink" href="#protocolhandlers" title="Permanent link">#</a></h3>
<p>See the <a href="../protocol-handlers/">Protocol Handlers Guide</a></p>
@@ -1821,13 +1716,13 @@ See <a href="https://docs.k8slens.dev/latest/extensions/api/modules/_renderer_ap
<a href="../stores/" class="md-footer__link md-footer__link--next" aria-label="Next: Stores" rel="next">
<a href="../catalog/" class="md-footer__link md-footer__link--next" aria-label="Next: Catalog" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Stores
Catalog
</div>
</div>
<div class="md-footer__button md-icon">