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

updated cluster settings doc

Browse Source 
Signed-off-by: Steve Richards <srichards@mirantis.com>
This commit is contained in:
Steve Richards 2020-11-03 12:08:22 +00:00
parent 9c073a88b9
commit 25e75c265c
1 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/clusters/settings.md
View File

@ -1,35 +1,63 @@
# 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`.
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`.
![Cluster Settings](images/cluster-settings.png)
## Status
## Cluster Status
An overview of the cluster status.
This section in the cluster settings provides details including the detected distribution, kernel version, API endpoint and online 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](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`.
## 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
Remove the current cluster.