mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Remove non-extension API docs (#2877)
All documents that related to Lens IDE in general will move to the private lens-ide repository. All extension API documents will remain in the lens repository and be served on a new url. Signed-off-by: Steve Richards <srichards@mirantis.com>
This commit is contained in:
steve richards
GitHub
parent
6cee819c8b
commit
88edeeef43
@ -1 +1 @@
|
|||||||
docs.k8slens.dev
|
api-docs.k8slens.dev
|
||||||
|
|||||||
@ -1,21 +1,46 @@
|
|||||||
# Overview
|
# Lens Extension API
|
||||||
|
|
||||||
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:
|
Customize and enhance the Lens experience with the Lens Extension API.
|
||||||
|
Use the extension API to create menus or page content.
|
||||||
|
The same extension API was used to create many of Lens's core features.
|
||||||
|
To install your first extension you should goto the [extension page](lens://app/extensions) in lens.
|
||||||
|
|
||||||
* Confidence that your clusters are properly setup and configured.
|
This documentation describes:
|
||||||
* 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:
|
* How to build, run, test, and publish an extension.
|
||||||
|
* How to take full advantage of the Lens Extension API.
|
||||||
|
* Where to find [guides](extensions/guides/README.md) and [code samples](https://github.com/lensapp/lens-extension-samples) to help get you started.
|
||||||
|
|
||||||
[](https://www.youtube.com/watch?v=eeDwdVXattc)
|
## What Extensions Can Do
|
||||||
|
|
||||||
**Note:** Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab
|
Here are some examples of what you can achieve with the Extension API:
|
||||||
|
|
||||||
|
* Add custom components & views in the UI - Extending the Lens Workbench
|
||||||
|
|
||||||
|
For an overview of the Lens Extension API, refer to the [Common Capabilities](extensions/capabilities/common-capabilities.md) page. [Extension Guides Overview](extensions/guides/README.md) also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.
|
||||||
|
|
||||||
|
## How to Build Extensions
|
||||||
|
|
||||||
|
Here is what each section of the Lens Extension API docs can help you with:
|
||||||
|
|
||||||
|
* **Getting 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.
|
||||||
|
* **API Reference** contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.
|
||||||
|
|
||||||
|
## What's New
|
||||||
|
|
||||||
|
Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release.
|
||||||
|
|
||||||
|
Keep up with Lens and the Lens Extension API by reviewing the [release notes](https://github.com/lensapp/lens/releases).
|
||||||
|
|
||||||
|
## Looking for Help
|
||||||
|
|
||||||
|
If you have questions for extension development, try asking on the [Lens Dev Slack](http://k8slens.slack.com/). It's a public chatroom for Lens developers, where Lens team members chime in from time to time.
|
||||||
|
|
||||||
|
To provide feedback on the documentation or issues with the Lens Extension API, create new issues at [lensapp/lens](https://github.com/lensapp/lens/issues). Please use the labels `area/documentation` and/or `area/extension`.
|
||||||
|
|
||||||
## Downloading Lens
|
## Downloading Lens
|
||||||
|
|
||||||
[Download Lens](https://github.com/lensapp/lens/releases) for macOS, Windows, or Linux.
|
[Download Lens](https://github.com/lensapp/lens/releases) for macOS, Windows, or Linux.
|
||||||
|
|
||||||
## Quick Start
|
|
||||||
|
|
||||||
Get up and running quickly by learning to [add clusters](clusters/adding-clusters.md).
|
|
||||||
|
|||||||
@ -1,22 +0,0 @@
|
|||||||
# 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). Or [click here](lens://app/cluster).
|
|
||||||
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.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known "gotchas" in some authentication types used in kubeconfig with Lens app.
|
|
||||||
|
|
||||||
## Exec auth plugins
|
|
||||||
|
|
||||||
When using [exec auth](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#configuration) plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 611 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 284 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 315 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 311 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 338 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 170 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 262 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 90 KiB |
@ -1,12 +0,0 @@
|
|||||||
# 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:
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
|
|
||||||
@ -1,75 +0,0 @@
|
|||||||
# 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**.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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](https://github.com/lensapp/lens/blob/master/troubleshooting/custom-prometheus.md).
|
|
||||||
|
|
||||||
### 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.
|
|
||||||
|
|
||||||
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
# Contributing
|
|
||||||
|
|
||||||
There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues.
|
|
||||||
|
|
||||||
Here are some ways you can contribute!
|
|
||||||
|
|
||||||
* [Development](./development.md) – Help make Lens better.
|
|
||||||
* [Maintaining the Project](./maintainers.md) – Become a community maintainer and help us maintain the project.
|
|
||||||
* [Extension Development](../extensions) – Add integrations via Lens Extensions.
|
|
||||||
* [Documentation](./documentation.md) – Help improve Lens documentation.
|
|
||||||
* [Promotion](./promotion.md) – Show your support, be an ambassador to Lens, write blogs, and make videos!
|
|
||||||
|
|
||||||
If you are an influencer, blogger, or journalist, feel free to [spread the word](./promotion.md)!
|
|
||||||
|
|
||||||
## Code of Conduct
|
|
||||||
|
|
||||||
This project adheres to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.
|
|
||||||
@ -1,43 +0,0 @@
|
|||||||
# Development
|
|
||||||
|
|
||||||
Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens.
|
|
||||||
|
|
||||||
When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.
|
|
||||||
|
|
||||||
## Recommended Reading:
|
|
||||||
|
|
||||||
- [TypeScript](https://www.typescriptlang.org/docs/home.html) (front-end/back-end)
|
|
||||||
- [ReactJS](https://reactjs.org/docs/getting-started.html) (front-end, ui)
|
|
||||||
- [MobX](https://mobx.js.org/) (app-state-management, back-end/front-end)
|
|
||||||
- [ElectronJS](https://www.electronjs.org/docs) (chrome/node)
|
|
||||||
- [NodeJS](https://nodejs.org/dist/latest-v12.x/docs/api/) (api docs)
|
|
||||||
|
|
||||||
## Local Development Environment
|
|
||||||
|
|
||||||
> Prerequisites: Nodejs v12, make, yarn
|
|
||||||
|
|
||||||
* `make dev` - builds and starts the app
|
|
||||||
* `make clean` - cleanup local environment build artifacts
|
|
||||||
|
|
||||||
### Developing on Windows
|
|
||||||
|
|
||||||
On Windows we only support [Git Bash](https://gitforwindows.org/) (or similar shell) for running commands.
|
|
||||||
|
|
||||||
## Github Workflow
|
|
||||||
|
|
||||||
We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes are tracked via Pull Requests.
|
|
||||||
A detailed guide on the recommended workflow can be found below:
|
|
||||||
|
|
||||||
* [Github Workflow](./github_workflow.md)
|
|
||||||
|
|
||||||
## Code Testing
|
|
||||||
|
|
||||||
All submitted PRs go through a set of tests and reviews. You can run most of these tests *before* a PR is submitted.
|
|
||||||
In fact, we recommend it, because it will save on many possible review iterations and automated tests.
|
|
||||||
The testing guidelines can be found here:
|
|
||||||
|
|
||||||
* [Contributor's Guide to Testing](./testing.md)
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
By contributing, you agree that your contributions will be licensed as described in [LICENSE](https://github.com/lensapp/lens/blob/master/LICENSE).
|
|
||||||
@ -1,33 +0,0 @@
|
|||||||
# Documentation
|
|
||||||
|
|
||||||
We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: [How to Contribute to Open Source](https://opensource.guide/how-to-contribute).
|
|
||||||
|
|
||||||
## Finding Documentation Issues to Work On
|
|
||||||
|
|
||||||
You can find a list of open documentation-related issues [here](https://github.com/lensapp/lens/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fdocumentation). When you find something you would like to work on:
|
|
||||||
|
|
||||||
1. Express your interest to start working on an issue via comments.
|
|
||||||
2. One of the maintainers will assign the issue for you.
|
|
||||||
3. You can start working on the issue. When you're done, simply submit a pull request.
|
|
||||||
|
|
||||||
## Requirements for Documentation Pull Requests
|
|
||||||
|
|
||||||
When you create a new pull request, we expect some requirements to be met.
|
|
||||||
|
|
||||||
* Follow this naming convention for Pull Requests:
|
|
||||||
* When adding new documentation, add `New Documentation:` before the title. E.g. `New Documentation: Getting Started`
|
|
||||||
* When fixing documentation, add `Fix Documentation:` before the title. E.g. `Fix Documentation: Getting Started`
|
|
||||||
* When updating documentation, add `Update Documentation:` before the title. E.g. `Update Documentation: Getting Started`
|
|
||||||
* If your Pull Request closes an issue, you must write `Closes #ISSUE_NUMBER` where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close.
|
|
||||||
* For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.
|
|
||||||
|
|
||||||
|
|
||||||
## Testing Documentation Site Locally
|
|
||||||
|
|
||||||
Run a local instance of `mkdocs` in a docker container for developing the Lens Documentation.
|
|
||||||
|
|
||||||
> Prerequisites: docker, yarn
|
|
||||||
|
|
||||||
* `make docs` - local build and serve of mkdocs with auto update enabled
|
|
||||||
|
|
||||||
Go to [localhost:8000](http://127.0.0.1:8000).
|
|
||||||
@ -1,148 +0,0 @@
|
|||||||
# Github Workflow
|
|
||||||
|
|
||||||
<!-- TOC -->
|
|
||||||
- [Fork The Project](#fork-the-project)
|
|
||||||
- [Adding the Forked Remote](#adding-the-forked-remote)
|
|
||||||
- [Create & Rebase Your Feature Branch](#create--rebase-your-feature-branch)
|
|
||||||
- [Commit & Push](#commit--push)
|
|
||||||
- [Open a Pull Request](#open-a-pull-request)
|
|
||||||
- [Get a code review](#get-a-code-review)
|
|
||||||
- [Squash commits](#squash-commits)
|
|
||||||
- [Push Your Final Changes](#push-your-final-changes)
|
|
||||||
|
|
||||||
<!-- /TOC -->
|
|
||||||
This guide assumes you have already cloned the upstream repo to your system via git clone.
|
|
||||||
|
|
||||||
## Fork The Project
|
|
||||||
|
|
||||||
1. Go to [http://github.com/lensapp/lens](http://github.com/lensapp/lens)
|
|
||||||
2. On the top, right-hand side, click on "fork" and select your username for the fork destination.
|
|
||||||
|
|
||||||
## Adding the Forked Remote
|
|
||||||
|
|
||||||
```
|
|
||||||
export GITHUB_USER={ your github's username }
|
|
||||||
|
|
||||||
cd $WORKDIR/lens
|
|
||||||
git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git
|
|
||||||
|
|
||||||
# Prevent push to Upstream
|
|
||||||
git remote set-url --push origin no_push
|
|
||||||
|
|
||||||
# Set your fork remote as a default push target
|
|
||||||
git push --set-upstream $GITHUB_USER master
|
|
||||||
```
|
|
||||||
|
|
||||||
Your remotes should look something like this:
|
|
||||||
|
|
||||||
```
|
|
||||||
➜ git remote -v
|
|
||||||
origin https://github.com/lensapp/lens (fetch)
|
|
||||||
origin no_push (push)
|
|
||||||
my_fork git@github.com:{ github_username }/lens.git (fetch)
|
|
||||||
my_fork git@github.com:{ github_username }/lens.git (push)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Create & Rebase Your Feature Branch
|
|
||||||
|
|
||||||
Create a feature branch:
|
|
||||||
|
|
||||||
```
|
|
||||||
git branch -b my_feature_branch
|
|
||||||
```
|
|
||||||
|
|
||||||
Rebase your branch:
|
|
||||||
|
|
||||||
```
|
|
||||||
git fetch origin
|
|
||||||
|
|
||||||
git rebase origin/master
|
|
||||||
Current branch my_feature_branch is up to date.
|
|
||||||
```
|
|
||||||
|
|
||||||
Please don't use `git pull` instead of the above `fetch / rebase`. `git pull` does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful.
|
|
||||||
|
|
||||||
## Commit & Push
|
|
||||||
|
|
||||||
Commit and sign your changes:
|
|
||||||
|
|
||||||
```
|
|
||||||
git commit -m "my commit title" --signoff
|
|
||||||
```
|
|
||||||
|
|
||||||
You can go back and edit/build/test some more, then `commit --amend` in a few cycles.
|
|
||||||
|
|
||||||
When ready, push your changes to your fork's repository:
|
|
||||||
|
|
||||||
```
|
|
||||||
git push --set-upstream my_fork my_feature_branch
|
|
||||||
```
|
|
||||||
|
|
||||||
## Open a Pull Request
|
|
||||||
|
|
||||||
See [Github Docs](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
|
|
||||||
|
|
||||||
### Get a code review
|
|
||||||
|
|
||||||
Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests.
|
|
||||||
|
|
||||||
Commit changes made in response to review comments should be added to the same branch on your fork.
|
|
||||||
|
|
||||||
Very small PRs are easy to review. Very large PRs are very difficult to review.
|
|
||||||
|
|
||||||
### Squashing Commits
|
|
||||||
Commits on your branch should represent meaningful milestones or units of work.
|
|
||||||
Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed.
|
|
||||||
|
|
||||||
To do that, it's best to perform an [interactive rebase](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History):
|
|
||||||
|
|
||||||
#### Example
|
|
||||||
If you PR has 3 commits, count backwards from your last commit using `HEAD~3`:
|
|
||||||
```
|
|
||||||
git rebase -i HEAD~3
|
|
||||||
```
|
|
||||||
Output would be similar to this:
|
|
||||||
```
|
|
||||||
pick f7f3f6d Changed some code
|
|
||||||
pick 310154e fixed some typos
|
|
||||||
pick a5f4a0d made some review changes
|
|
||||||
|
|
||||||
# Rebase 710f0f8..a5f4a0d onto 710f0f8
|
|
||||||
#
|
|
||||||
# Commands:
|
|
||||||
# p, pick <commit> = use commit
|
|
||||||
# r, reword <commit> = use commit, but edit the commit message
|
|
||||||
# e, edit <commit> = use commit, but stop for amending
|
|
||||||
# s, squash <commit> = use commit, but meld into previous commit
|
|
||||||
# f, fixup <commit> = like "squash", but discard this commit's log message
|
|
||||||
# x, exec <command> = run command (the rest of the line) using shell
|
|
||||||
# b, break = stop here (continue rebase later with 'git rebase --continue')
|
|
||||||
# d, drop <commit> = remove commit
|
|
||||||
# l, label <label> = label current HEAD with a name
|
|
||||||
# t, reset <label> = reset HEAD to a label
|
|
||||||
# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
|
|
||||||
# . create a merge commit using the original merge commit's
|
|
||||||
# . message (or the oneline, if no original merge commit was
|
|
||||||
# . specified). Use -c <commit> to reword the commit message.
|
|
||||||
#
|
|
||||||
# These lines can be re-ordered; they are executed from top to bottom.
|
|
||||||
#
|
|
||||||
# However, if you remove everything, the rebase will be aborted.
|
|
||||||
#
|
|
||||||
# Note that empty commits are commented out
|
|
||||||
```
|
|
||||||
Use a command line text editor to change the word `pick` to `fixup` for the commits you want to squash, then save your changes and continue the rebase:
|
|
||||||
|
|
||||||
Per the output above, you can see that:
|
|
||||||
```
|
|
||||||
fixup <commit> = like "squash", but discard this commit's log message
|
|
||||||
```
|
|
||||||
Which means that when rebased, the commit message "fixed some typos" will be removed, and squashed with the parent commit.
|
|
||||||
|
|
||||||
### Push Your Final Changes
|
|
||||||
|
|
||||||
Once done, you can push the final commits to your branch:
|
|
||||||
```
|
|
||||||
git push --force
|
|
||||||
```
|
|
||||||
You can run multiple iteration of `rebase`/`push -f`, if needed.
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
# Maintainers
|
|
||||||
|
|
||||||
We are looking for community maintainers for the Lens project. Maintainers will be added to a special team with write permissions. These permissions consist of opening, closing, tagging, and editing issues and pull requests, as well as creating and deleting non-protected branches.
|
|
||||||
|
|
||||||
The responsibilities of a community maintainer are listed below.
|
|
||||||
|
|
||||||
## Issues Triage
|
|
||||||
|
|
||||||
* **Labeling Issues:** Label issues accordingly.
|
|
||||||
* **Finding Duplicates:** Finding and closing duplicate issues.
|
|
||||||
* **Doing First Level Contact:** Getting more information on the issues (like version number or asking for clarification) if needed.
|
|
||||||
* **Closing Irrelevant Issues:** Closing issues that are determined irrelevant, no longer needed, not relevant to the project and/or don't follow the issues guidelines.
|
|
||||||
|
|
||||||
## Help with Contributions
|
|
||||||
|
|
||||||
* **Help Manage Pull Requests:** Help the author of the pull request with any problems.
|
|
||||||
* **Contributing:** Create pull requests to help maintain and drive the project forward.
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
# Promotion
|
|
||||||
|
|
||||||
Help promote Lens! If you are not a developer (or even if you are), you can still contribute to the project – a lot – by helping us to promote it. As we are a free and open source project, the community is our most important asset. Here are some ways that you can help the project continue to grow.
|
|
||||||
|
|
||||||
## Follow, Like, Recommend, Favorite, Vote and Star Us
|
|
||||||
|
|
||||||
There are many sites where you can vote, recommend, favorite, and star us.
|
|
||||||
|
|
||||||
* [Twitter](https://twitter.com/k8slens) - Like, comment and retweet our posts, and follow us on Twitter.
|
|
||||||
* [Medium](https://medium.com/k8slens) - Give claps to our articles and follow us on Medium.
|
|
||||||
* [GitHub](https://github.com/lensapp/lens) - Become a stargazer on GitHub.
|
|
||||||
* [StackShare](https://stackshare.io/lens) - Indicate you are using Lens and follow us on StackShare.
|
|
||||||
* [Reddit](https://www.reddit.com/search/?q=lens%20kubernetes&sort=new) - Upvote and be a Lens ambassador by participating in relevant discussions on Reddit.
|
|
||||||
* [Hacker News](https://hn.algolia.com/?dateRange=all&page=0&prefix=false&query=lens%20kubernetes&sort=byDate&type=story) - Upvote and be a Lens ambassador by participating in relevant discussions on Hacker News.
|
|
||||||
|
|
||||||
## Write Blogs or Make Videos About Us
|
|
||||||
|
|
||||||
Here are some nice blog posts and videos about our project for you to get some inspiration:
|
|
||||||
|
|
||||||
* [Onboard AWS EKS Cluster on Lens(Kubernetes IDE)](https://dev.to/himwad05/onboard-aws-eks-cluster-on-lens-kubernetes-ide-492l)
|
|
||||||
* [Using Lens to Manage All Your Kubernetes Cluster](https://medium.com/@magicmagnate/using-lens-to-manage-all-your-kubernetes-cluster-c1ef88fdb476)
|
|
||||||
* [Kontena Lens - Beautiful Kubernetes UI](https://www.youtube.com/watch?v=YGgaiGdYfdI)
|
|
||||||
* [Gerenciando Kubernetes com Lens e Octant](https://www.youtube.com/watch?v=h9ZqDelJLQQ)
|
|
||||||
* [Walkthrough of Kubernetes IDE - Lens](https://www.youtube.com/watch?v=602aHZSdEfY)
|
|
||||||
* [LENS - Interfaz Gráfica para Kubernetes en 1 PASO.](https://www.youtube.com/watch?v=DFMKcR4BqwM)
|
|
||||||
|
|
||||||
Psst... If you have created some content around Lens, let us know!
|
|
||||||
@ -1,45 +0,0 @@
|
|||||||
## Testing Your Code
|
|
||||||
|
|
||||||
Lens uses github actions to run automated tests on any PR, before merging.
|
|
||||||
However, a PR will not be reviewed before all tests are green, so to save time and prevent your PR from going stale, it is best to test it before submitting the PR.
|
|
||||||
|
|
||||||
### Run Local Verifications
|
|
||||||
|
|
||||||
Please run the following style and formatting commands and fix/check-in any changes:
|
|
||||||
|
|
||||||
#### 1. Linting
|
|
||||||
|
|
||||||
We use [ESLing](https://eslint.org/) for style verification.
|
|
||||||
In the repository's root directory, simply run:
|
|
||||||
|
|
||||||
```
|
|
||||||
make lint
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 3. Pre-submit Flight Checks
|
|
||||||
|
|
||||||
In the repository root directory, make sure that:
|
|
||||||
|
|
||||||
* `make build` runs successfully.
|
|
||||||
* `make test` runs successfully.
|
|
||||||
* `make integration` runs successfully (some tests require minikube running).
|
|
||||||
|
|
||||||
Please note that this last test is prone to "flakiness", so it might fail on occasion. If it fails constantly, take a deeper look at your code to find the source of the problem.
|
|
||||||
|
|
||||||
If you find that all tests passed, you may open a pull request upstream.
|
|
||||||
|
|
||||||
### Opening A Pull Request
|
|
||||||
|
|
||||||
#### Draft Mode
|
|
||||||
|
|
||||||
You may open a pull request in [draft mode](https://github.blog/2019-02-14-introducing-draft-pull-requests).
|
|
||||||
All automated tests will still run against the PR, but the PR will not be assigned for review.
|
|
||||||
Once a PR is ready for review, transition it from Draft mode, and code owners will be notified.
|
|
||||||
|
|
||||||
#### Pre-Requisites for PR Merge
|
|
||||||
|
|
||||||
In order for a PR to be merged, the following conditions should exist:
|
|
||||||
1. The PR has passed all the automated tests (style, build & conformance tests).
|
|
||||||
2. PR commits have been signed with the `--signoff` option.
|
|
||||||
3. PR was reviewed and approved by a code owner.
|
|
||||||
4. PR is rebased against upstream's master branch.
|
|
||||||
@ -1,46 +0,0 @@
|
|||||||
# Lens Extension API
|
|
||||||
|
|
||||||
Customize and enhance the Lens experience with the Lens Extension API.
|
|
||||||
Use the extension API to create menus or page content.
|
|
||||||
The same extension API was used to create many of Lens's core features.
|
|
||||||
To install your first extension you should goto the [extension page](lens://app/extensions) in lens.
|
|
||||||
|
|
||||||
This documentation describes:
|
|
||||||
|
|
||||||
* How to build, run, test, and publish an extension.
|
|
||||||
* How to take full advantage of the Lens Extension API.
|
|
||||||
* Where to find [guides](guides/README.md) and [code samples](https://github.com/lensapp/lens-extension-samples) to help get you started.
|
|
||||||
|
|
||||||
## What Extensions Can 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
|
|
||||||
|
|
||||||
For an overview of the Lens Extension API, refer to the [Common Capabilities](capabilities/common-capabilities.md) page. [Extension Guides Overview](guides/README.md) also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.
|
|
||||||
|
|
||||||
## How to Build Extensions
|
|
||||||
|
|
||||||
Here is what each section of the Lens Extension API docs can help you with:
|
|
||||||
|
|
||||||
* **Getting 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.
|
|
||||||
* **API Reference** contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.
|
|
||||||
|
|
||||||
## What's New
|
|
||||||
|
|
||||||
Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release.
|
|
||||||
|
|
||||||
Keep up with Lens and the Lens Extension API by reviewing the [release notes](https://github.com/lensapp/lens/releases).
|
|
||||||
|
|
||||||
## Looking for Help
|
|
||||||
|
|
||||||
If you have questions for extension development, try asking on the [Lens Dev Slack](http://k8slens.slack.com/). It's a public chatroom for Lens developers, where Lens team members chime in from time to time.
|
|
||||||
|
|
||||||
To provide feedback on the documentation or issues with the Lens Extension API, create new issues at [lensapp/lens](https://github.com/lensapp/lens/issues). Please use the labels `area/documentation` and/or `area/extension`.
|
|
||||||
|
|
||||||
## Downloading Lens
|
|
||||||
|
|
||||||
[Download Lens](https://github.com/lensapp/lens/releases) for macOS, Windows, or Linux.
|
|
||||||
@ -46,7 +46,7 @@ cmd /c mklink /D helloworld-sample lens-extension-samples\helloworld-sample
|
|||||||
|
|
||||||
Without administrator rights, you need to copy the extensions sample directory into `C:\Users\<user>\.k8slens\extensions`:
|
Without administrator rights, you need to copy the extensions sample directory into `C:\Users\<user>\.k8slens\extensions`:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
Copy-Item 'lens-extension-samples\helloworld-sample' 'C:\Users\<user>\.k8slens\extensions\helloworld-sample'
|
Copy-Item 'lens-extension-samples\helloworld-sample' 'C:\Users\<user>\.k8slens\extensions\helloworld-sample'
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -78,7 +78,7 @@ npm run dev
|
|||||||
You must restart Lens for the extension to load.
|
You must restart Lens for the extension to load.
|
||||||
After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds.
|
After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds.
|
||||||
|
|
||||||
With Lens running, either connect to an existing cluster or [create a new one](../../clusters/adding-clusters.md).
|
With Lens running, either connect to an existing cluster or create a new one - refer to the latest [Lens Documentation](https://docs.k8slens.dev/latest/clusters/adding-clusters) for details on how to add a cluster in Lens IDE.
|
||||||
You will see the "Hello World" page in the left-side cluster menu.
|
You will see the "Hello World" page in the left-side cluster menu.
|
||||||
|
|
||||||
## Develop the Extension
|
## Develop the Extension
|
||||||
|
|||||||
@ -70,6 +70,6 @@ To debug your extension, please see our instructions on [Testing Extensions](../
|
|||||||
To dive deeper, consider looking at [Common Capabilities](../capabilities/common-capabilities.md), [Styling](../capabilities/styling.md), or [Extension Anatomy](anatomy.md).
|
To dive deeper, consider looking at [Common Capabilities](../capabilities/common-capabilities.md), [Styling](../capabilities/styling.md), or [Extension Anatomy](anatomy.md).
|
||||||
|
|
||||||
If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an [issue](https://github.com/lensapp/generator-lens-ext/issues).
|
If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an [issue](https://github.com/lensapp/generator-lens-ext/issues).
|
||||||
You can find the Lens contribution guidelines [here](../../contributing/README.md).
|
You can find the latest Lens contribution guidelines [here](https://docs.k8slens.dev/latest/contributing).
|
||||||
|
|
||||||
The Generator source code is hosted at [Github](https://github.com/lensapp/generator-lens-ext).
|
The Generator source code is hosted at [Github](https://github.com/lensapp/generator-lens-ext).
|
||||||
|
|||||||
@ -914,4 +914,4 @@ Construct the table using the `Component.Table` and related elements.
|
|||||||
|
|
||||||
For each pod the name, age, and status are obtained using the `K8sApi.Pod` methods.
|
For each pod the name, age, and status are obtained using the `K8sApi.Pod` methods.
|
||||||
The table is constructed using the `Component.Table` and related elements.
|
The table is constructed using the `Component.Table` and related elements.
|
||||||
See [`Component` documentation](https://docs.k8slens.dev/master/extensions/api/modules/_renderer_api_components_/) for further details.
|
See [Component documentation](https://docs.k8slens.dev/latest/extensions/api/modules/_renderer_api_components_/) for further details.
|
||||||
|
|||||||
@ -1,66 +0,0 @@
|
|||||||
# FAQ
|
|
||||||
|
|
||||||
### What operating systems does Lens support?
|
|
||||||
|
|
||||||
Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options.
|
|
||||||
|
|
||||||
### Lens application is not opening, what might be wrong?
|
|
||||||
|
|
||||||
When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that `localhost` DNS points to `127.0.0.1` address.
|
|
||||||
|
|
||||||
### Why can't I add any clusters?
|
|
||||||
|
|
||||||
When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid.
|
|
||||||
|
|
||||||
### Why Cluster dashboard is not opening?
|
|
||||||
|
|
||||||
To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses `exec` command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see [#699](https://github.com/lensapp/lens/issues/699).
|
|
||||||
|
|
||||||
### Why I don't see anything on Cluster dashboard?
|
|
||||||
|
|
||||||
Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig.
|
|
||||||
|
|
||||||
### Why I don't see any metrics or some of the metrics are not working?
|
|
||||||
|
|
||||||
In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed.
|
|
||||||
|
|
||||||
Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using [here](https://github.com/lensapp/lens/tree/master/src/main/prometheus) and adapt your prometheus configuration to support those queries. Please refer [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) or your Prometheus installer documentation how to do this.
|
|
||||||
|
|
||||||
### Kubectl is not working in Lens terminal, what should I do?
|
|
||||||
|
|
||||||
Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead.
|
|
||||||
|
|
||||||
### How can I configure Helm repositories?
|
|
||||||
|
|
||||||
Lens comes with bundled Helm 3 binary and Lens will add by default `bitnami` repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line.
|
|
||||||
|
|
||||||
### Where can I find application logs?
|
|
||||||
|
|
||||||
Lens will store application logs to following locations depending on your operating system:
|
|
||||||
- MacOS: ~/Library/Logs/Lens/
|
|
||||||
- Windows: %USERPROFILE%\AppData\Roaming\Lens\logs\
|
|
||||||
- Linux: ~/.config/Lens/logs/
|
|
||||||
|
|
||||||
### How can I see more verbose logs?
|
|
||||||
|
|
||||||
You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide `DEBUG=true` environment variable and before starting the application, for example: `DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens`
|
|
||||||
|
|
||||||
### Why Lens window rendering is broken?
|
|
||||||
|
|
||||||
MacOS users can encouter visual bug with fuzzy lines appeared while [connected to external 4K display](https://www.forbes.com/sites/gordonkelly/2020/06/11/apple-macos-macbook-pro-google-chrome-display-problem/?sh=331ac27967b4). Same thing can happen with any of Electron applications or Chrome itself.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide `LENS_DISABLE_GPU=true` env variable and relaunch app.
|
|
||||||
|
|
||||||
First, open `.bash_profile` file from your terminal
|
|
||||||
|
|
||||||
```
|
|
||||||
open -a TextEdit.app ~/.bash_profile
|
|
||||||
```
|
|
||||||
|
|
||||||
Then, add this line
|
|
||||||
|
|
||||||
```
|
|
||||||
export LENS_DISABLE_GPU=true
|
|
||||||
```
|
|
||||||
@ -1,77 +0,0 @@
|
|||||||
# 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](../supporting/requirements.md) to check if your computer configuration is supported.
|
|
||||||
|
|
||||||
|
|
||||||
## macOS
|
|
||||||
|
|
||||||
1. [Download Lens](https://github.com/lensapp/lens/releases) for macOS.
|
|
||||||
2. Open the browser's download list and locate the downloaded archive.
|
|
||||||
3. Select the 'magnifying glass' icon to open the archive in Finder.
|
|
||||||
4. Double-click `Lens-{version}.dmg` and drag `Lens.app` to the `Applications` folder, making it available in the macOS Launchpad.
|
|
||||||
5. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing **Options**, **Keep in Dock**.
|
|
||||||
|
|
||||||
|
|
||||||
## Windows
|
|
||||||
|
|
||||||
1. Download the [Lens installer](https://github.com/lensapp/lens/releases) for Windows.
|
|
||||||
2. Once it is downloaded, run the installer `Lens-Setup-{version}.exe`. This will only take a minute.
|
|
||||||
3. By default, Lens is installed under `C:\users\{username}\AppData\Local\Programs\Lens`.
|
|
||||||
|
|
||||||
|
|
||||||
## Linux
|
|
||||||
|
|
||||||
See the [Download Lens](https://github.com/lensapp/lens/releases) page for a complete list of available installation options.
|
|
||||||
|
|
||||||
After installing Lens manually (not using a package manager file such as `.deb` or `.rpm`) the following will need to be done to allow protocol handling.
|
|
||||||
This assumes that your linux distribution uses `xdg-open` and the `xdg-*` suite of programs for determining which application can handle custom URIs.
|
|
||||||
|
|
||||||
1. Create a file called `lens.desktop` in either `~/.local/share/applications/` or `/usr/share/applications` (if you have permissions and are installing Lens for all users).
|
|
||||||
1. That file should have the following contents, with `<path/to/executable>` being the absolute path to where you have installed the unpacked `Lens` executable:
|
|
||||||
```
|
|
||||||
[Desktop Entry]
|
|
||||||
Name=Lens
|
|
||||||
Exec=<path/to/executable> %U
|
|
||||||
Terminal=false
|
|
||||||
Type=Application
|
|
||||||
Icon=lens
|
|
||||||
StartupWMClass=Lens
|
|
||||||
Comment=Lens - The Kubernetes IDE
|
|
||||||
MimeType=x-scheme-handler/lens;
|
|
||||||
Categories=Network;
|
|
||||||
```
|
|
||||||
1. Then run the following command:
|
|
||||||
```
|
|
||||||
xdg-settings set default-url-scheme-handler lens lens.desktop
|
|
||||||
```
|
|
||||||
1. If that succeeds (exits with code `0`) then your Lens install should be set up to handle `lens://` URIs.
|
|
||||||
|
|
||||||
### Snap
|
|
||||||
|
|
||||||
Lens is officially distributed as a Snap package in the [Snap Store](https://snapcraft.io/store):
|
|
||||||
|
|
||||||
[](https://snapcraft.io/kontena-lens)
|
|
||||||
|
|
||||||
You can install it by running:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
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](https://github.com/lensapp/lens/releases).
|
|
||||||
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
|
|
||||||
- [Launch Lens](lens://app/landing)
|
|
||||||
- [Add clusters](../clusters/adding-clusters.md)
|
|
||||||
- [Watch introductory videos](./introductory-videos.md)
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 131 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 124 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.3 KiB |
@ -1,36 +0,0 @@
|
|||||||
# 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.
|
|
||||||
|
|
||||||
<ul class="video-list">
|
|
||||||
<li class="video">
|
|
||||||
<a target="_blank" href="https://youtu.be/mc-BzPDKfkQ">
|
|
||||||
<img src="https://img.youtube.com/vi/mc-BzPDKfkQ/mqdefault.jpg" alt aria-hidden="true" class="thumb"/>
|
|
||||||
<div class="info">
|
|
||||||
<h3 class="title">Getting started</h3>
|
|
||||||
<p class="description">Get Lens Kubernetes IDE Running in 5 Minutes</p>
|
|
||||||
<span class="duration"><span class="sr-only">Duration </span>35<span class="sr-only"> minutes</span></span>
|
|
||||||
</div>
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
<li class="video">
|
|
||||||
<a target="_blank" href="https://youtu.be/epw_MjxjMYI">
|
|
||||||
<img src="https://img.youtube.com/vi/epw_MjxjMYI/mqdefault.jpg" alt aria-hidden="true" class="thumb"/>
|
|
||||||
<div class="info">
|
|
||||||
<h3 class="title">Introducing Lens</h3>
|
|
||||||
<p class="description">Lens Kubernetes IDE overview</p>
|
|
||||||
<span class="duration"><span class="sr-only">Duration </span>2<span class="sr-only"> minutes</span></span>
|
|
||||||
</div>
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
<li class="video">
|
|
||||||
<a target="_blank" href="https://youtu.be/fqneoWCgJdw">
|
|
||||||
<img src="https://img.youtube.com/vi/fqneoWCgJdw/mqdefault.jpg" alt aria-hidden="true" class="thumb"/>
|
|
||||||
<div class="info">
|
|
||||||
<h3 class="title">Demo of Mirantis Lens</h3>
|
|
||||||
<p class="description">The Best IDE For Kubernetes</p>
|
|
||||||
<span class="duration"><span class="sr-only">Duration </span>10<span class="sr-only"> minutes</span></span>
|
|
||||||
</div>
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
# Preferences
|
|
||||||
|
|
||||||
## Color Themes
|
|
||||||
|
|
||||||
The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking.
|
|
||||||
|
|
||||||
1. Go to **File** > **Preferences** (**Lens** > **Preferences** on Mac). Or follow [this link](lens://app/preferences?highlight=appearance).
|
|
||||||
2. 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](https://www.mirantis.com/company/privacy-policy/) 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.
|
|
||||||
|
|
||||||
1. Go to **File** > **Preferences** (**Lens** > **Preferences** on Mac). Or follow [this link](lens://app/preferences?highlight=telemetry-tracking).
|
|
||||||
2. Scroll down to **Telemetry & Usage Tracking**
|
|
||||||
3. 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.
|
|
||||||
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
# Using Helm Charts
|
|
||||||
|
|
||||||
Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Managing Helm Repositories
|
|
||||||
|
|
||||||
Used Helm repositories are possible to configure in the [Preferences](/getting-started/preferences). Lens app will fetch available Helm repositories from the [Artifact HUB](https://artifacthub.io/) and automatically add `bitnami` repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. **Note!** Configured Helm repositories are added globally to user's computer, so other processes can see those as well.
|
|
||||||
|
|
||||||
|
|
||||||
## Installing a Helm Chart
|
|
||||||
|
|
||||||
Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click "Install" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking "Install" button Lens will deploy the chart into the cluster.
|
|
||||||
|
|
||||||
## Updating a Helm Release
|
|
||||||
|
|
||||||
To update a Helm release, you can open the release details and modify the release values and click "Save" button. To upgrade or downgrade the release, click "Upgrade" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click "Upgrade" or "Upgrade and Close" button.
|
|
||||||
|
|
||||||
## Deleting a Helm Release
|
|
||||||
To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. **Note!** If the release included any persistent volumes, those are required to remove manually!
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.1 MiB |
@ -1,16 +0,0 @@
|
|||||||
# Support
|
|
||||||
|
|
||||||
Here you will find different ways of getting support for Lens IDE.
|
|
||||||
|
|
||||||
## Community Support
|
|
||||||
|
|
||||||
* [Community Slack](https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI) - Request for support and help from the Lens community via Slack.
|
|
||||||
* [Github Issues](https://github.com/lensapp/lens/issues) - Submit your issues and feature requests to Lens IDE via Github.
|
|
||||||
|
|
||||||
## Commercial Support & Services
|
|
||||||
|
|
||||||
If you are interested in paid support options, professional services or training, please see the offerings from the following vendors:
|
|
||||||
|
|
||||||
* [Mirantis](https://www.mirantis.com/software/lens/) offers commercial support for officially released versions of Lens IDE on MacOS, Windows and Linux operating systems. In addition, Mirantis offers professional services to create proprietary / custom Lens IDE extensions and custom `msi` packaging to meet enterprise IT policies for software distribution and configuration. Training is also available.
|
|
||||||
|
|
||||||
If you'd like to get your business listed in here, please contact us via email [info@k8slens.dev](mailto:info@k8slens.dev)
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
# 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:
|
|
||||||
|
|
||||||
* macOS
|
|
||||||
* Windows
|
|
||||||
* Linux
|
|
||||||
|
|
||||||
### Additional Windows requirements
|
|
||||||
|
|
||||||
...
|
|
||||||
|
|
||||||
### Additional Linux Requirements
|
|
||||||
|
|
||||||
...
|
|
||||||
23
mkdocs.yml
23
mkdocs.yml
@ -1,7 +1,7 @@
|
|||||||
site_name: Lens Documentation
|
site_name: Lens Extension API
|
||||||
site_description: Documentation for Lens IDE. The only system you’ll ever need to take control of your Kubernetes clusters. It's open source and free. Download it today!
|
site_description: Documentation for Lens Extension API.
|
||||||
site_author: Mirantis, Inc.
|
site_author: Mirantis, Inc.
|
||||||
site_url: https://docs.k8slens.dev
|
site_url: https://api-docs.k8slens.dev
|
||||||
docs_dir: docs/
|
docs_dir: docs/
|
||||||
repo_name: GitHub
|
repo_name: GitHub
|
||||||
repo_url: https://github.com/lensapp/lens
|
repo_url: https://github.com/lensapp/lens
|
||||||
@ -12,16 +12,7 @@ google_analytics:
|
|||||||
- auto
|
- auto
|
||||||
nav:
|
nav:
|
||||||
- Overview: README.md
|
- Overview: README.md
|
||||||
- Getting Started: getting-started/README.md
|
|
||||||
- Managing Clusters:
|
|
||||||
- Adding Clusters: clusters/adding-clusters.md
|
|
||||||
- Removing Clusters: 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:
|
- Extension Development:
|
||||||
- Overview: extensions/README.md
|
|
||||||
- Getting Started:
|
- Getting Started:
|
||||||
- Overview: extensions/get-started/overview.md
|
- Overview: extensions/get-started/overview.md
|
||||||
- Your First Extension: extensions/get-started/your-first-extension.md
|
- Your First Extension: extensions/get-started/your-first-extension.md
|
||||||
@ -43,14 +34,6 @@ nav:
|
|||||||
- Testing Extensions: extensions/testing-and-publishing/testing.md
|
- Testing Extensions: extensions/testing-and-publishing/testing.md
|
||||||
- Publishing Extensions: extensions/testing-and-publishing/publishing.md
|
- Publishing Extensions: extensions/testing-and-publishing/publishing.md
|
||||||
- API Reference: extensions/api/README.md
|
- API Reference: extensions/api/README.md
|
||||||
- Contributing:
|
|
||||||
- Overview: contributing/README.md
|
|
||||||
- Development: contributing/development.md
|
|
||||||
- Documentation: contributing/documentation.md
|
|
||||||
- Maintainers: contributing/maintainers.md
|
|
||||||
- Promotion: contributing/promotion.md
|
|
||||||
- Support: support/README.md
|
|
||||||
- FAQ: faq/README.md
|
|
||||||
theme:
|
theme:
|
||||||
name: 'material'
|
name: 'material'
|
||||||
highlightjs: true
|
highlightjs: true
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user