feat: add support for describe command #96

maanugh · 2024-08-07T07:56:40Z

closes #94

Adding support to visualize kruise rollout using the command kruise describe rollout rollouts-2

Signed-off-by: maanugh <[email protected]>

kruise-bot · 2024-08-07T07:56:45Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign furykerry for approval by writing /assign @furykerry in a comment. For more information see:The Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

Signed-off-by: maanugh <[email protected]>

pkg/cmd/describe/describe_rollout.go

furykerry · 2024-09-25T02:22:59Z

pkg/cmd/describe/describe_rollout.go

+	fmt.Fprintf(o.Out, tableFormat, "Strategy:", "Canary")
+
+	if canary := rollout.Spec.Strategy.Canary; canary != nil {
+		fmt.Fprintf(o.Out, tableFormat, " Step:", canary.Steps[0].Replicas)


the content in these field is incorrect, and shall we display the current step or all canary steps? I think current step is required.

step: the total number of canary steps can be get from the length of rollout.Spec.Strategy.Canary.steps, and current step can be calculated as rollout.status.canaryStatus.currentStepIndex + 1)

SetWeight is very confusing, i prefer trafficWeight, and it can be get from the rollout.Spec.Strategy.Canary.steps[*].weight if available.

conclusion -> we would showing each step, and highlighting the currentStepIndex .

Strategy: Canary Step: 3/3 Steps: - Replicas: 1 traffic: 5% - Replicas: 50% - Replicas: 100%

pkg/cmd/describe/describe_rollout.go

pkg/cmd/describe/describe.go

pkg/cmd/describe/describe_rollout.go

furykerry · 2024-09-25T08:15:22Z

pkg/cmd/describe/describe_rollout.go

+	info.Replicas.Current = int32(status.FieldByName("Replicas").Int())
+	info.Replicas.Updated = int32(status.FieldByName("UpdatedReplicas").Int())
+	info.Replicas.Ready = int32(status.FieldByName("ReadyReplicas").Int())
+	info.Replicas.Available = int32(status.FieldByName("AvailableReplicas").Int())


plz check the rollout.status.ObservedGeneration against rollout.Metadata.generation, if two generation does not match, we shall not display status related fields.

Signed-off-by: maanugh <[email protected]>

maanugh · 2024-09-30T10:23:57Z

Updated view - >

pkg/cmd/describe/describe_rollout.go

Signed-off-by: maanugh <[email protected]>

pkg/cmd/describe/describe_rollout.go

furykerry · 2024-10-10T11:17:49Z

pkg/cmd/describe/describe_rollout.go

+			BatchID:  pod.Labels["rollouts.kruise.io/rollout-batch-id"],
+			Status:   string(pod.Status.Phase),
+			Age:      duration.HumanDuration(time.Since(pod.CreationTimestamp.Time)),
+			Restarts: fmt.Sprintf("%v (%v ago)", strconv.Itoa(int(pod.Status.ContainerStatuses[0].RestartCount)), duration.HumanDuration(time.Since(pod.Status.ContainerStatuses[0].LastTerminationState.Terminated.FinishedAt.Time))),


plz sum the restart count of all containers in the pod

pkg/cmd/describe/describe_rollout.go

furykerry · 2024-10-10T11:46:43Z

pkg/cmd/describe/describe_rollout.go

+		}
+
+		// Traffic Routings
+		if len(rollout.Spec.Strategy.Canary.TrafficRoutings) > 0 {


for end-to-end canary release, it is also possible for rollout to use rollout.spec.strategy.canary.trafficRoutingRef to specify traffic routing obj, plz refer to
https://openkruise.io/rollouts/user-manuals/strategy-end2end-canary-update

if we have the ref of traffic routing then we have to fetch the detail from the api server. //TrafficRoutingRef

there is problem in the api .

furykerry · 2024-10-10T11:56:23Z

plz also update the user docs in
https://github.com/openkruise/openkruise.io/blob/master/rollouts/user-manuals/basic-usage.md

furykerry · 2024-10-15T09:51:06Z

pkg/cmd/describe/describe_rollout.go

+			BatchID:  pod.Labels["rollouts.kruise.io/rollout-batch-id"],
+			Status:   string(pod.Status.Phase),
+			Age:      duration.HumanDuration(time.Since(pod.CreationTimestamp.Time)),
+			Restarts: fmt.Sprintf("%v (%v ago)", strconv.Itoa(int(pod.Status.ContainerStatuses[0].RestartCount)), duration.HumanDuration(time.Since(pod.Status.ContainerStatuses[0].LastTerminationState.Terminated.FinishedAt.Time))),


this line will panic :

pod.status.containerstatus may be empty for a newly created pod

pod.status.containerstatus[0].LastTerminationState.Terminated may also be null

lastTerminationState unsure about what to do ?

pkg/cmd/describe/describe_rollout.go

Signed-off-by: maanugh <[email protected]>

furykerry · 2024-10-17T01:57:32Z

pkg/cmd/describe/describe_rollout.go

+		return err
+	}
+
+	parts := strings.Split(args[0], "/")


