Skip to content
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

UI Support for Custom CRD Resource Icons #20636

Open
ap0phi5 opened this issue Nov 1, 2024 · 1 comment
Open

UI Support for Custom CRD Resource Icons #20636

ap0phi5 opened this issue Nov 1, 2024 · 1 comment
Labels
component:ui User interfaces bugs and enhancements enhancement New feature or request

Comments

@ap0phi5
Copy link

ap0phi5 commented Nov 1, 2024

Summary

It would be great if we were able to add custom icons for custom resources that are created off the back of CRD installations. Currently only a subset of the core Kubernetes resources are supported in ArgoCD. These were added about 5 years ago and haven't been updated since: https://github.com/argoproj/argo-cd/tree/master/ui/src/assets/images/resources

Motivation

To give two examples of this:

1) Google Cloud - Config Connector CRD

Config Connector CRD allows external cloud resources to be created within Kubernetes. Here, a Cloud SQL Postgres Database resource has been created:
image

It would be great to be able to see this, instead of a grey blob:
image

SVGs of all the Google Cloud icons are available here: https://cloud.google.com/icons

2) Strimzi Kafka CRD

Another example would be https://strimzi.io/ - resources could include zookeeper instances, brokers etc

Proposal

How do you think this should be implemented?

I recon this could be done in several ways;

a) Adding the SVG files (with an index) as a volume to ArgoCD server
b) Update the config map with key-values - the values referencing URIs where to source the remote SVG/image from.

Example of b)

apiVersion: v1
kind: ConfigMap
metadata:
  ...
  name: argocd-cm
data:
  ui.cssurl: "https://www.example.com/my-styles.css"
  ui.customresourceicons:
    sqlinstance: "https://raw.githubusercontent.com/GoogleCloudPlatform/devrel-demos/refs/heads/main/app-dev/party-game/public/google-cloud-icons/cloud_sql.svg"
    someresource: "https://anotherURI.com/someotherresource.svg"
@ap0phi5 ap0phi5 added the enhancement New feature or request label Nov 1, 2024
@gdsoumya gdsoumya added the component:ui User interfaces bugs and enhancements label Nov 4, 2024
@crenshaw-dev
Copy link
Member

crenshaw-dev commented Nov 5, 2024

Might be nice to make the resource_customizations directory the interface for "built in" icons and use argocd-cm to add more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:ui User interfaces bugs and enhancements enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants