flannel is a network fabric for containers, designed for Kubernetes
Clone or download
Latest commit 1aa15b9 Sep 18, 2018
Permalink
Failed to load latest commit information.
.github Comment out the PR template message and add release note section Oct 26, 2017
Documentation Update version used in doc Aug 21, 2018
backend fix typo Apr 7, 2018
dist Lots of fixes getting it ready to merge (tests/docs) Jan 25, 2018
images/iperf3 Add support for multiarch e2e tests Oct 19, 2017
logos logos: resized for readme Jul 28, 2015
network Update network/iptables_windows.go Aug 25, 2018
pkg Merge pull request #911 from tomdee/rakelkar-jroggeman/windows_impl Jan 2, 2018
subnet subnet: handle unknown state in delete event May 31, 2018
vendor Merge pull request #929 from tomdee/feature/ipsec Jan 25, 2018
version Version embedding for Go 1.4 and 1.5 Nov 6, 2015
.appveyor.yml backend: Get flannel building on windows with stubs Nov 22, 2017
.dockerignore BUILDS: Overhaul build process Jul 19, 2016
.gitignore flannel: Get flannel running on windows Nov 30, 2017
.travis.yml travis: Only run the tests once Oct 27, 2017
CONTRIBUTING.md Added boilerplate files Aug 28, 2014
DCO Added boilerplate files Aug 28, 2014
Dockerfile.amd64 Fix up rebase Dec 23, 2017
Dockerfile.arm Fix up rebase Dec 23, 2017
Dockerfile.arm64 Fix up rebase Dec 23, 2017
Dockerfile.ppc64le Fix up rebase Dec 23, 2017
Dockerfile.s390x Fix up rebase Dec 23, 2017
LICENSE Added boilerplate files Aug 28, 2014
MAINTAINERS MAINTAINERS: remove steevej Mar 16, 2017
Makefile Use latest Go version Jul 9, 2018
NOTICE Added boilerplate files Aug 28, 2014
README.md edit Flannel license info so that GitHub recognizes it Jun 21, 2018
bill-of-materials.json bill-of-materials: initial commit May 3, 2017
bill-of-materials.override.json bill-of-materials: initial commit May 3, 2017
code-of-conduct.md update CoC Jan 4, 2018
glide.lock Merge pull request #929 from tomdee/feature/ipsec Jan 25, 2018
glide.yaml Apply changes to etcdv2 code after package move Dec 23, 2017
header-check.sh edit Flannel license info so that GitHub recognizes it Jun 21, 2018
main.go Merge pull request #978 from appvia/optional-forward-rules Jul 9, 2018
packet-01.png diagram: update to reflect name change Sep 17, 2014

README.md

flannel

flannel Logo

Build Status

Flannel is a simple and easy way to configure a layer 3 network fabric designed for Kubernetes.

How it works

Flannel runs a small, single binary agent called flanneld on each host, and is responsible for allocating a subnet lease to each host out of a larger, preconfigured address space. Flannel uses either the Kubernetes API or etcd directly to store the network configuration, the allocated subnets, and any auxiliary data (such as the host's public IP). Packets are forwarded using one of several backend mechanisms including VXLAN and various cloud integrations.

Networking details

Platforms like Kubernetes assume that each container (pod) has a unique, routable IP inside the cluster. The advantage of this model is that it removes the port mapping complexities that come from sharing a single host IP.

Flannel is responsible for providing a layer 3 IPv4 network between multiple nodes in a cluster. Flannel does not control how containers are networked to the host, only how the traffic is transported between hosts. However, flannel does provide a CNI plugin for Kubernetes and a guidance on integrating with Docker.

Flannel is focused on networking. For network policy, other projects such as Calico can be used.

Getting started on Kubernetes

The easiest way to deploy flannel with Kubernetes is to use one of several deployment tools and distributions that network clusters with flannel by default. For example, CoreOS's Tectonic sets up flannel in the Kubernetes clusters it creates using the open source Tectonic Installer to drive the setup process.

Though not required, it's recommended that flannel uses the Kubernetes API as its backing store which avoids the need to deploy a discrete etcd cluster for flannel. This flannel mode is known as the kube subnet manager.

Deploying flannel manually

Flannel can be added to any existing Kubernetes cluster though it's simplest to add flannel before any pods using the pod network have been started.

For Kubernetes v1.7+ kubectl apply -f https://raw.githubusercontent.com/coreos/flannel/master/Documentation/kube-flannel.yml

See Kubernetes for more details.

Getting started on Docker

flannel is also widely used outside of kubernetes. When deployed outside of kubernetes, etcd is always used as the datastore. For more details integrating flannel with Docker see Running

Documentation

Contact

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Reporting bugs

See reporting bugs for details about reporting any issues.

Licensing

Flannel is under the Apache 2.0 license. See the LICENSE file for details.