docs: remove deprecated CLI from Snowflake docs#43
Conversation
The pgEdge CLI is deprecated. Rewrite the snowflake.node setup to cover managed deployments and use ALTER SYSTEM plus pg_reload_conf() in place of ./pgedge commands, across docs/creating.md and README.md.
📝 WalkthroughWalkthroughThe documentation updates revise Snowflake installation wording and replace CLI-focused ChangesSnowflake setup documentation
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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.
Inline comments:
In `@docs/creating.md`:
- Around line 17-22: Update the installation example around ALTER SYSTEM SET
snowflake.node to state that this command must be executed by a superuser, while
leaving the existing node identifier and reload instructions unchanged.
- Around line 17-27: Update the installation guidance around the ALTER SYSTEM
and postgresql.conf examples to state that they are alternative configuration
methods. Explain that ALTER SYSTEM writes to postgresql.auto.conf and can
override the postgresql.conf value, instructing readers to use one method or
remove/reset any existing ALTER SYSTEM setting before switching.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: fcd7594d-efe6-464b-b6a8-33a35250a7eb
📒 Files selected for processing (2)
README.mddocs/creating.md
What
The pgEdge CLI is deprecated, but the Snowflake docs still instruct
users to configure
snowflake.nodewith./pgedgecommands. Thisrewrites those instructions to be deployment-aware and SQL-based.
docs/creating.mdpgedge spock node-create,pgedge db guc-set, andpgedge reloadsteps (and the "9 nodes or fewer"auto-numbering narrative that only existed because of the CLI).
ordinal), Helm charts (node name), and Ansible (zone) each set
snowflake.nodeautomatically.ALTER SYSTEM SET snowflake.nodeplus
SELECT pg_reload_conf();, keepingpg_ctl reloadas theshell alternative.
README.mdpgEdge deployment or from source".
Verification
snowflake.noderange (1-1023) andPGC_SUSETcontext confirmedagainst
snowflake.c.and pgedge-ansible.
./pgedge/ CLI references remain in the docs.Targets
main; picked up by the next tagged Snowflake release.