Improve the docs and fix typo

Author: hainesc

Makefile

@@ -30,7 +30,6 @@ anchor-image: anchor octopus
 monkey-image: monkey
 	$Q $(DOCKER) build -t monkey:$(VERSION) $(BUILD)/monkey
 
-# TODO: this will fmt or lint twice.
 anchor:
 	$Q mkdir -p $(BUILD)/anchor
 	$Q GOOS=$(GOOS) $(GO) build -o $(BUILD)/anchor/anchor cmd/anchor/anchor.go
@@ -111,9 +110,6 @@ test-coverage: fmt lint test-coverage-tools ; $(info $(M) running coverage tests
 lint: | $(GOLINT) ; $(info $(M) running golint...) @ ## Run golint
 	$Q $(GOLINT) -set_exit_status $(PKGS)
 
-.PHONY: binaries
-binaries: | $(ANCHOR) $(OCTOPUS) $(MONKEY) ; $(info $(M) build binaries...) @ ## Building
-
 .PHONY: fmt
 fmt: ; $(info $(M) running gofmt...) @ ## Run gofmt on all source files
 	@ret=0 && for d in $$($(GO) list -f '{{.Dir}}' ./...); do \

README.md

@@ -4,29 +4,29 @@ Some applications, especially legacy applications or applications which monitor
 
 ## There comes anchor
 
-Project anchor mainly contains four compenents, They are:
+Project anchor mainly contains four components, They are:
 
-Anchor is an ipam plugin following the [CNI SPEC](https://github.com/containernetworking/cni/blob/master/SPEC.md).
+* Anchor is an IPAM plugin following the [CNI SPEC](https://github.com/containernetworking/cni/blob/master/SPEC.md).
 
-Octopus is a main plugin that extends [macvlan](https://github.com/containernetworking/plugins/blob/master/plugins/main/macvlan/macvlan.go) to support multiple masters on the node. It is useful when there are multiple VLANs in the cluster.
+* Octopus is a main plugin that extends [macvlan](https://github.com/containernetworking/plugins/blob/master/plugins/main/macvlan/macvlan.go) to support multiple masters on the node. It is useful when there are multiple VLANs in the cluster.
 
-Monkey is a WebUI that displays and operates the data used by anchor ipam.
+* Monkey is a WebUI that displays and operates the data used by anchor IPAM.
 
-The backstage hero is the installation script of the anchor, which configures and maintains the network interfaces of the node.
+* The backstage hero is the installation script of the anchor, which configures and maintains the network interfaces of the node.
 
 ## CNI and Kubernetes
 
 CNI(Container Network Interface), a CNCF project, consists of a specification and libraries for writing plugins to configure network interfaces in Linux containers, along with a number of supported plugins. CNI concerns itself only with network connectivity of containers and removing allocated resources when the container is deleted. Because of this focus, CNI has a wide range of support and the specification is simple to implement.
 
-It is worth mentioning that kubernetes is just one of CNI runtimes, others including mesos, rkt, openshift.
+It is worth mentioning that kubernetes is just one of CNI runtimes, others including mesos, rkt, openshift, etc.
 
 ## MacVLAN
 
 MacVLAN is a Linux network driver that exposes underlay or host interfaces directly to VMs or Containers running in the host.
 
-MacVLAN allows a single physical interface to have multiple MAC and ip addresses using MacVLAN sub-interfaces. MacVLAN interface is typically used for virtualization applications and each MacVLAN interface is connected to a Container or VM. Each container or VM can directly get dhcp address as the host would do. This would help customers who want Containers to be part of their traditional network with the IP addressing scheme that they already have.
+MacVLAN allows a single physical interface to have multiple MACs and ip addresses using MacVLAN sub-interfaces. MacVLAN interface is typically used for virtualization applications and each MacVLAN interface is connected to a Container or VM. Each container or VM can directly get DHCP address or IPAM address as the host would do. This would help customers who want Containers to be part of their traditional network with the IP addressing scheme that they already have.
 
-When using MacVLAN, the containers is **NOT** reachable to the underlying host interfaces as the packages are intentionally filtered by Linux for additional isolation. This does not meet the SPEC of CNI and *service* in k8s cannot work correnctly. To work around it, we create a new MacVLAN interface and steal the IP and network traffic from the host interface by changing the route table on the node. This work is designed to be done by installation script.
+When using MacVLAN, the containers is **NOT** reachable to the underlying host interfaces as the packages are intentionally filtered by Linux for additional isolation. This does not meet the SPEC of CNI and causes *service* in k8s cannot work correnctly. To work around it, we create a new MacVLAN interface and steal the IP and network traffic from the host interface by changing the route table in the host. This work is designed to be done by installation script.
 
 ## Installation
 
@@ -46,11 +46,11 @@ Recently, I have no resources(No time, no machines) to test whether anchor works
 curl -O https://raw.githubusercontent.com/hainesc/anchor/master/deployment/anchor.yaml
 ```
 
-Edit the anchor.yaml use your favorite editor, *L* means *Line* below.
+Edit the anchor.yaml using your favorite editor, *L* means *Line* below.
 
 * Remove L200 and lines below if the k8s cluster has not enabled RBAC.
-* L8, input the etcd endpoints used as the store for anchor, example at the end of the line.
-* L10 - L12, input the access token of the etcd, do nothing if SSL not enabled.
+* L8, input the etcd endpoints used as the store by anchor, see example at the end of the line.
+* L10 - L12, input the access tokens of the etcd, remove if SSL not enabled.
 * L18, input the choice whether or not create macvlan interface during the installation.
 * L22, input the cluster network information. Use semicolon(;) to seperate between items. eg, item *node01,eth0.2,10.0.2.8,10.0.2.1,24* tells install script creating a MacVLAN interface with the master *eth0.2* at the node whose hostname is *node01*, the additional info including IP of the master(*eth0.2* here), the gateway and mask of the subnet(10.0.2.1 and 24). You CAN have Multiple items for each node.
 
@@ -68,10 +68,12 @@ There are several works done by the pod which created by the daemonset on each n
 * Config and write a CNI config file named 10-anchor.conf to the node
 * Create MacVLAN interface(s) on the node, the interfaces created here will be removed on node restart, but when the node rejoin the k8s cluster, the daemonset recreates a pod and it will recrete the interfaces.
 
-## Example
+## Run an example
 
 **Preparation**
 
+Before the example, we should initialize the etcd store used by anchor.
+
 There are three k-v stores used by the anchor ipam, they are:
 
 |  KV  |  Example  |  Explanation  |
@@ -80,7 +82,7 @@ There are three k-v stores used by the anchor ipam, they are:
 | Subnet -> Gateway | /anchor/gw/10.0.1.0/24 -> 10.0.1.1 | The map between subnet and its gateway |
 | Container -> IP | /anchor/cn/212b... -> 10.0.1.2 | The IP binding with the ContainerID |
 
-At the beginning, the stores are empty, so just input some data according to the environment.
+At the beginning, the stores are empty, so just input some data following the environment.
 
 I have created a WebUI named [Powder monkey](https://github.com/hainesc/powder) to display and operate the k-v stores. The frontend is written in Angular and the backend written in Golang.
 
@@ -96,7 +98,7 @@ Edit L14 and choose a subnet for it, then Run:
 kubectl apply -f anchor-2048.yaml
 ```
 
-Wait for the installation to complete, it will create a deployment named anchor-2048 and the service named anchor-2048.
+Wait for the installation to complete, it will create a deployment named anchor-2048 and a service named anchor-2048.
 
 ```shell
 kubectl get pods -n default -o wide

examples/anchor-2048.yaml

@@ -15,7 +15,7 @@ spec:
     spec:
       containers:
       - name: anchor-2048
-        image: blackicebird/2048
+        image: alexwhen/docker-2048
         ports:
         - containerPort: 80
 ---