Add Linux package repository migration guide (DEVPROD-4222)#1755
Open
JakeSCahill wants to merge 5 commits into
Open
Add Linux package repository migration guide (DEVPROD-4222)#1755JakeSCahill wants to merge 5 commits into
JakeSCahill wants to merge 5 commits into
Conversation
The setup-script URL PRs only update fresh-install snippets. This adds the
durable migration content the TSB describes but the docs lacked:
- New page: Migrate the Linux Package Repository — re-point apt/yum/zypper to
linux.pkg.redpanda.com, import the new GPG key, disable the legacy repo,
verify, validate before cutover, and config-management guidance. Includes a
manual configuration path for environments that cannot pipe a script to bash.
- New partial: repo-migration-note.adoc — a single deprecation/deadline note,
included from the Linux install, FIPS install, Console install, and rolling
upgrade pages so the callout is not duplicated.
- nav: add the new page under Deploy > Redpanda > Linux.
Manual repo definitions and key URLs were verified against the live
setup-redpanda.{deb,rpm}.sh scripts.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThe PR adds documentation for migrating Redpanda Linux package repositories from Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
The page is fundamentally a one-time host migration (dl.redpanda.com -> linux.pkg.redpanda.com), matching the Migrate section's existing 'X to Y' guides (Console v3, Helm-to-Operator, Strimzi) better than Deploy. Update the nav entry, the cross-reference in the shared note, and the page category. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Add :page-topic-type: how-to and three learning objectives with the standard 'After reading this page...' checkbox block (required for how-to pages). - Active voice: 'no Redpanda version is removed', 'shuts down on'. - Imperative section heading: 'Update configuration management'. - Partial wording: 'currently install' over 'already install'. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The shutdown date was hardcoded in four places across two files. Define
legacy-repo-shutdown-date and repo-dual-publish-start in antora.yml and
reference them with {attribute} so a date change is a single edit.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
modules/deploy/partials/linux/repo-migration-note.adoc (1)
3-3: ⚡ Quick winUse empty bracket xref syntax in hardcoded link references to support automatic title updates.
Both the migration note partial and the navigation entry use hardcoded link text in xref references, but per the repository's learning guidelines, AsciiDoc xref links should use empty brackets to allow Antora to automatically pull the page title from the target document. This approach reduces maintenance burden if the page title changes in the future.
modules/deploy/partials/linux/repo-migration-note.adoc#L3: Replacexref:migrate:linux-package-repository.adoc[Migrate the Linux Package Repository]withxref:migrate:linux-package-repository.adoc[]modules/ROOT/nav.adoc#L259: Replacexref:migrate:linux-package-repository.adoc[Migrate the Linux Package Repository]withxref:migrate:linux-package-repository.adoc[]🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/deploy/partials/linux/repo-migration-note.adoc` at line 3, Replace hardcoded link text in xref references with empty brackets to allow Antora to automatically pull page titles from target documents. In modules/deploy/partials/linux/repo-migration-note.adoc at line 3, change the xref reference from using `xref:migrate:linux-package-repository.adoc[Migrate the Linux Package Repository]` to `xref:migrate:linux-package-repository.adoc[]`. Apply the same change in modules/ROOT/nav.adoc at line 259, replacing `xref:migrate:linux-package-repository.adoc[Migrate the Linux Package Repository]` with `xref:migrate:linux-package-repository.adoc[]`. This approach allows automatic title updates if the page title changes in the future, reducing maintenance burden.Source: Learnings
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@modules/deploy/partials/linux/repo-migration-note.adoc`:
- Line 3: Replace hardcoded link text in xref references with empty brackets to
allow Antora to automatically pull page titles from target documents. In
modules/deploy/partials/linux/repo-migration-note.adoc at line 3, change the
xref reference from using `xref:migrate:linux-package-repository.adoc[Migrate
the Linux Package Repository]` to
`xref:migrate:linux-package-repository.adoc[]`. Apply the same change in
modules/ROOT/nav.adoc at line 259, replacing
`xref:migrate:linux-package-repository.adoc[Migrate the Linux Package
Repository]` with `xref:migrate:linux-package-repository.adoc[]`. This approach
allows automatic title updates if the page title changes in the future, reducing
maintenance burden.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 398e9476-abb7-415a-b10b-edf169ef25c6
📒 Files selected for processing (8)
antora.ymlmodules/ROOT/nav.adocmodules/deploy/pages/console/linux/deploy.adocmodules/deploy/partials/linux/install-fips.adocmodules/deploy/partials/linux/install-redpanda.adocmodules/deploy/partials/linux/repo-migration-note.adocmodules/migrate/pages/linux-package-repository.adocmodules/upgrade/pages/rolling-upgrade.adoc
kbatuigas
approved these changes
Jun 16, 2026
kbatuigas
left a comment
kbatuigas
left a comment
Contributor
There was a problem hiding this comment.
Looks good. Just one thing to flag from pr-review but not a blocker.
|
|
||
| [,bash] | ||
| ---- | ||
| grep -r dl.redpanda.com /etc/yum.repos.d/ |
Contributor
There was a problem hiding this comment.
From pr-review:
The SUSE grep command only checks /etc/yum.repos.d/, but SUSE uses /etc/zypp/repos.d/. A SUSE user running only this command would see no match even if affected.
- Current: grep -r dl.redpanda.com /etc/yum.repos.d/
- Suggested: Add a second line or a note, e.g.: grep -r dl.redpanda.com /etc/yum.repos.d/ /etc/zypp/repos.d/ 2>/dev/null
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
2 participants
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.
Description
The setup-script URL PRs (#1709 and the per-version backports #1747–#1753) update the fresh-install snippets to
linux.pkg.redpanda.com. They don't cover the customer migration described in TSB-2026-38 — re-pointing an existing apt/yum/zypper install, the new GPG signing key, the manual (non-piped) configuration path, the deprecation timeline, or SUSE/zypper. This PR adds that durable content.What's added
migrate:linux-package-repository.adoc— Migrate the Linux Package Repository (in the Migrate section, alongside Console v3 / Helm-to-Operator / Strimzi):grep dl.redpanda.com)apt-cache policy/yum info), validate-before-cutover, and config-management guidancelinux/repo-migration-note.adoc— a single deprecation/deadlineIMPORTANTnote, included from the Linux install, FIPS install, Console (Linux) install, and rolling-upgrade pages so the callout isn't duplicated.Verification
setup-redpanda.{deb,rpm}.shscripts (not just the TSB text), so they match what the scripts actually write.Notes for reviewers
install-redpanda.adoc; this PR only adds a note + include to that file (different lines), so the conflict should be trivial. Suggest landing Update setup script URLs from Cloudsmith to linux.pkg.redpanda.com #1709 first.setup-redpanda.rpm.shscript supports it; confirm it's officially supported.Checks
🤖 Generated with Claude Code