[LFX Fall '23 Mentorship]: Extend use-case of detecting deprecated Kubernetes API usage

[jwmatthews]

This is a LFX mentorship project intended to run in Fall 2023

Description

We are looking for help on extending a use-case of detecting usage of deprecated and removed Kubernetes APIs in applications. We need help in creating analysis rules that work with our static code analyzer, help to create automated tests to ensure this functionality is working as expected, and documentation to share with the community on how to leverage Konveyor for this scenario.

This work will involve

• determining what API resources have been deprecated or removed in each version of Kubernetes
• building Analyzer LSP Rules to be contributed to our Rulesets repository
• curation or development of sample applications in Golang, Java, and YAML to aid test scenarios
• creation of a new test to be integrated into Konveyor's CI
• documentation to show a guided walkthrough of this capability

You can see the beginning of this use-case being addressed with a sample rule in this demo of analyzer-lsp.

The development environment is based on Golang and Kubernetes. A minikube instance will work well for local development on Linux or Mac systems.

Related Links:

• Konveyor Contributor Guide
• Konveyor Unified Experience
• Example walk through of Konveyor running an analysis on a Java app
• Blog post showing value of Konveyor and Custom Rules
• Analysis Engine Repository: konveyor/analyzer-lsp
• Analysis Rulesets repository: konveyor/rulesets
• Analysis Rules Development Documentation: https://github.com/konveyor/analyzer-lsp/blob/main/docs/rules.md

Projects to consider for inspiration/collaboration/integration:

• https://github.com/devtron-labs/silver-surfer
• https://github.com/rikatz/kubepug
• https://github.com/redhat-developer/yaml-language-server
• https://github.com/FairwindsOps/pluto
• https://github.com/doitintl/kube-no-trouble

[jwmatthews]

Note: https://github.com/rikatz/kubepug may help for seeing how they determine what APIs are deprecated

[jwmatthews]

Related to: https://github.com/cncf/mentoring/pull/1035

[punithnayak]

Hey this project looks cool will defiantly apply when form come up

[satyampsoni]

Hello Konveyor team. This project aligns with my interest and my skills and I would love to contribute to this project and during LFX Fall 2023. Pls let me know if there is any slack community to join for further communication. Help will be highly appreciated.

[kaovilai]

You can join us on kubernetes slack

Need an invitation? Visit https://slack.k8s.io/ for an invitation.

[tanayvaswani]

The idea looks great! If I got the opportunity, I would feel happy to work with the team!

[AdiAkhileshSingh15]

Hey, I'm really interested in this project and I plan to apply as a Mentee once LFX Fall applications are open. Also, I'm curious to know if there are any beginner-friendly issues available for me to start contributing and get to know more about Konveyor. Any help would be highly appreciated. Thanks!

[jwmatthews]

Link to this project from LFX site: https://mentorship.lfx.linuxfoundation.org/project/989d0ad3-976a-4514-b2fc-34e9e6081567

[vishalrajofficial]

I am Vishal Raj, a final year CSE student. The CNCF - Konveyor project to extend the use-case of detecting deprecated Kubernetes API usage excites me. I'm eager to contribute to this mentorship project by creating analysis rules, developing automated tests, and providing documentation for leveraging Konveyor to detect deprecated and removed Kubernetes APIs. Building Analyzer LSP Rules and curating sample applications will be my focus. Let's collaborate to enhance Konveyor and support the Kubernetes community with valuable tools and resources!

[jwmatthews]

Note: https://github.com/devtron-labs/silver-surfer may help or at least knowing how they approach problem could be useful.

Thank you @savitharaghunathan for this suggestion

[jwmatthews]

Thank you @Parthiba-hazra for recommending we look at: https://github.com/FairwindsOps/pluto

https://kubernetes.slack.com/archives/C04QZJFQ0UA/p1690994666561419

Appreciate the tip!

[djzager]

@jwmatthews What's the status of this issue? Is it done? Should it be moved to another repo?

[jwmatthews]

Closed via https://github.com/konveyor/analyzer-lsp/pull/441

[konveyor-ci-bot[bot]]

This issue is currently awaiting triage. If contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance. The triage/accepted label can be added by org members.