Update README.md and split into several child documents #191

s1061123 · 2018-11-13T08:13:24Z

Fix #154 and #139. Thank you @dougbtv for reviewing the docs!

@dougbtv

Fix #154 and #139. Thank you @dougbtv for reviewing the docs!

coveralls · 2018-11-13T08:18:33Z

Pull Request Test Coverage Report for Build 510

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 49.474%

Totals
Change from base Build 482:	0.0%
Covered Lines:	564
Relevant Lines:	1140

💛 - Coveralls

doc/how-to-use.md

Billy99 · 2018-11-14T18:20:48Z

doc/how-to-use.md

+# Execute following command at Kubernetes master
+$ cat ./images/{multus-daemonset.yml,flannel-daemonset.yml} | kubectl apply -f -
+```
+


General comment, it is hard to tell on the remaining sections which have already been done by the Quickstart "use daemonset" command (which I used).

For example:

70-multus.conf is created for you, just needs to be edited.

I tried the "Create ServiceAccount, ClusterRole and its binding" step and got errors:
Error from server (AlreadyExists): error when creating "STDIN": serviceaccounts "multus" already exists
Error from server (AlreadyExists): error when creating "STDIN": clusterroles.rbac.authorization.k8s.io "multus" already exists
Error from server (AlreadyExists): error when creating "STDIN": clusterrolebindings.rbac.authorization.k8s.io "multus" already exists.

doc/how-to-use.md

…usage guide

Billy99 · 2018-11-16T21:18:40Z

doc/quickstart.md

+Two things we'll refer to a number of times through this document are:
+
+* "Default network" -- This is your pod-to-pod network. This is how pods communicate among one another in your cluster, how they have connectivity. Generally speaking, this is presented as the interface named `eth0`. This interface is always attached to your pods, so that they can have connectivity among themselves. We'll add interfaces in addition to this.
+* "CRDs" -- Custom Resource Definitions. Custom Resources are a way that the Kubernetes API is extended. We use these here to store some information that Multus can ready. Primarily, we use these to store the configurations for each of the additional interfaces that are attached to your pods.


Multus can ready. -> Multus can read.

Billy99 · 2018-11-16T21:33:24Z

doc/quickstart.md

+CNI configurations are JSON, and we have a structure here that has a few things we're interested in:
+
+1. `cniVersion`: Tells each CNI plugin which version is being used and can give the plugin information if it's using a too late (or too early) version.
+2. `type`: This tells CNI which binary to call on disk. Each CNI plugin is a binary that's called. Typically, these binaries are stored in `/opt/cni/bin` on each node, and CNI executes this binary. In this case we've specified the `loopback` binary (which create a loopback-type network interface).


Just notes that might be helpful to add, but don't feel you have to:

Does my CNI need to be in place (/opt/cni/bin/) before the quick start is run for it to be propagated to each node?

Along the same lines, if I'm debugging and update the CNI, do I need to manually propagate it to each node?

Cool, made a note to check the contents of the directory to make sure your binaries are on disk. And then also made a note about how the configs are read on pod creation & deletion.

…ations generally per review

…ocp-master OCPBUGS-19859: Multus annotation permissions: Certificate duration should be configurable

Update README.md and split into several child documents

27128b5

Fix #154 and #139. Thank you @dougbtv for reviewing the docs!

s1061123 added the readme-update label Nov 13, 2018

s1061123 requested review from dougbtv and rkamudhan November 13, 2018 08:13