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

Helm deployment instructions (README) include architecture diagrams #68

Open
boazmichaely opened this issue Jul 13, 2020 · 0 comments
Open

Comments

@boazmichaely
Copy link

Summary

The deployment instructions may be hard to follow without visuals.
Adding a few diagrams that show the target deployment architecture would be very beneficial.
For example -

  1. pod layout showing which containers are used
  2. networking diagram showing internal and external comm with ports

Note that some of these diagrams already exist elsewhere (ask @boazmichaely )

Expected Results

Users should be able to understand what they are building to start with, and verify that they have correctly built it at the end.

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

No branches or pull requests

1 participant