Add additionalPrinterColumns `WORKLOAD-KIND` for Work CRD #2066

lonelyCZ · 2022-06-27T13:30:59Z

Signed-off-by: lonelyCZ 531187475@qq.com

What type of PR is this?
/kind feature

What this PR does / why we need it:
When we debug, kubectl get work -A is only shown the NAME, not KIND, which will take more time to check the kind of manifests of work.

So directly show the kind by additionalPrinterColumns.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

The best is to show all kind of manifests, because it possibly contains multi manifests in one work. But I don't find an easy way to implement it. Now, it only show the first manifests kind.

[root@master67 ~]# kapi get work -A
NAMESPACE            NAME                              KIND                 APPLIED   AGE
karmada-es-member1   cert-manager-674b866f4c           Namespace            True      8d
karmada-es-member1   karmada-impersonator-7cbb6bd5c9   ClusterRole          True      8d
karmada-es-member1   karmada-impersonator-84f8c8f8c6   ClusterRoleBinding   True      8d
karmada-es-member1   nginx-7f8d449df9                  Workload             False     8d
karmada-es-member2   cert-manager-674b866f4c           Namespace            True      46d
karmada-es-member2   karmada-impersonator-7cbb6bd5c9   ClusterRole          True      53d
karmada-es-member2   karmada-impersonator-84f8c8f8c6   ClusterRoleBinding   True      53d
karmada-es-member2   nginx-7f8d449df9                  Workload             False     8d

/cc @RainbowMango

Does this PR introduce a user-facing change?:

Added additional printer columns `KIND` for `Work` CRD.

prodanlabs · 2022-06-27T13:53:37Z

cool, i like this.

XiShanYongYe-Chang

Looks great!

XiShanYongYe-Chang · 2022-06-28T01:21:49Z

charts/karmada/_crds/bases/work.karmada.io_works.yaml

@@ -16,6 +16,9 @@ spec:
  scope: Namespaced
  versions:
  - additionalPrinterColumns:
+    - jsonPath: .spec.workload.manifests[*].kind


kind can be directly parsed from runtime.RawExtension, it looks amazing! 👍

XiShanYongYe-Chang · 2022-06-28T01:24:32Z

charts/karmada/_crds/bases/work.karmada.io_works.yaml

@@ -16,6 +16,9 @@ spec:
  scope: Namespaced
  versions:
  - additionalPrinterColumns:
+    - jsonPath: .spec.workload.manifests[*].kind
+      name: Kind


The work Kind can be a bit confusing, IMOP, WorkloadKind feel a little better.

How is WORKLOAD-KIND? like CLUSTER-IP with splited by -.

NAMESPACE NAME WORKLOAD-KIND APPLIED AGE karmada-es-member1 cert-manager-674b866f4c Namespace True 9d karmada-es-member1 karmada-impersonator-7cbb6bd5c9 ClusterRole True 9d

NAMESPACE NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE default kubernetes ClusterIP 10.96.0.1 <none> 443/TCP 88d karmada-system karmada-aggregated-apiserver ExternalName <none> karmada-aggregated-apiserver.karmada-system.svc.cluster.local <none> 88d

RainbowMango · 2022-06-28T03:41:58Z

I totally agree with the idea that showing more info out.

The best is to show all kind of manifests, because it possibly contains multi manifests in one work. But I don't find an easy way to implement it. Now, it only show the first manifests kind.

In my opinion, it's still possible to put more than one manifests into a single Work. My concern is it might become technical debt.

So, let's hold for a while, and see if we can solve it.

lonelyCZ · 2022-06-28T06:55:18Z

I just researched it, the crd only support simple JsonPath. If we need to customize it, we could put it in aggregated-apiserver, but for now, this seems unnecessary and too complicated.

The CustomResourceDefinition "works.work.karmada.io" is invalid: spec.additionalPrinterColumns[0].JSONPath: Invalid value: "{.spec.workload.manifests[*]}{.kind}{'\t'}{end}": must be a simple json path starting with .

RainbowMango · 2022-06-28T07:14:42Z

Thanks for your time. Yes, aggregated-apiserver is way too complicated for this.
I'll look at it.

jwcesign · 2023-12-07T02:03:10Z

/cc @RainbowMango

I think we can push this forward

RainbowMango · 2023-12-07T02:40:19Z

Yeah, I agree, we have to do this now. I'll get back to it later.

XiShanYongYe-Chang · 2023-12-07T02:51:48Z

Hi @lonelyCZ, can you help rebase the master branch and push it again?

Signed-off-by: lonelyCZ <chengzhe@zju.edu.cn>

RainbowMango · 2023-12-07T03:10:43Z

charts/karmada/_crds/bases/work/work.karmada.io_works.yaml

@@ -20,6 +20,9 @@ spec:
  scope: Namespaced
  versions:
  - additionalPrinterColumns:
+    - jsonPath: .spec.workload.manifests[*].kind


What's the difference between manifests[*] and manifests[0]?

It looks the same, that only print the fisrt one.

codecov-commenter · 2023-12-07T03:16:42Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (58b1790) 51.87% compared to head (fd7139d) 51.87%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2066   +/-   ##
=======================================
  Coverage   51.87%   51.87%           
