Skip to content

/flannel

flannel is a network fabric for containers, designed for Kubernetes
kubernetes network overlay-network docker go flannel subnet docker-image
Go C Makefile Other
  1. Go 91.9%
  2. C 4.0%
  3. Makefile 3.9%
  4. Other 0.2%
Branch: master
Find File
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

@rajatchopra
rajatchopra Merge pull request #1161 from professor/replaces-go-powershell 
Replaces gorillalabs go-powershell with bhendo/go-powershell
Latest commit ecb6db3 Aug 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Comment out the PR template message and add release note section Oct 26, 2017
Documentation Update deprecated API resources Jul 18, 2019
backend Make VXLAN device learning attribute configurable Jun 22, 2019
dist Added README.md Jul 16, 2019
images/iperf3 Add support for multiarch e2e tests Oct 19, 2017
logos logos: resized for readme Jul 28, 2015
network Use iptables --random-fully when available Sep 19, 2018
pkg Fix function comments based on best practices from Effective Go Feb 13, 2019
subnet Needs to clear NodeNetworkUnavailable flag on Kubernetes Jul 24, 2019
vendor Replaces gorillalabs go-powershell with bhendo/go-powershell Jul 15, 2019
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 Update MAINTAINERS Oct 25, 2018
Makefile Makefile: fix indentation Jan 17, 2019
NOTICE Added boilerplate files Aug 28, 2014
OWNERS New maintainers and reviewers. Creating an owners file that the ci-bo… Jan 9, 2019
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 Replaces gorillalabs go-powershell with bhendo/go-powershell Jul 15, 2019
glide.yaml Fix typo in glide.yaml Apr 9, 2019
header-check.sh edit Flannel license info so that GitHub recognizes it Jun 21, 2018
main.go main.go: add the "net-config-path" flag May 15, 2019
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.

You can’t perform that action at this time.