DOCS-2846: Add instruction for disabling upgrade-ipam#2520
DOCS-2846: Add instruction for disabling upgrade-ipam#2520ctauchen wants to merge 1 commit intotigera:mainfrom
Conversation
For manifest installs, you need to disable upgrade-ipam when using host-local IPAM. DOCS-2846
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@tomastigera Taking a first stab at this. Questions:
|
There was a problem hiding this comment.
Pull request overview
Adds documentation for Calico v3.31 manifest-based installs to clarify that upgrade-ipam should be disabled when using the CNI host-local IPAM mode, and provides a kubectl/jq command to remove the init container from the calico-node DaemonSet.
Changes:
- Document disabling the
upgrade-ipaminit container for manifest installs using host-local IPAM. - Add a kubectl/jq example command to remove the init container from
calico-node.
|
|
||
| #### Disabling the `upgrade-ipam` init container | ||
|
|
||
| To use host-local IPAM on a manifest-based installation of $[prodname], you should disable the `upgrade-ipam` init container. |
There was a problem hiding this comment.
For consistency with the rest of this section (and with the CNI plugin name), consider formatting host-local as inline code in this sentence.
| To use host-local IPAM on a manifest-based installation of $[prodname], you should disable the `upgrade-ipam` init container. | |
| To use `host-local` IPAM on a manifest-based installation of $[prodname], you should disable the `upgrade-ipam` init container. |
| #### Disabling the `upgrade-ipam` init container | ||
|
|
||
| To use host-local IPAM on a manifest-based installation of $[prodname], you should disable the `upgrade-ipam` init container. | ||
|
|
There was a problem hiding this comment.
This new instruction is added only to the versioned v3.31 page; the unversioned (next/current) equivalent page at calico/reference/configure-cni-plugins.mdx still lacks the upgrade-ipam guidance. If this requirement applies generally (as implied by the PR title/description), it should also be added to the unversioned docs (and any other supported versions), or the PR description should clarify that this is a v3.31-only backport.
|
|
||
| ```bash | ||
| kubectl get ds calico-node -n kube-system -o json | \ | ||
| jq 'del(.spec.template.spec.initContainers[] | select(.name == "upgrade-ipam"))' | \ |
There was a problem hiding this comment.
The jq filter uses .spec.template.spec.initContainers[], which will error if initContainers is missing/null (for example if the init container was already removed). Consider making the command idempotent by using the optional iterator ([]?) or defaulting initContainers to an empty array before filtering.
| jq 'del(.spec.template.spec.initContainers[] | select(.name == "upgrade-ipam"))' | \ | |
| jq 'del(.spec.template.spec.initContainers[]? | select(.name == "upgrade-ipam"))' | \ |

For manifest installs, you need to disable upgrade-ipam when
using host-local IPAM.
DOCS-2846
Product Version(s):
Issue:
projectcalico/calico#11702
Link to docs preview:
SME review:
DOCS review:
Additional information:
Merge checklist: