- - - - Adding Clusters# -Add clusters by clicking the Add Cluster button in the left-side menu. - -Click the Add Cluster button (indicated with a '+' icon). Or click here. -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 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. -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 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. - - - - - - - -
- - - - 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: - -Right-click the name of the cluster in the left-side menu that you want to remove. -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. - - - - - - - - -
- - - - Settings# -It is easy to configure Lens Clusters to your liking through its various settings. - -Right-click the name of the cluster in the left-side menu that you want to open the settings for. -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. -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. - - - - - - - - -
- - - - 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 (front-end/back-end) -ReactJS (front-end, ui) -MobX (app-state-management, back-end/front-end) -ElectronJS (chrome/node) -NodeJS (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 (or similar shell) for running commands. -Github Workflow# -We Use Github Flow, so all code changes are tracked via Pull Requests. -A detailed guide on the recommended workflow can be found below: - -Github Workflow - -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 - -License# -By contributing, you agree that your contributions will be licensed as described in LICENSE. - - - - - - - -
- - - - 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. -Finding Documentation Issues to Work On# -You can find a list of open documentation-related issues here. When you find something you would like to work on: - -Express your interest to start working on an issue via comments. -One of the maintainers will assign the issue for you. -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. - - - - - - - -
- - - - Github Workflow# - - -Fork The Project -Adding the Forked Remote -Create & Rebase Your Feature Branch -Commit & Push -Open a Pull Request -Get a code review -Squash commits -Push Your Final Changes - - -This guide assumes you have already cloned the upstream repo to your system via git clone. -Fork The Project# - -Go to http://github.com/lensapp/lens -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. -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: -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. - - - - - - - -
- - - - 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 – Help make Lens better. -Maintaining the Project – Become a community maintainer and help us maintain the project. -Extension Development – Add integrations via Lens Extensions. -Documentation – Help improve Lens documentation. -Promotion – 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! -Code of Conduct# -This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev. - - - - - - - -
- - - - 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. - - - - - - - - -
- - - - 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 - Like, comment and retweet our posts, and follow us on Twitter. -Medium - Give claps to our articles and follow us on Medium. -GitHub - Become a stargazer on GitHub. -StackShare - Indicate you are using Lens and follow us on StackShare. -Reddit - Upvote and be a Lens ambassador by participating in relevant discussions on Reddit. -Hacker News - 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) -Using Lens to Manage All Your Kubernetes Cluster -Kontena Lens - Beautiful Kubernetes UI -Gerenciando Kubernetes com Lens e Octant -Walkthrough of Kubernetes IDE - Lens -LENS - Interfaz Gráfica para Kubernetes en 1 PASO. - -Psst... If you have created some content around Lens, let us know! - - - - - - - -
- - - - Testing - - 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 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. -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. - - - - - - - -