Documentation (MKDOCS) (#1230)

Co-authored-by: Steve Richards <srichards@mirantis.com>
Co-authored-by: Mario Sarcher <msarcher@mirantis.com>
Co-authored-by: steve richards <steve.james.richards@gmail.com>
Co-authored-by: Paul Williams <pawilliams@mirantis.com>
Co-authored-by: pauljwil <pauljwil@gmail.com>
This commit is contained in:
authored and GitHub committed 2020-11-05 16:38:56 +02:00
1 parent d074e0499f
commit 3bc45218c1
41 files changed
+719 -2

No files matched your search

+16
View File
@@ -0,0 +1,16 @@
# Adding clusters
Add clusters by clicking the **Add Cluster** button in the left-side menu.
1. Click the **Add Cluster** button (indicated with a '+' icon).
2. 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](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) 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.
![Add Cluster](images/add-cluster.png)
For more information on kubeconfig see [Kubernetes docs](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/).
To see your currently-enabled config with `kubectl`, enter `kubectl config view --minify --raw` in your terminal.
Binary file not shown.

After

Width:  |  Height:  |  Size: 253 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 262 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

+12
View File
@@ -0,0 +1,12 @@
# 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:
1. Hover over the name of the cluster you want to remove in the left side menu. A context menu will appear.
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.
![Remove Cluster](images/remove-cluster.png)
+63
View File
@@ -0,0 +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 `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](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.