=======================================
  Files         243      243           
  Lines       24114    24114           
=======================================
  Hits        12509    12509           
+ Misses      10923    10922    -1     
- Partials      682      683    +1

Flag	Coverage Δ
unittests	`51.87% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

RainbowMango

/lgtm
/approve

Just echo the test report here:

-bash-5.0# kubectl get works.work.karmada.io -n karmada-es-member1 
NAME                              WORKLOAD-KIND        APPLIED   AGE
karmada-impersonator-7cbb6bd5c9   ClusterRole          True      2m55s
karmada-impersonator-84f8c8f8c6   ClusterRoleBinding   True      2m55s
nginx-687f7fb96f                  Deployment           True      13s

It looks good, and I think we still have the chance to update without breaking compatibility.

karmada-bot · 2023-12-08T02:13:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [RainbowMango]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

karmada-bot requested a review from RainbowMango June 27, 2022 13:31

karmada-bot added kind/feature Categorizes issue or PR as related to a new feature. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 27, 2022

XiShanYongYe-Chang reviewed Jun 28, 2022

View reviewed changes

lonelyCZ force-pushed the pr-work-kind branch from 29ce4b7 to dd28feb Compare June 28, 2022 02:22

RainbowMango added this to the v1.9 milestone Dec 7, 2023

Add additionalPrinterColumns Kind for Work CRD

fd7139d

Signed-off-by: lonelyCZ <chengzhe@zju.edu.cn>

lonelyCZ force-pushed the pr-work-kind branch from dd28feb to fd7139d Compare December 7, 2023 03:05

RainbowMango reviewed Dec 7, 2023

View reviewed changes

RainbowMango approved these changes Dec 8, 2023

View reviewed changes

karmada-bot assigned RainbowMango Dec 8, 2023

karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 8, 2023

karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 8, 2023

karmada-bot merged commit b168d9c into karmada-io:master Dec 8, 2023
13 checks passed

RainbowMango changed the title ~~Add additionalPrinterColumns KIND for Work CRD~~ Add additionalPrinterColumns WORKLOAD-KIND for Work CRD Dec 8, 2023

jwcesign mentioned this pull request Dec 19, 2023

[umbrella] Add Implementation for Service discovery with native Kubernetes naming and resolution #4292

Open

25 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add additionalPrinterColumns `WORKLOAD-KIND` for Work CRD #2066

Add additionalPrinterColumns `WORKLOAD-KIND` for Work CRD #2066

lonelyCZ commented Jun 27, 2022 •

edited by RainbowMango

Loading

prodanlabs commented Jun 27, 2022

XiShanYongYe-Chang left a comment

XiShanYongYe-Chang Jun 28, 2022

XiShanYongYe-Chang Jun 28, 2022

lonelyCZ Jun 28, 2022

XiShanYongYe-Chang Jun 28, 2022

lonelyCZ Jun 28, 2022

RainbowMango commented Jun 28, 2022

lonelyCZ commented Jun 28, 2022

RainbowMango commented Jun 28, 2022

jwcesign commented Dec 7, 2023 •

edited

Loading

RainbowMango commented Dec 7, 2023

XiShanYongYe-Chang commented Dec 7, 2023

RainbowMango Dec 7, 2023

lonelyCZ Dec 7, 2023

codecov-commenter commented Dec 7, 2023

RainbowMango left a comment

karmada-bot commented Dec 8, 2023

Add additionalPrinterColumns WORKLOAD-KIND for Work CRD #2066

Add additionalPrinterColumns WORKLOAD-KIND for Work CRD #2066

Conversation

lonelyCZ commented Jun 27, 2022 • edited by RainbowMango Loading

prodanlabs commented Jun 27, 2022

XiShanYongYe-Chang left a comment

Choose a reason for hiding this comment

XiShanYongYe-Chang Jun 28, 2022

Choose a reason for hiding this comment

XiShanYongYe-Chang Jun 28, 2022

Choose a reason for hiding this comment

lonelyCZ Jun 28, 2022

Choose a reason for hiding this comment

XiShanYongYe-Chang Jun 28, 2022

Choose a reason for hiding this comment

lonelyCZ Jun 28, 2022

Choose a reason for hiding this comment

RainbowMango commented Jun 28, 2022

lonelyCZ commented Jun 28, 2022

RainbowMango commented Jun 28, 2022

jwcesign commented Dec 7, 2023 • edited Loading

RainbowMango commented Dec 7, 2023

XiShanYongYe-Chang commented Dec 7, 2023

RainbowMango Dec 7, 2023

Choose a reason for hiding this comment

lonelyCZ Dec 7, 2023

Choose a reason for hiding this comment

codecov-commenter commented Dec 7, 2023

Codecov Report

RainbowMango left a comment

Choose a reason for hiding this comment

karmada-bot commented Dec 8, 2023

Add additionalPrinterColumns `WORKLOAD-KIND` for Work CRD #2066

Add additionalPrinterColumns `WORKLOAD-KIND` for Work CRD #2066

lonelyCZ commented Jun 27, 2022 •

edited by RainbowMango

Loading

jwcesign commented Dec 7, 2023 •

edited

Loading