Skip to content

DOCS-2966: Correct the Envoy Gateway version and regenerate the 3.22 Installation API reference - #2932

Merged
ctauchen merged 3 commits into
publish/ce-3.22.7from
DOCS-2966-api-ref-envoy
Aug 19, 2026
Merged

DOCS-2966: Correct the Envoy Gateway version and regenerate the 3.22 Installation API reference#2932
ctauchen merged 3 commits into
publish/ce-3.22.7from
DOCS-2966-api-ref-envoy

Conversation

@ctauchen

@ctauchen ctauchen commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Follow-up to the 3.22.7 publishing PR #2917, from a tag-to-tag diff of calico-private v3.22.6 to v3.22.7 and operator v1.40.12 to v1.40.14 against the draft release notes.

Three changes.

First, the Installation API reference for 3.22 is regenerated against operator v1.40.14. The release notes announce the new spec.cni.specVersion field, but the reference did not document it. The regeneration adds the specVersion row to the CNISpec table and a CNISpecVersion enum section. It also resolves cross-reference links the generator previously left as plain text. This clears the "update the operator API docs if needed" item from the publishing PR description.

Second, the Envoy Gateway version is corrected from v1.8.2 to v1.8.3, applying the review suggestion on #2917. third_party/envoy-gateway/Makefile at tag v3.22.7 reads ENVOY_GATEWAY_VERSION = v1.8.3. The envoyVersion variable is corrected in the same commit, from 1.7.2 to 1.8.3. That variable renders on the customize an ingress gateway page as the Envoy Gateway version that custom configuration must be valid for, and it was stale for 3.22.6 as well, where the shipped version was v1.8.0.

Third, two version downgrades in the v3.22.0-1.0 entry of releases.json are reverted, addressing the review comments on that hunk. The downgrades were coreos-alertmanager v0.28.1 to v0.28.0 and eck-elasticsearch-operator 2.16.1 to 2.16.0. Both came from the release tooling's pinned version template, which lags what the images are built from. The third_party Makefiles at tag v3.22.0-1.0 read v0.28.1 and v2.16.1, so the original values were right.

On the source of truth question the review raised, the third_party Makefiles are authoritative and calico/_data/versions.yml is stale at release tags. At tag v3.22.6 that file records alertmanager v0.28.1 while the Makefile reads v0.32.1, and the release branch has since been corrected to v0.32.1. Every other historical correction in #2917 is confirmed against the Makefile at its tag and is kept.

Disposition of the remaining review comments on #2917:

  • The TBD placeholder under Bug fixes is already replaced with the real list.
  • The Dikastes suggestion is already applied.
  • The suggestion to derive releaseTitle, filesUrl and chart_version_name from releases[0].title is not taken here. It changes the shared publish template for every version stream and does not belong in a patch release.
  • The comment about the sentence "A fix is included in Calico Enterprise 3.22.7." sitting above the 3.22.7 section is a false positive. It belongs to the 3.22.6 known issue and forward-references correctly, and every entry ends with the same "To update an existing installation" footer.

Not addressed here, for a decision by the release owners:

  • coreos-prometheus in the v3.22.5 entry reads v3.11.1 but the Makefile at tag v3.22.5 reads v3.11.2. This mismatch predates DOCS-2966: Publish Calico Enterprise 3.22.7 #2917, which deliberately left pre-existing mismatches alone, so it is reported rather than changed.
  • The ECK bullet credits 3.4.1 with the transport CA rotation fix, which is in 3.4.0 upstream, and names only the destination version. The real move is 2.16.1 to 3.4.1, a major-line jump in a patch release. The jump also installs two new CRDs, autoopsagentpolicies.autoops.k8s.elastic.co and packageregistries.packageregistry.k8s.elastic.co, and adds ClusterRole rules without which the ECK operator restart-loops and Elasticsearch is never created.
  • Two user-facing changes have no bullet. Windows flow logs reported zero packet and byte counts for flows whose VFP entry came from a policy match, fixed under CORE-12154. And calico-node now mounts securityfs read-only at /sys/kernel/security, under CORE-13107, which fixes kernel lockdown detection but will be rejected by hostPath allowlist policies until they are updated.
  • The release note says the non-cluster host packages "disable nftables on RHEL 8". The commit message for that change describes it, but the diff does not implement it and NFTablesMode appears nowhere in the packaging at tag v3.22.7. Only the BPF half shipped. The rpm also gained a Requires on nftables, which can fail an install where that package is unavailable.

