An IP Address Management (IPAM) CNI plugin that assigns IP addresses cluster-wide.
You might be looking for the upstream community distribution of this project. Which has all the instructions to get you started with installing and working with Whereabouts.
This repository here is used for distribution of Whereabouts as part of OpenShift Container Platform.
If you have bugs, usage questions or otherwise with the community distribution, please file issues there.
Otherwise, please use your support channels to file issues with Whereabouts.
You can also specify ranges to exclude from assignment, so if for example you'd like to assign IP addresses within the range 192.168.2.0/24, you can exclude IP addresses within it by adding them to an exclude list. For example, if you decide to exclude the range 192.168.2.0/28, the first IP address assigned in the range will be 192.168.2.16.
In respect to the old equipment out there that doesn't think that IP addresses that end in .0 are valid -- Whereabouts will not assign addresses that end in .0.
The original inspiration for Whereabouts comes from when users have tried to use the samples from Multus CNI (a CNI plugin that attaches multiple network interfaces to your pods), which includes examples that use the host-local plugin, and they find that it's... Almost the right thing. Sometimes people even assume it'll work across nodes -- and then wind up with IP address collisions.
Whereabouts is designed with Kubernetes in mind, but, isn't limited to use in just Kubernetes.
To track which IP addresses are in use between nodes, Whereabouts uses etcd or a Kubernetes Custom Resource as a backend. The goal is to make Whereabouts more flexible and to use additional storage backends, we welcome any contributions towards this goal.
Issues and PRs are welcome! Some of the known limitations are found at the bottom of the README.
There's two steps to installing Whereabouts:
- Installing Whereabouts itself (it's just a binary on disk).
- Creating IPAM CNI configurations.
Further installation options (including etcd usage) and configuration parameters can be found in the extended configuration document.
You can install this plugin with a Daemonset, using:
git clone https://github.com/k8snetworkplumbingwg/whereabouts && cd whereabouts
kubectl apply \
-f doc/crds/daemonset-install.yaml \
-f doc/crds/whereabouts.cni.cncf.io_ippools.yaml \
-f doc/crds/whereabouts.cni.cncf.io_overlappingrangeipreservations.yaml
The daemonset installation requires Kubernetes Version 1.16 or later.
You can also install whereabouts with helm 3:
helm template whereabouts oci://ghcr.io/k8snetworkplumbingwg/whereabouts-chart --version <WHEREABOUTS_VERSION>
Helm will install the crd as well as the daemonset
Included here is an entire CNI configuration. Whereabouts only cares about the ipam section of the CNI config. In particular this example uses the macvlan CNI plugin. (If you decide to copy this block and try it too, make sure that the master setting is set to a network interface name that exists on your nodes). Typically, you'll already have a CNI configuration for an existing CNI plugin in your cluster, and you'll just copy the ipam section and modify the values there.
{
"cniVersion": "0.3.0",
"name": "whereaboutsexample",
"type": "macvlan",
"master": "eth0",
"mode": "bridge",
"ipam": {
"type": "whereabouts",
"range": "192.168.2.225/28",
"exclude": [
"192.168.2.229/30",
"192.168.2.236/32"
]
}
}
Whereabouts is particularly useful in scenarios where you're using additional network interfaces for Kubernetes. A NetworkAttachmentDefinition custom resource can be used with a CNI meta plugin such as Multus CNI to attach multiple interfaces to your pods in Kubernetes.
In short, a NetworkAttachmentDefinition contains a CNI configuration packaged into a custom resource. Here's an example of a NetworkAttachmentDefinition containing a CNI configuration which uses Whereabouts for IPAM:
apiVersion: "k8s.cni.cncf.io/v1"
kind: NetworkAttachmentDefinition
metadata:
name: whereabouts-conf
spec:
config: '{
"cniVersion": "0.3.0",
"name": "whereaboutsexample",
"type": "macvlan",
"master": "eth0",
"mode": "bridge",
"ipam": {
"type": "whereabouts",
"range": "192.168.2.225/28"
}
}'
The same applies for the usage of IPv6:
{
"cniVersion": "0.3.0",
"name": "whereaboutsexample",
"type": "macvlan",
"master": "eth0",
"mode": "bridge",
"ipam": {
"type": "whereabouts",
"range": "2001::0/116",
"gateway": "2001::f:1"
}
}
ipRanges field can be used to provide a list of range configurations for assigning multiple IP addresses.
{
"cniVersion": "0.3.0",
"name": "whereaboutsexample",
"type": "macvlan",
"master": "eth0",
"mode": "bridge",
"ipam": {
"type": "whereabouts",
"ipRanges": [{
"range": "192.168.10.1/24"
}, {
"range": "176.168.10.1/16"
}]
}
}
The above can also be used in combination with basic range field as below:
{
"cniVersion": "0.3.0",
"name": "whereaboutsexample",
"type": "macvlan",
"master": "eth0",
"mode": "bridge",
"ipam": {
"type": "whereabouts",
"ipRanges": [{
"range": "192.168.10.1/24"
}, {
"range": "176.168.10.1/16"
}],
"range": "abcd::1/64"
}
}
Similar to above, ipRanges can be used for configuring DualStack
{
"cniVersion": "0.3.0",
"name": "whereaboutsexample",
"type": "macvlan",
"master": "eth0",
"mode": "bridge",
"ipam": {
"type": "whereabouts",
"ipRanges": [{
"range": "192.168.10.1/24"
}, {
"range": "abcd::1/64"
}]
}
}
Enhance IPAM performance in large-scale Kubernetes environments by reducing IP allocation contention through node-based IP slicing.
apiVersion: "k8s.cni.cncf.io/v1"
kind: NetworkAttachmentDefinition
metadata:
name: whereabouts-fast-ipam
spec:
config: '{
"cniVersion": "0.3.0",
"name": "whereaboutsexample",
"type": "macvlan",
"master": "eth0",
"mode": "bridge",
"ipam": {
"type": "whereabouts",
"range": "192.168.2.0/24",
"node_slice_size": "/22"
}
}'
This setup enables the fast IPAM feature to optimize IP allocation for nodes, improving network performance in clusters with high pod density.
Please note, you must run a whereabouts controller for this to work. Manifest can be found in doc/crds/node-slice-controller.yaml.
You must run your whereabouts daemonset, whereabouts controller in the same namespaces as your network-attachment-definitions.
The field in the example node_slice_size determines how large of a CIDR to allocate per node and the existence of the field is what triggers
Fast IPAM mode.
Required
These parameters are required:
type: This should be set towhereabouts.range: This specifies the range in which IP addresses will be allocated.
If for example the range is set to 192.168.2.225/28, this will allocate IP addresses in the range excluding the first network address and the last broadcast address.
If you need a tool to figure out the range of a given CIDR address, try this online tool, subnet-calculator.com or an IPv6 subnet calculator.
Range end syntax
Additionally, the range parameter can support a CIDR notation that includes the last IP to use. Example: range: "192.168.2.225-192.168.2.230/28".
Optional
The following parameters are optional:
range_start: First IP to use when allocating from therange. Optional, if unset is inferred from therange.range_end: Last IP to use when allocating from therange. Optional, if unset the last ip within the range is determined.exclude: This is a list of CIDRs to be excluded from being allocated.
In the example, we exclude IP addresses in the range 192.168.2.229/30 from being allocated (in this case it's 3 addresses, .229, .230, .231), as well as 192.168.2.236/32 (just a single address).
Note 1: It's up to you to properly set exclusion ranges that are within your subnet, there's no double checking for you (other than that the CIDR notation parses).
Note 2: In case of wide IPv6 CIDRs (range≤/64) only the first /65 range is addressable (e.g. from x:x:x:x::0 to x:x:x:x:7fff:ffff:ffff:ffff).
Additionally -- you can set the route, gateway and DNS using anything from the configurations for the static IPAM plugin (as well as additional static IP addresses).
The overlapping ranges feature is enabled by default, and will not allow an IP address to be re-assigned across two different ranges which overlap. However, this can be disabled.
enable_overlapping_ranges: (boolean) Checks to see if an IP has been allocated across another range before assigning it (defaults totrue).
Please note: This feature is only implemented for the Kubernetes storage backend.
Run the build command from the ./hack directory:
./hack/build-go.sh
You can start a kind cluster to run local changes with:
make kind
# or make kind COMPUTE_NODES=<desired number of worker nodes>
You can then create a NetworkAttachmentDefinition with:
cat <<'EOF' | kubectl apply -f -
apiVersion: "k8s.cni.cncf.io/v1"
kind: NetworkAttachmentDefinition
metadata:
name: whereabouts-conf
spec:
config: '{
"cniVersion": "0.3.0",
"name": "whereaboutsexample",
"type": "macvlan",
"master": "eth0",
"mode": "bridge",
"ipam": {
"type": "whereabouts",
"range": "192.168.2.225/28"
}
}'
EOF
Create a deployment that uses the NetworkAttachmentDefinition, for example:
cat <<'EOF' | kubectl apply -f -
apiVersion: apps/v1
kind: Deployment
metadata:
name: netshoot-deployment
labels:
app: netshoot-deployment
spec:
replicas: 1
selector:
matchLabels:
app: netshoot-pod
template:
metadata:
annotations:
k8s.v1.cni.cncf.io/networks: whereabouts-conf
labels:
app: netshoot-pod
spec:
containers:
- name: netshoot
image: nicolaka/netshoot
command:
- sleep
- "3600"
imagePullPolicy: IfNotPresent
EOF
Thanks big time to Tomofumi Hayashi, I utilized his static CNI IPAM plugin as a basis for this project to give me a head start!
The typeface used in the logo is AZONIX, by MixoFX.
- A hard system crash on a node might leave behind stranded IP allocations, so if you have a trashing system, this might exhaust IPs.
- Potentially we need an operator to ensure data is clean, even if just at some kind of interval (e.g. with a cron job)
- There's probably a lot of comparison of IP addresses that could be optimized, lots of string conversion.
- The etcd method has a number of limitations, in that it uses an all ASCII methodology. If this was binary, it could probably store more and have more efficient IP address comparison.
- Unlikely to work in Canada, apparently it would have to be "where aboots?" for Canadians to be able to operate it.
- In case of wide IPv6 CIDRs (
range≤/64) only the first /65 range is addressable by Whereabouts due to uint64 offset calculation.