Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sponte committed Jul 19, 2022
1 parent 63a604d commit ad3880b
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 5 deletions.
41 changes: 36 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,43 @@
# Lens "FluxCD" Extension
# Lens FluxCD Extension

Adds FluxCD actions to Flux resources:
Add FluxCD support to Lens. https://fluxcd.io/

The following features are available:

* FluxCD dashboard of Flux Application components (Kustomizations and HelmReleases) and Sources (GitRepositories, HelmRepositories, HelmCharts and Buckets)
* FluxCD resource menus
* Reconcile
* Suspend/Resume
* FluxCD Kustomization details

## Screenshots

Dashboard
![./docs/images/dashboard.png](./docs/images/dashboard.png)

Details
![./docs/images/details.png](./docs/images/details.png)


Events
![./docs/images/events.png](./docs/images/events.png)

* Reconcile
* Suspend/Resume

## Install

To install open K8s Lens and go to Extensions (CTRL+SHIFT+E or CMD+SHIFT+E), and install `@evops/lens-extension-fluxcd`.

or

Click on the following lens:// link [lens://app/extensions/install/lens-certificate-info](lens://app/extensions/install/lens-certificate-info)




## Development

To install extension for development

```sh
mkdir -p ~/.k8slens/extensions
git clone https://github.com/eu-evops/lens-extension-fluxcd.git
Expand Down Expand Up @@ -36,7 +67,7 @@ npm run dev

## Test

Open Lens application and navigate to a cluster. You should see "Hello World" in a menu.
Open Lens application and navigate to a cluster. You should see "FluxCD" dashboard in a cluster menu.

## Uninstall

Expand Down
Binary file added docs/images/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/events.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ad3880b

Please sign in to comment.