Netlify does not build a deploy preview for a pull request based on a publish branch, so there is no preview link for this PR. The changed pages are:

  • /calico-enterprise/3.22/reference/installation/api, for the new specVersion field and the CNISpecVersion enum
  • /calico-enterprise/3.22/release-notes/, for the Envoy Gateway version in the Ingress Gateway bullet
  • /calico-enterprise/3.22/networking/ingress-gateway/customize-ingress-gateway, for the rendered Envoy Gateway version

Once this merges into publish/ce-3.22.7, the deploy preview on #2917 covers all three.

ctauchen and others added 3 commits August 19, 2026 15:49
The 3.22.7 release notes announce the new spec.cni.specVersion field, but
the Installation reference for 3.22 did not document it. Regenerating
against the operator version that 3.22.7 ships adds the specVersion row to
the CNISpec table and a CNISpecVersion enum section with the Auto, 0.3.1,
0.4.0 and 1.0.0 values.

The same run resolves cross-reference links the generator previously left
as plain text, for Duration, DSCP, DashboardsJob, Index,
TLSPassThroughRoute and TLSTerminatedRoute.

Run with make calico-enterprise_versioned_docs/version-3.22-2__operator_reference.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
third_party/envoy-gateway/Makefile at tag v3.22.7 reads
ENVOY_GATEWAY_VERSION = v1.8.3. The Ingress Gateway fix set v1.8.2 on
29 July, then the 3.22.7 CVE round moved it to v1.8.3 on 7 August, so the
release note was one bump behind. This applies the reviewer's suggestion.

The envoyVersion variable was also stale, and renders on the customize an
ingress gateway page as the Envoy Gateway version that custom
configuration must be valid for. It was still 1.7.2, which was wrong for
3.22.6 as well, where the shipped version was v1.8.0.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The historical version corrections in this PR downgraded
coreos-alertmanager from v0.28.1 to v0.28.0 and
eck-elasticsearch-operator from 2.16.1 to 2.16.0 in the v3.22.0-1.0
entry. Both downgrades were sourced from the release tooling's pinned
version template, which lags what the images are actually built from.

The third_party Makefiles at tag v3.22.0-1.0 read
ALERTMANAGER_VERSION = v0.28.1 and ECK_OPERATOR_VERSION = v2.16.1, so the
original values were right. The same tag's calico/_data/versions.yml
agrees with the template, but that file is demonstrably stale at release
tags: at tag v3.22.6 it records alertmanager v0.28.1 while the Makefile
reads v0.32.1, and the release branch has since been corrected to
v0.32.1.

The other corrections in this PR are confirmed against the Makefiles at
their tags and are kept, including alertmanager v0.32.1 and prometheus
v3.12.0 for 3.22.6, istio 1.29.2 for 3.22.6, fluentd 1.19.0 for the
earlier entries, and Elasticsearch and Kibana 8.18.8 for 3.22.0-2.0.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ctauchen
ctauchen requested a review from a team as a code owner August 19, 2026 14:54
Copilot AI lite review requested due to automatic review settings August 19, 2026 14:54

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Calico Enterprise 3.22 versioned documentation to align with the 3.22.7 patch release contents by correcting referenced component versions and regenerating the operator Installation API reference.

Changes:

  • Corrected the Envoy Gateway version references for 3.22.7 (including the rendered envoyVersion variable).
  • Reverted two unintended third-party component version downgrades in the 3.22.0-1.0 entry of releases.json.
  • Regenerated the 3.22 Installation API reference to include the new spec.cni.specVersion field and improve cross-references.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
calico-enterprise_versioned_docs/version-3.22-2/variables.js Updates the envoyVersion variable used by 3.22 docs rendering.
calico-enterprise_versioned_docs/version-3.22-2/releases.json Restores correct third-party component versions in the 3.22.0-1.0 component map.
calico-enterprise_versioned_docs/version-3.22-2/release-notes/index.mdx Corrects the Envoy Gateway version mentioned in the 3.22.7 release notes.
calico-enterprise_versioned_docs/version-3.22-2/reference/installation/_api.mdx Regenerates Installation API reference to include specVersion and fix cross-reference links.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@ctauchen
ctauchen merged commit dfeb790 into publish/ce-3.22.7 Aug 19, 2026
4 checks passed
@ctauchen
ctauchen deleted the DOCS-2966-api-ref-envoy branch August 19, 2026 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants