calicoctl

This repository is the home of calicoctl.

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

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

For information on calicoctl usage, see the calicoctl reference information

Developing

Print useful actions with make help.

Building calicoctl

There are two ways to build calicoctl: natively, and dockerized

Dockerized Builds

For simplicity, calicoctl can be built in a Docker container, eliminating the need for any dependencies in your host developer environment, using the following command:

make dist/calicoctl

The binary will be put in ./dist:

./dist/calicoctl --help

Native Builds

1. Assuming you have already installed go version 1.7.1+, ensure you've cloned this repository into your Go project path.

   git clone https://github.com/projectcalico/calicoctl.git $GOPATH/src/github.com/projectcalico/calicoctl
   

2. Install Glide.

3. Populate the vendor/ directory in the project's root with this project's dependencies:

   glide install -strip-vendor
   

4. Build the binary:

   make binary
   

Tests

Tests can be run in a container to ensure all build dependencies are met.

To run the tests

make ut

To run the tests in a container

make test-containerized