-
Notifications
You must be signed in to change notification settings - Fork 29
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
Update design docs. #14
Conversation
Pull Request Test Coverage Report for Build 23
💛 - Coveralls |
docs/design.md
Outdated
|
||
- stability mechanism of Pod IP address | ||
|
||
- in many cases, Pod need to have specified IP address or make sure its IP address not changing after restarting. Knitter introduces a concept of IP group which can support IP address stablity well. |
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.
stablity -> stability
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.
done.
docs/design.md
Outdated
## Features | ||
|
||
- support for multiple networks/interfaces. | ||
- in telecommunication senarios, service data traffic is generally separated into several network planes, e.g., control plane, data plane and management plane. Those types of traffic have different QoS requirements. Multiple network interfaces are needed to isolate the networks and provide QoS ability. The current Kubernetes network model doesn't support multiple networks while Knitter can meet the multiple networks requirements. |
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.
senarios -> scenarios will be normally used IMO.
If you agree this, please sweep other words :)
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.
cool! done.
docs/design.md
Outdated
@@ -0,0 +1,102 @@ | |||
# Knitter Features and Design | |||
|
|||
[TOC] |
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.
TOC seems doesn't work well in github.
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.
TOC is not so necessary in this doc, so I remove it.
1f85822
to
13ee790
Compare
docs/design.md
Outdated
|
||
Take setting up networks for pod for example, the workflow of interaction among the components is shown as the below diagram. | ||
|
||
```mermaid |
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.
mermaid is not supported on github. I will replace with image.
13ee790
to
0e49c3d
Compare
@guangxuli updated. PTAL. Thanks! |
LGTM |
THANKS peter !!! |
ohh, we should update the image path from ./docs/images/ to ./images/, i will file another PR to fix this. |
Why we need this PR:
Updated the design doc. There might be further updating needed.
Which issue(s) this PR fixes(we suggest there is at least one issue related to this PR)
Fixes # none
cc @guangxuli