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

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>

2020-11-05 16:38:56 +02:00

3.0 KiB

Raw Blame History

Lens | The Kubernetes IDE

Lens is the only IDE you’ll ever need to take control of your Kubernetes clusters. It is a standalone application for MacOS, Windows and Linux operating systems. It is open source and free.

What makes Lens special?

Amazing usability and end-user experience
Multi cluster management: support for hundreds of clusters
Standalone application: no need to install anything in-cluster
Real-time cluster state visualization
Resource utilization charts and trends with history powered by built-in Prometheus
Terminal access to nodes and containers
Performance optimized to handle massive clusters (tested with a cluster running 25k pods)
Full support for Kubernetes RBAC

Installation

Download a pre-built package from the releases page. Lens can be also installed via snapcraft (Linux only).

Alternatively on Mac:

brew cask install lens

Development

Prerequisites: Nodejs v12, make, yarn

make init - initial compilation, installing deps, etc.
make dev - builds and starts the app
make test - run tests

Development (advanced)

Allows for faster separate re-runs of some of the more involved processes:

yarn dev:main compiles electron's main process app part
yarn dev:renderer compiles electron's renderer app part
yarn dev:extension-types compile declaration types for @k8slens/extensions
yarn dev-run runs app in dev-mode and auto-restart when main process file has changed

Development (documentation)

Run a local instance of mkdocs serve in a docker container for developing the Lens Documentation.

Prerequisites: docker, yarn

yarn mkdocs-serve-local - local build and serve of mkdocs with auto update enabled

Go to localhost:8000

Developer's RTFM recommended list:

TypeScript (front-end/back-end)
ReactJS (front-end, ui)
MobX (app-state-management, back-end/front-end)
ElectronJS (chrome/node)
NodeJS (api docs)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lensapp/lens.

3.0 KiB Raw Blame History Unescape Escape