DOCS-2966: Correct the Envoy Gateway version and regenerate the 3.22 Installation API reference - #2932
Merged
Merged
Conversation
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>
Contributor
There was a problem hiding this comment.
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
envoyVersionvariable). - 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.specVersionfield 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Not addressed here, for a decision by the release owners:
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:
Once this merges into publish/ce-3.22.7, the deploy preview on #2917 covers all three.