Add Kafka options to yorkie-cluster and missing WriteTimeout

[emplam27]

What this PR does / why we need it:

Add deployment template with configurable Kafka options and resolves
missing write timeout settings.

Which issue(s) this PR fixes:

Address #1130

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

• Added relevant tests or not required
• Addressed and resolved all CodeRabbit review comments
• Didn't break anything

Summary by CodeRabbit

• New Features
  • Enabled additional Kafka configuration options for deployments.
  • Now supports specifying Kafka addresses and topics via new command-line parameters.
  • Introduced a configurable write timeout for the Kafka message broker to enhance performance.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes extend Kafka integration in the application. In the Kubernetes deployment configuration, two new command-line arguments (--kafka-addresses and --kafka-topic) are conditionally added to the yorkie container based on configuration values. In the server command initialization, a new WriteTimeout field is introduced in the Kafka message broker configuration, expanding the parameters available for Kafka without altering existing logic.

Changes

File(s)	Change Summary
build/charts/…/yorkie/deployment.yaml	Conditionally adds --kafka-addresses and --kafka-topic arguments to the container's CLI if configuration exists.
cmd/yorkie/server.go	Adds WriteTimeout to the Kafka message broker configuration within the server command initialization.

Sequence Diagram(s)

sequenceDiagram
    participant Config as Deployment Config
    participant Template as Template Engine
    participant Container as Yorkie Container

    Config->>Template: Check for kafkaAddresses and kafkaTopic
    alt Kafka config provided
        Template-->>Container: Inject --kafka-addresses and --kafka-topic args
    else
        Template-->>Container: Proceed without kafka args
    end
    Container->>Container: Start with given arguments

Loading

sequenceDiagram
    participant User as Operator
    participant ServerCmd as Server Command Initialization
    participant MsgBroker as Kafka Configurator

    User->>ServerCmd: Execute server command
    ServerCmd->>MsgBroker: Build config with Addresses, Topic, and WriteTimeout
    MsgBroker-->>ServerCmd: Return complete Kafka configuration
    ServerCmd->>User: Launch server with Kafka integration

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1b2718b and 5f16ef1.

📒 Files selected for processing (2)

• build/charts/yorkie-cluster/templates/yorkie/deployment.yaml (1 hunks)
• cmd/yorkie/server.go (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 38.46%. Comparing base (45c3259) to head (5f16ef1).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/yorkie/server.go	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1149      +/-   ##
==========================================
- Coverage   38.59%   38.46%   -0.13%     
==========================================
  Files         165      169       +4     
  Lines       25293    25434     +141     
==========================================
+ Hits         9761     9783      +22     
- Misses      14712    14830     +118     
- Partials      820      821       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[hackerwins]

Thanks for your contribution.