1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Merge branch 'master' into docs/syntax-highlight

This commit is contained in:
Jari Kolehmainen 2020-11-06 10:52:50 +02:00 committed by GitHub
commit 9997230d98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 77 additions and 58 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 284 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 315 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 311 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 338 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 170 KiB

View File

@ -1,10 +1,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.
1. Right-click the name of the cluster in the left-side menu that you want to remove.
2. 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.

View File

@ -1,54 +1,62 @@
# Cluster Settings
# 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`.
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. Click **Settings**.
![Cluster settings](images/cluster-context-menu.png)
## 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](images/cluster-settings-status.png)
## 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:
* Lens
* Helm Operator
* Prometheus Operator
* Stacklight
For more details of custom Prometheus configurations refer to this [guide](https://github.com/lensapp/lens/blob/master/troubleshooting/custom-prometheus.md).
To learn more about custom Prometheus configurations, please refer to this [guide](https://github.com/lensapp/lens/blob/master/troubleshooting/custom-prometheus.md).
### 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](images/cluster-settings-general.png)
## Features
Additional Lens features that can be installed by the user.
Additional Lens features that can be installed by the user
### Metrics
@ -58,6 +66,10 @@ Enable timeseries data visualization (Prometheus stack) for your cluster. Instal
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](images/cluster-settings-features.png)
## Removal
Remove the current cluster.
Use this setting to remove the current cluster.
![Cluster settings removal](images/cluster-settings-removal.png)

View File

@ -0,0 +1 @@
TBD

View File

@ -0,0 +1,3 @@
# Lens Extension API Reference
TBD

View File

@ -0,0 +1,3 @@
# Using Extensions
TBD

1
docs/faq/README.md Normal file
View File

@ -0,0 +1 @@
TBD

View File

@ -1,4 +1,4 @@
# Downloading Lens
# Getting Started
Lens is lightweight and simple to install. You'll be up and running in just a few minutes.
@ -41,17 +41,6 @@ You can install it by running:
sudo snap install kontena-lens --classic
```
## Network
Lens is built on top of Electron and benefits from all the networking stack capabilities of Chromium.
### Proxy server support
...
## 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!
@ -59,6 +48,8 @@ Lens releases a new version each month with new features and important bug fixes
To stay current with the Lens features, you can review the [release notes](https://github.com/lensapp/lens/releases).
## Quick Start
## Next Steps
- [Add clusters](../clusters/adding-clusters.md)
- [Watch introductory videos](./introductory-videos.md)
Get up and running quickly by learning to [add clusters](../clusters/adding-clusters.md).

3
docs/helm/README.md Normal file
View File

@ -0,0 +1,3 @@
# Using Helm Charts
TBD

View File

@ -8,33 +8,35 @@ repo_url: https://github.com/lensapp/lens
copyright: Copyright &copy; 2020 <a href="https://mirantis.com/">Mirantis Inc.</a> - All rights reserved.
edit_uri: ""
nav:
- Overview: README.md
- Getting started:
- Downloading Lens: getting-started/downloading-lens.md
- Preferences: getting-started/preferences.md
- Introductory videos: getting-started/introductory-videos.md
- Clusters:
- Adding clusters: clusters/adding-clusters.md
- Removing cluster: clusters/removing-clusters.md
- Settings: clusters/settings.md
- Extensions:
- Overview: extensions/overview.md
- Get Started:
- Your First Extension: extensions/get-started/your-first-extension.md
- Extension Anatomy: extensions/get-started/anatomy.md
- Wrapping Up: extensions/get-started/wrapping-up.md
- Extension Capabilities:
- Overview: extensions/capabilities/overview.md
- Common Capabilities: extensions/capabilities/common-capabilities.md
- Theming: extensions/capabilities/theming.md
- Extension Guides:
- Overview: extensions/guides/overview.md
- Renderer Extension: extensions/guides/renderer-extension.md
- Testing and Publishing:
- Testing Extensions: extensions/testing-and-publishing/testing.md
- Publishing Extensions: extensions/testing-and-publishing/publishing.md
- Bundling Extensions: extensions/testing-and-publishing/bundling.md
- Lens Website: https://k8slens.dev
- Overview: README.md
- Getting Started: getting-started/README.md
- Managing Clusters:
- Adding clusters: clusters/adding-clusters.md
- Removing cluster: clusters/removing-clusters.md
- Settings: clusters/settings.md
- Using Helm Charts: helm/README.md
- Using Extensions: extensions/usage/README.md
- Preferences: getting-started/preferences.md
- Extension Development:
- Overview: extensions/README.md
- Get Started:
- Your First Extension: extensions/get-started/your-first-extension.md
- Extension Anatomy: extensions/get-started/anatomy.md
- Wrapping Up: extensions/get-started/wrapping-up.md
- Extension Capabilities:
- Overview: extensions/capabilities/README.md
- Common Capabilities: extensions/capabilities/common-capabilities.md
- Theming: extensions/capabilities/theming.md
- Extension Guides:
- Overview: extensions/guides/README.md
- Renderer Extension: extensions/guides/renderer-extension.md
- Testing and Publishing:
- Testing Extensions: extensions/testing-and-publishing/testing.md
- Publishing Extensions: extensions/testing-and-publishing/publishing.md
- Bundling Extensions: extensions/testing-and-publishing/bundling.md
- API Reference: extensions/api/README.md
- Contributing: contributing/README.md
- FAQ: faq/README.md
theme:
name: 'material'
highlightjs: true
@ -84,5 +86,8 @@ extra:
- icon: fontawesome/brands/slack
link: http://k8slens.slack.com/
name: Lens on Slack
- icon: fontawesome/solid/link
link: https://k8slens.dev/
name: Lens Website
version:
method: mike