docs: document preview support for systemd#321
docs: document preview support for systemd#321jason-lynch wants to merge 1 commit intofeat/PLAT-459/rpm-packagingfrom
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThese changes introduce documentation for installing pgEdge Control Plane via RPM packages on Linux systems without Docker. A new installation guide was added along with index and navigation updates to reflect this preview feature. Changes
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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 |
jason-lynch
force-pushed
the
feat/PLAT-459/rpm-packaging
branch
from
1e4673e to
9b54d96
Compare
jason-lynch
force-pushed
the
docs/PLAT-511/systemd-docs
branch
from
a876501 to
2f71477
Compare
Up to standards ✅🟢 Issues
|
jason-lynch
force-pushed
the
feat/PLAT-459/rpm-packaging
branch
from
9b54d96 to
43254b8
Compare
jason-lynch
force-pushed
the
docs/PLAT-511/systemd-docs
branch
from
2f71477 to
2f03fb0
Compare
jason-lynch
force-pushed
the
feat/PLAT-459/rpm-packaging
branch
from
43254b8 to
3426d14
Compare
jason-lynch
force-pushed
the
docs/PLAT-511/systemd-docs
branch
from
2f03fb0 to
5067048
Compare
jason-lynch
force-pushed
the
feat/PLAT-459/rpm-packaging
branch
from
3426d14 to
12cb3b8
Compare
jason-lynch
force-pushed
the
docs/PLAT-511/systemd-docs
branch
from
5067048 to
959fe6a
Compare
jason-lynch
force-pushed
the
feat/PLAT-459/rpm-packaging
branch
from
12cb3b8 to
9095732
Compare
jason-lynch
force-pushed
the
docs/PLAT-511/systemd-docs
branch
from
959fe6a to
7b0ae3d
Compare
jason-lynch
force-pushed
the
feat/PLAT-459/rpm-packaging
branch
from
9095732 to
e81f943
Compare
jason-lynch
force-pushed
the
docs/PLAT-511/systemd-docs
branch
from
7b0ae3d to
41034d1
Compare
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/installation/index.md (1)
11-11: Polish wording for clarity.Line 11 reads a bit awkwardly (“Currently only supports…”). A small wording tweak improves readability.
✏️ Suggested edit
-* [Installing via System Packages](systemd.md) covers installing the Control Plane via system packages, without Docker. This is a **preview feature** and is not recommended for production use. Currently only supports installation through RPMs. +* [Installing via System Packages](systemd.md) covers installing the Control Plane via system packages, without Docker. This is a **preview feature** and is not recommended for production use. Currently, it supports installation through RPMs only.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/installation/index.md` at line 11, Reword the awkward sentence in the list item that begins "* [Installing via System Packages](systemd.md)..." to improve clarity; replace "Currently only supports installation through RPMs." with a clearer variant such as "Currently supports RPM-based installations only." so the phrasing flows naturally and reads consistently with the preceding clause about preview status.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/installation/installation.md`:
- Line 5: Replace the non-descriptive anchor text "[here](../using-ha/index.md)"
with a meaningful, accessible label that describes the target, e.g.,
"High-Availability Deployment Best Practices" (keep the existing URL
../using-ha/index.md); update the markdown link in the installation.md sentence
so the link text clearly conveys what the reader will find.
In `@docs/installation/systemd.md`:
- Around line 130-147: Update the example JSON block and curl payload to use the
API's expected field name server_urls (an array) instead of server_url, and
adjust the surrounding text to indicate an array of server URLs is required;
specifically change the JSON token payload and the --data body for the POST to
/v1/cluster/join to include "server_urls": ["http://198.19.249.2:3000"] so the
init/join API receives an array as documented.
---
Nitpick comments:
In `@docs/installation/index.md`:
- Line 11: Reword the awkward sentence in the list item that begins "*
[Installing via System Packages](systemd.md)..." to improve clarity; replace
"Currently only supports installation through RPMs." with a clearer variant such
as "Currently supports RPM-based installations only." so the phrasing flows
naturally and reads consistently with the preceding clause about preview status.
🪄 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: 86e9a8b2-76b8-42f0-8a73-3304293f6fd2
📒 Files selected for processing (4)
docs/installation/index.mddocs/installation/installation.mddocs/installation/systemd.mdmkdocs.yml
| This guide contains instructions for deploying the Control Plane on a set of Linux hosts, such as virtual machines or bare metal servers. | ||
|
|
||
| Control Plan excels at managing Postgres in a highly-available configuration. To review a list of best practices for Control Plane deployment in a high-availability environment, visit [here](../using-ha/index.md). | ||
| Control Plane excels at managing Postgres in a highly-available configuration. To review a list of best practices for Control Plane deployment in a high-availability environment, visit [here](../using-ha/index.md). |
There was a problem hiding this comment.
Use descriptive link text instead of “here”.
Line 5 uses non-descriptive anchor text ([here]), which reduces accessibility and scanability in docs navigation.
✏️ Suggested edit
-Control Plane excels at managing Postgres in a highly-available configuration. To review a list of best practices for Control Plane deployment in a high-availability environment, visit [here](../using-ha/index.md).
+Control Plane excels at managing Postgres in a highly-available configuration. To review best practices for high-availability deployments, see the [High-Availability Deployment Best Practices](../using-ha/index.md).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Control Plane excels at managing Postgres in a highly-available configuration. To review a list of best practices for Control Plane deployment in a high-availability environment, visit [here](../using-ha/index.md). | |
| Control Plane excels at managing Postgres in a highly-available configuration. To review best practices for high-availability deployments, see the [High-Availability Deployment Best Practices](../using-ha/index.md). |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 5-5: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/installation/installation.md` at line 5, Replace the non-descriptive
anchor text "[here](../using-ha/index.md)" with a meaningful, accessible label
that describes the target, e.g., "High-Availability Deployment Best Practices"
(keep the existing URL ../using-ha/index.md); update the markdown link in the
installation.md sentence so the link text clearly conveys what the reader will
find.
| ```json | ||
| { | ||
| "token": "PGEDGE-0c470f2eac35bb25135654a8dd9c812fc4aca4be8c8e34483c0e279ab79a7d30-907336deda459ebc79079babf08036fc", | ||
| "server_url": "http://198.19.249.2:3000" | ||
| } | ||
| ``` | ||
|
|
||
| Join each additional host to the cluster by submitting a `POST` request to that | ||
| host's `/v1/cluster/join` endpoint with the token and server URL from the | ||
| previous step: | ||
|
|
||
| ```sh | ||
| curl -i -X POST http://<host_ip>:3000/v1/cluster/join \ | ||
| -H 'Content-Type: application/json' \ | ||
| --data '{ | ||
| "token": "PGEDGE-0c470f2eac35bb25135654a8dd9c812fc4aca4be8c8e34483c0e279ab79a7d30-907336deda459ebc79079babf08036fc", | ||
| "server_url": "http://198.19.249.2:3000" | ||
| }' |
There was a problem hiding this comment.
Fix API field names: use server_urls (array), not server_url.
The examples on Line 133 and Line 146 use server_url, but the API contract for init/join uses server_urls as an array. Copy/pasting this currently can break join requests.
✅ Suggested correction
{
"token": "PGEDGE-0c470f2eac35bb25135654a8dd9c812fc4aca4be8c8e34483c0e279ab79a7d30-907336deda459ebc79079babf08036fc",
- "server_url": "http://198.19.249.2:3000"
+ "server_urls": ["http://198.19.249.2:3000"]
} --data '{
"token": "PGEDGE-0c470f2eac35bb25135654a8dd9c812fc4aca4be8c8e34483c0e279ab79a7d30-907336deda459ebc79079babf08036fc",
- "server_url": "http://198.19.249.2:3000"
+ "server_urls": ["http://198.19.249.2:3000"]
}'🧰 Tools
🪛 Betterleaks (1.1.1)
[high] 132-132: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
[high] 145-145: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
🪛 markdownlint-cli2 (0.22.0)
[warning] 130-130: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
[warning] 141-141: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/installation/systemd.md` around lines 130 - 147, Update the example JSON
block and curl payload to use the API's expected field name server_urls (an
array) instead of server_url, and adjust the surrounding text to indicate an
array of server URLs is required; specifically change the JSON token payload and
the --data body for the POST to /v1/cluster/join to include "server_urls":
["http://198.19.249.2:3000"] so the init/join API receives an array as
documented.
Adds a page to our docs that describes the preview support for systemd using the RPM files attached to our releases. PLAT-511
jason-lynch
force-pushed
the
feat/PLAT-459/rpm-packaging
branch
from
e81f943 to
e8b57e4
Compare
jason-lynch
force-pushed
the
docs/PLAT-511/systemd-docs
branch
from
41034d1 to
7f41594
Compare
| ```json | ||
| { | ||
| "token": "PGEDGE-0c470f2eac35bb25135654a8dd9c812fc4aca4be8c8e34483c0e279ab79a7d30-907336deda459ebc79079babf08036fc", | ||
| "server_url": "http://198.19.249.2:3000" |
There was a problem hiding this comment.
Here tag is server_urls
2 participants
Summary
Adds a page to our docs that describes the preview support for systemd using the RPM files attached to our releases.
Testing
Create a test release with:
Then, start one or more VMs using the template in the
limadirectory, e.g.:Now, when you connect to the new machine, you'll find that your home directory is mounted inside the VM. The path will change depending on where the control plane repo is on your host machine, the VM architecture, and the specific git commit that you've built, but in general the installation should look like:
From there, you can follow the other instructions in the doc to install prerequisites, configure, and start the control plane.
PLAT-511