Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

disaster-recovery: add replica-set option #155

Merged
merged 2 commits into from
Jun 15, 2024

Conversation

jkralik
Copy link
Member

@jkralik jkralik commented Jun 14, 2024

Summary by CodeRabbit

  • Documentation
    • Updated disaster recovery terminology for clarity and consistency.
    • Clarified backup strategies and emphasized the importance of consistent Root CAs for certificates.
    • Introduced metadata for the "Integration Service," detailing planned features like event stream management and support for various target services.
    • Enhanced explanation of the Integration Service's role in event data transmission and interoperability.

Copy link

netlify bot commented Jun 14, 2024

Deploy Preview for docsplgd ready!

Name Link
🔨 Latest commit a055a1d
🔍 Latest deploy log https://app.netlify.com/sites/docsplgd/deploys/666de237b27acd00087ff05b
😎 Deploy Preview https://deploy-preview-155--docsplgd.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Jun 14, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

The recent updates improve the consistency and clarity of disaster recovery documentation by standardizing terminology and outlining MongoDB synchronization strategies. Additionally, the changes introduce metadata and detailed features for the new Integration Service, enhancing the overall functionality and interoperability of the system.

Changes

Files/Directories Change Summary
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md Standardizes terminology from "secondary cluster" to "standby cluster", clarifies backup strategies, and emphasizes consistent Root CAs for certificates.
content/en/docs/services/integration-service/_index.md Introduces metadata for the Integration Service, setting its title and weight.
content/en/docs/services/integration-service/features.md Adds features for the Integration Service, including event stream management, advanced filtration, and support for various target services.
content/en/docs/services/integration-service/integration-service.md Describes the Integration Service's functionality in facilitating event data transmission to external services.

Poem

In data flows that sync and thrive,
The clusters stay alive.
Standby waits with steady grace,
Ensuring there's no falter in the race.
Integration now with features bright,
Connects the world, day and night.
Here's to progress, smooth and clear,
Bringing us together, far and near.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range and nitpick comments (4)
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (4)

Line range hint 67-67: Grammar correction needed for article usage.

- utilize the `mongodump` tool to create a export of the database contents,
+ utilize the `mongodump` tool to create an export of the database contents,
Tools
LanguageTool

[uncategorized] ~75-~75: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: .../note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...

Markdownlint

75-75: null (MD042, no-empty-links)
No empty links


Line range hint 52-52: Correct the verb form for clarity and grammatical accuracy.

- they won't be published again and your service has to anyway fallback to reconciliation using plgd gRPC Gateway.
+ they won't be published again and your service has to anyway fall back to reconciliation using plgd gRPC Gateway.
Tools
LanguageTool

[uncategorized] ~75-~75: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: .../note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...

Markdownlint

75-75: null (MD042, no-empty-links)
No empty links


Line range hint 12-12: Consider using more common American English phrases for clarity and consistency.

- Let's have a look at them.
+ Let's take a look at them.
Tools
LanguageTool

[uncategorized] ~75-~75: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: .../note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...

Markdownlint

75-75: null (MD042, no-empty-links)
No empty links


Line range hint 42-42: Grammar correction: use 'and' instead of 'as well as' for consistency.

- supports both global ETag as well as ETag per resource.
+ supports both global ETag and ETag per resource.
Tools
LanguageTool

[uncategorized] ~75-~75: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: .../note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...

Markdownlint

75-75: null (MD042, no-empty-links)
No empty links

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e351f3c and 98a547f.

Files selected for processing (1)
  • content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (1 hunks)
Additional context used
LanguageTool
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

[style] ~10-~10: ‘crisis situation’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_CRISIS_SITUATION)
Context: ...is understood as a way to readapt to a "crisis situation", which applies to both infrastructure ...


[locale-violation] ~12-~12: In American English, “take a look” is more commonly used. (HAVE_A_LOOK)
Context: ...r or system failure was detected. Let's have a look at them. ## Event Data Loss {{< note ...


[grammar] ~42-~42: Probable usage error. Use “and” after ‘both’. (BOTH_AS_WELL_AS)
Context: ... gRPC Gateway supports both global ETag as well as ETag per resource. Additionally, you ca...


[style] ~52-~52: Consider using “unable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...tStream / NATS failure and plgd hub was not able to publish some events, they won't be p...


