Network revisited docs #325

zaibon · 2019-10-14T09:10:35Z

No description provided.

codecov · 2019-10-18T07:22:43Z

Codecov Report

Merging #325 into master will increase coverage by 10.42%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #325       +/-   ##
==========================================
+ Coverage   39.17%   49.6%   +10.42%     
==========================================
  Files          58      26       -32     
  Lines        3602    1252     -2350     
==========================================
- Hits         1411     621      -790     
+ Misses       1999     578     -1421     
+ Partials      192      53      -139

Impacted Files	Coverage Δ
pkg/upgrade/hub.go	`15.21% <0%> (-28.62%)`	⬇️
pkg/kernel/kernel.go	`73.91% <0%> (ø)`	⬆️
pkg/upgrade/upgrade.go	`0% <0%> (ø)`	⬆️
pkg/identity/store.go	`0% <0%> (ø)`	⬆️
.../gedis/types/provision/tfgrid_reservation_zdb_1.go
pkg/provision/network.go
pkg/gedis/gedis.go
pkg/container/startup.go
...s/types/provision/tfgrid_reservation_workload_1.go
pkg/provision/zdb.go
... and 30 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ee944be...9eae78e. Read the comment docs.

zaibon

Added some inline comments and typo fixes.

I also don't see the point of the setup directory being added in this PR.
Also this PR should push the documentation into /docs/network and not /docs/network_new
old /docs can be totally deleted since not relevant anymore

zaibon · 2019-10-22T10:56:52Z

docs/network_new/MESH.md

@@ -0,0 +1,122 @@
+# Zero-Mesh


I don't think this field is linked from anywhere. We should have an Index page for all the network docs an referring this file from it

docs/network_new/README.md

zaibon · 2019-10-22T11:11:25Z

docs/network_new/README.md

+- **CNI** 
+ZOS and it's Wireguard mesh per user is a quite novel way to do things, but there are many overlay networks that are built to solve other network requirements in very different ways, and these solutions could be intagrated in a later phase, through the use of `CNI`, a common way to request a network for a user, or for a specific workload.
+
+- **automated provisioning**  


As far as I know this is not on the roadmap at all. So I would remove this paragraph altogether

zaibon · 2019-10-22T11:13:37Z

docs/network_new/README.md

+As such, these nodes can only partake in a network as client-only towards publicly reachable peers, and can only initiate the connections themselves. (ref previous drawing).  
+To make sure connectivity stays up, the clients (all) have a keepalive towards all their peers so that communications towards network resources in hidden nodes can be established.
+
+## caveats


This caveats paragraph is actually what the farmer needs to be aware of when configuring their farm network.
@andhartl can you check if this is enough for them or should we add more detail ?

We should also reference this paragraph from the index of the network documentation as Farm network consideration

zaibon · 2019-10-22T11:14:31Z

docs/network_new/network_module.md

+
+```go
+//Networker is the interface for the network module
+type Networker interface {


Suggested change

type Networker interface {

type Networker interface {

// Create a new network resource

CreateNR(Network) (string, error)

// Delete a network resource

DeleteNR(Network) error

// Join a network (with network id) will create a new isolated namespace

// that is hooked to the network bridge with a veth pair, and assign it a

// new IP from the network resource range. The method return the new namespace

// name.

// The member name specifies the name of the member, and must be unique

// The NetID is the network id to join

Join(networkdID NetID, containerID string, addrs []string) (join Member, err error)

// Leave delete a container nameapce created by Join

Leave(networkdID NetID, containerID string) (err error)

// ZDBPrepare creates a network namespace with a macvlan interface into it

// to allow the 0-db container to be publicly accessible

// it retusn the name of the network namespace created

ZDBPrepare() (string, error)

// Addrs return the IP addresses of interface

// if the interface is in a network namespace netns needs to be not empty

Addrs(iface string, netns string) ([]net.IP, error)

}

zaibon · 2019-10-22T11:15:27Z

docs/network_new/network_module.md

+
+## Zero-OS networking
+
+### Some First Explanations


This sounds like redundant with the rest of the documentation. Let's get rid of this.

zaibon · 2019-10-22T11:25:15Z

docs/network_new/network_module.md

+
+[Here some thought dumps from where we started working this out](../../specs/network/Requirements.md)
+
+### Jargon


Let's convert this paragraph into a proper glossary page that we can reference throughout the all network documentation.

Co-Authored-By: Christophe de Carvalho <zaibon@users.noreply.github.com>

andhartl mentioned this pull request Oct 22, 2019

Node and farmer migration to grid 2.0 documentation #328

Closed

7 tasks

zaibon added this to the 0.1.1 milestone Oct 22, 2019

zaibon assigned delandtj Oct 22, 2019

zaibon requested a review from andhartl October 22, 2019 08:58

zaibon commented Oct 22, 2019

View reviewed changes

zaibon marked this pull request as ready for review October 28, 2019 15:00

zaibon requested review from LeeSmet, delandtj, maxux and muhamadazmy as code owners October 28, 2019 15:00

delandtj and others added 18 commits October 28, 2019 16:00

initial niew network docs

474986c

docs

1ed3ca2

docs

df8d8cd

docs, continued

eed10a5

docsdocs...

b097527

docsdocsdocs

ce11803

added config for 8-blade server

43c393b

NETWORK

672a237

Update docs/network_new/README.md

f0a1b08

Co-Authored-By: Christophe de Carvalho <zaibon@users.noreply.github.com>

Update docs/network_new/README.md

8733368

Co-Authored-By: Christophe de Carvalho <zaibon@users.noreply.github.com>

Update docs/network_new/README.md

c841720

Co-Authored-By: Christophe de Carvalho <zaibon@users.noreply.github.com>

farmer

2af4e3f

Update README.md

5125509

Update README.md

a4bb684

Update docs/network_new/README.md

5a5ff5c

Co-Authored-By: Christophe de Carvalho <zaibon@users.noreply.github.com>

network docs restructure

391aa2f

rip network_new

34327cc

documentation: add index for network doc and split into smaller pages

9eae78e

zaibon force-pushed the network_revisited_docs branch from 9d0924d to 9eae78e Compare October 28, 2019 15:01

zaibon merged commit 86c098a into master Oct 28, 2019

zaibon deleted the network_revisited_docs branch October 28, 2019 15:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Network revisited docs #325

Network revisited docs #325

Uh oh!

zaibon commented Oct 14, 2019

Uh oh!

codecov bot commented Oct 18, 2019 •

edited

Loading

Uh oh!

zaibon left a comment

Uh oh!

zaibon Oct 22, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zaibon Oct 22, 2019

Uh oh!

zaibon Oct 22, 2019

Uh oh!

zaibon Oct 22, 2019

Uh oh!

zaibon Oct 22, 2019

Uh oh!

zaibon Oct 22, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-type Networker interface {
+type Networker interface {
+	// Create a new network resource
+	CreateNR(Network) (string, error)
+	// Delete a network resource
+	DeleteNR(Network) error
+	// Join a network (with network id) will create a new isolated namespace
+	// that is hooked to the network bridge with a veth pair, and assign it a
+	// new IP from the network resource range. The method return the new namespace
+	// name.
+	// The member name specifies the name of the member, and must be unique
+	// The NetID is the network id to join
+	Join(networkdID NetID, containerID string, addrs []string) (join Member, err error)
+	// Leave delete a container nameapce created by Join
+	Leave(networkdID NetID, containerID string) (err error)
+	// ZDBPrepare creates a network namespace with a macvlan interface into it
+	// to allow the 0-db container to be publicly accessible
+	// it retusn the name of the network namespace created
+	ZDBPrepare() (string, error)
+	// Addrs return the IP addresses of interface
+	// if the interface is in a network namespace netns needs to be not empty
+	Addrs(iface string, netns string) ([]net.IP, error)
+}


		[Here some thought dumps from where we started working this out](../../specs/network/Requirements.md)

		### Jargon

Network revisited docs #325

Network revisited docs #325

Uh oh!

Conversation

zaibon commented Oct 14, 2019

Uh oh!

codecov bot commented Oct 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

zaibon left a comment

Choose a reason for hiding this comment

Uh oh!

zaibon Oct 22, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zaibon Oct 22, 2019

Choose a reason for hiding this comment

Uh oh!

zaibon Oct 22, 2019

Choose a reason for hiding this comment

Uh oh!

zaibon Oct 22, 2019

Choose a reason for hiding this comment

Uh oh!

zaibon Oct 22, 2019

Choose a reason for hiding this comment

Uh oh!

zaibon Oct 22, 2019

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Oct 18, 2019 •

edited

Loading