-
Notifications
You must be signed in to change notification settings - Fork 174
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
frontend Map: Allow plugins to customize the map #2602
Open
sniok
wants to merge
7
commits into
main
Choose a base branch
from
map-plugins
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… the plugins Signed-off-by: Oleksandr Dubenko <[email protected]>
Signed-off-by: Oleksandr Dubenko <[email protected]>
Signed-off-by: Oleksandr Dubenko <[email protected]>
Signed-off-by: Oleksandr Dubenko <[email protected]>
Signed-off-by: Oleksandr Dubenko <[email protected]>
sniok
force-pushed
the
map-plugins
branch
2 times, most recently
from
November 27, 2024 10:38
870e4cc
to
f434b04
Compare
Signed-off-by: Oleksandr Dubenko <[email protected]>
Signed-off-by: Oleksandr Dubenko <[email protected]>
sniok
changed the title
WIP frontend Map: Allow plugins to customize the map
frontend Map: Allow plugins to customize the map
Nov 27, 2024
dosubot
bot
added
the
size:XL
This PR changes 500-999 lines, ignoring generated files.
label
Nov 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
frontend
Issues related to the frontend
plugins
resourceMap
size:XL
This PR changes 500-999 lines, ignoring generated files.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Basic Map extension
This PR introduces 3 new functions that allow for the simplest case of extending the Map.
You can read the full docs page over here https://github.com/headlamp-k8s/headlamp/blob/d02531292dd770360d127a792d345e82428ad994/docs/development/plugins/functionality/extending-the-map.md
You can add your own nodes and edges, customize the icon for the nodes and show a details page for the node.
registerMapSource
registers a "Source" which provides Nodes and Edges to the map
registerKindIcon
adds an icon for a specific resource "kind", which is displayed on the node and the map search (not the global one)
registerKindDetailsPage
registers details panel for a specific resource "kind"
Reasoning and intentions
The
registerKindIcon
andregisterKindDetailsPage
don't mention Map and have a generic name (and notregisterMapNodeIcon
for example) for a reason.I think in the near future this can be used in other places and not just Map.
For example KindIcon can be used in the global search, and Details component can be used in the normal Details page for custom resources.
For now the customizations are very granular to keep it simple but I think in the future we should have an ability to register a custom resource that will integrate it everywhere all at once, something like this:
which I think would be extremely useful since a lot of plugins are listing/displaying custom resources.