Skip to content

Latest commit

 

History

History
113 lines (86 loc) · 5.45 KB

README.md

File metadata and controls

113 lines (86 loc) · 5.45 KB
Raw

Starboard Lens Extension

This is a Lens extension for Starboard which provides visibility into vulnerability assessment reports for Kubernetes workloads stored as custom security resources.

GitHub Release GitHub Build Actions License GitHub All Releases

Screenshot

Installation

This guide shows how to install the extension either from pre-built binary releases or source.

Prerequisites

  • Lens >= 4.0 should first be installed.
  • Follow Starboard Getting Started guide to understand how Starboard is initialized and how it generates security reports, which are then stored as custom resources.

Compatibility Matrix

The following matrix indicates versions of this extension and compatible Lens releases.

Lens Extension
5.2 0.2.0
5.0 0.1.0
4.0 0.0.2
4.0 0.0.1

From the Binary Releases

Every release of Lens extension for Starboard provides the tarball-file that can be manually downloaded and installed. Alternatively, you can copy the download URL of the release artifact to paste it in the Manage Lens Extensions page.

  1. Download your desired version from GitHub releases page or GitHub package registry. Alternatively, just copy the download URL of the release artifact.
  2. Open Lens application and select Lens menu, and then click Extensions item, or press Shift + Command + E to open the Manage Lens Extensions page.
  3. Specify the path (.tar, .tgz) or download URL to the extension package and click Install.
  4. If everything is fine, you'll see the @aquasecurity/starboard-lens-extension extension listed under Installed Extensions. Click Enable to enable it.
  5. Close the Manage Lens Extensions page and verify that the Starboard menu item shows up in the main menu.

From Source (Linux, macOS)

Building from source is slightly more involved, but it's the best way to go if you want to test the latest (pre-release) version of the extension.

You must have a working Node.js environment.

  1. Clone the source code: 
    git clone https://github.com/aquasecurity/starboard-lens-extension.git
cd starboard-lens-extensions
  2. Build the extension's package: 
    npm install && npm run build
  3. Create a tarball from a package: 
    npm pack
    This will create the aquasecurity-starboard-lens-extension-$VERSION.tgz tarball in the root directory.
  4. Open Lens application and select Lens menu, and then click Extensions item, or press Shift + Command + E to open the Manage Lens Extensions page.
  5. Specify the path the aquasecurity-starboard-lens-extension-$VERSION.tgz extension package and click Install.
  6. If everything goes fine, you'll see the @aquasecurity/starboard-lens-extension extension listed under Installed Extensions.

Getting Started

NOTE: As the source code of the extension is evolving very fast, some screenshots shown below may be outdated. We'll also update this section with more examples.

  • VulnerabilityReports

  • ConfigAuditReports and ClusterConfigAuditReports

  • CISKubeBenchReports