From 068fb8e250e00ca18416b047119c7557f389a946 Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Mon, 5 Aug 2024 17:02:53 +0000 Subject: [PATCH] Testeable documentation for the Pod Lifecycle events --- .../lfx-mentorship/2024/03-Sep-Nov/project_ideas.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md b/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md index 228aa954..347cab4c 100644 --- a/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md +++ b/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md @@ -55,3 +55,16 @@ - Mentor(s): Lee Calcote (@leecalcote, leecalcote@gmail.com), Xin Huang (@gyohuangxin, xin1.huang@intel.com) - Upstream Issue: https://github.com/service-mesh-performance/service-mesh-performance/issues/432 - LFX URL: + + +### Kubernetes + +#### Testeable documentation for the Pod Lifecycle events + +- Description: Kubernetes Pods are the unit of execution. Pods's API surface is limited, but yet presenting many challenges for people authoring complex behaviors like proper graceful termination, probes, or advances initialization behaviors. Documentation and testing of those scenarios is limited. The misunderstanding of pod lifecycle and edge casesoften lead to reliability issues in Pods. Lately there were limited efforts to document and test those behaviors. Creating a skaffolding to document and test those behaviors will help temendously the Kubernetes project as well as end users. +- Expected Outcome: Skaffolding in https://github.com/kubernetes/website/ to add new pod lifecycle behavios descriptions. Tests for those edge cases. And cross linking between tests and documentation. +- Recommended Skills: familiarity with Golang, some knowledge about the K8s and containers, understanding of Hugo is a plus. +- Mentor(s): + - Sergey Kanzhelev (@SergeyKanzhelev, S.Kanzhelev@live.com) + - Tim Allclair (@tallclair, tallclair@google.com) +- Upstream Issue: https://github.com/kubernetes/kubernetes/issues/126369