LFX Mentorship 2025_01 test task

[antoninbas]

First, we'd like to thank everyone who is interested in taking part to the LFX Mentorship program with us, and we are excited to welcome new contributors to Project Antrea.

We only submitted one project for this iteration of the LFX Mentorship program:

• Support L4 protocol filters in PacketCapture API
  • https://mentorship.lfx.linuxfoundation.org/project/c1b6fda9-e2e6-41e1-8495-68abe9e980ca
  • Issue Support L4 protocol specific filters in PacketCapture #6864

In order to help us find the right candidate, we have prepared a simple task. It's a good opportunity for you to get familiar with Antrea, and for us to ensure that you have some of the required skills for a successful mentorship. We do not expect this task to take more than a couple of hours.

Remember to apply at https://lfx.linuxfoundation.org/tools/mentorship/ in addition to completing the task.

Task details

Steps:

1. Create a Kind cluster locally with 1 control-plane Node and 1 worker Node. You will need to disable the default CNI, as we will later deploy Antrea for networking. Refer to the Kind documentation for information.
2. Install Helm on your machine.
3. Fork the Antrea Github repository (https://github.com/antrea-io/antrea) to your personal Github account, and clone the fork to your local machine. This is a standard Github workflow, but you can refer to our CONTRIBUTING.md for assistance. More generally, this document may be helpful for later steps as well.
4. Modify the Antrea source code as follows:
   • Add a test log entry to the antrea-agent program and the antrea-controller programs. The source code for these programs can be found here: https://github.com/antrea-io/antrea/tree/main/cmd. Hint: look for the run(o *Options) function.
   • Each of the 2 log entries should be a call to klog.InfoS (look at the rest of the source code for examples).
   • In both cases, the call should happen early in the execution of the program. Ideally it should be one of the first entries to be logged after the program starts.
   • klog.InfoS is a "structured logging" primitive and lets you include key-value pairs with your log message. Your log message should include the following data: 1) your Github username, and 2) the name of the K8s Pod executing the program (antrea-agent and antrea-controller are meant to be run as Pods). Hint: You will need the env.GetPodName() function from the antrea.io/antrea/pkg/util/env package.
5. Build Antrea locally with make. Again you may find it useful to refer to CONTRIBUTING.md.
6. Deploy your Antrea build to the Kind cluster that you created in the first step. Use these 2 steps:

# load the local Antrea Docker images in the Nodes; these are the custom images that you built in the previous step
kind load docker-image antrea/antrea-controller-ubuntu:latest antrea/antrea-agent-ubuntu:latest
# deploy Antrea using Helm: this command will use your custom images and enable the PacketCapture feature
helm install -n kube-system antrea --set featureGates.PacketCapture=true ./build/charts/antrea

7. Using kubectl, dump the logs for each antrea Pod (1 controller Pod and 2 agent Pods) and copy the first 10 lines of each log to a local file at the root of the repository: (controller.txt, agent1.txt, agent2.txt). Among the log lines should be the one you added in step 3.
8. Using kubectl, exec into the antrea-ovs container of the antrea-agent Pod (any one of them) and find out the version of OVS which is installed, using the appropriate OVS command. Write it to to a local file (ovs-version.txt) at the root of the repository. To get the OVS version, you will need to use the ovs-vsctl command-line utility (find the documentation online).
9. Using kubectl, exec into the antrea-agent container of the antrea-agent Pod (any one of them) and run antctl get featuregates. Write the output to a local file (antrea-agent-features.txt) at the root of the repository.
10. Create the lfx-mentorship Namespace.
11. Using kubectl and a YAML manifest named deployment.yml, create a single-replica Deployment in the lfx-mentorship Namespace, using the antrea/toolbox:1.6 container image.
12. Create a PacketCapture Custom Resource (CR) to capture all ICMP traffic from the toolbox Pod (source) created in the previous step to external IP address 8.8.8.8 (destination). Write the CR definition to a local YAML manifest file (capture.yml) at the root of the repository and apply it using kubectl. You will need to refer to the Antrea documentation: https://github.com/antrea-io/antrea/blob/main/docs/packetcapture-guide.md. Your PacketCapture should be configured as follows:
    • only capture ICMP traffic
    • use a long enough timeout - we suggest 300s
    • only capture the first 10 packets
13. Using kubectl, exec into the toolbox Pod and start a ping to 8.8.8.8. After at least 10 successful ICMP requests, you can stop the ping command.
14. Using kubectl, check the status of your PacketCapture CR. More precisely, run kubectl get pcap <name> -o yaml and save the result to a local file (capture-status.yml) at the root of the repository. If everything went well, you should see the PacketCaptureComplete condition under status set to "True". if not, figure out what went wrong and go back to step 12. The status also includes a filePath field, which indicates the location of the pcapng file storing the results of the capture. For example: filePath: antrea-agent-8lnp8:/tmp/antrea/packetcapture/packets/pc.pcapng. The file is currently stored in the filesystem of the antrea-agent Pod which ran the capture.
15. Copy the pcapng file from the Pod to your local filesystem using kubectl cp. Place the local file at the root of the repository and name it capture.pcapng.
16. Read the pcapng file using tcpdump -r (you may have to install tcpdump first), and save the output to a local file (capture.txt) at the root of the repository.
17. Commit all your changes (changes to the Antrea source code + the 6 .txt files + the 3 .yml files + the .pcapng file) as a single commit. All the new files should be at the root of the repository. We ask that you:
    • sign your commit: see https://github.com/antrea-io/antrea/blob/main/CONTRIBUTING.md#sign-off-your-work
    • follow best practices when writing your commit message: see https://cbea.ms/git-commit/
18. Push the changes to your fork, using branch name antrea-lfx-mentorship-2025_01-6864.

Submissions

Upon completing the task, reply to the thread below with the following information:

Name: [Your name, as it appears in your LFX mentorship profile]
Antrea GitHub Repo: [Provide a link to your GitHub repository containing the completed task]

Make sure that your Github repository use the correct branch name, as specified above in the task description.

For any queries, please reply reply to this discussion below or post in the #antrea channel in the K8s Slack workspace. Do not send emails or DMs to ask for assistance, use public channels only. We are happy to provide some assistance if you get stuck or if some instructions are not clear enough.

Deadlines

Task Deadline: Submissions must be completed by February 20, 5:00 PM PDT.
LFX Application Deadline: LFX applicants must submit by February 18, 5:00 PM PDT.

[antoninbas]

For submissions, please reply to this thread with the requested information

[shreekara-rajendra]

Name: Shreekara Rajendra
Antrea GitHub Repo: https://github.com/shreekara-rajendra/antrea/tree/antrea-lfx-mentorship-2025_01-6864

[devc007]

Name: Devesh Chouhan
Antrea Github Repo: https://github.com/devc007/antrea/tree/antrea-lfx-mentorship-2025_01-6864

[ngh227]

Name: Maeve Ho
Antrea Github Repo: https://github.com/ngh227/antrea/tree/antrea-lfx-mentorship-2025_01-6864

[sarthak21-negi]

Name: Sarthak Negi
Antrea Github Repo: https://github.com/sarthak21-negi/antrea/tree/antrea-lfx-mentorship-2025_01-6864

[patrostkowski]

Name: patrostkowski
Antrea GitHub Repo: https://github.com/patrostkowski/antrea/tree/antrea-lfx-mentorship-2025_01-6864