Project Calico's per-host agent Felix, responsible for programming routes and security policy.
Clone or download
Latest commit aa252e1 Sep 25, 2018
Permalink
Failed to load latest commit information.
.github Add CODEOWNERS file Sep 12, 2018
buildinfo Fix up Golang imports after moving go files. Jan 26, 2017
calc Enable test reports for all tests and save reports with different fil… Sep 12, 2018
check-licenses Fix up yaml license Jul 13, 2018
cmd/calico-felix Allow others to import and run Felix May 31, 2018
config Enable test reports for all tests and save reports with different fil… Sep 12, 2018
conntrack Enable test reports for all tests and save reports with different fil… Sep 12, 2018
daemon make update-typha Sep 19, 2018
dataplane Enable test reports for all tests and save reports with different fil… Sep 12, 2018
debian Debian/RPM packaging for Felix v3.2.0 Aug 13, 2018
dispatcher Replace log.Fatal with log.Panic in most cases. Aug 31, 2017
docker-build-images Build packages for Bionic Jul 17, 2018
docker-image Remove glibc to fix build breakage. Aug 14, 2018
docs Bring calc graph diagram up to date. Aug 31, 2017
etc Improve calico-diags redaction. Apr 26, 2018
fv Enable test reports for all tests and save reports with different fil… Sep 12, 2018
git-hooks Clean up Makefile Jun 14, 2018
hashutils Enable test reports for all tests and save reports with different fil… Sep 12, 2018
ifacemonitor Enable test reports for all tests and save reports with different fil… Sep 12, 2018
ip Enable test reports for all tests and save reports with different fil… Sep 12, 2018
ipsets Enable test reports for all tests and save reports with different fil… Sep 12, 2018
iptables Enable test reports for all tests and save reports with different fil… Sep 12, 2018
jitter Enable test reports for all tests and save reports with different fil… Sep 12, 2018
k8sfv Enable test reports for all tests and save reports with different fil… Sep 12, 2018
labelindex Enable test reports for all tests and save reports with different fil… Sep 12, 2018
logutils Add support for dumping a CPU profile on SIGUSR2. Apr 18, 2018
markbits Enable test reports for all tests and save reports with different fil… Sep 12, 2018
multidict Enable test reports for all tests and save reports with different fil… Sep 12, 2018
policysync Enable test reports for all tests and save reports with different fil… Sep 12, 2018
proto Check in protobufs May 31, 2018
report Enable test reports for all tests and save reports with different fil… Sep 12, 2018
routetable Enable test reports for all tests and save reports with different fil… Sep 12, 2018
rpm Debian/RPM packaging for Felix v3.2.0 Aug 13, 2018
rules Enable test reports for all tests and save reports with different fil… Sep 12, 2018
statusrep Enable test reports for all tests and save reports with different fil… Sep 12, 2018
stringutils Enable test reports for all tests and save reports with different fil… Sep 12, 2018
testutils Move go code up to main directory. Jan 26, 2017
throttle Enable test reports for all tests and save reports with different fil… Sep 12, 2018
usagerep Enable test reports for all tests and save reports with different fil… Sep 12, 2018
utils Merge pull request #1648 from fasaxc/add-v-to-version Jul 20, 2018
.gitignore Enable test reports for all tests and save reports with different fil… Sep 12, 2018
CHANGES.md Version 2.0.0-beta.3 Nov 7, 2016
CONTRIBUTING.md Cleanup README, CONTRIBUTING and unused file. Jan 27, 2017
LICENSE Project Calico version 0.1 Jun 26, 2014
Makefile Fix release targets Sep 24, 2018
README.md multi-arch push May 21, 2018
RELEASING.md Update release targets to be consistent with other Makefiles Jun 13, 2018
glide.lock Automated Typha pin update Sep 26, 2018
glide.yaml Automated Typha pin update Sep 26, 2018
install-git-hooks Add commit hook that checks copyright and license. Jun 23, 2016

