Skip to content

As a user I'd like to be able to navigate from selector labels/expressions to matching labels #642

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.

Sign up for GitHub

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

Jump to bottom
Closed
adietish opened this issue Jul 24, 2023 · 5 comments · Fixed by #858
Closed

As a user I'd like to be able to navigate from selector labels/expressions to matching labels #642

adietish opened this issue Jul 24, 2023 · 5 comments · Fixed by #858
Assignees
@adietish
Labels
editor kind/feature

Comments

@adietish
Copy link
Collaborator

adietish commented Jul 24, 2023 •
edited
Loading

When editing k8 resources, it is cumbersome to make sure that your selector label/expression is really matching existing labels on templates/pods. Furthermore as a user I'd like to have an easy way to jump from the referee to the referencing component and vice-versa.
The jetbrains plugin displays clickable markers to labels (on the left ruler) but it doesnt work for me/I'm unsure how this works).
I'd like to implement those as clickable InlayHint.

ex. in the following multi-resource file that was generated by quarkus, there's a service that's referencing a pod (Service->Deployment, Ingress->Service)

---
apiVersion: v1
kind: Service
metadata:
  annotations:
    app.quarkus.io/build-timestamp: 2023-07-14 - 15:53:39 +0000
  labels:
    app.kubernetes.io/name: openshift-quickstart
    app.kubernetes.io/version: 1.0.0-SNAPSHOT
    app.kubernetes.io/managed-by: quarkus
  name: openshift-quickstart
spec:
  ports:
    - name: http
      port: 80
      protocol: TCP
      targetPort: 8080
    - name: https
      port: 443
      protocol: TCP
      targetPort: 8443
  selector:
    app.kubernetes.io/name: openshift-quickstart
    app.kubernetes.io/version: 1.0.0-SNAPSHOT
  type: LoadBalancer
---
apiVersion: apps/v1
kind: Deployment
metadata:
  annotations:
    app.quarkus.io/build-timestamp: 2023-07-14 - 15:53:39 +0000
  labels:
    app.kubernetes.io/managed-by: quarkus
    app.kubernetes.io/version: 1.0.0-SNAPSHOT
    app.kubernetes.io/name: openshift-quickstart
  name: openshift-quickstart
spec:
  replicas: 1
  selector:
    matchLabels:
      app.kubernetes.io/version: 1.0.0-SNAPSHOT
      app.kubernetes.io/name: openshift-quickstart
  template:
    metadata:
      annotations:
        app.quarkus.io/build-timestamp: 2023-07-14 - 15:53:39 +0000
      labels:
        app.kubernetes.io/managed-by: quarkus
        app.kubernetes.io/version: 1.0.0-SNAPSHOT
        app.kubernetes.io/name: openshift-quickstart
    spec:
      containers:
        - env:
            - name: KUBERNETES_NAMESPACE
              valueFrom:
                fieldRef:
                  fieldPath: metadata.namespace
          image: adietish/openshift-quickstart:1.0.0-SNAPSHOT
          imagePullPolicy: Always
          name: openshift-quickstart
          ports:
            - containerPort: 8080
              name: http
              protocol: TCP
            - containerPort: 8443
              name: https
              protocol: TCP
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    app.quarkus.io/build-timestamp: 2023-07-14 - 15:53:39 +0000
  labels:
    app.kubernetes.io/name: openshift-quickstart
    app.kubernetes.io/version: 1.0.0-SNAPSHOT
    app.kubernetes.io/managed-by: quarkus
  name: openshift-quickstart
spec:
  rules:
    - http:
        paths:
          - backend:
              service:
                name: openshift-quickstart
                port:
                  name: http
            path: /
            pathType: Prefix
@adietish adietish self-assigned this Dec 11, 2024
@adietish adietish moved this to 📋 Backlog in IDE Cloudaptors Dec 11, 2024
@adietish
Copy link
Collaborator Author

adietish commented Dec 11, 2024 •
edited
Loading

An idea would be to have Ctrl + click scroll to the portion in the editor that is matching. Lookup on the cluster could also be provided.
We could also highlight matching resources like we know it from properties in java class.

Jetbrains kubernetes plugin has no such support afaik.

@adietish adietish added the editor label Feb 7, 2025
@adietish adietish changed the title As a user I'd like to see the references within a multi-doc file As a user I'd like help with references in a multi-doc file Feb 26, 2025
@adietish
Copy link
Collaborator Author

adietish commented Mar 5, 2025

In a 2nd step, we could look up matching resources on the cluster

