[CORE-12848] Document the OpenStack Neutron-etcd resync process#2800
[CORE-12848] Document the OpenStack Neutron-etcd resync process#2800nelljerram wants to merge 2 commits into
Conversation
✅ 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. |
Add a new networking/openstack/resync.mdx page covering the resync behaviour as it now exists after the post-v3.32 changes: one-shot startup resync (gated by [calico] startup_resync), the on-demand calico-resync command, per-item INFO logging, and performance and concurrency characteristics. Also note the removal of the old periodic resync and deprecation of resync_interval_secs and resync_max_interval_secs. Cross-reference the new page from configuration.mdx and add it to the calico sidebar. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
e393afe to
ae63aa1
Compare
There was a problem hiding this comment.
Pull request overview
Adds new Calico OpenStack documentation describing how the Neutron-to-etcd reconciliation (“resync”) works after the post-v3.32 behavior changes, and wires that content into the OpenStack docs navigation.
Changes:
- Adds a new
networking/openstack/resync.mdxpage documenting startup resync behavior, thecalico-resynccommand (including scoping), observability, and performance/concurrency characteristics. - Cross-references the resync behavior from the OpenStack configuration docs, including noting deprecated periodic-resync options.
- Adds the new page to the Calico OpenStack sidebar section.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sidebars-calico.js | Adds the new OpenStack resync page to the Calico docs sidebar navigation. |
| calico/networking/openstack/resync.mdx | New documentation page detailing resync mechanisms (startup + on-demand) and upgrade notes. |
| calico/networking/openstack/configuration.mdx | Documents the startup_resync option and links to the new resync page; notes deprecated periodic-resync options. |
Note that the calico-resync command ships in a dedicated calico-resync package, to be installed on each control node like calico-control. Add an example ResyncResult JSON to the Output section, and correct the description of the endpoints phase, which counts WorkloadEndpoint and LiveMigration resources together rather than reporting them separately. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
| Neutron server starts or is restarted. This is the normal, hands-off | ||
| mechanism, and is enabled by default. | ||
|
|
||
| - **On-demand resync** — run explicitly by an operator using the |
There was a problem hiding this comment.
nit since it can be inferred from context: I'd prefer to use the term user or administrator to avoid possible confusion with automated operators such as the Tigera operator, but don't feel too strongly about it in this context
| watching, and endpoint-status watching), which elect a single active worker | ||
| dynamically through an etcd key so that the work fails over cleanly, the | ||
| startup resync is governed by this static `startup_resync` config switch. It | ||
| runs once rather than continuously, so operator-level control over whether and |
There was a problem hiding this comment.
again, maybe change operator to administrator?

Add a new networking/openstack/resync.mdx page covering the resync behaviour as it now exists after the post-v3.32 changes: one-shot startup resync (gated by [calico] startup_resync), the on-demand calico-resync command, per-item INFO logging, and performance and concurrency characteristics. Also note the removal of the old periodic resync and deprecation of resync_interval_secs and resync_max_interval_secs.
Cross-reference the new page from configuration.mdx and add it to the calico sidebar.