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

Update design docs. #14

Merged
merged 1 commit into from
Apr 9, 2018
Merged

Update design docs. #14

merged 1 commit into from
Apr 9, 2018

Conversation

xiangpengzhao
Copy link
Collaborator

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

@coveralls
Copy link

coveralls commented Apr 8, 2018

Pull Request Test Coverage Report for Build 23

  • 0 of 0 (NaN%) changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 35.538%

Totals Coverage Status
Change from base Build 20: 0.0%
Covered Lines: 5630
Relevant Lines: 15842

💛 - Coveralls

@guangxuli guangxuli self-requested a review April 8, 2018 05:58
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stablity -> stability

Copy link
Collaborator Author

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.
Copy link
Contributor

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 :)

Copy link
Collaborator Author

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]
Copy link
Contributor

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.

Copy link
Collaborator Author

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.

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
Copy link
Collaborator Author

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.

@xiangpengzhao
Copy link
Collaborator Author

@guangxuli updated. PTAL. Thanks!

@guangxuli
Copy link
Contributor

LGTM

@guangxuli
Copy link
Contributor

THANKS peter !!!

@guangxuli guangxuli merged commit f88d374 into ZTE:master Apr 9, 2018
@guangxuli
Copy link
Contributor

ohh, we should update the image path from ./docs/images/ to ./images/, i will file another PR to fix this.

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

Successfully merging this pull request may close these issues.

None yet

3 participants