diff --git a/latest/clusters/adding-clusters/index.html b/latest/clusters/adding-clusters/index.html index ab8b6b7268..3bc2a3cba7 100644 --- a/latest/clusters/adding-clusters/index.html +++ b/latest/clusters/adding-clusters/index.html @@ -700,7 +700,7 @@
- Last update: November 5, 2020 + Last update: November 6, 2020
diff --git a/latest/clusters/images/cluster-context-menu.png b/latest/clusters/images/cluster-context-menu.png new file mode 100644 index 0000000000..d733840df3 Binary files /dev/null and b/latest/clusters/images/cluster-context-menu.png differ diff --git a/latest/clusters/images/cluster-settings-features.png b/latest/clusters/images/cluster-settings-features.png new file mode 100644 index 0000000000..3a8066309d Binary files /dev/null and b/latest/clusters/images/cluster-settings-features.png differ diff --git a/latest/clusters/images/cluster-settings-general.png b/latest/clusters/images/cluster-settings-general.png new file mode 100644 index 0000000000..d7de0a1a35 Binary files /dev/null and b/latest/clusters/images/cluster-settings-general.png differ diff --git a/latest/clusters/images/cluster-settings-removal.png b/latest/clusters/images/cluster-settings-removal.png new file mode 100644 index 0000000000..badcbcc6e0 Binary files /dev/null and b/latest/clusters/images/cluster-settings-removal.png differ diff --git a/latest/clusters/images/cluster-settings-status.png b/latest/clusters/images/cluster-settings-status.png new file mode 100644 index 0000000000..af8e939e35 Binary files /dev/null and b/latest/clusters/images/cluster-settings-status.png differ diff --git a/latest/clusters/removing-clusters/index.html b/latest/clusters/removing-clusters/index.html index 24ba5bd102..c3c8ff7dae 100644 --- a/latest/clusters/removing-clusters/index.html +++ b/latest/clusters/removing-clusters/index.html @@ -682,10 +682,10 @@

Removing clusters#

-

You can remove Lens clusters using the context menu that appears when you hover over the cluster in the left-side menu that you want to remove. By right-clicking the cluster of choice you can hit the Remove button to delete it from your list.

+

Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove.

To remove a cluster from your cluster list:

    -
  1. Hover over the name of the cluster you want to remove in the left side menu. A context menu will appear.
    2. +
  2. Right-click the name of the cluster in the left-side menu that you want to remove.
  3. Click Remove.

NOTE: This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.

