update cluster module helptext#299
Merged
Merged
Conversation
moizpgedge
reviewed
Apr 16, 2025
| """ | ||
| Remove a cluster. | ||
|
|
||
| Remove a cluster. |
Contributor
There was a problem hiding this comment.
Remove a cluster.
placed twice
moizpgedge
requested changes
Apr 16, 2025
Contributor
moizpgedge
left a comment
moizpgedge
left a comment
There was a problem hiding this comment.
Small change needed.Mentioned in comment
|
|
||
| This command removes Spock subscriptions and nodes, and stops PostgreSQL on each node. | ||
| If the `force` flag is set to `True`, it will also remove the `pgedge` directory on each node. | ||
|
|
Member
There was a problem hiding this comment.
Does this remove the PG data directory as well, and if so, you might want to add: it will also remove the pgedge directory (including the Postgres data directory) on each node.
| 3. Installs pgEdge on all nodes. | ||
| 4. Configures Spock for replication for all configured databases across all nodes. | ||
| 5. Integrates pgBackRest on nodes, if configured | ||
|
|
Member
There was a problem hiding this comment.
Suggested tweaks to first sentence, added '.' to end of step 5:
Initialize a cluster using details provided in the cluster configuration JSON file by performing the following steps:
1. Loads the cluster configuration.
2. Checks SSH connectivity for all nodes.
3. Installs pgEdge on all nodes.
4. Configures Spock for replication for all configured databases across all nodes.
5. Integrates pgBackRest on nodes, if configured.
Member
Author
There was a problem hiding this comment.
I added the . but kept the other sentence as-is due to length
moizpgedge
approved these changes
Apr 20, 2025
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
3 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.
various helptext updates and formatting fixes to ensure each parameter is documented and helptext renders properly in fire