LFX Mentorship 2024_03 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 application-level DNS caches when using FQDN-based security rules
  • https://mentorship.lfx.linuxfoundation.org/project/99e8e0a0-4d82-4ac5-88bc-55b1d1a2c1f4
  • Issue Make NetworkPolicy FQDN rule work with applications that cache DNS resolutions with hard-coded TTL #6229

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. 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.
3. 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.
4. Build Antrea locally with make. Again you may find it useful to refer to CONTRIBUTING.md.
5. Deploy your Antrea build to the Kind cluster that you created in the first step. The instructions to do this can be found in https://github.com/antrea-io/antrea/blob/main/docs/kind.md#deploy-a-local-build-of-antrea-to-your-kind-cluster-for-developers.
6. 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.
7. 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).
8. Download antctl from the Github release assets for the latest Antrea release. Run the antctl version command and write the output to antrea-version.txt, at the root of the repository.
9. Create the lfx-mentorship Namespace.
10. Using kubectl and a YAML manifest named deployment.yml, create a single-replica Deployment in the lfx-mentorship Namespace, using the antrea/toolbox:1.4 container image.
11. Using kubectl and a YAML manifest named anp.yml, create an Antrea NetworkPolicy Custom Resource in the lfx-mentorship Namespace. The policy must apply to all Pods in the Namespace. The policy must specify 3 egress rules, in this order: a) one rule to Allow traffic to all Pods in all Namespaces (hint: use namespaceSelector: {} for this), b) one FQDN rule to Allow traffic to the api.github.com domain, and c) one rule to Reject all remaining traffic (hint: omit the to field to match all). You will need to refer to the Antrea documentation: https://github.com/antrea-io/antrea/blob/main/docs/antrea-network-policy.md
12. Using kubectl, exec into the Pod created in step 10. Validate your Antrea NetworkPolicy using these 2 shell commands: curl -I api.github.com, curl -I www.example.com. It may take a few tries for you to write the correct policy. Once the 2 curl commands produce the desired output, take a screenshot of your terminal window and save it as a PNG, JPEG or PDF file to the root of the repository (e.g., as screenshot.png). The screenshot should show the outcome of both curl commands.
13. Commit all your changes (changes to the Antrea source code + the 5 .txt files + the 2 .yml files + the screenshot) 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/
14. Push the changes to your fork, using branch name antrea-lfx-mentorship-2024_03-6229.

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 August 16, 5:00 PM PDT.
LFX Application Deadline: LFX applicants must submit by August 13, 5:00 PM PDT.

[antoninbas]

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

[AryanBakliwal]

Name: Aryan Bakliwal
Antrea GitHub Repo: https://github.com/AryanBakliwal/antrea/tree/antrea-lfx-mentorship-2024_03-6229

[Harsh4902]

Name: Harshvardhan Parmar
Antrea GitHub Repo: https://github.com/Harsh4902/antrea/tree/antrea-lfx-mentorship-2024_03-6229

[viveksahu26]

Name: Vivek Kumar Sahu
Antrea Github Repo: https://github.com/viveksahu26/antrea/tree/antrea-lfx-mentorship-2024_03-6229

[hkiiita]

Name: Hemant Kumar
Antrea Github Repo: https://github.com/hkiiita/antrea/tree/antrea-lfx-mentorship-2024_03-6229

[AtalGupta]

Name: Atal Gupta
Antrea Github Repo: https://github.com/AtalGupta/antrea/tree/antrea-lfx-mentorship-2024_03-6229

[Harsh4902]

@antoninbas Do we need to submit a proposal?

[tnqn]

Not sure what you mean by proposal. If you mean a proposal about how to fix #6229, that's not needed for now.

[Harsh4902]

Yeah, I was asking for it. Got the answer, thank you.