@@ -698,7 +698,7 @@
- Last update: November 5, 2020 + Last update: November 6, 2020
diff --git a/latest/clusters/settings/index.html b/latest/clusters/settings/index.html index 956fc10066..c688c855fa 100644 --- a/latest/clusters/settings/index.html +++ b/latest/clusters/settings/index.html @@ -75,7 +75,7 @@
- + Skip to content @@ -406,6 +406,26 @@ Features + +
  • @@ -881,6 +901,26 @@ Features + +
  • @@ -904,38 +944,50 @@ -

    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 Settings.

    +

    Settings#

    +

    It is easy to configure Lens Clusters to your liking through its various settings.

    +
      +
    1. Right-click the name of the cluster in the left-side menu that you want to open the settings for.
      2. +
    2. Click Settings.
      3. +
    +

    Cluster settings

    Status#

    -

    An overview of the cluster status.

    +

    Overview of the cluster status

    Cluster Status#

    -

    This section provides cluster details including the detected distribution, kernel version, API endpoint and online status.

    +

    Cluster status information including the detected distribution, kernel version, API endpoint, and online status

    +

    Cluster settings status

    General#

    -

    General information for the cluster with some settings that can be customized.

    +

    General cluster settings

    Cluster Name#

    -

    The cluster name is inheritated from the kubeconfig by default. You can change the cluster name to another value by updating here. Note this does not update your kubeconfig file.

    +

    The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file.

    Workspace#

    -

    This is the Lens Workspace that the cluster is associated with. You can change to another workspace or create a new workspace - this option will take you the Workspaces editor where you can create a new workspace and then -navigate back to the cluster settings.

    +

    This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in "Define cluster workspace" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings.

    Cluster Icon#

    -

    A random cluster icon is associated with your cluster when it is first created. You can define your own cluster icon here.

    +

    Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon.

    HTTP Proxy#

    -

    If you need to use a HTTP proxy to communicate with the Kubernetes API you can define it here.

    +

    Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so.

    Prometheus#

    -

    Lens can be configured to query a Prometheus server that is installed in the cluster. The query format used can be configured here to either auto-detect or a pre-configured query format. The available formats are:

    +

    Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations:

    -

    For more details of custom Prometheus configurations refer to this guide.

    +

    To learn more about custom Prometheus configurations, please refer to this guide.

    Working Directory#

    -

    The terminat working directory can be configured here - by default it is set to $HOME.

    +

    Use this field to set the terminal working directory. The default is $HOME.

    +

    Cluster settings general

    Features#

    -

    Additional Lens features that can be installed by the user.

    +

    Additional Lens features that can be installed by the user

    +

    Metrics#

    +

    Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed.

    +

    User Mode#

    +

    User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces.

    +

    Cluster settings features

    Removal#

    -

    Remove the current cluster.

    +

    Use this setting to remove the current cluster.

    +

    Cluster settings removal

    @@ -944,7 +996,7 @@ navigate back to the cluster settings.

    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/contributing/index.html b/latest/contributing/index.html index aedd8d79a1..c944cc59c6 100644 --- a/latest/contributing/index.html +++ b/latest/contributing/index.html @@ -677,7 +677,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/api/index.html b/latest/extensions/api/index.html index a035eb29ac..567bcecde6 100644 --- a/latest/extensions/api/index.html +++ b/latest/extensions/api/index.html @@ -691,7 +691,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/capabilities/common-capabilities/index.html b/latest/extensions/capabilities/common-capabilities/index.html index 3375c28c84..1410a8db98 100644 --- a/latest/extensions/capabilities/common-capabilities/index.html +++ b/latest/extensions/capabilities/common-capabilities/index.html @@ -681,7 +681,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/capabilities/index.html b/latest/extensions/capabilities/index.html index cfa11d381f..0df0494a02 100644 --- a/latest/extensions/capabilities/index.html +++ b/latest/extensions/capabilities/index.html @@ -681,7 +681,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/capabilities/theming/index.html b/latest/extensions/capabilities/theming/index.html index 37a891b978..341871f079 100644 --- a/latest/extensions/capabilities/theming/index.html +++ b/latest/extensions/capabilities/theming/index.html @@ -681,7 +681,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/get-started/anatomy/index.html b/latest/extensions/get-started/anatomy/index.html index e348a442d6..c3cc78b96e 100644 --- a/latest/extensions/get-started/anatomy/index.html +++ b/latest/extensions/get-started/anatomy/index.html @@ -681,7 +681,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/get-started/wrapping-up/index.html b/latest/extensions/get-started/wrapping-up/index.html index 93cc1a2452..984dbe9e12 100644 --- a/latest/extensions/get-started/wrapping-up/index.html +++ b/latest/extensions/get-started/wrapping-up/index.html @@ -790,7 +790,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/get-started/your-first-extension/index.html b/latest/extensions/get-started/your-first-extension/index.html index 44d5388129..8071820c2c 100644 --- a/latest/extensions/get-started/your-first-extension/index.html +++ b/latest/extensions/get-started/your-first-extension/index.html @@ -843,7 +843,7 @@ npm run dev
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/guides/index.html b/latest/extensions/guides/index.html index 5266e1a122..1e248569c0 100644 --- a/latest/extensions/guides/index.html +++ b/latest/extensions/guides/index.html @@ -681,7 +681,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/guides/renderer-extension/index.html b/latest/extensions/guides/renderer-extension/index.html index 2ff983a02f..172df97fa5 100644 --- a/latest/extensions/guides/renderer-extension/index.html +++ b/latest/extensions/guides/renderer-extension/index.html @@ -692,7 +692,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/index.html b/latest/extensions/index.html index e524abaa23..cdc22f46d0 100644 --- a/latest/extensions/index.html +++ b/latest/extensions/index.html @@ -840,7 +840,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/testing-and-publishing/bundling/index.html b/latest/extensions/testing-and-publishing/bundling/index.html index bf8c5276ef..61aa87e630 100644 --- a/latest/extensions/testing-and-publishing/bundling/index.html +++ b/latest/extensions/testing-and-publishing/bundling/index.html @@ -681,7 +681,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/testing-and-publishing/publishing/index.html b/latest/extensions/testing-and-publishing/publishing/index.html index ad95577a37..26679cb427 100644 --- a/latest/extensions/testing-and-publishing/publishing/index.html +++ b/latest/extensions/testing-and-publishing/publishing/index.html @@ -681,7 +681,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/testing-and-publishing/testing/index.html b/latest/extensions/testing-and-publishing/testing/index.html index 176340355d..75d65f92b0 100644 --- a/latest/extensions/testing-and-publishing/testing/index.html +++ b/latest/extensions/testing-and-publishing/testing/index.html @@ -681,7 +681,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/extensions/usage/index.html b/latest/extensions/usage/index.html index e8540d78f4..79eea364fc 100644 --- a/latest/extensions/usage/index.html +++ b/latest/extensions/usage/index.html @@ -689,7 +689,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/faq/index.html b/latest/faq/index.html index 0ed7caa3be..25a1cae302 100644 --- a/latest/faq/index.html +++ b/latest/faq/index.html @@ -677,7 +677,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/getting-started/index.html b/latest/getting-started/index.html index d3220b0c49..e16a9a2b81 100644 --- a/latest/getting-started/index.html +++ b/latest/getting-started/index.html @@ -876,7 +876,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/getting-started/introductory-videos/index.html b/latest/getting-started/introductory-videos/index.html index f3e18c6b06..0af5b60134 100644 --- a/latest/getting-started/introductory-videos/index.html +++ b/latest/getting-started/introductory-videos/index.html @@ -712,7 +712,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/getting-started/preferences/index.html b/latest/getting-started/preferences/index.html index 177621f8af..56c72be198 100644 --- a/latest/getting-started/preferences/index.html +++ b/latest/getting-started/preferences/index.html @@ -805,7 +805,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/helm/index.html b/latest/helm/index.html index 015527df4e..f7bb436460 100644 --- a/latest/helm/index.html +++ b/latest/helm/index.html @@ -689,7 +689,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/index.html b/latest/index.html index f75f1202e2..eac6a79e93 100644 --- a/latest/index.html +++ b/latest/index.html @@ -774,7 +774,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020
    diff --git a/latest/search/search_index.json b/latest/search/search_index.json index 58402706b6..c631719559 100644 --- a/latest/search/search_index.json +++ b/latest/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview # Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab Downloading Lens # Download Lens for macOS, Windows, or Linux. Quick Start # Get up and running quickly by learning to add clusters .","title":"Overview"},{"location":"#overview","text":"Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab","title":"Overview"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"#quick-start","text":"Get up and running quickly by learning to add clusters .","title":"Quick Start"},{"location":"clusters/adding-clusters/","text":"Adding clusters # Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. 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 cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal.","title":"Adding clusters"},{"location":"clusters/adding-clusters/#adding-clusters","text":"Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. 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 cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal.","title":"Adding clusters"},{"location":"clusters/removing-clusters/","text":"Removing clusters # You can remove Lens clusters using the context menu that appears when you hover over the cluster in the left-side menu that you want to remove. By right-clicking the cluster of choice you can hit the Remove button to delete it from your list. To remove a cluster from your cluster list: Hover over the name of the cluster you want to remove in the left side menu. A context menu will appear. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing cluster"},{"location":"clusters/removing-clusters/#removing-clusters","text":"You can remove Lens clusters using the context menu that appears when you hover over the cluster in the left-side menu that you want to remove. By right-clicking the cluster of choice you can hit the Remove button to delete it from your list. To remove a cluster from your cluster list: Hover over the name of the cluster you want to remove in the left side menu. A context menu will appear. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing clusters"},{"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 Settings . Status # An overview of the cluster status. Cluster Status # This section provides cluster details including the detected distribution, kernel version, API endpoint and online status. General # General information for the cluster with some settings that can be customized. Cluster Name # The cluster name is inheritated from the kubeconfig by default. You can change the cluster name to another value by updating here. Note this does not update your kubeconfig file. Workspace # This is the Lens Workspace that the cluster is associated with. You can change to another workspace or create a new workspace - this option will take you the Workspaces editor where you can create a new workspace and then navigate back to the cluster settings. Cluster Icon # A random cluster icon is associated with your cluster when it is first created. You can define your own cluster icon here. HTTP Proxy # If you need to use a HTTP proxy to communicate with the Kubernetes API you can define it here. Prometheus # Lens can be configured to query a Prometheus server that is installed in the cluster. The query format used can be configured here to either auto-detect or a pre-configured query format. The available formats are: Lens Helm Operator Prometheus Operator Stacklight For more details of custom Prometheus configurations refer to this guide . Working Directory # The terminat working directory can be configured here - by default it is set to $HOME . Features # Additional Lens features that can be installed by the user. Removal # Remove the current cluster.","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 Settings .","title":"Cluster Settings"},{"location":"clusters/settings/#status","text":"An overview of the cluster status.","title":"Status"},{"location":"clusters/settings/#cluster-status","text":"This section provides cluster details including the detected distribution, kernel version, API endpoint and online status.","title":"Cluster Status"},{"location":"clusters/settings/#general","text":"General information for the cluster with some settings that can be customized.","title":"General"},{"location":"clusters/settings/#cluster-name","text":"The cluster name is inheritated from the kubeconfig by default. You can change the cluster name to another value by updating here. Note this does not update your kubeconfig file.","title":"Cluster Name"},{"location":"clusters/settings/#workspace","text":"This is the Lens Workspace that the cluster is associated with. You can change to another workspace or create a new workspace - this option will take you the Workspaces editor where you can create a new workspace and then navigate back to the cluster settings.","title":"Workspace"},{"location":"clusters/settings/#cluster-icon","text":"A random cluster icon is associated with your cluster when it is first created. You can define your own cluster icon here.","title":"Cluster Icon"},{"location":"clusters/settings/#http-proxy","text":"If you need to use a HTTP proxy to communicate with the Kubernetes API you can define it here.","title":"HTTP Proxy"},{"location":"clusters/settings/#prometheus","text":"Lens can be configured to query a Prometheus server that is installed in the cluster. The query format used can be configured here to either auto-detect or a pre-configured query format. The available formats are: Lens Helm Operator Prometheus Operator Stacklight For more details of custom Prometheus configurations refer to this guide .","title":"Prometheus"},{"location":"clusters/settings/#working-directory","text":"The terminat working directory can be configured here - by default it is set to $HOME .","title":"Working Directory"},{"location":"clusters/settings/#features","text":"Additional Lens features that can be installed by the user.","title":"Features"},{"location":"clusters/settings/#removal","text":"Remove the current cluster.","title":"Removal"},{"location":"contributing/","text":"TBD","title":"Contributing"},{"location":"extensions/","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/#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/#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/#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/#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/#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/#download-lens-the-kubernetes-ide","text":"Go to Lens","title":"Download Lens - The Kubernetes IDE"},{"location":"extensions/api/","text":"Lens Extension API Reference # TBD","title":"API Reference"},{"location":"extensions/api/#lens-extension-api-reference","text":"TBD","title":"Lens Extension API Reference"},{"location":"extensions/capabilities/","text":"","title":"Overview"},{"location":"extensions/capabilities/common-capabilities/","text":"","title":"Common Capabilities"},{"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 & 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 # First you will need to clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink from the directory that Lens will monitor for user installed extensions to the sample extension, in this case helloworld-sample : mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s /helloworld-sample helloworld-sample To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build OR cd /helloworld-sample npm install npm run build If you want to watch for any source code changes and automatically rebuild the extension you can use: cd /helloworld-sample npm run dev Finally, if you already have Lens open you will need to quit and restart Lens for the extension to be loaded. After this initial restart you can reload Lens and it will pick up any new builds of the extension. Within Lens connect to an existing cluster or create a new one . You should see then see the \"Hello World\" page in the Lens sidebar cluster menu. Developing the extension # Let's make a change to the message that our helloworld-sample extension displays: Navigate to /helloworld-sample . Change the message from HelloWorld! to Hello Lens Extensions in page.tsx . Rebuild the extension or, if you used npm run dev , the extension should automatically rebuild. Reload the Lens window and click on the Hello World page. 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":"First you will need to clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink from the directory that Lens will monitor for user installed extensions to the sample extension, in this case helloworld-sample : mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s /helloworld-sample helloworld-sample To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build OR cd /helloworld-sample npm install npm run build If you want to watch for any source code changes and automatically rebuild the extension you can use: cd /helloworld-sample npm run dev Finally, if you already have Lens open you will need to quit and restart Lens for the extension to be loaded. After this initial restart you can reload Lens and it will pick up any new builds of the extension. Within Lens connect to an existing cluster or create a new one . You should see then see the \"Hello World\" page in the Lens sidebar cluster menu.","title":"Linux"},{"location":"extensions/get-started/your-first-extension/#developing-the-extension","text":"Let's make a change to the message that our helloworld-sample extension displays: Navigate to /helloworld-sample . Change the message from HelloWorld! to Hello Lens Extensions in page.tsx . Rebuild the extension or, if you used npm run dev , the extension should automatically rebuild. Reload the Lens window and click on the Hello World page. 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/","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":"extensions/usage/","text":"Using Extensions # TBD","title":"Using Extensions"},{"location":"extensions/usage/#using-extensions","text":"TBD","title":"Using Extensions"},{"location":"faq/","text":"TBD","title":"FAQ"},{"location":"getting-started/","text":"Getting Started # Lens is lightweight and simple to install. You'll be up and running in just a few minutes. System requirements # Review the System Requirements to check if your computer configuration is supported. macOS # 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 . Windows # 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 . Linux # 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 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 . Next Steps # Add clusters Watch introductory videos","title":"Getting Started"},{"location":"getting-started/#getting-started","text":"Lens is lightweight and simple to install. You'll be up and running in just a few minutes.","title":"Getting Started"},{"location":"getting-started/#system-requirements","text":"Review the System Requirements to check if your computer configuration is supported.","title":"System requirements"},{"location":"getting-started/#macos","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":"macOS"},{"location":"getting-started/#windows","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":"Windows"},{"location":"getting-started/#linux","text":"See the Download Lens page for a complete list of available installation options.","title":"Linux"},{"location":"getting-started/#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":"getting-started/#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":"getting-started/#next-steps","text":"Add clusters Watch introductory videos","title":"Next Steps"},{"location":"getting-started/introductory-videos/","text":"Introductory Videos # Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features. 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":"Introductory Videos"},{"location":"getting-started/introductory-videos/#introductory-videos","text":"Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features.","title":"Introductory Videos"},{"location":"getting-started/preferences/","text":"Preferences # Color themes # The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown. Telemetry & usage tracking # Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see 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. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck 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 this setting.","title":"Preferences"},{"location":"getting-started/preferences/#preferences","text":"","title":"Preferences"},{"location":"getting-started/preferences/#color-themes","text":"The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown.","title":"Color themes"},{"location":"getting-started/preferences/#telemetry-usage-tracking","text":"Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more.","title":"Telemetry & usage tracking"},{"location":"getting-started/preferences/#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. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck 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 this setting.","title":"Disable telemetry reporting"},{"location":"helm/","text":"Using Helm Charts # TBD","title":"Using Helm Charts"},{"location":"helm/#using-helm-charts","text":"TBD","title":"Using Helm Charts"},{"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"}]} \ No newline at end of file +{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview # Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab Downloading Lens # Download Lens for macOS, Windows, or Linux. Quick Start # Get up and running quickly by learning to add clusters .","title":"Overview"},{"location":"#overview","text":"Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab","title":"Overview"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"#quick-start","text":"Get up and running quickly by learning to add clusters .","title":"Quick Start"},{"location":"clusters/adding-clusters/","text":"Adding clusters # Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. 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 cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal.","title":"Adding clusters"},{"location":"clusters/adding-clusters/#adding-clusters","text":"Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. 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 cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal.","title":"Adding clusters"},{"location":"clusters/removing-clusters/","text":"Removing clusters # Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing cluster"},{"location":"clusters/removing-clusters/#removing-clusters","text":"Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing clusters"},{"location":"clusters/settings/","text":"Settings # It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings . Status # Overview of the cluster status Cluster Status # Cluster status information including the detected distribution, kernel version, API endpoint, and online status General # General cluster settings Cluster Name # The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file. Workspace # This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings. Cluster Icon # Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon. HTTP Proxy # Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so. Prometheus # Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide . Working Directory # Use this field to set the terminal working directory. The default is $HOME . Features # Additional Lens features that can be installed by the user Metrics # Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed. User Mode # User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces. Removal # Use this setting to remove the current cluster.","title":"Settings"},{"location":"clusters/settings/#settings","text":"It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings .","title":"Settings"},{"location":"clusters/settings/#status","text":"Overview of the cluster status","title":"Status"},{"location":"clusters/settings/#cluster-status","text":"Cluster status information including the detected distribution, kernel version, API endpoint, and online status","title":"Cluster Status"},{"location":"clusters/settings/#general","text":"General cluster settings","title":"General"},{"location":"clusters/settings/#cluster-name","text":"The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file.","title":"Cluster Name"},{"location":"clusters/settings/#workspace","text":"This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings.","title":"Workspace"},{"location":"clusters/settings/#cluster-icon","text":"Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon.","title":"Cluster Icon"},{"location":"clusters/settings/#http-proxy","text":"Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so.","title":"HTTP Proxy"},{"location":"clusters/settings/#prometheus","text":"Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide .","title":"Prometheus"},{"location":"clusters/settings/#working-directory","text":"Use this field to set the terminal working directory. The default is $HOME .","title":"Working Directory"},{"location":"clusters/settings/#features","text":"Additional Lens features that can be installed by the user","title":"Features"},{"location":"clusters/settings/#metrics","text":"Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed.","title":"Metrics"},{"location":"clusters/settings/#user-mode","text":"User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces.","title":"User Mode"},{"location":"clusters/settings/#removal","text":"Use this setting to remove the current cluster.","title":"Removal"},{"location":"contributing/","text":"TBD","title":"Contributing"},{"location":"extensions/","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/#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/#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/#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/#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/#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/#download-lens-the-kubernetes-ide","text":"Go to Lens","title":"Download Lens - The Kubernetes IDE"},{"location":"extensions/api/","text":"Lens Extension API Reference # TBD","title":"API Reference"},{"location":"extensions/api/#lens-extension-api-reference","text":"TBD","title":"Lens Extension API Reference"},{"location":"extensions/capabilities/","text":"","title":"Overview"},{"location":"extensions/capabilities/common-capabilities/","text":"","title":"Common Capabilities"},{"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 & 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 # First you will need to clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink from the directory that Lens will monitor for user installed extensions to the sample extension, in this case helloworld-sample : mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s /helloworld-sample helloworld-sample To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build OR cd /helloworld-sample npm install npm run build If you want to watch for any source code changes and automatically rebuild the extension you can use: cd /helloworld-sample npm run dev Finally, if you already have Lens open you will need to quit and restart Lens for the extension to be loaded. After this initial restart you can reload Lens and it will pick up any new builds of the extension. Within Lens connect to an existing cluster or create a new one . You should see then see the \"Hello World\" page in the Lens sidebar cluster menu. Developing the extension # Let's make a change to the message that our helloworld-sample extension displays: Navigate to /helloworld-sample . Change the message from HelloWorld! to Hello Lens Extensions in page.tsx . Rebuild the extension or, if you used npm run dev , the extension should automatically rebuild. Reload the Lens window and click on the Hello World page. 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":"First you will need to clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink from the directory that Lens will monitor for user installed extensions to the sample extension, in this case helloworld-sample : mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s /helloworld-sample helloworld-sample To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build OR cd /helloworld-sample npm install npm run build If you want to watch for any source code changes and automatically rebuild the extension you can use: cd /helloworld-sample npm run dev Finally, if you already have Lens open you will need to quit and restart Lens for the extension to be loaded. After this initial restart you can reload Lens and it will pick up any new builds of the extension. Within Lens connect to an existing cluster or create a new one . You should see then see the \"Hello World\" page in the Lens sidebar cluster menu.","title":"Linux"},{"location":"extensions/get-started/your-first-extension/#developing-the-extension","text":"Let's make a change to the message that our helloworld-sample extension displays: Navigate to /helloworld-sample . Change the message from HelloWorld! to Hello Lens Extensions in page.tsx . Rebuild the extension or, if you used npm run dev , the extension should automatically rebuild. Reload the Lens window and click on the Hello World page. 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/","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":"extensions/usage/","text":"Using Extensions # TBD","title":"Using Extensions"},{"location":"extensions/usage/#using-extensions","text":"TBD","title":"Using Extensions"},{"location":"faq/","text":"TBD","title":"FAQ"},{"location":"getting-started/","text":"Getting Started # Lens is lightweight and simple to install. You'll be up and running in just a few minutes. System requirements # Review the System Requirements to check if your computer configuration is supported. macOS # 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 . Windows # 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 . Linux # 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 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 . Next Steps # Add clusters Watch introductory videos","title":"Getting Started"},{"location":"getting-started/#getting-started","text":"Lens is lightweight and simple to install. You'll be up and running in just a few minutes.","title":"Getting Started"},{"location":"getting-started/#system-requirements","text":"Review the System Requirements to check if your computer configuration is supported.","title":"System requirements"},{"location":"getting-started/#macos","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":"macOS"},{"location":"getting-started/#windows","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":"Windows"},{"location":"getting-started/#linux","text":"See the Download Lens page for a complete list of available installation options.","title":"Linux"},{"location":"getting-started/#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":"getting-started/#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":"getting-started/#next-steps","text":"Add clusters Watch introductory videos","title":"Next Steps"},{"location":"getting-started/introductory-videos/","text":"Introductory Videos # Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features. 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":"Introductory Videos"},{"location":"getting-started/introductory-videos/#introductory-videos","text":"Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features.","title":"Introductory Videos"},{"location":"getting-started/preferences/","text":"Preferences # Color themes # The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown. Telemetry & usage tracking # Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see 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. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck 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 this setting.","title":"Preferences"},{"location":"getting-started/preferences/#preferences","text":"","title":"Preferences"},{"location":"getting-started/preferences/#color-themes","text":"The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown.","title":"Color themes"},{"location":"getting-started/preferences/#telemetry-usage-tracking","text":"Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more.","title":"Telemetry & usage tracking"},{"location":"getting-started/preferences/#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. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck 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 this setting.","title":"Disable telemetry reporting"},{"location":"helm/","text":"Using Helm Charts # TBD","title":"Using Helm Charts"},{"location":"helm/#using-helm-charts","text":"TBD","title":"Using Helm Charts"},{"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"}]} \ No newline at end of file diff --git a/latest/sitemap.xml b/latest/sitemap.xml index 0a9a27764e..bcacbfd6c2 100644 --- a/latest/sitemap.xml +++ b/latest/sitemap.xml @@ -1,95 +1,95 @@ https://docs.k8slens.dev/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/getting-started/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/clusters/adding-clusters/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/clusters/removing-clusters/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/clusters/settings/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/helm/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/usage/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/getting-started/preferences/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/get-started/your-first-extension/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/get-started/anatomy/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/get-started/wrapping-up/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/capabilities/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/capabilities/common-capabilities/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/capabilities/theming/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/guides/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/guides/renderer-extension/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/testing-and-publishing/testing/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/testing-and-publishing/publishing/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/testing-and-publishing/bundling/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/extensions/api/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/contributing/ - 2020-11-05 + 2020-11-06 daily https://docs.k8slens.dev/faq/ - 2020-11-05 + 2020-11-06 daily \ No newline at end of file diff --git a/latest/sitemap.xml.gz b/latest/sitemap.xml.gz index 0870e186a5..3dc4b687ae 100644 Binary files a/latest/sitemap.xml.gz and b/latest/sitemap.xml.gz differ diff --git a/latest/supporting/requirements/index.html b/latest/supporting/requirements/index.html index ff0ce64fe6..fcd04a2514 100644 --- a/latest/supporting/requirements/index.html +++ b/latest/supporting/requirements/index.html @@ -754,7 +754,7 @@
    - Last update: November 5, 2020 + Last update: November 6, 2020