Skip to content

Commit

Permalink
Adding architecture details
Browse files Browse the repository at this point in the history
  • Loading branch information
murali-reddy committed Aug 24, 2017
1 parent 89105e8 commit 5951f55
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions Documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,28 @@ Kube-router consists of 3 core controllers and multiple watchers as depicted in

![Arch](./img/kube-router-arch.png)

Each of the [controller](https://github.com/cloudnativelabs/kube-router/tree/master/app/controllers) follows below structure

```
func Run() {
for {
Sync() // control loop that runs for ever and perfom sync at periodic interval
}
}
func OnUpdate() {
Sync() // on receiving update of a watched API object (namespace, node, pod, network policy etc)
}
Sync() {
//re-concile any state changes
}
Cleanup() {
// cleanup any changes (to iptables, ipvs, network etc) done to the system
}
```

## See Kube-router in action

#### Network Services Controller
Expand Down

0 comments on commit 5951f55

Please sign in to comment.