Skip to content

Commit

Permalink
feat: update ReadME
Browse files Browse the repository at this point in the history
  • Loading branch information
Erick dela Cruz committed Feb 12, 2021
1 parent 358b552 commit 5de0610
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 15 deletions.
37 changes: 23 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,46 +7,55 @@ This is a [Lens](https://k8slens.dev/) Extension for [Carbonetes](https://carbon
## Prerequisites

* You need to have [node](https://nodejs.org/en/) and [npm](https://nodejs.org/en/) installed on your system. It is recommended to use the node version used for Lens development itself which is documented [here](https://github.com/lensapp/lens#development).
* [Install][lens-installation] Lens >= [4.0.3][min-lens].
* Install [Lens](https://github.com/lensapp/lens/releases/latest) application.
* You need to have a [Carbonetes](https://console.carbonetes.com) account. Sign Up [here](https://console.carbonetes.com/register).

Note:
Image Analysis can only be used on images that are in container registries added through Carbonetes application

## Install

## Install
#### From the Binary Releases
1. Download your desired version from GitHub [release](https://github.com/carbonetes/carbonetes-lens-extension/releases) page. 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
<kbd>Shift</kbd> + <kbd>Command</kbd> + <kbd>E</kbd> to open the **Manage Lens Extensions** page.
3. Specify the path of the extension package `.tar`, `.tgz` or the download URL and click **Install**.
4. If everything is fine, you'll see the `@carbonetes/carbonetes-lens-extension` extension listed under
**Installed Extensions**. Click **Enable** to enable it.

#### From Source (Linux, macOS)
1. Clone the source code to the ~/.k8slens/extensions/carbonetes-lens-extensions directory:
```sh
mkdir -p ~/.k8slens/extensions
git clone https://github.com/carbonetes/carbonetes-lens-extension.git
ln -s $(pwd)/carbonetes-lens-extension ~/.k8slens/extensions/carbonetes-lens-extension
```

## Build

To build the extension you can use `make` or run the `npm` commands manually:
2. To build the extension you can use `make` or run the `npm` commands manually:

```sh
cd carbonetes-lens-extension
make build
```

OR

or
```sh
cd carbonetes-lens-extension
npm install
npm run build
```
3. Open Lens application and select **Lens** menu, and then click **Extensions** item, or press <kbd>Shift</kbd> + <kbd>Command</kbd> + <kbd>E</kbd> to open the **Manage Lens Extensions** page.

## Getting Started

1. Open Lens application and select **Lens** menu, and then click **Extensions** item, or press <kbd>Shift</kbd> + <kbd>Command</kbd> + <kbd>E</kbd> to open the **Manage Lens Extensions** page.
2. You'll see the @aquasecurity/starboard-lens-extension extension listed under Installed Extensions. Click Enable to enable it.
1. You'll see the @carbonetes/carbonetes-lens-extension extension listed under Installed Extensions. Click Enable to enable it.
![](docs/images/manage-extension.png)
3. Image
2. Image
![](docs/images/manage.png)
4. Complete Analysis
3. Complete Analysis
![](docs/images/complete-analysis.png)
5. Policy Evaluation
4. Policy Evaluation
![](docs/images/policy-evaluation.png)
6. Vulnerabilities
5. Vulnerabilities
![](docs/images/vulnerabilities.png)

## Uninstall
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@k8slens/carbonetes-lens-extension",
"name": "carbonetes-lens-extension",
"publisher": "Carbonetes",
"version": "0.0.1",
"description": "Lens Carbonetes extension",
Expand Down

0 comments on commit 5de0610

Please sign in to comment.