[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...me events, they won't be published again and your service has to anyway fallback to ...


[grammar] ~52-~52: The word “fallback” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...ed again and your service has to anyway fallback to reconciliation using plgd gRPC Gatew...


[misspelling] ~67-~67: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Context: ... utilize the mongodump tool to create a export of the database contents, store ...


[uncategorized] ~75-~75: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: .../note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...


[uncategorized] ~105-~105: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ces If a primary cluster failure occurs and you cannot dynamically modify the endpo...


[uncategorized] ~115-~115: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...ls/load-balancing/tcp/) and [Failover & Worst Case Management With HAProxy](https://www.ha...

Markdownlint
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

75-75: null (MD042, no-empty-links)
No empty links

Additional comments not posted (2)
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (2)

78-78: Consider using a hyphen in compound adjectives for clarity.

- This is compliant with the MongoDB Community Server license.
+ This is compliant with the MongoDB Community-Server license.

Likely invalid or redundant comment.

Tools
LanguageTool

[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


75-81: Provide detailed descriptions and ensure compliance information is accurate.

Ensure that the MongoDB features described are compliant with the licensing terms as stated. This is crucial for legal and operational integrity.

Tools
LanguageTool

[uncategorized] ~75-~75: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: .../note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...

Markdownlint

75-75: null (MD042, no-empty-links)
No empty links


* `replica-set-sync`: The primary and secondary cluster MongoDB members are in the same MongoDB replica set. The secondary cluster members are configured as [hidden](https://www.mongodb.com/docs/manual/core/replica-set-hidden-member), [delayed](https://www.mongodb.com/docs/manual/core/replica-set-delayed-member/), and with [zero priority](https://www.mongodb.com/docs/manual/core/replica-set-priority-0-member/). When the primary cluster goes down, the secondary cluster MongoDB members are promoted to secondary state—one of them will become primary. After the primary is back online, the primary cluster members will be demoted to hidden. For switching back, the primary cluster members will be promoted to secondary MongoDB members and secondary cluster members will be demoted. **This approach is supported by plgd hub helm chart**. For setup instructions, please refer to this [tutorial]().
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure all links are functional.

- For setup instructions, please refer to this [tutorial]().
+ For setup instructions, please refer to this [tutorial](<insert-link-here>).

Please provide the correct link for the tutorial or remove the placeholder if the tutorial is not yet available.

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.

Suggested change
* `replica-set-sync`: The primary and secondary cluster MongoDB members are in the same MongoDB replica set. The secondary cluster members are configured as [hidden](https://www.mongodb.com/docs/manual/core/replica-set-hidden-member), [delayed](https://www.mongodb.com/docs/manual/core/replica-set-delayed-member/), and with [zero priority](https://www.mongodb.com/docs/manual/core/replica-set-priority-0-member/). When the primary cluster goes down, the secondary cluster MongoDB members are promoted to secondary state—one of them will become primary. After the primary is back online, the primary cluster members will be demoted to hidden. For switching back, the primary cluster members will be promoted to secondary MongoDB members and secondary cluster members will be demoted. **This approach is supported by plgd hub helm chart**. For setup instructions, please refer to this [tutorial]().
* `replica-set-sync`: The primary and secondary cluster MongoDB members are in the same MongoDB replica set. The secondary cluster members are configured as [hidden](https://www.mongodb.com/docs/manual/core/replica-set-hidden-member), [delayed](https://www.mongodb.com/docs/manual/core/replica-set-delayed-member/), and with [zero priority](https://www.mongodb.com/docs/manual/core/replica-set-priority-0-member/). When the primary cluster goes down, the secondary cluster MongoDB members are promoted to secondary state—one of them will become primary. After the primary is back online, the primary cluster members will be demoted to hidden. For switching back, the primary cluster members will be promoted to secondary MongoDB members and secondary cluster members will be demoted. **This approach is supported by plgd hub helm chart**. For setup instructions, please refer to this [tutorial](<insert-link-here>).
Tools
LanguageTool

[uncategorized] ~75-~75: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...

Markdownlint

75-75: null (MD042, no-empty-links)
No empty links

@jkralik jkralik force-pushed the jkralik/feature/standby-cluster branch 2 times, most recently from 5b68ce8 to 5eaabf4 Compare June 14, 2024 07:39
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range and nitpick comments (3)
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (3)

71-71: Clarify the term "real-time" in the context of data synchronization.

The term "real-time" can be interpreted in various ways depending on the context. It might be beneficial to specify what "real-time" entails in this scenario to avoid ambiguity.


87-87: Clarify licensing restrictions for MongoDB cluster-to-cluster sync.

The note on licensing restrictions is crucial for legal compliance. Consider expanding this section to explain what the non-compliance implications might mean for users, or how they can ensure compliance.


Line range hint 109-109: Improve the clarity of device connection fallback procedures.

The section on device connection fallback procedures could be clearer. Consider using bullet points or a flowchart to outline the steps more distinctly, which could improve readability and user understanding.

Tools
LanguageTool

[uncategorized] ~73-~73: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...r MongoDB, use: * replica-set-sync: ![active-backup-replica-set](/docs...


[uncategorized] ~79-~79: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~82-~82: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...note >}} * cluster-to-cluster-sync: ![active-backup](/docs/features/mo...

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 98a547f and 5eaabf4.

Files ignored due to path filters (1)
  • content/en/docs/features/monitoring-and-diagnostics/static/disaster-recovery-active-replica-set-backup.drawio.svg is excluded by !**/*.svg
Files selected for processing (1)
  • content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (1 hunks)
Additional context used
LanguageTool
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

[style] ~10-~10: ‘crisis situation’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_CRISIS_SITUATION)
Context: ...is understood as a way to readapt to a "crisis situation", which applies to both infrastructure ...


[locale-violation] ~12-~12: In American English, “take a look” is more commonly used. (HAVE_A_LOOK)
Context: ...r or system failure was detected. Let's have a look at them. ## Event Data Loss {{< note ...


[grammar] ~42-~42: Probable usage error. Use “and” after ‘both’. (BOTH_AS_WELL_AS)
Context: ... gRPC Gateway supports both global ETag as well as ETag per resource. Additionally, you ca...


[style] ~52-~52: Consider using “unable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...tStream / NATS failure and plgd hub was not able to publish some events, they won't be p...


[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...me events, they won't be published again and your service has to anyway fallback to ...


[grammar] ~52-~52: The word “fallback” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...ed again and your service has to anyway fallback to reconciliation using plgd gRPC Gatew...


[misspelling] ~67-~67: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Context: ... utilize the mongodump tool to create a export of the database contents, store ...


[uncategorized] ~73-~73: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...r MongoDB, use: * replica-set-sync: ![active-backup-replica-set](/docs...


[uncategorized] ~79-~79: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~82-~82: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...note >}} * cluster-to-cluster-sync: ![active-backup](/docs/features/mo...


[uncategorized] ~109-~109: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ces If a primary cluster failure occurs and you cannot dynamically modify the endpo...


[uncategorized] ~119-~119: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...ls/load-balancing/tcp/) and [Failover & Worst Case Management With HAProxy](https://www.ha...

Additional comments not posted (1)
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (1)

73-76: Ensure the diagram links are accessible and diagrams are correctly displayed.

#!/bin/bash
# Description: Verify that the linked diagrams are accessible.

# Test: Check if the SVG files exist and are accessible.
fd 'disaster-recovery-active-replica-set-backup.drawio.svg' content/en/docs/features/monitoring-and-diagnostics/static
fd 'disaster-recovery-active-backup.drawio.svg' content/en/docs/features/monitoring-and-diagnostics/static

Also applies to: 82-85

Tools
LanguageTool

[uncategorized] ~73-~73: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...r MongoDB, use: * replica-set-sync: ![active-backup-replica-set](/docs...

The database actively synchronizes data between two clusters in realtime. This approach is more complex and resource-intensive but is more reliable for disaster recovery. For MongoDB, use `cluster-to-cluster-sync` feature to synchronize data between two MongoDB clusters. For more details on this approach, refer to the [MongoDB documentation](https://www.mongodb.com/docs/cluster-to-cluster-sync/current/connecting/onprem-to-onprem/).
* `replica-set-sync`:
![active-backup-replica-set](/docs/features/monitoring-and-diagnostics/static/disaster-recovery-active-replica-set-backup.drawio.svg)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Provide the correct link for the MongoDB replica set tutorial.

The link placeholder for the MongoDB replica set tutorial is empty. It's crucial to provide a valid link to ensure users can access detailed setup instructions.

- For setup instructions, please refer to this [tutorial]().
+ For setup instructions, please refer to this [tutorial](<insert-link-here>).

Committable suggestion was skipped due to low confidence.

@jkralik jkralik force-pushed the jkralik/feature/standby-cluster branch from 5eaabf4 to d1a675a Compare June 14, 2024 07:44
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Outside diff range and nitpick comments (4)
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (4)

Line range hint 67-67: Correct the article before "export".

- to create a export of the database contents
+ to create an export of the database contents
Tools
LanguageTool

[uncategorized] ~73-~73: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...r MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...

Markdownlint

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


81-81: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


73-73: null (MD042, no-empty-links)
No empty links


Line range hint 52-52: Correct the verb form for "fallback".

- your service has to anyway fallback to reconciliation using plgd gRPC Gateway.
+ your service has to anyway fall back to reconciliation using plgd gRPC Gateway.
Tools
LanguageTool

[uncategorized] ~73-~73: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...r MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...

Markdownlint

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


81-81: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


73-73: null (MD042, no-empty-links)
No empty links


Line range hint 52-52: Add a comma before "and" in compound sentences for clarity.

- they won't be published again and your service has to anyway fallback to reconciliation using plgd gRPC Gateway.
+ they won't be published again, and your service has to anyway fall back to reconciliation using plgd gRPC Gateway.
Tools
LanguageTool

[uncategorized] ~73-~73: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...r MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...

Markdownlint

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


81-81: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


73-73: null (MD042, no-empty-links)
No empty links


Line range hint 107-107: Add a comma before "and" in compound sentences for clarity.

- If a primary cluster failure occurs and you cannot dynamically modify the endpoint on the devices
+ If a primary cluster failure occurs, and you cannot dynamically modify the endpoint on the devices
Tools
LanguageTool

[uncategorized] ~73-~73: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...r MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...

Markdownlint

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


81-81: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


73-73: null (MD042, no-empty-links)
No empty links

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 98a547f and 5b68ce8.

Files ignored due to path filters (1)
  • content/en/docs/features/monitoring-and-diagnostics/static/disaster-recovery-active-replica-set-backup.drawio.svg is excluded by !**/*.svg
Files selected for processing (1)
  • content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (1 hunks)
Additional context used
LanguageTool
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

[style] ~10-~10: ‘crisis situation’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_CRISIS_SITUATION)
Context: ...is understood as a way to readapt to a "crisis situation", which applies to both infrastructure ...


[locale-violation] ~12-~12: In American English, “take a look” is more commonly used. (HAVE_A_LOOK)
Context: ...r or system failure was detected. Let's have a look at them. ## Event Data Loss {{< note ...


[uncategorized] ~17-~17: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ...n the system, _e.g. when the content of resource changes, when a new resource is publish...


[grammar] ~42-~42: Probable usage error. Use “and” after ‘both’. (BOTH_AS_WELL_AS)
Context: ... gRPC Gateway supports both global ETag as well as ETag per resource. Additionally, you ca...


[style] ~52-~52: Consider using “unable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...tStream / NATS failure and plgd hub was not able to publish some events, they won't be p...


[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...me events, they won't be published again and your service has to anyway fallback to ...


[grammar] ~52-~52: The word “fallback” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...ed again and your service has to anyway fallback to reconciliation using plgd gRPC Gatew...


[misspelling] ~67-~67: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Context: ... utilize the mongodump tool to create a export of the database contents, store ...


[uncategorized] ~73-~73: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...r MongoDB, use: * replica-set-sync: The primary and secondary cluster Mongo...


[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~81-~81: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...note >}} * cluster-to-cluster-sync: A feature to synchronize data between t...


[uncategorized] ~107-~107: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ces If a primary cluster failure occurs and you cannot dynamically modify the endpo...


[uncategorized] ~117-~117: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...ls/load-balancing/tcp/) and [Failover & Worst Case Management With HAProxy](https://www.ha...

Markdownlint
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


81-81: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


73-73: null (MD042, no-empty-links)
No empty links

@jkralik jkralik force-pushed the jkralik/feature/standby-cluster branch from d1a675a to 5e497c0 Compare June 14, 2024 07:51
@jkralik jkralik force-pushed the jkralik/feature/standby-cluster branch from 5e497c0 to 3115b9e Compare June 14, 2024 07:54
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Outside diff range and nitpick comments (2)
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (2)

Line range hint 52-52: Replace "fallback" with "fall back" to correct the verb usage.

- ...ed again and your service has to anyway fallback to reconciliation using plgd gRPC Gateway.
+ ...ed again and your service has to anyway fall back to reconciliation using plgd gRPC Gateway.
Tools
LanguageTool

[uncategorized] ~71-~71: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...h is more complex and resource-intensive but is more reliable for disaster recovery....

Markdownlint

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


79-79: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


77-77: null (MD042, no-empty-links)
No empty links


Line range hint 67-67: Correct the article usage before "export".

- ... utilize the `mongodump` tool to create a export of the database contents, store ...
+ ... utilize the `mongodump` tool to create an export of the database contents, store ...
Tools
LanguageTool

[uncategorized] ~71-~71: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...h is more complex and resource-intensive but is more reliable for disaster recovery....

Markdownlint

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


79-79: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


77-77: null (MD042, no-empty-links)
No empty links

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 98a547f and 5e497c0.

Files ignored due to path filters (1)
  • content/en/docs/features/monitoring-and-diagnostics/static/disaster-recovery-active-replica-set-backup.drawio.svg is excluded by !**/*.svg
Files selected for processing (1)
  • content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (1 hunks)
Additional context used
LanguageTool
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

[style] ~10-~10: ‘crisis situation’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_CRISIS_SITUATION)
Context: ...is understood as a way to readapt to a "crisis situation", which applies to both infrastructure ...


[locale-violation] ~12-~12: In American English, “take a look” is more commonly used. (HAVE_A_LOOK)
Context: ...r or system failure was detected. Let's have a look at them. ## Event Data Loss {{< note ...


[grammar] ~42-~42: Probable usage error. Use “and” after ‘both’. (BOTH_AS_WELL_AS)
Context: ... gRPC Gateway supports both global ETag as well as ETag per resource. Additionally, you ca...


[style] ~52-~52: Consider using “unable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...tStream / NATS failure and plgd hub was not able to publish some events, they won't be p...


[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...me events, they won't be published again and your service has to anyway fallback to ...


[grammar] ~52-~52: The word “fallback” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...ed again and your service has to anyway fallback to reconciliation using plgd gRPC Gatew...


[misspelling] ~67-~67: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Context: ... utilize the mongodump tool to create a export of the database contents, store ...


[uncategorized] ~71-~71: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...h is more complex and resource-intensive but is more reliable for disaster recovery....


[uncategorized] ~103-~103: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ces If a primary cluster failure occurs and you cannot dynamically modify the endpo...


[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...ls/load-balancing/tcp/) and [Failover & Worst Case Management With HAProxy](https://www.ha...

Markdownlint
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


79-79: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


77-77: null (MD042, no-empty-links)
No empty links

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Outside diff range and nitpick comments (2)
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (2)

Line range hint 52-52: Correct the verb form for "fallback" to maintain grammatical accuracy.

- ...and your service has to anyway fallback to reconciliation using plgd gRPC Gateway.
+ ...and your service has to anyway fall back to reconciliation using plgd gRPC Gateway.
Tools
LanguageTool

[uncategorized] ~71-~71: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...h is more complex and resource-intensive but is more reliable for disaster recovery....


[uncategorized] ~80-~80: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...

Markdownlint

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


83-83: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


77-77: null (MD042, no-empty-links)
No empty links


Line range hint 67-67: Correct the article usage for grammatical accuracy.

- ...utilize the `mongodump` tool to create a export of the database contents, store it securely...
+ ...utilize the `mongodump` tool to create an export of the database contents, store it securely...
Tools
LanguageTool

[uncategorized] ~71-~71: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...h is more complex and resource-intensive but is more reliable for disaster recovery....


[uncategorized] ~80-~80: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...

Markdownlint

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


83-83: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


77-77: null (MD042, no-empty-links)
No empty links

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5eaabf4 and d1a675a.

Files ignored due to path filters (1)
  • content/en/docs/features/monitoring-and-diagnostics/static/disaster-recovery-active-replica-set-backup.drawio.svg is excluded by !**/*.svg
Files selected for processing (1)
  • content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (1 hunks)
Additional context used
LanguageTool
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

[style] ~10-~10: ‘crisis situation’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_CRISIS_SITUATION)
Context: ...is understood as a way to readapt to a "crisis situation", which applies to both infrastructure ...


[locale-violation] ~12-~12: In American English, “take a look” is more commonly used. (HAVE_A_LOOK)
Context: ...r or system failure was detected. Let's have a look at them. ## Event Data Loss {{< note ...


[uncategorized] ~17-~17: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ...n the system, _e.g. when the content of resource changes, when a new resource is publish...


[grammar] ~42-~42: Probable usage error. Use “and” after ‘both’. (BOTH_AS_WELL_AS)
Context: ... gRPC Gateway supports both global ETag as well as ETag per resource. Additionally, you ca...


[style] ~52-~52: Consider using “unable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...tStream / NATS failure and plgd hub was not able to publish some events, they won't be p...


[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...me events, they won't be published again and your service has to anyway fallback to ...


[grammar] ~52-~52: The word “fallback” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...ed again and your service has to anyway fallback to reconciliation using plgd gRPC Gatew...


[misspelling] ~67-~67: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Context: ... utilize the mongodump tool to create a export of the database contents, store ...


[uncategorized] ~71-~71: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...h is more complex and resource-intensive but is more reliable for disaster recovery....


[uncategorized] ~80-~80: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...more information, refer to the [MongoDB Server Side Public License](https://www.mongodb.com...


[uncategorized] ~101-~101: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...ase needs to be backed up regularly. In case of OAuth2 server failure, devices won't...


[uncategorized] ~101-~101: You might be missing the article “an” here. (AI_EN_LECTOR_MISSING_DETERMINER_AN)
Context: ...s to be backed up regularly. In case of OAuth2 server failure, devices won't connect t...


[uncategorized] ~111-~111: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ces If a primary cluster failure occurs and you cannot dynamically modify the endpo...


[uncategorized] ~121-~121: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ... the IP address could be challenging in case of primary cluster failure, as the publ...


[uncategorized] ~121-~121: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...ls/load-balancing/tcp/) and [Failover & Worst Case Management With HAProxy](https://www.ha...

Markdownlint
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


83-83: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


77-77: null (MD042, no-empty-links)
No empty links

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 98a547f and 3115b9e.

Files ignored due to path filters (1)
  • content/en/docs/features/monitoring-and-diagnostics/static/disaster-recovery-active-replica-set-backup.drawio.svg is excluded by !**/*.svg
Files selected for processing (1)
  • content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (4 hunks)
Additional context used
LanguageTool
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

[style] ~10-~10: ‘crisis situation’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_CRISIS_SITUATION)
Context: ...is understood as a way to readapt to a "crisis situation", which applies to both infrastructure ...


[locale-violation] ~12-~12: In American English, “take a look” is more commonly used. (HAVE_A_LOOK)
Context: ...r or system failure was detected. Let's have a look at them. ## Event Data Loss {{< note ...


[grammar] ~42-~42: Probable usage error. Use “and” after ‘both’. (BOTH_AS_WELL_AS)
Context: ... gRPC Gateway supports both global ETag as well as ETag per resource. Additionally, you ca...


[style] ~52-~52: Consider using “unable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...tStream / NATS failure and plgd hub was not able to publish some events, they won't be p...


[uncategorized] ~52-~52: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...me events, they won't be published again and your service has to anyway fallback to ...


[grammar] ~52-~52: The word “fallback” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...ed again and your service has to anyway fallback to reconciliation using plgd gRPC Gatew...


[misspelling] ~67-~67: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Context: ... utilize the mongodump tool to create a export of the database contents, store ...


[uncategorized] ~103-~103: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ces If a primary cluster failure occurs and you cannot dynamically modify the endpo...


[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...ls/load-balancing/tcp/) and [Failover & Worst Case Management With HAProxy](https://www.ha...

Markdownlint
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md

73-73: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


79-79: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


77-77: null (MD042, no-empty-links)
No empty links

Additional comments not posted (6)
content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md (6)

71-71: The database actively synchronizes data between two clusters in real-time. Ensure that the term "real-time" is hyphenated to maintain consistency and accuracy in technical documentation.


99-99: It is crucial that the Root CAs used for the primary and standby clusters are identical. This change enhances clarity by replacing "secondary" with "standby," aligning with the rest of the document's terminology.


103-103: If a primary cluster failure occurs and you cannot dynamically modify the endpoint on the devices, they will be unable to establish a connection with the hub. This section clearly outlines the implications of a primary cluster failure and the importance of having a contingency plan.

Tools
LanguageTool

[uncategorized] ~103-~103: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ces If a primary cluster failure occurs and you cannot dynamically modify the endpo...


113-113: Changing the IP address could be challenging in case of primary cluster failure. This statement is well-placed and highlights the potential challenges and solutions involving IP management in disaster scenarios.

Tools
LanguageTool

[uncategorized] ~113-~113: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...ls/load-balancing/tcp/) and [Failover & Worst Case Management With HAProxy](https://www.ha...


117-117: Under these circumstances, you have the option to update the DPS endpoint to the standby cluster. This section provides a comprehensive overview of the steps and considerations necessary for updating the DPS endpoint in disaster recovery scenarios.
[APROVED]


57-57: Please ensure all links are functional.

- For setup instructions, please refer to this [tutorial]().
+ For setup instructions, please refer to this [tutorial](<insert-link-here>).

Please provide the correct link for the tutorial or remove the placeholder if the tutorial is not yet available.

Likely invalid or redundant comment.


![active-backup-replica-set](/docs/features/monitoring-and-diagnostics/static/disaster-recovery-active-replica-set-backup.drawio.svg)

The primary and standby cluster MongoDB members are in the same MongoDB replica set. The standby cluster members are configured as [hidden](https://www.mongodb.com/docs/manual/core/replica-set-hidden-member), [delayed](https://www.mongodb.com/docs/manual/core/replica-set-delayed-member/), and with [zero priority](https://www.mongodb.com/docs/manual/core/replica-set-priority-0-member/). When the primary cluster goes down, the standby cluster MongoDB members are promoted to standby state—one of them will become primary. After the primary is back online, the primary cluster members will be demoted to hidden. For switching back, the primary cluster members will be promoted to standby MongoDB members and standby cluster members will be demoted. **This approach is supported by the plgd hub helm chart because it complies with the MongoDB Community Server license.** For setup instructions, please refer to this [tutorial]().
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip

Codebase Verification

The tutorial link in the markdown file is currently empty and needs to be updated with a valid URL.

  • File: content/en/docs/features/monitoring-and-diagnostics/disaster-recovery.md
  • Line: 77
Analysis chain

The primary and standby cluster MongoDB members are in the same MongoDB replica set. The description of the standby cluster's role and configuration is clear and informative.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the MongoDB replica set configuration tutorial link.

# Test: Search for the tutorial link. Expect: Valid URL.
rg --type markdown $'\[tutorial\]\(\)'

Length of output: 1047

Tools
Markdownlint

77-77: null (MD042, no-empty-links)
No empty links

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3115b9e and 5eb25b8.

Files selected for processing (1)
  • content/en/docs/features/control-plane/integration-service.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • content/en/docs/features/control-plane/integration-service.md

@jkralik jkralik force-pushed the jkralik/feature/standby-cluster branch 4 times, most recently from 6f57739 to 4a814f0 Compare June 14, 2024 08:39
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5eb25b8 and da6c3b9.

Files selected for processing (2)
  • content/en/docs/services/integration-service/_index.md (1 hunks)
  • content/en/docs/services/integration-service/integration-service.md (1 hunks)
Files not summarized due to errors (1)
  • content/en/docs/services/integration-service/_index.md: Error: Server error. Please try again later.
Additional comments not posted (4)
content/en/docs/services/integration-service/_index.md (1)

1-4: Metadata settings are appropriate and clear.

content/en/docs/services/integration-service/integration-service.md (3)

11-17: The introduction clearly outlines the purpose and scope of the Integration Service. The note indicating it as a planned feature is crucial for setting correct user expectations.


19-40: The features section is comprehensive, detailing the capabilities of the Integration Service effectively. This enhances understanding and sets clear expectations for the service's functionality.


41-48: The benefits section effectively communicates the advantages of the Integration Service, highlighting its flexibility, scalability, and enhanced data control.

@jkralik jkralik force-pushed the jkralik/feature/standby-cluster branch from 4a814f0 to 4d1c142 Compare June 14, 2024 08:59
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between da6c3b9 and 4d1c142.

Files selected for processing (3)
  • content/en/docs/services/integration-service/_index.md (1 hunks)
  • content/en/docs/services/integration-service/features.md (1 hunks)
  • content/en/docs/services/integration-service/integration-service.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • content/en/docs/services/integration-service/_index.md
  • content/en/docs/services/integration-service/integration-service.md
Additional context used
Markdownlint
content/en/docs/services/integration-service/features.md

15-15: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


16-16: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


17-17: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


18-18: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


19-19: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


22-22: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


23-23: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation

Additional comments not posted (1)
content/en/docs/services/integration-service/features.md (1)

10-25: The planned features for the Integration Service are well-detailed and provide a good overview of the capabilities. This should help users understand the potential applications of the service.

Tools
Markdownlint

15-15: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


16-16: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


17-17: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


18-18: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


19-19: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


22-22: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


23-23: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation

Comment on lines +15 to +23
- **Device ID:** Filter events based on the unique identifier of the originating device.
- **Href:** Utilize the href attribute for event selection.
- **Resource Types:** Specify resource types to target events relevant to particular data types.
- **Event Type:** Differentiate events based on their type.
- **Content Filtering:** Apply jq expressions for advanced content-based filtering.

- **&#x2610; Supported Target Services:**
- **HTTP:** Integrate with web services and APIs via HTTP endpoints.
- **NATS:** Use the NATS messaging system for distributed event streaming.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjust the indentation for unordered list items to improve readability.

-   - **Device ID:** Filter events based on the unique identifier of the originating device.
+  - **Device ID:** Filter events based on the unique identifier of the originating device.
-   - **Href:** Utilize the href attribute for event selection.
+  - **Href:** Utilize the href attribute for event selection.
-   - **Resource Types:** Specify resource types to target events relevant to particular data types.
+  - **Resource Types:** Specify resource types to target events relevant to particular data types.
-   - **Event Type:** Differentiate events based on their type.
+  - **Event Type:** Differentiate events based on their type.
-   - **Content Filtering:** Apply jq expressions for advanced content-based filtering.
+  - **Content Filtering:** Apply jq expressions for advanced content-based filtering.
-   - **HTTP:** Integrate with web services and APIs via HTTP endpoints.
+  - **HTTP:** Integrate with web services and APIs via HTTP endpoints.
-   - **NATS:** Use the NATS messaging system for distributed event streaming.
+  - **NATS:** Use the NATS messaging system for distributed event streaming.
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.

Suggested change
- **Device ID:** Filter events based on the unique identifier of the originating device.
- **Href:** Utilize the href attribute for event selection.
- **Resource Types:** Specify resource types to target events relevant to particular data types.
- **Event Type:** Differentiate events based on their type.
- **Content Filtering:** Apply jq expressions for advanced content-based filtering.
- **&#x2610; Supported Target Services:**
- **HTTP:** Integrate with web services and APIs via HTTP endpoints.
- **NATS:** Use the NATS messaging system for distributed event streaming.
- **Device ID:** Filter events based on the unique identifier of the originating device.
- **Href:** Utilize the href attribute for event selection.
- **Resource Types:** Specify resource types to target events relevant to particular data types.
- **Event Type:** Differentiate events based on their type.
- **Content Filtering:** Apply jq expressions for advanced content-based filtering.
- **&#x2610; Supported Target Services:**
- **HTTP:** Integrate with web services and APIs via HTTP endpoints.
- **NATS:** Use the NATS messaging system for distributed event streaming.
Tools
Markdownlint

15-15: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


16-16: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


17-17: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


18-18: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


19-19: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


22-22: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation


23-23: Expected: 2; Actual: 3 (MD007, ul-indent)
Unordered list indentation

@jkralik jkralik force-pushed the jkralik/feature/standby-cluster branch from 4d1c142 to a055a1d Compare June 15, 2024 18:49
@jkralik jkralik merged commit bec73e5 into main Jun 15, 2024
11 checks passed
@jkralik jkralik deleted the jkralik/feature/standby-cluster branch June 15, 2024 18:52
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant