Skip to content

Commit

Permalink
Add Konveyor proposal for Fall 2023
Browse files Browse the repository at this point in the history
Signed-off-by: John Matthews <jwmatthews@gmail.com>
  • Loading branch information
jwmatthews committed Jul 22, 2023
1 parent 92fba9b commit 56dfd48
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions programs/lfx-mentorship/2023/03-Sep-Nov/project_ideas.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,23 @@

## Proposed Project ideas

### Konveyor

#### Extend use-case of detecting deprecated Kubernetes API usage

- Description: [Konveyor](https://www.konveyor.io/) provides a [unified experience](https://github.com/konveyor/enhancements/tree/master/enhancements/unified_experience) of tools to help organizations modernize their applications at scale to Kubernetes and cloud-native technologies. We are looking for help on extending a use-case of detecting usage of [deprecated and removed Kubernetes APIs](https://kubernetes.io/docs/reference/using-api/deprecation-guide/) in applications. This work will involve determining what API resources have been deprecated or removed in each version of Kubernetes and then building [Analyzer Rules](https://github.com/konveyor/analyzer-lsp/blob/main/docs/rules.md) to be contributed to our [Rulesets repository](https://github.com/konveyor/rulesets), curation or development of sample applications in Golang, Java, and YAML to aid test scenarios, and documentation to help show a guided walkthrough of this capability. You can see the beginning of this use-case being addressed with a [sample rule](https://github.com/konveyor/analyzer-lsp/blob/main/rule-example.yaml#L42-L45) in this [demo of analyzer-lsp](https://github.com/konveyor/analyzer-lsp/tree/main#quick-demo). The development environment is based on Golang and Kubernetes. A minikube instance will work well for local development on Linux or Mac systems.
- Expected Outcome:
- [Rules](https://github.com/konveyor/analyzer-lsp/blob/main/docs/rules.md) contributed to [konveyor/rulesets](https://github.com/konveyor/rulesets) to detect usage of deprecated or removed Kubernetes APIs. Coverage for YAML, Golang, and Java source code, addition of this scenario into the project's automated test suite, and documentation of a guided scenario showing usage of these rules via a curated set of application source code examples.
- Recommended Skills:
- Go
- Basic understanding of interaction with Kubernetes via kubectl
- Basic software development skills (command line, git)
- Mentor(s):
- Emily McMullan (@eemcmullan, emcmulla@redhat.com)
- Jonah Sussman (@JonahSussman, jsussman@redhat.com)
- John Matthews (@jwmatthews, jwmatthews@gmail.com)
- Upstream Issue:
- https://github.com/konveyor/operator/issues/251

---

0 comments on commit 56dfd48

Please sign in to comment.