RFC for K8S Commons library

[chentex]

Type of change

• [ ] Refactor
• [x] New feature
• [ ] Bug fix
• [ ] Optimization
• [ ] Documentation Update

Description

Trying to create Commons methods that could be used simply by other project in our Orgs.

This is an RFC please be sure to review the code ask questions and comment.

I went with the simplest way to create a client at this point it is not set in stone, basing my methods of what I've seen mainly in K8S-netperf repo.

I'll be adding methods during this development.

Code might change during the development, so marking this as a draft.

Main Feedback Requested

• Do you think is useful?
• Do we fear maintaining this??
• What would you like to see???

Related Tickets & Documents

• Document: Draft analysis of the methods: https://docs.google.com/document/d/1ZlB7k1V6jpOP_Sy9qP6GDfVasg7k8DEuQPIPlaIwghw/edit

Checklist before requesting a review

• [ ] I have performed a self-review of my code.
• [ ] If it is a core feature, I have added thorough tests.

Testing

• Please describe the System Under Test.
• Please provide detailed steps to perform tests related to this code change.
• How were the fix/results from this change verified? Please provide relevant screenshots or results.

[codecov[bot]]

Codecov Report

Merging #28 (f3d9b31) into main (58fcfe9) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #28   +/-   ##
=======================================
  Coverage   85.13%   85.13%           
=======================================
  Files           6        6           
  Lines         343      343           
=======================================
  Hits          292      292           
  Misses         37       37           
  Partials       14       14           

[vishnuchalla]

Thanks for this initial draft Vicente! Lets take these changes slow from this draft to PRs, one component at a time. That way we can ensure that, it is being properly tested and safe to use. And also can we name this package as just k8s please! As the go-commons name itself refers to a common library!

[vishnuchalla]

@chentex Design looks very complex. Lets follow Repository Design Pattern here, which seems to be best fit for our use case. Open to other thoughts too. Thank you! Example snippet: https://docs.google.com/document/d/1ZlB7k1V6jpOP_Sy9qP6GDfVasg7k8DEuQPIPlaIwghw/edit#bookmark=id.mj2jy1bmhzin

[vishnuchalla]

@chentex I have a working design implemented separately here that follows Repository Design Pattern, just not to tamper this one. Let combine our both ideas and proceed with the PRs. Thank you!