cluster-api-provider-gcp
cluster-api-provider-gcp copied to clipboard
kubernetes-sigs
[EPIC] Improve the supportability of CAPG (LFX Spring 2023 Mentorship)
/kind feature /help
Describe the solution you'd like
We would like to improve the supportability of CAPG. We would like to make it easier for operations/support users to investigate issues with CAPG.
There will be a number of areas of improvement:
- Add tracing using something like OpenTelemetry. This will enable us to see how many and how long reconcile loops, GCP API calls etc take, which will be very helpful for issue investigation.
- Add a pprof endpoint that can be enabled
Anything else you would like to add: [Miscellaneous information that will assist in solving the issue.]
Items to do (not exhaustive yet)
- [ ] Implement OTEL in CAPG
- [ ] Docs
- [ ] e2e test to be added
- [ ] otel backend for local dev
- [ ] otel backend for e2e
@richardcase: This request has been marked as needing help from a contributor.
Guidelines
Please ensure that the issue body includes answers to the following questions:
- Why are we solving this issue?
- To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
- Does this issue have zero to low barrier of entry?
- How can the assignee reach out to you for help?
For more details on the requirements of such an issue, please see here and ensure that they are met.
If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.
In response to this:
/kind feature /help
Describe the solution you'd like
We would like to improve the supportability of CAPG. We would like to make it easier for operations/support users to investigate issues with CAPG.
There will be a number of areas of improvement:
- Add tracing using something like OpenTelemetry. This will enable us to see how many and how long reconcile loops, AWS API calls etc take which will be very helpful for issue investigation.
- Add a pprof endpoint that can be enabled
Anything else you would like to add: [Miscellaneous information that will assist in solving the issue.]
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
This will be used for the LFX mentorship Spring 2023 program. Until that starts:
/assign
@richardcase This feature looks interesting to me, I would like to work on this feature as an lfx mentee, can you give me brief idea about the prerequisites to learn ?
@richardcase it's an interesting feature, I would like to contribute to this feature in the spring mentorship, can you give me an idea about the prerequisites?
Some information for anyone interested in this.
The LFX Spring Mentorship program will open for applications between 1st - 14th February. The applications are then reviewed & decided upon between 15 - 28th February. And then the mentorship program begins 1st March and ends May 26.
You will not need access to your own GCP account, as you will be added to one you can use for this issue during the mentorship period.
For prerequisites:
- Golang
- Kubernetes
Everything else (like Cluster API, tracing, profiling) will be learnt as part of the mentorship.
When it comes to the application, the more information you can supply as to why this interests you and what you expect to gain from mentorship will help the reviewers.
If you have any questions, feel free to ask here or ping me or @cpanato in Slack.
Hello all :wave: I am Dharmick a final-year undergrad student from India,
This proposal looks really exciting :fire::boom: Looking forward to contributing to LFX this spring
Ohh interesting currently contributing to open telemetry now. Looking forward to contributing to this essential tool that I use as a DevOps engineer
Hey @richardcase and @cpanato , I'm Chandrashekhar from India . I started my journey of opensource with Hacktoberfest 2022 and it excites me a lot . I'm really interested in this project and would like to contribute in it . My Techstack's are - Java , Go , Docker , Kubernetes and currently learning other devops chapters .
Thanks everyone. The project looks like its listed now:
https://mentorship.lfx.linuxfoundation.org/project/55469b74-0c98-44f1-b8e1-4244a736bf82
The dates have slightly changed and applications are now open until 21st Feb.
The full timeline can be seen here: https://github.com/cncf/mentoring/tree/main/lfx-mentorship/2023/01-Mar-May#term-01---2023-march---may
- Add tracing using something like OpenTelemetry. This will enable us to see how many and how long reconcile loops, AWS API calls etc take which will be very helpful for issue investigation.
Anything else you would like to add: [Miscellaneous information that will assist in solving the issue.]
Should this AWS API calls be GCP API calls?
Hey @richardcase , I applied for LFX mentorship to contribute to this project. I'm looking forward to contributing to this which is an interesting feature.
@richardcase: GitHub didn't allow me to assign the following users: meobilivang.
Note that only kubernetes-sigs members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. For more information please see the contributor guide
In response to this:
/assign meobilivang
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
Hi @richardcase @cpanato :wave: Glad to be onboard! Pls add me to the Issue so we can get started :muscle:
hmm i was really looking forward to this, did you encounter technical issues and stopped or what was the reason?
hmm i was really looking forward to this, did you encounter technical issues and stopped or what was the reason?
No technical issue, the LFX mentorship came to an end and we couldn't get it in. I will re-open the PR and we can resurrect this.
@c0ffeeschwarz - let me know if you'd like to help out.
@salasberryfin - it would be good to get this in. As i'm no longer actively involved with CAPG i will unassign myself.
/unassign