@adietish adietish moved this from 📋 Backlog to 📝 In Progress in IDE Cloudaptors Mar 5, 2025
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 10, 2025
@adietish
feat: hint resources ref'd by matchLabels/-Expressions and nav editor…
9d44bb2 
… to them (redhat-developer#642)
@adietish adietish mentioned this issue Mar 10, 2025
Merged
@adietish
Copy link
Collaborator Author

adietish commented Mar 11, 2025 •
edited
Loading

matchLabel and matchExpression in a Deployment target Pods which are most likely defined as a template in the very same resource. You can of course define a pod in a file and create it. Nevertheless the more useful usecase is a lookup of references that exist on the cluster. This is true for most resources that can target pods like Service, DaemonSet, StatefulSet, Service, ReplicaSet, Job, CronJob, NetworkPolicies , PodDisruptionBudgets, ReplicationController, HorizontalPodAutoscaler. Similar but not identical are PersistentVolumeClaims which target PersistentVolumes.

Image

Here's an example of PVC and PV:

# --------------------------
# PersistentVolume 1 (targeted by PVC with matchLabels)
# --------------------------
apiVersion: v1
kind: PersistentVolume
metadata:
  name: pv-labels
  labels:
    pvc-target: labels          # Label for direct matching
    storage-tier: ssd           # Additional label (not required for binding)
spec:
  capacity:
    storage: 5Gi
  accessModes:
    - ReadWriteOnce
  storageClassName: manual       # Disables dynamic provisioning
  hostPath:
    path: /mnt/data-labels

---
# --------------------------
# PersistentVolume 2 (targeted by PVC with matchExpressions)
# --------------------------
apiVersion: v1
kind: PersistentVolume
metadata:
  name: pv-expressions
  labels:
    environment: production      # Label for matchExpressions
    region: us-west              # Label for matchExpressions (key existence)
spec:
  capacity:
    storage: 10Gi
  accessModes:
    - ReadWriteOnce
  storageClassName: manual       # Disables dynamic provisioning
  hostPath:
    path: /mnt/data-expressions

---
# --------------------------
# PVC 1: Uses matchLabels
# --------------------------
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: pvc-labels
spec:
  storageClassName: manual
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 5Gi
  selector:
    matchLabels:
      pvc-target: labels         # Direct label match

---
# --------------------------
# PVC 2: Uses matchExpressions
# --------------------------
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: pvc-expressions
spec:
  storageClassName: manual
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 10Gi
  selector:
    matchExpressions:
      - key: environment
        operator: In             # Value must be in the list
        values: [production, staging]
      - key: region
        operator: Exists         # Key must exist (value ignored)

@adietish
Copy link
Collaborator Author

We can offer a 2nd label that reports references to pods running on the cluster X references on cluster.

@adietish
Copy link
Collaborator Author

adietish commented Mar 13, 2025 •
edited
Loading

Jetbrains kubernetes plugin provides similar functionality using icons in the gutter.

Image

If you click the gutter icon you'll get scrolled to the occurrence

Image

I discussed this with @angelozerr and we both agreed that a hint is better because it is matching the usual behaviour for references better. And then, gutter icons can come handy if you have multiple actions (ex. a run gutter icon where you can have mutliple entries for running, debugging, coverage run, etc.). For the references there's only 1 action: list the matching resources or click right to it if there's only 1.

adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 17, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
152e3d1 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 18, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
8ccf183 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 19, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
b6f3fd7 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 22, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
953f406 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 22, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
789d79b 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 24, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
0fdc80e 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 24, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
c3af784 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 24, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
80cf550 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 24, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
08d67ed 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 24, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
447616c 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 24, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
0f11987 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 24, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
60c32ef 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 24, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
93ae689 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 25, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
c4ffe01 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 25, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
5df0d1d 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Mar 25, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
9294831 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 9, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
357f08c 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 9, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
434c7f6 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 9, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
6fb8116 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 9, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
7932e69 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 9, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
1564620 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 10, 2025
@adietish
feat: hint resources ref'd by matchLabels/-Expressions and nav editor…
a61eb75 
… to them (redhat-developer#642)
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 10, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
0de64d0 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 11, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
909f2c3 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 11, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
f7ac201 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 11, 2025
@adietish
feat: display occurrences in std search usage (redhat-developer#642)
6f18a38 
Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 11, 2025
@adietish
feat: hint ref'd by matchLabels/-Expressions & list them in editor (r…
c1c2c85 
…edhat-developer#642)

Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 11, 2025
@adietish
feat: hint ref'd by matchLabels/-Expressions & list them in editor (r…
8ef1541 
…edhat-developer#642)

Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 11, 2025
@adietish
feat: hint ref'd by matchLabels/-Expressions & list them in editor (r…
c9b2dd1 
…edhat-developer#642)

Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 12, 2025
@adietish
feat: hint ref'd by matchLabels/-Expressions & list them in editor (r…
e8f76cf 
…edhat-developer#642)

Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 14, 2025
@adietish
fix: search result for selector is template labels (redhat-developer#642
d9bd688 
)
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 14, 2025
@adietish
fix: search result for selector is template labels (redhat-developer#642
8b6b043 
)
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 14, 2025
@adietish
fix: search result for selector is template labels (redhat-developer#642
ad2eb27 
)
@adietish adietish moved this from 📝 In Progress to 👀 In review in IDE Cloudaptors Apr 16, 2025
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 25, 2025
@adietish
fix: search result for selector is template labels (redhat-developer#642
9355acf 
)
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 27, 2025
@adietish
fix: search result for selector is template labels (redhat-developer#642
73001e8 
)
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 27, 2025
@adietish
feat: editor: hint matches for matchLabels/-Expressions & list them i…
acb7ad6 
…n dialog (redhat-developer#642)

Signed-off-by: Andre Dietisheim <[email protected]>
adietish added a commit to adietish/intellij-kubernetes that referenced this issue Apr 28, 2025
@adietish
feat: editor: hint matches for matchLabels/-Expressions & list them i…
8f72b9e 
…n dialog (redhat-developer#642)

Signed-off-by: Andre Dietisheim <[email protected]>
@adietish adietish mentioned this issue Apr 28, 2025
Merged
adietish added a commit that referenced this issue May 13, 2025
@adietish
feat: editor: hint matches for matchLabels/-Expressions & list them i…
bea4995 
…n dialog (#642)

Signed-off-by: Andre Dietisheim <[email protected]>
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in IDE Cloudaptors May 13, 2025
@adietish adietish changed the title As a user I'd like help with references in a multi-doc file As a user I'd like to be able to navigate from selector labels/expressions to matching labels May 16, 2025
This was referenced May 16, 2025
Closed
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adietish adietish

Labels
editor kind/feature
Projects
IDE Cloudaptors
Status: ✅ Done
Milestone
No milestone
1 participant
@adietish