feat: add vcctl pod list #3530

googs1025 · 2024-06-16T07:28:18Z

What type of PR is this?

/kind feature

New features: support list pod created by vcjob

What this PR does / why we need it:

Add vcctl pod command feature
- -j, --job string list pod with specified job name
- -k, --kubeconfig string (optional) absolute path to the kubeconfig file (default "/root/.kube/config")
- -s, --master string the address of apiserver
- -n, --namespace string the namespace of job (default "default")
- --all-namespaces list jobs in all namespaces
- -h, --help help for list
- -q, --queue string list pod with specified queue name

Which issue(s) this PR fixes:

Fixes part of: #3495

Special notes for your reviewer:

None

Does this PR introduce a user-facing change?

Added vcctl pod command feature

How to use it:

root@VM-0-9-ubuntu:~/volcano/_output/bin# vcctl pod list -h
list pod information created by vcjob

Usage:
  vcctl pod list [flags]

root@VM-0-16-ubuntu:~/volcano/example/jobflow# vcctl pod list -h
list pod information created by vcjob

Usage:
  vcctl pod list [flags]

Flags:
      --all-namespaces      list jobs in all namespaces
  -h, --help                help for list
  -j, --job string          list pod with specified job name
  -k, --kubeconfig string   (optional) absolute path to the kubeconfig file (default "/root/.kube/config")
  -s, --master string       the address of apiserver
  -n, --namespace string    the namespace of job (default "default")
  -q, --queue string        list pod with specified queue name

Global Flags:
      --log-flush-frequency duration   Maximum number of seconds between log flushes (default 5s)
  -v, --v Level                        number for the log level verbosity
      --vmodule moduleSpec             comma-separated list of pattern=N settings for file-filtered logging (only works for the default text log format)

root@VM-0-9-ubuntu:~/volcano/_output/bin# vcctl pod list
Name                                  Ready      Status           Restart  Age
tensorflow-dist-mnist-worker-0        0/1        Completed        0        12d
tensorflow-dist-mnist-worker-1        0/1        Completed        0        12d

root@VM-0-9-ubuntu:~/volcano/_output/bin# vcctl pod list -j tensorflow-dist-mnist
Name                                  Ready      Status           Restart  Age
tensorflow-dist-mnist-worker-0        0/1        Completed        0        12d
tensorflow-dist-mnist-worker-1        0/1        Completed        0        12d

root@VM-0-9-ubuntu:~/volcano/_output/bin# vcctl pod list -j tensorflow-dist-mnist1
No resources found

root@VM-0-16-ubuntu:~/volcano/example/jobflow# vcctl pod list -q=default -j=test-a
Name                          Ready      Status         Restart  Age
test-a-default-nginx-0        1/1        Running        0        10s

root@VM-0-16-ubuntu:~/volcano/example/jobflow# vcctl pod list -q=default
Name                          Ready      Status           Restart  Age
test-a-default-nginx-0        0/1        Completed        0        47s
test-b-default-nginx-0        0/1        Completed        0        33s
test-c-default-nginx-0        0/1        Completed        0        19s
test-d-default-nginx-0        0/1        Completed        0        19s
test-e-default-nginx-0        1/1        Running          0        5s

root@VM-0-9-ubuntu:~/volcano/_output/bin# kubectl get pods
NAME                                   READY   STATUS      RESTARTS   AGE
job-pod-failure-policy-example-72jrr   0/1     Error       0          10d
kueue-sleep-jqf8t                      0/1     Completed   0          8d
kueue-sleep-sfqbd                      0/1     Completed   0          8d
network-jobset-leader-0-0-pb422        0/1     Completed   0          6d

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

None

googs1025 · 2024-06-17T04:52:39Z

/assign @Monokaix

Monokaix · 2024-06-17T09:39:59Z

Please descibe more details about what sub commands and what flags are added by this pr: ）

googs1025 · 2024-06-18T14:32:46Z

Please descibe more details about what sub commands and what flags are added by this pr: ）

done

wuyueandrew · 2024-06-19T02:17:11Z

Bro， Because of #3524 can not query pod assigned to queue. There are several other job type like deployment , pod needed to query by queue name. Could u plz take query pod by queue name into your consideration.

googs1025 · 2024-06-19T04:44:14Z

Bro， Because of #3524 can not query pod assigned to queue. There are several other job type like deployment , pod needed to query by queue name. Could u plz take query pod by queue name into your consideration.

