emqx-operator icon indicating copy to clipboard operation
emqx-operator copied to clipboard

docs: update blue green update document

Open Rory-Z opened this issue 1 year ago • 4 comments

Summary by CodeRabbit

  • Documentation
    • Revised English and Chinese documents on blue-green deployment for EMQX, improving clarity and usability.
    • Enhanced background sections to detail limitations of traditional rolling updates.
    • Updated steps for creating new Pods and redirecting service traffic during upgrades.
    • Introduced state diagrams for clearer visual representation of the upgrade process.
    • Expanded configuration examples and monitoring sections to provide comprehensive user guidance.

Rory-Z avatar Oct 22 '24 10:10 Rory-Z

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 76.04%. Comparing base (75eb1ef) to head (d43a316).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1081      +/-   ##
==========================================
- Coverage   76.27%   76.04%   -0.23%     
==========================================
  Files          69       69              
  Lines        6250     6250              
==========================================
- Hits         4767     4753      -14     
- Misses       1245     1255      +10     
- Partials      238      242       +4     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Oct 22 '24 10:10 codecov[bot]

Walkthrough

The pull request involves updates to the documentation for the blue-green deployment strategy of the EMQX cluster. Changes include enhanced clarity in the task objectives, background, and solution sections, with a focus on creating new Pods instead of clusters. The upgrade process has been reformatted for readability, and state diagrams have replaced previous diagrams to illustrate the upgrade steps. Configuration examples have been updated, and a new monitoring section has been added to provide tools for tracking connection metrics during the upgrade.

Changes

File Path Change Summary
docs/en_US/tasks/configure-emqx-blueGreenUpdate.md Revised for clarity on blue-green deployment, expanded background, restructured solution, added state diagram, updated deployment commands, and added monitoring section.
docs/zh_CN/tasks/configure-emqx-blueGreenUpdate.md Improved explanation of blue-green deployment, expanded background, restructured solution, added state diagram, updated configuration examples, and expanded monitoring section.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EMQX Cluster
    participant New Pods
    participant Old Pods

    User->>EMQX Cluster: Initiate Upgrade
    EMQX Cluster->>New Pods: Create New Pods
    New Pods->>EMQX Cluster: Join Existing Cluster
    EMQX Cluster->>User: Redirect Traffic to New Pods
    User->>Old Pods: Gradually Remove Old Pods
    Old Pods->>EMQX Cluster: Evacuate Connections
    EMQX Cluster->>User: Upgrade Complete

🐇 "In the garden where upgrades bloom,
New Pods arise, dispelling gloom.
Old ones fade, as traffic flows,
With YAML guides, the process grows.
Monitoring metrics, clear as day,
Blue-green magic, hip-hip-hooray!" 🌼


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

coderabbitai[bot] avatar Oct 22 '24 10:10 coderabbitai[bot]

should we suggest another architecture which do not serve MQTT traffic on core nodes ?

In this document, just deployment only core nodes cluster, should I change cluster to core + repl cluster ?

Rory-Z avatar Oct 25 '24 01:10 Rory-Z

should I change cluster to core + repl clus

but I can see replicant node in the flow

HasReplNode --> SelectOldestReplPod: Has EMQX replicant node pod

zmstone avatar Oct 25 '24 09:10 zmstone