-
Notifications
You must be signed in to change notification settings - Fork 96
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
Add architecture and design principles doc #715
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
Improvements or additions to documentation
label
Jun 5, 2023
kate-osborn
commented
Jun 5, 2023
pleshakov
reviewed
Jun 6, 2023
sjberman
approved these changes
Jun 6, 2023
pleshakov
approved these changes
Jun 6, 2023
kate-osborn
force-pushed
the
docs/architecture
branch
from
June 6, 2023 21:26
4dec472
to
2b98f38
Compare
mpstefan
reviewed
Jun 7, 2023
mpstefan
reviewed
Jun 7, 2023
ADubhlaoich
reviewed
Jun 16, 2023
ADubhlaoich
reviewed
Jun 16, 2023
ADubhlaoich
reviewed
Jun 16, 2023
ADubhlaoich
reviewed
Jun 16, 2023
ADubhlaoich
reviewed
Jun 16, 2023
ADubhlaoich
reviewed
Jun 16, 2023
ADubhlaoich
approved these changes
Jun 16, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made a few suggestions, but otherwise LGTM! Very well written, and easy to understand.
Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com>
Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com>
Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com>
kate-osborn
force-pushed
the
docs/architecture
branch
from
June 16, 2023 20:20
c36ffad
to
5c69af7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Adds architecture and design principles doc.
Problem: The project has no document that explains the architecture or design principles.
Solution: I added a document that describes the high-level architecture and proposes some design principles.
The architecture portions of the doc are high-level. I mimicked the structure and diagrams from the first half of NIC's How NGINX Ingress Controller Works doc, but I did not include any diagrams or explanations of the architecture of the code. I anticipate the code's architecture will change and do not want to commit us to update this doc every time we make a code change. As our architecture stabilizes, we can expand this document to provide a more comprehensive overview.
Testing: None
Please focus on (optional): The design principles are aspirational. We may not follow all of them today. They are based on a document that @pleshakov started early in the project. I am looking for feedback on them; they are all up for debate.
Closes #673
Checklist
Before creating a PR, run through this checklist and mark each as complete.