README.md

Build Status Coverage Status Slack Status IRC Channel

Project Calico

Note that the documentation in this repo is targeted at Calico contributors.

Documentation for Calico users is here:
http://docs.projectcalico.org

This repository contains the source code for Project Calico's per-host daemon, Felix.

How can I get support for contributing to Project Calico?

The best place to ask a question or get help from the community is the calico-users #slack. We also have an IRC channel.

Who is behind Project Calico?

Tigera, Inc. is the company behind Project Calico and is responsible for the ongoing management of the project. However, it is open to any members of the community – individuals or organizations – to get involved and contribute code.

Contributing

Thanks for thinking about contributing to Project Calico! The success of an open source project is entirely down to the efforts of its contributors, so we do genuinely want to thank you for even thinking of contributing.

Before you do so, you should check out our contributing guidelines in the CONTRIBUTING.md file, to make sure it's as easy as possible for us to accept your contribution.

How do I build Felix?

Felix mostly uses Docker for builds. We develop on Ubuntu 16.04 but other Linux distributions should work (there are known Makefile issues that prevent building on OS X).
To build Felix, you will need:

  • A suitable linux box.
  • To check out the code into your GOPATH.
  • Docker >=1.12
  • GNU make.
  • Plenty of disk space (since the builds use some heavyweight full-OS containers in order to build debs and RPMs).

Then, as a one-off, run

make update-tools

which will install a couple more go tools that we haven't yet containerised.

Then, to build the calico-felix binary:

make build

or, the calico/felix docker image:

make image

Other architectures

When you run make build or make image, it creates the felix binary or docker image for linux on your architecture. The outputs are as follows:

  • Binary: bin/calico-felix-${ARCH}, e.g. bin/calico-felix-amd64 or bin/calico-felix-arm64
  • Image: calico/felix:${TAG}-${ARCH}, e.g. calico/felix:3.0.0-amd64 or calico/felix:latest-ppc64le

When you are running on amd64, you can build the binaries and images for other platforms by setting the ARCH variable. For example:

$ make build ARCH=arm64 # OR
$ make image ARCH=ppc64le

If you wish to make all of the binaries or images, use the standard calico project targets build-all and image-all:

$ make build-all # OR
$ make image-all

Note that the image and image-all targets have the build targets as a depedency.

How can I run Felix's unit tests?

To run all the UTs:

make ut

To start a ginkgo watch, which will re-run the relevant UTs as you update files:

make ut-watch

To get coverage stats:

make cover-report

or

make cover-browser

How can a subset of the go unit tests?

If you want to be able to run unit tests for specific packages for more iterative development, you'll need to install

  • GNU make
  • go >=1.7

then run make update-tools to install ginkgo, which is the test tool used to run Felix's unit tests.

There are several ways to run ginkgo. One option is to change directory to the package you want to test, then run ginkgo. Another is to use ginkgo's watch feature to monitor files for changes:

cd go
ginkgo watch -r

Ginkgo will re-run tests as files are modified and saved.

How do I build packages/run Felix?

Docker

After building the docker image (see above), you can run Felix and log to screen with, for example:

docker run --privileged \
           --net=host \
           -v /run:/run \
           -e FELIX_LOGSEVERITYSCREEN=INFO \
           calico/felix

Notes:

  • --privileged is required because Felix needs to execute iptables and other privileged commands.
  • --net=host is required so that Felix can manipulate the routes and iptables tables in the host namespace (outside its container).
  • -v /run:/run is required so that Felix shares the global iptables file lock with other processes; this allows Felix and other daemons that manipulate iptables to avoid clobbering each other's updates.
  • -e FELIX_LOGSEVERITYSCREEN=INFO tells Felix to log at info level to stderr.

Debs and RPMs

The Makefile has targets for building debs and RPMs for different platforms. By using docker, the build does not need to be run on the target platform.

make deb
make rpm

The packages (and source packages) are output to the dist directory.