Ok, I will add this feature

wuyueandrew · 2024-06-19T07:49:27Z

Bro， Because of #3524 can not query pod assigned to queue. There are several other job type like deployment , pod needed to query by queue name. Could u plz take query pod by queue name into your consideration.

Ok, I will add this feature

thanks bro, it is very useful

googs1025 · 2024-06-19T12:30:33Z

Bro， Because of #3524 can not query pod assigned to queue. There are several other job type like deployment , pod needed to query by queue name. Could u plz take query pod by queue name into your consideration.

Ok, I will add this feature

thanks bro, it is very useful

already support in this pr

pkg/cli/pod/pod.go

googs1025 · 2024-08-06T12:04:59Z

# query by queue name
root@VM-0-14-ubuntu:~/volcano/_output/bin# vcctl pod list -q=test
Name                                       Ready      Status           Restart  Age
job-1-nginx-0                              0/1        Completed        0        32h
deploy-with-volcano-bf5784c5f-wrl4k        1/1        Running          0        26h

# query by job name and queue name
root@VM-0-14-ubuntu:~/volcano/_output/bin# vcctl pod list -q=test -j=job-1
Name                 Ready      Status           Restart  Age
job-1-nginx-0        0/1        Completed        0        32h

# query by job name and queue name, but not match
root@VM-0-14-ubuntu:~/volcano/_output/bin# vcctl pod list -q=aaaa -j=job-1
Failed to list pod: the input vcjob job-1 does not match the queue aaaa

Monokaix · 2024-08-08T07:29:04Z

pkg/cli/pod/pod.go

