Skip to content

[Docs] Add Kubernetes Component Configuration Reference Guide#1110

Open
PARTH-TUSSLE wants to merge 2 commits into
layer5io:masterfrom
PARTH-TUSSLE:Audit-of-Kubernetes-component-configuration-properties-and-descriptions
Open

[Docs] Add Kubernetes Component Configuration Reference Guide#1110
PARTH-TUSSLE wants to merge 2 commits into
layer5io:masterfrom
PARTH-TUSSLE:Audit-of-Kubernetes-component-configuration-properties-and-descriptions

Conversation

@PARTH-TUSSLE

Copy link
Copy Markdown
Contributor

Notes for Reviewers

The Problem:

Previously, users dragging complex Kubernetes components (like Service or Deployment) 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:

  1. Kubernetes Deployment: Documented replicas, strategy (RollingUpdate vs Recreate), selector, template, minReadySeconds, progressDeadlineSeconds, revisionHistoryLimit, and paused.
  2. Kubernetes Service: Documented networking behaviors including type (ClusterIP, NodePort, LoadBalancer), selector, ports, and clusterIP.
    For each property, the documentation strictly adheres to the requested format:
  • What it does: Plain English explanation of the field.
  • Expected values/Syntax: How to correctly fill it out.
  • Behavior: How tweaking the setting practically affects the cluster infrastructure.
    This provides the much-needed inline guidance for beginners to confidently design architectures in Kanvas.

Location of changes:

  • Created: content/en/kanvas/reference/kubernetes-components.md

Preview ->

{C24D6673-5299-4581-9EE6-C47394CB3C20} image {C1478E45-CDE7-4ADB-968B-06BADDBC0950}

This PR fixes #920

Signed commits

  • [✅ ] Yes, I signed my commits.

Signed-off-by: PARTH-TUSSLE <parthgartan26feb@gmail.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread content/en/kanvas/reference/kubernetes-components.md Outdated
Comment thread content/en/kanvas/reference/kubernetes-components.md Outdated
Comment thread content/en/kanvas/reference/kubernetes-components.md Outdated
Comment thread content/en/kanvas/reference/kubernetes-components.md
@github-actions

github-actions Bot commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

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>
@Bhumikagarggg

Copy link
Copy Markdown
Contributor

@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 banana-three-join left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@PARTH-TUSSLE

Copy link
Copy Markdown
Contributor Author

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.
My intention was not to explain Kubernetes concepts in general, but to provide contextual guidance for the configuration fields exposed in Kanvas (for example, what changing replicas, strategy, or Service.type actually affects when users are configuring components through the UI).
I understand the concern about scope, though. I'll raise the topic in Slack and get feedback on whether this kind of reference material belongs in the Kanvas docs before making further revisions. Thanks for the suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Audit of Kubernetes component configuration properties and descriptions

3 participants