Skip to content

Commit a8e129a

Browse files
caseydavenportthockin
authored andcommitted
Sort network plugins alphabetically. (kubernetes#1583)
1 parent 2a4501e commit a8e129a

File tree

3 files changed

+29
-29
lines changed

3 files changed

+29
-29
lines changed

docs/admin/addons.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,20 @@ Add-ons extend the functionality of Kubernetes.
77

88
This page lists some of the available add-ons and links to their respective installation instructions.
99

10+
Add-ons in each section are sorted alphabetically - the ordering does not imply any preferential status.
11+
1012
## Networking and Network Policy
1113

12-
* [Weave Net](https://github.com/weaveworks/weave-kube) provides networking and network policy, will carry on working on both sides of a network partition, and does not require an external database.
13-
* [Calico](http://docs.projectcalico.org/v1.5/getting-started/kubernetes/installation/hosted/) is a secure L3 networking and network policy provider.
14-
* [Flannel](https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml) is a overlay network provider that can be used with Kubernetes.
14+
* [Calico](http://docs.projectcalico.org/v1.6/getting-started/kubernetes/installation/hosted/) is a secure L3 networking and network policy provider.
1515
* [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm) unites Flannel and Calico, providing networking and network policy.
16+
* [Flannel](https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml) is a overlay network provider that can be used with Kubernetes.
1617
* [Romana](http://romana.io) is a Layer 3 networking solution for pod networks that also supports the [NetworkPolicy API](/docs/user-guide/networkpolicies/). Kubeadm add-on installation details available [here](https://github.com/romana/romana/tree/master/containerize).
18+
* [Weave Net](https://github.com/weaveworks/weave-kube) provides networking and network policy, will carry on working on both sides of a network partition, and does not require an external database.
1719

1820
## Visualization & Control
1921

20-
* [Weave Scope](https://www.weave.works/documentation/scope-latest-installing/#k8s) is a tool for graphically visualizing your containers, pods, services etc. Use it in conjunction with a [Weave Cloud account](https://cloud.weave.works/) or host the UI yourself.
2122
* [Dashboard](https://github.com/kubernetes/dashboard#kubernetes-dashboard) is a dashboard web interface for Kubernetes.
23+
* [Weave Scope](https://www.weave.works/documentation/scope-latest-installing/#k8s) is a tool for graphically visualizing your containers, pods, services etc. Use it in conjunction with a [Weave Cloud account](https://cloud.weave.works/) or host the UI yourself.
2224

2325
## Legacy Add-ons
2426

docs/admin/networking.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,19 @@ existence or non-existence of host ports.
100100
There are a number of ways that this network model can be implemented. This
101101
document is not an exhaustive study of the various methods, but hopefully serves
102102
as an introduction to various technologies and serves as a jumping-off point.
103-
If some techniques become vastly preferable to others, we might detail them more
104-
here.
103+
104+
The following networking options are sorted alphabetically - the order does not
105+
imply any preferential status.
106+
107+
### Contiv
108+
109+
[Contiv](https://github.com/contiv/netplugin) provides configurable networking (native l3 using BGP, overlay using vxlan, classic l2, or Cisco-SDN/ACI) for various use cases. [Contiv](http://contiv.io) is all open sourced.
110+
111+
### Flannel
112+
113+
[Flannel](https://github.com/coreos/flannel#flannel) is a very simple overlay
114+
network that satisfies the Kubernetes requirements. Many
115+
people have reported success with Flannel and Kubernetes.
105116

106117
### Google Compute Engine (GCE)
107118

@@ -158,29 +169,12 @@ Follow the "With Linux Bridge devices" section of [this very nice
158169
tutorial](http://blog.oddbit.com/2014/08/11/four-ways-to-connect-a-docker/) from
159170
Lars Kellogg-Stedman.
160171

161-
### Weave Net from Weaveworks
162-
163-
[Weave Net](https://www.weave.works/products/weave-net/) is a
164-
resilient and simple to use network for Kubernetes and its hosted applications.
165-
Weave Net runs as a [CNI plug-in](https://www.weave.works/docs/net/latest/cni-plugin/)
166-
or stand-alone. In either version, it doesn't require any configuration or extra code
167-
to run, and in both cases, the network provides one IP address per pod - as is standard for Kubernetes.
168-
169-
170-
### Flannel
171-
172-
[Flannel](https://github.com/coreos/flannel#flannel) is a very simple overlay
173-
network that satisfies the Kubernetes requirements. It installs in minutes and
174-
should get you up and running if the above techniques are not working. Many
175-
people have reported success with Flannel and Kubernetes.
176-
177172
### OpenVSwitch
178173

179174
[OpenVSwitch](/docs/admin/ovs-networking) is a somewhat more mature but also
180175
complicated way to build an overlay network. This is endorsed by several of the
181176
"Big Shops" for networking.
182177

183-
184178
### Project Calico
185179

186180
[Project Calico](https://github.com/projectcalico/calico-containers/blob/master/docs/cni/kubernetes/README.md) is an open source container networking provider and network policy engine.
@@ -193,9 +187,13 @@ Calico can also be run in policy enforcement mode in conjunction with other netw
193187

194188
[Romana](http://romana.io) is an open source network and security automation solution that lets you deploy Kubernetes without an overlay network. Romana supports Kubernetes [Network Policy](/docs/user-guide/networkpolicies/) to provide isolation across network namespaces.
195189

196-
### Contiv
190+
### Weave Net from Weaveworks
197191

198-
[Contiv](https://github.com/contiv/netplugin) provides configurable networking (native l3 using BGP, overlay using vxlan, classic l2, or Cisco-SDN/ACI) for various use cases. [Contiv](http://contiv.io) is all open sourced.
192+
[Weave Net](https://www.weave.works/products/weave-net/) is a
193+
resilient and simple to use network for Kubernetes and its hosted applications.
194+
Weave Net runs as a [CNI plug-in](https://www.weave.works/docs/net/latest/cni-plugin/)
195+
or stand-alone. In either version, it doesn't require any configuration or extra code
196+
to run, and in both cases, the network provides one IP address per pod - as is standard for Kubernetes.
199197

200198
## Other reading
201199

docs/getting-started-guides/scratch.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,12 @@ to implement one of the above options:
8181

8282
- **Use a network plugin which is called by Kubernetes**
8383
- Kubernetes supports the [CNI](https://github.com/containernetworking/cni) network plugin interface.
84-
- There are a number of solutions which provide plugins for Kubernetes:
84+
- There are a number of solutions which provide plugins for Kubernetes (listed alphabetically):
85+
- [Calico](http://docs.projectcalico.org/)
8586
- [Flannel](https://github.com/coreos/flannel)
86-
- [Calico](https://github.com/projectcalico/calico-containers)
87-
- [Weave](https://weave.works/)
88-
- [Romana](http://romana.io/)
8987
- [Open vSwitch (OVS)](http://openvswitch.org/)
88+
- [Romana](http://romana.io/)
89+
- [Weave](http://weave.works/)
9090
- [More found here](/docs/admin/networking#how-to-achieve-this)
9191
- You can also write your own.
9292
- **Compile support directly into Kubernetes**

0 commit comments

Comments
 (0)