lens/0.3/search/search_index.json

{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Getting Started # Lens is the most powerful IDE for people who need to deal with Kubernetes clusters on a daily basis. It is a standalone application for MacOS, Windows and Linux operating systems. Ensure your clusters are properly setup and configured. Enjoy increased visibility, real time statistics, log streams and hands-on troubleshooting capabilities. With Lens, you can work with your clusters more easily and fast, radically improving productivity and the speed of business. Begin your journey with Lens with these introductory videos . 1 Lens in Action # Top Extensions # One Two Three First Steps # To get the most out of Lens, start by reviewing a few introductory topics: Intro Videos - Begin your journey with Lens through these introductory videos. Add Clusters - Add your first Cluster to radically improve productivity and the speed of business. Extension API - Learn how to write a Lens extension. Downloads # Download Lens IDE - Quickly find the appropriate install for your platform (Windows, macOS and Linux)","title":"Overview"},{"location":"#getting-started","text":"Lens is the most powerful IDE for people who need to deal with Kubernetes clusters on a daily basis. It is a standalone application for MacOS, Windows and Linux operating systems. Ensure your clusters are properly setup and configured. Enjoy increased visibility, real time statistics, log streams and hands-on troubleshooting capabilities. With Lens, you can work with your clusters more easily and fast, radically improving productivity and the speed of business. Begin your journey with Lens with these introductory videos . 1","title":"Getting Started"},{"location":"#lens-in-action","text":"","title":"Lens in Action"},{"location":"#top-extensions","text":"One Two Three","title":"Top Extensions"},{"location":"#first-steps","text":"To get the most out of Lens, start by reviewing a few introductory topics: Intro Videos - Begin your journey with Lens through these introductory videos. Add Clusters - Add your first Cluster to radically improve productivity and the speed of business. Extension API - Learn how to write a Lens extension.","title":"First Steps"},{"location":"#downloads","text":"Download Lens IDE - Quickly find the appropriate install for your platform (Windows, macOS and Linux)","title":"Downloads"},{"location":"clusters/add-cluster/","text":"Add Cluster # Add clusters by clicking the Add Cluster button in the left-side menu. You'll need to obtain a working kubeconfig for the cluster you want to add. You can either browse it from the file system or paste it as a text from the clipboard. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any manually added cluster is not merged into your kubeconfig file.","title":"Add cluster"},{"location":"clusters/add-cluster/#add-cluster","text":"Add clusters by clicking the Add Cluster button in the left-side menu. You'll need to obtain a working kubeconfig for the cluster you want to add. You can either browse it from the file system or paste it as a text from the clipboard. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any manually added cluster is not merged into your kubeconfig file.","title":"Add Cluster"},{"location":"clusters/remove-cluster/","text":"Remove Cluster # You can remove a Lens Clusters from your cluster list using the context-menu of the cluster item in the left-side menu. By right-clicking the cluster of choice you can hit the Remove button to delete it from your list. NOTE : This will only remove the cluster from your Lens Cluster list but not affect your actual Kubernetes Cluster or its configuration!","title":"Remove cluster"},{"location":"clusters/remove-cluster/#remove-cluster","text":"You can remove a Lens Clusters from your cluster list using the context-menu of the cluster item in the left-side menu. By right-clicking the cluster of choice you can hit the Remove button to delete it from your list. NOTE : This will only remove the cluster from your Lens Cluster list but not affect your actual Kubernetes Cluster or its configuration!","title":"Remove Cluster"},{"location":"clusters/settings/","text":"Cluster Settings # It is easy to configure Lens Clusters to your liking through its various settings. By right-clicking the cluster of choice you can open the Settings . Cluster Status # This section in the cluster settings provides details including the detected distribution, kernel version, API endpoint and online status. General # Cluster Name # Workspace # Cluster Icon # HTTP Proxy # Prometheus # Working Directory # Features # Metrics # User Mode #","title":"Settings"},{"location":"clusters/settings/#cluster-settings","text":"It is easy to configure Lens Clusters to your liking through its various settings. By right-clicking the cluster of choice you can open the Settings .","title":"Cluster Settings"},{"location":"clusters/settings/#cluster-status","text":"This section in the cluster settings provides details including the detected distribution, kernel version, API endpoint and online status.","title":"Cluster Status"},{"location":"clusters/settings/#general","text":"","title":"General"},{"location":"clusters/settings/#cluster-name","text":"","title":"Cluster Name"},{"location":"clusters/settings/#workspace","text":"","title":"Workspace"},{"location":"clusters/settings/#cluster-icon","text":"","title":"Cluster Icon"},{"location":"clusters/settings/#http-proxy","text":"","title":"HTTP Proxy"},{"location":"clusters/settings/#prometheus","text":"","title":"Prometheus"},{"location":"clusters/settings/#working-directory","text":"","title":"Working Directory"},{"location":"clusters/settings/#features","text":"","title":"Features"},{"location":"clusters/settings/#metrics","text":"","title":"Metrics"},{"location":"clusters/settings/#user-mode","text":"","title":"User Mode"},{"location":"extensions/overview/","text":"Lens Extension API # The Extensions API in Lens allows users to customize and enhance the Lens experience by creating their own menus or page content that is extended from the existing pages. Many of the core features of Lens are built as extensions and use the same Extension API. This documentation describes: How to build, run, test and publish an extension How to take advantage of Lens's Extension API Where to find guides and code samples to help get you started Code samples are available at lensapp/lens-extension-samples . What can extensions do # Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench If you'd like to have a more comprehensive overview of the Extension API, refer to the Extension Capabilities Overview page. Extension Guides Overview also includes a list of code samples and guides that illustrate various Extension API usage. How to build extensions # Building a good extension can take a lot of effort. Here is what each section of the API doc can help you with: Get Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. Advanced Topics explains advanced concepts such as integrating with 3rd party applications/services. References contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics. What's new # Lens updates on a monthly cadence, and that applies to the Extension API as well. New features and APIs become available every month to increase the power and scope of Lens extensions. To stay current with the Extension API and Lens features in general, you can review the release notes . Looking for help # If you have questions for extension development, try asking on: Lens Dev Slack : Public chatroom for Lens developers. Some Lens team members chime in on conversations. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens with the labels area/documentation and/or area/extension . Download Lens - The Kubernetes IDE # Go to Lens","title":"Overview"},{"location":"extensions/overview/#lens-extension-api","text":"The Extensions API in Lens allows users to customize and enhance the Lens experience by creating their own menus or page content that is extended from the existing pages. Many of the core features of Lens are built as extensions and use the same Extension API. This documentation describes: How to build, run, test and publish an extension How to take advantage of Lens's Extension API Where to find guides and code samples to help get you started Code samples are available at lensapp/lens-extension-samples .","title":"Lens Extension API"},{"location":"extensions/overview/#what-can-extensions-do","text":"Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench If you'd like to have a more comprehensive overview of the Extension API, refer to the Extension Capabilities Overview page. Extension Guides Overview also includes a list of code samples and guides that illustrate various Extension API usage.","title":"What can extensions do"},{"location":"extensions/overview/#how-to-build-extensions","text":"Building a good extension can take a lot of effort. Here is what each section of the API doc can help you with: Get Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. Advanced Topics explains advanced concepts such as integrating with 3rd party applications/services. References contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.","title":"How to build extensions"},{"location":"extensions/overview/#whats-new","text":"Lens updates on a monthly cadence, and that applies to the Extension API as well. New features and APIs become available every month to increase the power and scope of Lens extensions. To stay current with the Extension API and Lens features in general, you can review the release notes .","title":"What's new"},{"location":"extensions/overview/#looking-for-help","text":"If you have questions for extension development, try asking on: Lens Dev Slack : Public chatroom for Lens developers. Some Lens team members chime in on conversations. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens with the labels area/documentation and/or area/extension .","title":"Looking for help"},{"location":"extensions/overview/#download-lens-the-kubernetes-ide","text":"Go to Lens","title":"Download Lens - The Kubernetes IDE"},{"location":"extensions/capabilities/common-capabilities/","text":"","title":"Common Capabilities"},{"location":"extensions/capabilities/overview/","text":"","title":"Overview"},{"location":"extensions/capabilities/theming/","text":"","title":"Theming"},{"location":"extensions/get-started/anatomy/","text":"","title":"Extension Anatomy"},{"location":"extensions/get-started/wrapping-up/","text":"Wrapping Up # In the Your First Extension topic, you learned how to create and run an extension. In the Extension Anatomy topic, you learned fundamental concepts to Lens extension development. However, this is just a small glimpse of what can be created with Lens Extensions. Below are some suggested routes for furthering your Lens extension development skills. Extension Capabilities # In this section, we split the Lens extension points into a few categories, each with short descriptions as to what your extension could achieve. Validate that your extension idea is achievable by reading the Extension Capabilities section for new extension ideas. Guides & Samples # We have a great collection of sample extensions that you can adapt from, and some of them include a detailed guide that explains the source code. You can find all Samples & Guides in the lens-extension-samples repository. Testing and Publishing # This section includes topics that help you develop high-quality Lens extensions. For example, you can learn How to add integration tests for your extension How to publish your extension","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#wrapping-up","text":"In the Your First Extension topic, you learned how to create and run an extension. In the Extension Anatomy topic, you learned fundamental concepts to Lens extension development. However, this is just a small glimpse of what can be created with Lens Extensions. Below are some suggested routes for furthering your Lens extension development skills.","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#extension-capabilities","text":"In this section, we split the Lens extension points into a few categories, each with short descriptions as to what your extension could achieve. Validate that your extension idea is achievable by reading the Extension Capabilities section for new extension ideas.","title":"Extension Capabilities"},{"location":"extensions/get-started/wrapping-up/#guides-samples","text":"We have a great collection of sample extensions that you can adapt from, and some of them include a detailed guide that explains the source code. You can find all Samples & Guides in the lens-extension-samples repository.","title":"Guides &amp; Samples"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","text":"This section includes topics that help you develop high-quality Lens extensions. For example, you can learn How to add integration tests for your extension How to publish your extension","title":"Testing and Publishing"},{"location":"extensions/get-started/your-first-extension/","text":"Your First Extension # In this topic, we'll teach you the fundamental concepts for building extensions. Make sure you have Node.js and Git installed.... Installing and Building the extension # Simple Lens extension that adds \"hello-world\" page to a cluster menu. Linux # mkdir -p ~/.k8slens/extensions git clone https://github.com/lensapp/lens-extension-samples.git cp -pr lens-extension-samples/helloworld-sample ~/.k8slens/extensions To build the extension you can use make or run the npm commands manually: cd ~/.k8slens/extensions/helloworld-sample make build OR cd ~/.k8slens/extensions/helloworld-sample npm install npm run build Open Lens application and navigate to a cluster. You should see \"Hello World\" in the Lens sidebar menu. Developing the extension # Let's make a change to the message: Change the message from Hello World from HelloWorld! to Hello Lens Extensions in page.tsx Rebuild the extension Reload the Lens window You should see the updated message showing up. Next steps # In the next topic, Extension Anatomy , we'll take a closer look at the source code of the Hello World sample and explain key concepts. You can find the source code of this tutorial at: lensapp/lens-extension-samples . The Extension Guides topic contains other samples, each illustrating a different Lens Extension API.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#your-first-extension","text":"In this topic, we'll teach you the fundamental concepts for building extensions. Make sure you have Node.js and Git installed....","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#installing-and-building-the-extension","text":"Simple Lens extension that adds \"hello-world\" page to a cluster menu.","title":"Installing and Building the extension"},{"location":"extensions/get-started/your-first-extension/#linux","text":"mkdir -p ~/.k8slens/extensions git clone https://github.com/lensapp/lens-extension-samples.git cp -pr lens-extension-samples/helloworld-sample ~/.k8slens/extensions To build the extension you can use make or run the npm commands manually: cd ~/.k8slens/extensions/helloworld-sample make build OR cd ~/.k8slens/extensions/helloworld-sample npm install npm run build Open Lens application and navigate to a cluster. You should see \"Hello World\" in the Lens sidebar menu.","title":"Linux"},{"location":"extensions/get-started/your-first-extension/#developing-the-extension","text":"Let's make a change to the message: Change the message from Hello World from HelloWorld! to Hello Lens Extensions in page.tsx Rebuild the extension Reload the Lens window You should see the updated message showing up.","title":"Developing the extension"},{"location":"extensions/get-started/your-first-extension/#next-steps","text":"In the next topic, Extension Anatomy , we'll take a closer look at the source code of the Hello World sample and explain key concepts. You can find the source code of this tutorial at: lensapp/lens-extension-samples . The Extension Guides topic contains other samples, each illustrating a different Lens Extension API.","title":"Next steps"},{"location":"extensions/guides/overview/","text":"","title":"Overview"},{"location":"extensions/guides/renderer-extension/","text":"Renderer Extension #","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#renderer-extension","text":"","title":"Renderer Extension"},{"location":"extensions/testing-and-publishing/bundling/","text":"","title":"Bundling Extensions"},{"location":"extensions/testing-and-publishing/publishing/","text":"","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/testing/","text":"","title":"Testing Extensions"},{"location":"get-started/intro-videos/","text":"Introductory Videos # Start your journey using Lens with this set of introductory videos! These videos are designed to give you an overview of Lens various features and quickly get you familiar with them. Getting started Get Lens Kubernetes IDE Running in 5 Minutes Duration 35 minutes Introducing Lens Lens Kubernetes IDE overview Duration 2 minutes Demo of Mirantis Lens The Best IDE For Kubernetes Duration 10 minutes","title":"Intro Videos"},{"location":"get-started/intro-videos/#introductory-videos","text":"Start your journey using Lens with this set of introductory videos! These videos are designed to give you an overview of Lens various features and quickly get you familiar with them.","title":"Introductory Videos"},{"location":"get-started/telemetry/","text":"Telemetry & Usage Tracking # Lens collects telemetry data, which is used to help understand how to improve the product. For example, this usage data helps to debug issues, such as slow start-up times, and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data and you can disable telemetry as described in disable telemetry reporting . You can also read our privacy statement to learn more. Disable telemetry reporting # If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. From File > Preferences (macOS: Lens > Preferences ), search for Telemetry & Usage Tracking , and uncheck the Allow telemetry & usage tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable the setting.","title":"Telemetry"},{"location":"get-started/telemetry/#telemetry-usage-tracking","text":"Lens collects telemetry data, which is used to help understand how to improve the product. For example, this usage data helps to debug issues, such as slow start-up times, and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data and you can disable telemetry as described in disable telemetry reporting . You can also read our privacy statement to learn more.","title":"Telemetry &amp; Usage Tracking"},{"location":"get-started/telemetry/#disable-telemetry-reporting","text":"If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. From File > Preferences (macOS: Lens > Preferences ), search for Telemetry & Usage Tracking , and uncheck the Allow telemetry & usage tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable the setting.","title":"Disable telemetry reporting"},{"location":"get-started/themes/","text":"Color Themes # Color themes let you modify the colors in Lens user interface to suit your preferences and work environment. In Lens, open the Preferences with File > Preferences . ( Code > Preferences on macOS) and select your preferred theme from the Color Theme dropdown.","title":"Themes"},{"location":"get-started/themes/#color-themes","text":"Color themes let you modify the colors in Lens user interface to suit your preferences and work environment. In Lens, open the Preferences with File > Preferences . ( Code > Preferences on macOS) and select your preferred theme from the Color Theme dropdown.","title":"Color Themes"},{"location":"setup/linux/","text":"Lens on Linux # Installation # See the Download Lens page for a complete list of available installation options. Snap # Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic","title":"Linux"},{"location":"setup/linux/#lens-on-linux","text":"","title":"Lens on Linux"},{"location":"setup/linux/#installation","text":"See the Download Lens page for a complete list of available installation options.","title":"Installation"},{"location":"setup/linux/#snap","text":"Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic","title":"Snap"},{"location":"setup/macos/","text":"Lens on macOS # Installation # Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock .","title":"macOS"},{"location":"setup/macos/#lens-on-macos","text":"","title":"Lens on macOS"},{"location":"setup/macos/#installation","text":"Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock .","title":"Installation"},{"location":"setup/network/","text":"Network Connections in Lens # Lens is built on top of Electron and benefits from all the networking stack capabilities of Chromium. Proxy server support # ...","title":"Network"},{"location":"setup/network/#network-connections-in-lens","text":"Lens is built on top of Electron and benefits from all the networking stack capabilities of Chromium.","title":"Network Connections in Lens"},{"location":"setup/network/#proxy-server-support","text":"...","title":"Proxy server support"},{"location":"setup/overview/","text":"Setting up Lens # Getting up and running with Lens is quick and easy. It is a small download so you can install in a matter of minutes and give Lens a try. Cross platform # Lens is the most powerful IDE for people who need to deal with Kubernetes clusters on a daily basis which runs on the macOS, Linux, and Windows operating systems. Follow the platform-specific guides below: Linux macOS Windows Lens is lightweight and should run on most available hardware and platform versions. You can review the System Requirements to check if your computer configuration is supported. Update cadence # Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes .","title":"Overview"},{"location":"setup/overview/#setting-up-lens","text":"Getting up and running with Lens is quick and easy. It is a small download so you can install in a matter of minutes and give Lens a try.","title":"Setting up Lens"},{"location":"setup/overview/#cross-platform","text":"Lens is the most powerful IDE for people who need to deal with Kubernetes clusters on a daily basis which runs on the macOS, Linux, and Windows operating systems. Follow the platform-specific guides below: Linux macOS Windows Lens is lightweight and should run on most available hardware and platform versions. You can review the System Requirements to check if your computer configuration is supported.","title":"Cross platform"},{"location":"setup/overview/#update-cadence","text":"Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes .","title":"Update cadence"},{"location":"setup/windows/","text":"Lens on Windows # Installation # Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens .","title":"Windows"},{"location":"setup/windows/#lens-on-windows","text":"","title":"Lens on Windows"},{"location":"setup/windows/#installation","text":"Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens .","title":"Installation"},{"location":"supporting/requirements/","text":"Requirements for Lens # Hardware # Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM Platforms # Lens has been tested on the following platforms: OS X Windows Linux Additional Windows requirements # ... Additional Linux requirements # ...","title":"Requirements for Lens"},{"location":"supporting/requirements/#requirements-for-lens","text":"","title":"Requirements for Lens"},{"location":"supporting/requirements/#hardware","text":"Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM","title":"Hardware"},{"location":"supporting/requirements/#platforms","text":"Lens has been tested on the following platforms: OS X Windows Linux","title":"Platforms"},{"location":"supporting/requirements/#additional-windows-requirements","text":"...","title":"Additional Windows requirements"},{"location":"supporting/requirements/#additional-linux-requirements","text":"...","title":"Additional Linux requirements"}]}