[Docs] Add Kubernetes Component Configuration Reference Guide#1110
Conversation
Signed-off-by: PARTH-TUSSLE <parthgartan26feb@gmail.com>
There was a problem hiding this comment.
Code Review
This pull request introduces a new reference guide (kubernetes-components.md) detailing the configuration properties of Kubernetes Deployments and Services in Kanvas. The review feedback focuses on improving formatting consistency across the document by ensuring literal values, defaults, and specific API terms (such as 10, 600s, ProgressDeadlineExceeded, app: frontend, and None) are formatted as inline code, as well as removing a trailing whitespace.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
Preview deployment for PR #1110 removed. This PR preview was automatically pruned because we keep only the 6 most recently updated previews on GitHub Pages to stay within deployment size limits. If needed, push a new commit to this PR to generate a fresh preview. |
Signed-off-by: PARTH-TUSSLE <parthgartan26feb@gmail.com>
|
@PARTH-TUSSLE Thank you for your contribution! Let's discuss this during the website call tomorrow at 5:30 PM IST | 7 AM CST Add it as an agenda item to the meeting minutes, if you would 🙂 |
banana-three-join
left a comment
There was a problem hiding this comment.
I'm not sure how helpful this tutorial is since users are already familiarized with Kubernetes. Kanvas serves as an easier way to do so, but it's not within its responsabilities to explain how Kubernetes works.
I think it might be good to ask over in the slack about the inclusion of the topic rather than a revision of the PR first
Thanks for reviewing this. |
Notes for Reviewers
The Problem:
Previously, users dragging complex Kubernetes components (like
ServiceorDeployment) onto the Kanvas canvas were met with a wall of configuration fields. While the UI tooltips provide brief hints, there was no centralized, comprehensive documentation explaining what these properties actually do or how they affect the infrastructure.The Solution:
This PR resolves the issue by creating a new "no-fluff" reference guide specifically tailored for Kanvas component configurations.
I've audited the Kanvas UI for Kubernetes components and drafted the initial behavior-focused guides for the most requested components:
replicas,strategy(RollingUpdate vs Recreate),selector,template,minReadySeconds,progressDeadlineSeconds,revisionHistoryLimit, andpaused.type(ClusterIP, NodePort, LoadBalancer),selector,ports, andclusterIP.For each property, the documentation strictly adheres to the requested format:
This provides the much-needed inline guidance for beginners to confidently design architectures in Kanvas.
Location of changes:
content/en/kanvas/reference/kubernetes-components.mdPreview ->
This PR fixes #920
Signed commits