Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Documenting Kanvas Support for Exported Kubernetes Pods #443

Open
souvikinator opened this issue Feb 3, 2025 · 2 comments
Open
Labels
area/docs Improvements or additions to documentation framework/hugo issue/willfix This issue will be worked on language/markdown

Comments

@souvikinator
Copy link

souvikinator commented Feb 3, 2025

Current State

A new documentation page under (Getting Started with Designer](https://docs.layer5.io/kanvas/getting-started/) entitled, “Starting from Existing Infrastructure” is needed.

Desired State

With Kanvas now supporting the rendering of exported Kubernetes pods using the kubectl command:

kubectl get pods -n <namespace> -o yaml > exported-pods.yaml

We want to provide clear and comprehensive documentation that helps users quickly get started. This will allow them to experience firsthand how powerful Kanvas is in visualizing and managing Kubernetes resources. The goal is to ensure a smooth onboarding process and showcase the efficiency of this new capability.

Documentation of the following questions, too:

  1. What's the upper limit of components that can be ingested?
  2. What effect do the number of relationships definitions have on this?

This update should identify that kubectl describe is not currently supported.


Contributor Guide and Resources

@souvikinator souvikinator added area/docs Improvements or additions to documentation framework/hugo language/markdown labels Feb 3, 2025
@souvikinator
Copy link
Author

@leecalcote FYI

@leecalcote
Copy link
Member

Thank you. Issue description updated.

@leecalcote leecalcote added the issue/willfix This issue will be worked on label Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation framework/hugo issue/willfix This issue will be worked on language/markdown
Development

No branches or pull requests

2 participants