[Docs] Migrate Kubernetes Request Flow tutorial from Meshery Docs#1021
[Docs] Migrate Kubernetes Request Flow tutorial from Meshery Docs#1021leecalcote wants to merge 2 commits intomasterfrom
Conversation
Add the Kubernetes Request Flow visual tutorial under content/en/kanvas/tutorials/, with aliases preserving the original Meshery Docs URLs. Updates terminology to use Kanvas naming (Designer/Operator modes) and stores the diagram asset alongside the page. Signed-off-by: Lee Calcote <leecalcote@gmail.com>
leecalcote
force-pushed
the
claude/migrate-kubernetes-tutorial-1POvc
branch
from
55b9959 to
c115428
Compare
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new visual tutorial for understanding Kubernetes request flows using Kanvas. The guide covers key components such as Services, Deployments, and Pods. Feedback was provided to resolve a logical inconsistency in the Service description and to ensure grammatical consistency when listing advanced Kubernetes objects like Ingress Controllers and HPAs.
| #### 2. Service (ClusterIP) | ||
|
|
||
| - This is the entry point into the cluster. | ||
| - It forwards traffic to the Pods. While this visual is a placeholder, in a real Kubernetes Service, we would typically define a type (like ClusterIP or NodePort) and use selectors to route traffic to matching Pods. This is how services know where to forward requests. |
There was a problem hiding this comment.
There is a logical inconsistency here. The Lab Scenario (line 28) states that the service is a ClusterIP routing the request, but this line describes the visual as a "placeholder" and suggests that one would "typically define a type (like ClusterIP)" in a real service. Since the scenario already specifies the type and function, it's better to describe how this specific component is configured in the design.
| - It forwards traffic to the Pods. While this visual is a placeholder, in a real Kubernetes Service, we would typically define a type (like ClusterIP or NodePort) and use selectors to route traffic to matching Pods. This is how services know where to forward requests. | |
| - In this design, the Service is configured as a **ClusterIP**. In a production setup, you would use selectors to route traffic to matching Pods, which is how the Service knows where to forward requests. |
| - **Scale smarter** — Once we know where the load hits, we can add replicas where it actually matters. | ||
| - **Design better** — From tracing logs to optimizing performance, knowing the flow helps us place the right tools in the right spots. | ||
|
|
||
| Think of this request path as the backbone of your Kubernetes understanding. Everything else like Ingress, HPA (Horizontal Pod Autoscalers), or Service Meshes builds upon this foundation. |
There was a problem hiding this comment.
The list of components uses a mix of singular and plural forms ("Ingress", "HPA", "Service Meshes"). For consistency, especially since "Service Meshes" is plural, it's better to use plural forms for all or ensure they match the phrasing used later in the conclusion (line 120).
| Think of this request path as the backbone of your Kubernetes understanding. Everything else like Ingress, HPA (Horizontal Pod Autoscalers), or Service Meshes builds upon this foundation. | |
| Think of this request path as the backbone of your Kubernetes understanding. Everything else, such as Ingress Controllers, HPAs (Horizontal Pod Autoscalers), or Service Meshes, builds upon this foundation. |
|
🚀 Preview deployment: https://layer5io.github.io/docs/pr-preview/pr-1021/
|
There was a problem hiding this comment.
Pull request overview
This PR migrates the “Kubernetes Request Flow – A Visual Guide” tutorial into Layer5 Docs under the Kanvas Tutorials section, preserving legacy Meshery Docs URLs via aliases and updating terminology for Kanvas.
Changes:
- Adds a new Kanvas tutorial page for Kubernetes request flow.
- Includes legacy URL aliases to redirect prior Meshery Docs tutorial paths.
- Uses Docsy
alertshortcodes for note styling and links to a prebuilt Kanvas design.
|
|
||
| [](https://kanvas.new/extension/meshmap?mode=design&design=629b6039-ebb3-4bd8-9b1b-19184fade225) | ||
|
|
||
| > Click the image above to open the interactive design in Kanvas. |
| - This is the entry point into the cluster. | ||
| - It forwards traffic to the Pods. While this visual is a placeholder, in a real Kubernetes Service, we would typically define a type (like ClusterIP or NodePort) and use selectors to route traffic to matching Pods. This is how services know where to forward requests. |
| - **Scale smarter** — Once we know where the load hits, we can add replicas where it actually matters. | ||
| - **Design better** — From tracing logs to optimizing performance, knowing the flow helps us place the right tools in the right spots. | ||
|
|
||
| Think of this request path as the backbone of your Kubernetes understanding. Everything else like Ingress, HPA (Horizontal Pod Autoscalers), or Service Meshes builds upon this foundation. |
- Clarify ClusterIP access boundary (reachable only from inside the cluster; external traffic enters via Ingress/LoadBalancer/NodePort). - State that the design uses a ClusterIP Service rather than calling the visual a placeholder, since the lab scenario already names the type. - Make the advanced-objects list grammatically consistent (Ingress Controllers, HPAs (Horizontal Pod Autoscalers), Service Meshes). - Convert the remaining blockquote note under the prebuilt-design link into a Docsy alert shortcode for consistency with the rest of the page. Signed-off-by: Lee Calcote <leecalcote@gmail.com>
Summary
Migrates the Kubernetes Request Flow – A Visual Guide tutorial from Meshery Docs into Layer5 Docs under the Kanvas tutorials section.
content/en/kanvas/tutorials/kubernetes-request-flow.mdcontent/en/kanvas/tutorials/images/kubernetes-request-flow/k8s-request-flow.png/guides/tutorials/kubernetes-request-flowand/guides/tutorials/kubernetes/kubernetes-request-flow){{< alert >}}shortcodes for visual consistency with other Kanvas tutorialsA companion PR removing the original page from Meshery Docs is filed at meshery/meshery.
Test plan
hugo serverrenders the page at/kanvas/tutorials/kubernetes-request-flow/without warningsGenerated by Claude Code