clastix/capsule-lens-extension

Lens Extension for Capsule Operator - Looking for a maintainer

Capsule Lens extension

This is a Lens extension for the Capsule Operator which provides advanced multi-tennancy and policy control on your Kubernetes cluster.

Installation

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

Prerequisites

• Lens minimum 5.3.0 should first be installed on your workstation.
• Follow the Capsule Getting Started guide to understand how to install the Capsule Operator in your Kubernetes cluster.
• Optionally, install the Capsule Proxy for an enhanced user experience for your tenant users.

From pre-built release

Lens extension for Capsule 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 release page. Alternatively, just copy the download URL of the release artefact.
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 of the extension package .tar, .tgz or the download URL and click Install.
4. If everything is fine, you'll see the @clastix/capsule-lens-extension extension listed under Installed Extensions. Click Enable to enable it.
5. Close the Manage Lens Extensions page and verify that the Capsule menu item shows up in the main Lens menu.

From source (Linux/MacOS)

1. Clone this repo.
2. make build && make install to build the extension and create a symlink.
3. Enable the extension in Lens Extensions as above.

Development mode

1. Install the extension by following the steps above.
2. make dev to start webpack process in watch mode.
3. Press Ctrl+R in Lens to reload the extension after making changes.

Getting Started

With Capsule extension for Lens, a cluster administrator can easly manage from a single pane of glass all resources of a Kubernetes cluster, including all the Tenants created through the Capsule Operator. Please, refer to the documentation about how Capsule can help to address multi-tanancy and policy control on your Kubernetes cluster.

Tenants list

List all tenants:

Tenant details

See the deatils of each tenant and change it through the embedded Lens editor:

Resources Quota and Budget for all tenants

Check the resources usage and quota at both the tenant and namespace level:

Allowed namespaces list

If you installed the Capsule Proxy, each tenant user can see only the namespaces he has access:

capsule-lens-extension's Issues

[Resource Budget List] Make the list readonly

[Resource Budget List]
Make the list readonly

Installing from source code on Mac OS fails

Installing from source code on Mac OS fails:

make build
make install
ln -sT "/Users/joe/Shared/clastix/capsule-lens-extension" "/Users/joe/.k8slens/extensions/capsule"
ln: illegal option -- T

Change Icon on the left side menu

Change the icon of Capsule extension.

Try this one verified_user

Incompatible in lens 5

[Tenant details page] Display the Allowed fields even when empty

[Tenant details page]

Display the Allowed fields even when empty.

For example

should be

[Tenant details page] Use capital letters for the names of fields

[Tenant detail page]: use capital letters for the names of fields

e.g.
Ingress Classes instead of Ingress classes
Network Policies instead of Network policies
...

Installing from the npm tarball

Installing from the npm tarball. I generated the tarball as following the instructions from Lens documentation. After installation, the extension is not loaded in Lens.

Make the Network Policy panel collapsable

In the tenant details window, make the Network Policy panel collapsable similar to the Resource Quota panel

[Tenant details page] Display of Resource Quotas elements

[Tenant details page]

Display of Resource Quotas elements in a consistent way with other tenant fields

For example

Network policies view isn't consistent with other fields

In the Tenant details window, the Network policies view isn't consistent with other fields. Let's to make it consistent in look & feel by align to other fields, e.g. Resource Quota, or by changing how other fields look.

[Tenants details page] Change the display of Namespace Quota and Count

[Tenants details page]
Change the display of Namespace Quota and Count

Should be

Add new Tenant button

In the Tenants list windows, provide a button to create a new tenant. This will open a wizard with guided process to create a new tenant.

Support of CapsuleConfiguration CR

Introduce support of CapsuleConfiguration CRD APIs:

apiVersion: capsule.clastix.io/v1alpha1
kind: CapsuleConfiguration
metadata:
  name: default
spec:
  userGroups: ["capsule.clastix.io"]
  forceTenantPrefix: false
  protectedNamespaceRegex: ""

Update the Resource Budget menu

Currently, the "Resource Budget" menu shows the list of Resource Quota objects. Initially, the aim of this menu was to give users a way to check the resource consumption at both namespace and tenant level. This info is derived from the annotations placed on the Resource Quota object by the Capsule Operator.

However, current implementation already provides this info in the Resource Quota objects from the standard "Resource Quota" page. The "Resource Budget" menu is now redundant. Shall we consider to remove it?

Add documentation

Add documentation and how to

Hide the menu for unprivileged users

Currently, the Capsule menu on the left side of Lens is displayed for all the users. It would be nice to hide/show the menu according to the user's permissions. For example, users that cannot list tenants should not see the menu.

Support of Capsule Tenant CR v1beta1

Introduce the support of Capsule Tenant CRD v1beta1 APIs version:

apiVersion: capsule.clastix.io/v1beta1
kind: Tenant
metadata:
  name: gas
spec:
  owners:
    -
      kind: User
      name: bob

Implement a proper notification for Add Tenant button

The button (#21) is implemented but if an error happens it's being reported to the user with a basic alert(err) call. Need to implement a proper notification using Lens API.

[Tenant details page] Display of Network Policies elements

[Tenant details page]
Display of Network Policies elements in a consistent way to the other tenants fields.

[Tenant details page] Change the display of the owner fields

[Tenant details page] Change the display of the owner fields

Currently:

Expected:

Expose the Tenant metrics in a graphical format

In the Tenant detail window, we need to expose the metrics in a graphical format.

[Tenants details page] Display of Resource Quota

[Tenants details page] Display of Resource Quota as toggle list

Current

Expected

[Tenant details page] Display of Limit Ranges

[Tenant details page]

Change the display of Limit Ranges to make it consistent with yaml structure of LimitRanges and aligned with look&feel of the other tenant fields.

@zhilinn I appreciate your effort to make the display more compact and readable but I prefer to have a more consistent view.

Try this display

[Tenant details page] Highlight the background of Allowed regex

[Tenant details page]

Highlight the background of the Allowed regex. They should appear like labels.

Extension incompatible with Lens 5.4.x

When adding the pre-build release (0.0.1) to the Lens instance (version 5.4.3), it states "Incompatible version".

Is there a dependency that needs to be bumped to get the extension to work with newer versions of Lens?