the following command will panic due
kubectl kruise describe

panic: runtime error: index out of range [0] with length 0

goroutine 1 [running]:
github.com/openkruise/kruise-tools/pkg/cmd/describe.(*DescribeRolloutOptions).Complete(0x1400023c360, {0x101f22bc0, 0x1400028e280}, {0x102d3d720, 0x0, 0x0?})
/Users/shouchen/git/kruise-tools/src/github.com/openkruise/kruise-tools/pkg/cmd/describe/describe_rollout.go:137 +0x324

feat: add support for describe command

377b945

Signed-off-by: maanugh <[email protected]>

kruise-bot added the do-not-merge/work-in-progress label Aug 7, 2024

kruise-bot requested review from FillZpp and furykerry August 7, 2024 07:56

kruise-bot added the size/L label Aug 7, 2024

maanugh marked this pull request as draft August 7, 2024 07:56

add rollout viewer and sub functions

1b56134

Signed-off-by: maanugh <[email protected]>

kruise-bot added the needs-rebase label Sep 19, 2024

feat: add rollout describe, print Info, Status

b6091e0

Signed-off-by: maanugh <[email protected]>

maanugh changed the title ~~[WIP] feat: add support for describe command~~ feat: add support for describe command Sep 22, 2024

maanugh marked this pull request as ready for review September 22, 2024 14:05

chore: lint

9d2c3e3

Signed-off-by: maanugh <[email protected]>

furykerry reviewed Sep 25, 2024

View reviewed changes

pkg/cmd/describe/describe_rollout.go Show resolved Hide resolved

furykerry reviewed Sep 25, 2024

View reviewed changes

maanugh added 2 commits September 30, 2024 06:17

add support to different workloads, namespace support, pod revision ...

bdc51a4

Signed-off-by: maanugh <[email protected]>

merge master -> feat/describe

e8ab8a3

Signed-off-by: maanugh <[email protected]>

kruise-bot removed the needs-rebase label Sep 30, 2024

furykerry reviewed Oct 2, 2024

View reviewed changes

pkg/cmd/describe/describe_rollout.go Outdated Show resolved Hide resolved

pkg/cmd/describe/describe_rollout.go Outdated Show resolved Hide resolved

pkg/cmd/describe/describe_rollout.go Show resolved Hide resolved

pkg/cmd/describe/describe_rollout.go Show resolved Hide resolved

add support for traffic routings and strategy matches fields

e3f6085

Signed-off-by: maanugh <[email protected]>

furykerry reviewed Oct 10, 2024

View reviewed changes

furykerry reviewed Oct 15, 2024

View reviewed changes

pkg/cmd/describe/describe_rollout.go Outdated Show resolved Hide resolved

furykerry reviewed Oct 15, 2024

View reviewed changes

pkg/cmd/describe/describe_rollout.go Outdated Show resolved Hide resolved

furykerry reviewed Oct 16, 2024

View reviewed changes

pkg/cmd/describe/describe_rollout.go Show resolved Hide resolved

add support for trafficRoutingRef, update the status

4d602ca

Signed-off-by: maanugh <[email protected]>

furykerry reviewed Oct 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for describe command #96

feat: add support for describe command #96

maanugh commented Aug 7, 2024 •

edited

Loading

kruise-bot commented Aug 7, 2024

furykerry Sep 25, 2024

maanugh Sep 25, 2024

furykerry Sep 25, 2024

maanugh commented Sep 30, 2024

furykerry Oct 10, 2024

furykerry Oct 10, 2024

maanugh Oct 10, 2024

maanugh Oct 16, 2024

furykerry commented Oct 10, 2024

furykerry Oct 15, 2024

maanugh Oct 16, 2024

furykerry Oct 17, 2024

feat: add support for describe command #96

Are you sure you want to change the base?

feat: add support for describe command #96

Conversation

maanugh commented Aug 7, 2024 • edited Loading

kruise-bot commented Aug 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maanugh commented Sep 30, 2024

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

furykerry commented Oct 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maanugh commented Aug 7, 2024 •

edited

Loading