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

Project Architecture Documentation Improvements #4383

Open
angellk opened this issue Oct 10, 2024 · 3 comments
Open

Project Architecture Documentation Improvements #4383

angellk opened this issue Oct 10, 2024 · 3 comments

Comments

@angellk
Copy link

angellk commented Oct 10, 2024

The Dapr project thoroughly documents the architecture and design from an application developer's point of view. The Operations/SRE point of view, however, isn't clear and key information is in various places in the documentation and not in a single, easy to find location.

Recommendations:

  • An overview architectural diagram/page from an Infrastructure / DevOps Architect point of view detailing:
    • Infrastructure components for PoC, Dev, Test, Prod
    • Infrastructure resource minimums for each environment including CPU, Network, Memory, Storage
    • High Availability infrastructure components
    • Observability of the project in the hosted environments themselves

xref: cncf/toc#1354

@angellk
Copy link
Author

angellk commented Oct 11, 2024

Hi @yaron2 - those documents cover pieces of the recommendations. Overall recommendation is to make it easily assessable for that target persona.

@msfussell
Copy link
Member

@angellk - @hhunter-ms and I are going to dig into this one and resolve it.

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

No branches or pull requests

3 participants