beta install: update instructions for macos #1525
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis change updates the beta installation documentation file with environment-specific setup guidance across multiple deployment methods. It adds macOS installation notes redirecting to Docker, expands Docker-based beta setup with image pulling and Docker Compose YAML configuration, introduces Linux package manager installation steps for Fedora/RedHat/Amazon Linux and Debian/Ubuntu repositories, and extends Kubernetes/Helm deployment instructions with repository setup and manifest generation commands. The changes consolidate beta installation information into organized sections for each platform. Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (3)📓 Common learnings📚 Learning: 2025-07-14T19:28:43.296ZApplied to files:
📚 Learning: 2025-12-12T16:18:28.126ZApplied to files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
🔇 Additional comments (3)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
modules/get-started/pages/install-beta.adoc (4)
27-27: Fix thelinesattribute to display the complete Docker Compose YAML.The
lines=35attribute restricts the output to only line 35, displaying just theservices:key. Remove this attribute to show the entire Docker Compose configuration.🔎 Apply this diff:
-.Reveal the YAML content +.Reveal the YAML content [%collapsible] ==== -[source,yaml,subs="attributes+",lines=35] +[source,yaml,subs="attributes+"] ----
115-120: Complete the curl commands by piping tosh.Both the Fedora/RedHat and Debian/Ubuntu repository setup commands are incomplete. The curl commands download the repository setup script but do not execute it. This will cause the subsequent package installation to fail.
🔎 Apply this diff:
Fedora/RedHat/Amazon Linux:: + . Add the `redpanda-unstable` repository to your package manager: + ```bash curl -1sLf \ - 'https://dl.redpanda.com/E4xN1tVe3Xy60GTx/redpanda-unstable/setup.rpm.sh' + 'https://dl.redpanda.com/E4xN1tVe3Xy60GTx/redpanda-unstable/setup.rpm.sh' | sh```diff Debian/Ubuntu:: + . Add the `redpanda-unstable` repository to your package manager: + ```bash curl -1sLf \ - 'https://dl.redpanda.com/E4xN1tVe3Xy60GTx/redpanda-unstable/setup.deb.sh' + 'https://dl.redpanda.com/E4xN1tVe3Xy60GTx/redpanda-unstable/setup.deb.sh' | sh</details> Also applies to: 130-135 --- `189-191`: **Fix the broker array index in the third broker configuration.** Line 191 incorrectly reuses `brokers[0]` instead of `brokers[2]`, which overwrites the first broker configuration. This results in only two unique broker addresses being registered instead of three. <details> <summary>🔎 Apply this diff:</summary> ```diff --set "config.kafka.brokers[0]=redpanda-0.redpanda.redpanda.svc.cluster.local.:9093" \ --set "config.kafka.brokers[1]=redpanda-1.redpanda.redpanda.svc.cluster.local.:9093" \ - --set "config.kafka.brokers[0]=redpanda-2.redpanda.redpanda.svc.cluster.local.:9093" \ + --set "config.kafka.brokers[2]=redpanda-2.redpanda.redpanda.svc.cluster.local.:9093" \
180-183: Fix hardcoded Console chart version and broker index duplication.Two issues found in the helm template command:
Hardcoded chart version (line 183): The version
v0.0-k8s0-968fcab9-helm-chartis not a valid public chart version. This should use a dynamic placeholder like{console-beta-chart-version}to match the pattern used forimage.tag={console-beta-tag}.Broker index error (line 191): The third broker configuration incorrectly uses
brokers[0]instead ofbrokers[2], which overwrites the first broker and leaves only two unique brokers configured:--set "config.kafka.brokers[0]=redpanda-0.redpanda.redpanda.svc.cluster.local.:9093" \ --set "config.kafka.brokers[1]=redpanda-1.redpanda.redpanda.svc.cluster.local.:9093" \ --set "config.kafka.brokers[2]=redpanda-2.redpanda.redpanda.svc.cluster.local.:9093" \
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
modules/get-started/pages/install-beta.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: Feediver1
Repo: redpanda-data/docs PR: 1153
File: antora.yml:3-5
Timestamp: 2025-07-14T19:28:43.296Z
Learning: In Redpanda docs, during beta releases, the version metadata may intentionally show inconsistencies where the header displays the beta version (e.g., 25.2 Beta) while internal attributes like full-version, latest-redpanda-tag, operator-beta-tag still reference the stable version (e.g., 25.1). This is resolved during the GA merge process when all version references are synchronized.
📚 Learning: 2025-07-14T19:28:43.296Z
Learnt from: Feediver1
Repo: redpanda-data/docs PR: 1153
File: antora.yml:3-5
Timestamp: 2025-07-14T19:28:43.296Z
Learning: In Redpanda docs, during beta releases, the version metadata may intentionally show inconsistencies where the header displays the beta version (e.g., 25.2 Beta) while internal attributes like full-version, latest-redpanda-tag, operator-beta-tag still reference the stable version (e.g., 25.1). This is resolved during the GA merge process when all version references are synchronized.
Applied to files:
modules/get-started/pages/install-beta.adoc
📚 Learning: 2025-12-12T16:18:28.126Z
Learnt from: andrewstucki
Repo: redpanda-data/docs PR: 1514
File: modules/troubleshoot/partials/errors-and-solutions.adoc:618-632
Timestamp: 2025-12-12T16:18:28.126Z
Learning: In Redpanda ShadowLink CRD usage, do not copy CA certificates into pods via kubectl cp because they won't persist across pod restarts. Store CA certs in Kubernetes Secrets and reference them in the ShadowLink's staticConfiguration block (or inline the cert data in that block) to ensure persistence and proper secret management.
Applied to files:
modules/get-started/pages/install-beta.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (3)
modules/get-started/pages/install-beta.adoc (3)
150-158: Clear macOS guidance for beta users.The macOS section appropriately informs users that beta versions are not available through Homebrew and redirects them to Docker. This is accurate and helpful.
163-174: Kubernetes Redpanda installation looks good.The Helm setup properly installs cert-manager and configures the Redpanda chart to use the unstable image. The console is correctly disabled here to be deployed separately.
214-216: Verify the Console service name for port-forwarding.Confirm that the service name
consolev3-console-unstablematches the actual Kubernetes service name generated by thehelm template consolev3command. If the Helm chart uses different naming conventions, this port-forward command may fail.You can verify the generated service name by:
- Running the
helm templatecommand and examining the generated YAML for the Service resource name, or- After deploying, running
kubectl get svc -n <namespace>and noting the actual service name.
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1786
Review deadline:
Page previews
Checks