+	var pods corev1.PodList
+
+	// filter pods based on annotationKey and annotationValue
+	filterByAnnotationFunc := func(pods *corev1.PodList, annotationKey, annotationValue string) *corev1.PodList {


Please extract filterByAnnotationFunc and filterByLabelFunc as a seperate func.

Monokaix · 2024-08-08T07:31:51Z

pkg/cli/pod/pod.go

+		pods.Items = append(pods.Items, listVcjobPodsRes.Items...)
+		if listPodFlags.QueueName != "" {
+			// if queue is specified, check if the queue name used by the pod matches with the one passed in
+			_, err := filterByLabelFunc(listVcjobPodsRes, v1alpha1.QueueNameKey, listPodFlags.QueueName, true)


There is no need to set a flag in filterByLabelFunc, which increased
code complexity, just compare pods.Items[0].queueName and listPodFlags.QueueName is ok.

Monokaix · 2024-08-12T12:27:27Z

pkg/cli/pod/pod.go

+}
+
+// filterByAnnotationFunc filter pods based on annotationKey and annotationValue
+func filterByAnnotationFunc(pods *corev1.PodList, annotationKey, annotationValue string) *corev1.PodList {


filterByAnnotationFunc => filterPodsByAnnotation

pkg/cli/pod/pod.go

Signed-off-by: googs1025 <googs1025@gmail.com>

hwdef · 2024-08-13T06:49:35Z

cmd/cli/job.go

@@ -1,3 +1,19 @@
+/*
+Copyright 2024 The Volcano Authors.


It is recommended to remove the year #3668

I think we can remove year in auto generated files: )

Monokaix · 2024-08-15T01:19:47Z

/lgtm
/approve

volcano-sh-bot · 2024-08-15T01:19:55Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Monokaix

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~~ [Monokaix]

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

volcano-sh-bot added the kind/feature Categorizes issue or PR as related to a new feature. label Jun 16, 2024

volcano-sh-bot requested review from wangyang0616 and wpeng102 June 16, 2024 07:28

volcano-sh-bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jun 16, 2024

googs1025 mentioned this pull request Jun 16, 2024

enhancement vcctl features #3495

Open

5 tasks

googs1025 force-pushed the add_vcctl_pod_command branch 2 times, most recently from 53a780d to aa25e6e Compare June 16, 2024 08:18

volcano-sh-bot assigned Monokaix Jun 17, 2024

googs1025 changed the title ~~feat: add vcctl pod list~~ [WIP]: feat: add vcctl pod list Jun 19, 2024

volcano-sh-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 19, 2024

googs1025 force-pushed the add_vcctl_pod_command branch 2 times, most recently from f71319e to a724316 Compare June 19, 2024 11:44

googs1025 changed the title ~~[WIP]: feat: add vcctl pod list~~ feat: add vcctl pod list Jun 19, 2024

volcano-sh-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 19, 2024

googs1025 force-pushed the add_vcctl_pod_command branch from a724316 to 05ff66d Compare June 19, 2024 11:59

Monokaix reviewed Jun 20, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

Monokaix reviewed Jun 20, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

Monokaix reviewed Jun 20, 2024

View reviewed changes

pkg/cli/pod/pod.go Show resolved Hide resolved

googs1025 force-pushed the add_vcctl_pod_command branch 2 times, most recently from 869b49e to 2b0633e Compare June 20, 2024 08:42

Monokaix reviewed Jun 26, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

Monokaix reviewed Jun 26, 2024

View reviewed changes

pkg/cli/pod/pod.go Show resolved Hide resolved

googs1025 commented Jun 26, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

googs1025 changed the title ~~[wip]feat: add vcctl pod list~~ feat: add vcctl pod list Aug 5, 2024

volcano-sh-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 5, 2024

Monokaix reviewed Aug 6, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

Monokaix reviewed Aug 6, 2024

View reviewed changes

pkg/cli/pod/pod.go Show resolved Hide resolved

Monokaix reviewed Aug 6, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

Monokaix reviewed Aug 6, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

Monokaix reviewed Aug 6, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

googs1025 force-pushed the add_vcctl_pod_command branch 4 times, most recently from 3d015f9 to 3fea772 Compare August 6, 2024 11:56

googs1025 force-pushed the add_vcctl_pod_command branch from 3fea772 to a65c3f4 Compare August 6, 2024 14:57

volcano-sh-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 6, 2024

googs1025 requested a review from Monokaix August 7, 2024 00:36

Monokaix reviewed Aug 8, 2024

View reviewed changes

googs1025 force-pushed the add_vcctl_pod_command branch from a65c3f4 to d41491b Compare August 8, 2024 09:00

Monokaix reviewed Aug 12, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

Monokaix reviewed Aug 12, 2024

View reviewed changes

pkg/cli/pod/pod.go Outdated Show resolved Hide resolved

feat: add vcctl pod list

9f24b28

Signed-off-by: googs1025 <googs1025@gmail.com>

googs1025 force-pushed the add_vcctl_pod_command branch from d41491b to 9f24b28 Compare August 12, 2024 12:46

hwdef reviewed Aug 13, 2024

View reviewed changes

volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 15, 2024

volcano-sh-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 15, 2024

volcano-sh-bot merged commit 1142deb into volcano-sh:master Aug 15, 2024
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add vcctl pod list #3530

feat: add vcctl pod list #3530

googs1025 commented Jun 16, 2024 •

edited

Loading

googs1025 commented Jun 17, 2024

Monokaix commented Jun 17, 2024

googs1025 commented Jun 18, 2024

wuyueandrew commented Jun 19, 2024 •

edited

Loading

googs1025 commented Jun 19, 2024

wuyueandrew commented Jun 19, 2024

googs1025 commented Jun 19, 2024

googs1025 commented Aug 6, 2024 •

edited

Loading

Monokaix Aug 8, 2024

googs1025 Aug 8, 2024

Monokaix Aug 8, 2024

googs1025 Aug 8, 2024

Monokaix Aug 12, 2024

googs1025 Aug 12, 2024

hwdef Aug 13, 2024

Monokaix Aug 13, 2024

Monokaix commented Aug 15, 2024

volcano-sh-bot commented Aug 15, 2024

feat: add vcctl pod list #3530

feat: add vcctl pod list #3530

Conversation

googs1025 commented Jun 16, 2024 • edited Loading

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

googs1025 commented Jun 17, 2024

Monokaix commented Jun 17, 2024

googs1025 commented Jun 18, 2024

wuyueandrew commented Jun 19, 2024 • edited Loading

googs1025 commented Jun 19, 2024

wuyueandrew commented Jun 19, 2024

googs1025 commented Jun 19, 2024

googs1025 commented Aug 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Monokaix commented Aug 15, 2024

volcano-sh-bot commented Aug 15, 2024

googs1025 commented Jun 16, 2024 •

edited

Loading

wuyueandrew commented Jun 19, 2024 •

edited

Loading

googs1025 commented Aug 6, 2024 •

edited

Loading