Skip to main content
Calico Open Source 3.33 (latest) documentation

calicoctl ipam split

This section describes the calicoctl ipam split command.

Read the calicoctlOverview for a full list of calicoctl commands.

Display the help text for calicoctl ipam split command​

Run calicoctl ipam split --help to display the following help menu for the command.

Split an IP pool into the given number of smaller pools of equal size. Useful
for carving a large pool into per-zone or per-node pools.

Usage:
  calicoctl ipam split NUMBER [flags]

Examples:
  # Split a pool into 4 smaller pools.
  calicoctl ipam split 4 --name my-pool

Flags:
      --cidr string     CIDR of the IP pool to split.
  -c, --config string   Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg")
  -h, --help            help for split
      --name string     Name of the IP pool to split.

Global Flags:
      --allow-version-mismatch   Allow client and cluster versions mismatch
      --context string           The name of the kubeconfig context to use
  -l, --log-level string         Set the log level (panic, fatal, error, warn, info, debug) (default "panic")

Prerequisites​

To split an IP pool, you will first need to lock the Calico database so that no IPAM data can change during the split. This is accomplished by using the calicoctl datastore migrate lock command. To continue normal IPAM operation, you will need to unlock the calico datastore after the split with the calicoctl datastore migrate unlock command.

Examples​

Lock the Calico datastore.

calicoctl datastore migrate lock

Split the IP pool specified by 172.0.0.0/15 into 2 smaller pools.

calicoctl ipam split --cidr=172.0.0.0/15 2

This should create 2 IP pools, one covering CIDR 172.0.0.0/16 and one covering CIDR 172.1.0.0/16.

Unlock the Calico datastore to restore normal IPAM operation.

calicoctl datastore migrate unlock

General options​

  -c, --config string   Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg")

See also​