isabella232 / calico

Documentation and release artifacts for Calico

Calico

This repository contains the source code for Project Calico's documentation and demos as well as the source for the calico/node container.

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

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

For information on calico/node, see the documentation on calico/node architecture.

Developing

Print useful actions with make help.

Building calico/node

To build the calico/node container, run the following build step from the root of the repository:

make -C calico_node calico/node

Use the build variables listed in the Calico binaries variable section at the top of the Makefile to modify which components are included in the resulting image. For example, the following command will produce a docker image called calico/node:custom which uses custom Felix and Libnetwork binaries:

FELIX_CONTAINER_NAME=calico/felix:1.4.3 \
LIBNETWORK_PLUGIN_CONTAINER_NAME=calico/libnetwork-plugin:v1.0.0-beta \
BUILD_CONTAINER_NAME=calico/node:custom \
make calico/node

The canonical source for which versions are included in the calico/node image come from the _date/versions.yml file.

Building the docs

See CONTRIBUTING_DOCS.md