layer5io / layer5io/docs

[Docs] Documenting Kanvas Support for Exported Kubernetes Pods

Open
#443 3 comments 0 reactions 1 assignee Claimed by @PARTH-TUSSLE View on GitHub
area/docs framework/hugo issue/willfix language/markdown
Dominant language
JavaScript
Stars
99
Forks
223
Avg merge
1d 1h
Merged PRs (30d)
17

Description

#### 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:
```bash
kubectl get pods -n -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?
1. 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
- 📚 [Instructions for contributing to documentation](https://github.com/layer5io/docs/blob/master/CONTRIBUTING.md)
- Layer5 documentation [site](https://docs.layer5.io) and [source](https://github.com/layer5io/docs/)
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.