This document applies to the HEAD of the calico-containers source tree.
View the calico-containers documentation for the latest release here.
The command line tool, calicoctl, makes it easy to configure and start Calico
services and to manage Calico network and security policy.
The tool provides a simple interface for using Calico networking with Docker containers. In addition, many of the calicoctl commands are useful for general management of Calico configuration regardless of whether you are running Calico on VMs, containers or bare metal.
This user reference is organized in sections based on the top level command options of calicoctl.
Run calicoctl --help to display the following help menu for the top level
calicoctl commands.
calicoctl
Override the host:port of the ETCD server by setting the environment variable
ETCD_AUTHORITY [default: 127.0.0.1:2379]
Usage: calicoctl <command> [<args>...]
status Print current status information
node Configure the main calico/node container and establish Calico networking
container Configure containers and their addresses
profile Configure endpoint profiles
endpoint Configure the endpoints assigned to existing containers
pool Configure ip-pools
bgp Configure global bgp
ipam Configure IP address management
checksystem Check for incompatibilities on the host system
diags Save diagnostic information
version Display the version of calicoctl
config Configure low-level component configuration
See 'calicoctl <command> --help' to read about a specific subcommand.
Details on the calicoctl commands are described in the documents linked below
organized by top level command.
- calicoctl status
- calicoctl node
- calicoctl container
- calicoctl profile
- calicoctl endpoint
- calicoctl pool
- calicoctl bgp
- calicoctl ipam
- calicoctl checksystem
- calicoctl diags
- calicoctl version
- calicoctl config