Support bundle should include OVS groups

[tnqn]

Describe the bug

The support bundle collected from antrea-agent includes OVS flows but not OVS groups, which made it hard to debug issues related to Services.

This is the current list of collected files:

-rw-r--r-- 1 root root   4038 Mar  5 03:56 address
-rw-r--r-- 1 root root    633 Mar  5 03:56 addressgroups
-rw-r--r-- 1 root root   2100 Mar  5 03:56 agentinfo
-rw-r--r-- 1 root root    750 Mar  5 03:56 appliedtogroups
-rw-r--r-- 1 root root  37052 Mar  5 03:56 flows
-rw-r--r-- 1 root root 244095 Mar  5 03:56 goroutinestacks
-rw-r--r-- 1 root root  22080 Mar  5 03:56 iptables
-rw-r--r-- 1 root root   2800 Mar  5 03:56 link
drwxr-xr-x 4 root root   4096 Mar  5 04:06 logs
-rw-r--r-- 1 root root    179 Mar  5 03:56 memberlist
-rw-r--r-- 1 root root 124323 Mar  5 03:56 memprofile
-rw-r--r-- 1 root root   1810 Mar  5 03:56 networkpolicies
-rw-r--r-- 1 root root   1092 Mar  5 03:56 ovsports
-rw-r--r-- 1 root root    256 Mar  5 03:56 route

This is some example flows using groups:

table=ServiceLB, n_packets=0, n_bytes=0, idle_age=65535, priority=200,tcp,reg4=0x10000/0x70000,nw_dst=10.96.0.10,tp_dst=53 actions=set_field:0x200/0x200->reg0,set_field:0x20000/0x70000->reg4,set_field:0x7->reg7,group:7
table=ServiceLB, n_packets=0, n_bytes=0, idle_age=65535, priority=200,tcp,reg4=0x10000/0x70000,nw_dst=10.96.0.10,tp_dst=9153 actions=set_field:0x200/0x200->reg0,set_field:0x20000/0x70000->reg4,set_field:0x8->reg7,group:8
table=ServiceLB, n_packets=0, n_bytes=0, idle_age=65535, priority=200,tcp,reg4=0x10000/0x70000,nw_dst=10.96.0.1,tp_dst=443 actions=set_field:0x200/0x200->reg0,set_field:0x20000/0x70000->reg4,set_field:0x9->reg7,group:9
table=ServiceLB, n_packets=0, n_bytes=0, idle_age=65535, priority=200,tcp,reg4=0x10000/0x70000,nw_dst=10.96.162.29,tp_dst=80 actions=set_field:0x200/0x200->reg0,set_field:0x30000/0x70000->reg4,set_field:0xa->reg7,group:10

To Reproduce

Use antctl supportbundle to collect support bundle and check the collected files.

Expected

The support bundle (both the bundle collected by antctl and the SupportBundleCollection CR) should include a file named "groups" dumping the OVS groups.

Actual behavior

Versions:

• Antrea version (Docker image tag): 1.15 and before

[Bharadwajshivam28]

Hey @tnqn I want to take on this one can you please assign it to me.

Can you please share the file or where I can find the directory which returns the antctl supportbundle output like basically files related to this issue

[tnqn]

@Bharadwajshivam28 thanks for working on it.
This function may be a good place to start:

antrea/pkg/apiserver/registry/system/supportbundle/rest.go

Lines 261 to 275 in 397dd36

	func (r *supportBundleREST) collectAgent(ctx context.Context, since string) (*systemv1beta1.SupportBundle, error) {
	dumper := newAgentDumper(defaultFS, defaultExecutor, r.ovsCtlClient, r.aq, r.npq, since, r.v4Enabled, r.v6Enabled)
	return r.collect(
	ctx,
	dumper.DumpLog,
	dumper.DumpHostNetworkInfo,
	dumper.DumpFlows,
	dumper.DumpNetworkPolicyResources,
	dumper.DumpAgentInfo,
	dumper.DumpHeapPprof,
	dumper.DumpGoroutinePprof,
	dumper.DumpOVSPorts,
	dumper.DumpMemberlist,
	)
	}

[Bharadwajshivam28]

@Bharadwajshivam28 thanks for working on it. This function may be a good place to start:

antrea/pkg/apiserver/registry/system/supportbundle/rest.go

Lines 261 to 275 in 397dd36

	func (r *supportBundleREST) collectAgent(ctx context.Context, since string) (*systemv1beta1.SupportBundle, error) {
	dumper := newAgentDumper(defaultFS, defaultExecutor, r.ovsCtlClient, r.aq, r.npq, since, r.v4Enabled, r.v6Enabled)
	return r.collect(
	ctx,
	dumper.DumpLog,
	dumper.DumpHostNetworkInfo,
	dumper.DumpFlows,
	dumper.DumpNetworkPolicyResources,
	dumper.DumpAgentInfo,
	dumper.DumpHeapPprof,
	dumper.DumpGoroutinePprof,
	dumper.DumpOVSPorts,
	dumper.DumpMemberlist,
	)
	}

Thanks for this @tnqn

[EraKin575]

@tnqn can I work on this issue if its not being worked on?

[tnqn]

@EraKin575 thank you for offering to help. I'm not sure if it's still being actively worked on. But as there hasn't been any update for a long time, it's reasonable to have an ETA, after which it should be reassigned.

@Bharadwajshivam28 could you please send your patch if there is one before 6th April (1 month after the last update), or I would reassign it, thanks.