Skip to content

Latest commit

 

History

History
119 lines (71 loc) · 3.7 KB

README.md

File metadata and controls

119 lines (71 loc) · 3.7 KB
Raw

Kubescape Lens Extension

This extension brings the power of Kubescape to Lens so managing clusters was never simpler and more secure.

License GitHub Workflow Status GitHub package.json version

Prerequisites

  • Lens should be installed on your workstation. Please consult the following support matrix for version compatibility:

    Lens Kubescape Extension
    5.4 0.1.x
    5.5 0.1.x
    6.0 0.2.x
    6.1 0.2.x

Installation

  1. Open Lens and navigate to the Extensions page (or press Command + Shift+E on macOS).

  2. Enter @kubescape/lens-extension into the Install Extension box

  3. Click on the Install button.

Getting Started

The Kubescape extension for Lens will help you to easily scan and detect misconfigurations, software vulnerabilities, and RBAC (role-based-access-control) violations in your Kubernetes cluster.

Cluster-level information

  • Navigate to Kubescape from the side menu.
  • A Kubescape scan runs automatically on your cluster for the first time. You can also run a scan on-demand by clicking the Scan button.
  • The table reflects a cluster-level summary of Kubescape scan results.


  • To find out more information on a specific Kubescape control and its failed resources, click on it to open the side bar for a detailed view:

Object-level information

  • Kubescape information is also available at the object level. Click on the desired resource to open the details side bar and scroll down to Kubescape section:

This view only shows failed controls. If you don't see any that's a good thing 😅

Development mode

You must have a working Node.js environment.

  1. Clone the repository and then link to it:
git clone https://github.com/kubescape/lens-extension.git 
mkdir -p ~/.k8slens/extensions
ln -s $(pwd)/lens-extension ~/.k8slens/extensions/kubescape
  1. Install dependencies and build the extension by running make or npm commands:
cd lens-extension
make build

OR

cd lens-extension
npm install
npm run build
  1. To put your development build in watch mode you can run:
npm start

  1. Open Lens and navigate to the Extensions page (or press Command + Shift+E on macOS).

  2. If everything is fine, you should see the @kubescape/lens-extension extension listed under Installed Extensions. Click Enable to enable it.

To reflect your source code changes, reload the Lens window by pressing Command+R (macOS). Note: Any changes which affect Len's main thread will require a restart to the Lens application.

Uninstall

  1. Remove the link:
rm ~/.k8slens/extensions/kubescape
  1. Restart Lens application.