lensapp/lens

Discovery based API support

Open

#666 opened on Aug 10, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (22,003 stars) (1,433 forks)batch import
bugenhancementhelp wanted

Description

What would you like to be added: A mechanism for cluster supported APIs to be discovered and handled automatically.

Why is this needed: Currently, our KubeApi<T> interface treats a version difference (say between v1beta1 and v1 of customresourcedefinition) as completely different apis and thus when trying to create a new CRD in lens unhelpful error messages are being displayed.

I don't know if this is a problem with other aspects of lens but it seems like definitely could be.

Possible Solutions:

  • Do nothing, keep manually adding apis as they come up
  • Add some sort of discovery mechanism that (might) request the supported APIs via kubectl or something similar.

Contributor guide

Tech stack
typescriptreact
Domain
backendapideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of Kubernetes API versioningFamiliarity with Lens's KubeApi<T> interface
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue proposes adding automatic discovery of supported APIs for Kubernetes clusters. To implement this, first explore the current KubeApi<T> interface in the Lens codebase to understand how API versions are handled. Then research how kubectl discovers API versions (e.g., via API discovery endpoints) and consider how to integrate that into Lens. The discussion suggests two possible solutions: manual addition or automatic discovery. The maintainers' input on preferred approach would be helpful.