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

ci: scale up coredns to 3 replicas to prevent it from being affected by node down test cases #2181

Merged
merged 2 commits into from
Dec 6, 2024

Conversation

yangchiu
Copy link
Member

@yangchiu yangchiu commented Dec 6, 2024

Which issue(s) this PR fixes:

Issue longhorn/longhorn#9870 longhorn/longhorn#9752

What this PR does / why we need it:

scale up coredns to 3 replicas to prevent it from being affected by node down test cases

Special notes for your reviewer:

Additional documentation or context

Summary by CodeRabbit

  • New Features

    • Introduced a new function to scale up CoreDNS during the Longhorn installation process.
    • Enhanced setup scripts to manage CoreDNS configurations more effectively.
  • Bug Fixes

    • Ensured error handling remains intact while integrating new functionalities.

@yangchiu yangchiu self-assigned this Dec 6, 2024
@yangchiu yangchiu requested a review from a team as a code owner December 6, 2024 02:11
Copy link

coderabbitai bot commented Dec 6, 2024

Warning

Rate limit exceeded

@yangchiu has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 2 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 95598bb and b7c9e99.

Walkthrough

The changes in this pull request involve the addition of a new function, scale_up_coredns, to manage the scaling of CoreDNS replicas during the Longhorn installation process. This function is implemented in the coredns.sh script and is called within the longhorn-setup.sh script after the installation of the CSI snapshotter. The modifications ensure that CoreDNS is scaled to three replicas, enhancing the setup process without altering the existing error handling or control flow.

Changes

File Path Change Summary
pipelines/e2e/scripts/longhorn-setup.sh Added function call scale_up_coredns after CSI snapshotter installation.
pipelines/utilities/coredns.sh Introduced function scale_up_coredns to patch CoreDNS deployment to 3 replicas.
test_framework/scripts/longhorn-setup.sh Sourced coredns.sh and invoked scale_up_coredns in the main function.

Assessment against linked issues

Objective Addressed Explanation
Scale up CoreDNS replicas to three before Longhorn installation (#9870)

Possibly related PRs

Suggested reviewers

  • khushboo-rancher

Poem

In the land of nodes and clouds so bright,
A rabbit hops with all its might.
Scaling up CoreDNS, oh what a sight,
Three replicas now, a true delight!
Longhorn's setup, smooth as can be,
Hooray for changes, let’s all agree! 🐇✨


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.

Copy link

@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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eaa6312 and 95598bb.

📒 Files selected for processing (3)
  • pipelines/e2e/scripts/longhorn-setup.sh (1 hunks)
  • pipelines/utilities/coredns.sh (1 hunks)
  • test_framework/scripts/longhorn-setup.sh (2 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
pipelines/utilities/coredns.sh

[error] 1-1: Tips depend on target shell and yours is unknown. Add a shebang or a 'shell' directive.

(SC2148)

🔇 Additional comments (2)
test_framework/scripts/longhorn-setup.sh (2)

9-9: LGTM: Properly sourced CoreDNS utility.

The CoreDNS utility script is correctly sourced alongside other utility scripts.


567-568: LGTM: Consistent implementation with e2e script.

The scale_up_coredns function is called at the appropriate time in the setup process, maintaining consistency with the e2e implementation.

Comment on lines 1 to 7
scale_up_coredns(){
kubectl patch deployment coredns -n kube-system --type='merge' -p '{"spec": {"replicas": 3}}'
}
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add shell options and error handling.

The script needs improvements for robustness and error handling:

  1. Add shebang and shell options
  2. Add error handling and validation

Apply this diff:

+#!/bin/bash
+
+set -euo pipefail
+
 scale_up_coredns(){
+  echo "Scaling CoreDNS deployment to 3 replicas..."
+  
+  # Verify current replicas to avoid unnecessary patches
+  current_replicas=$(kubectl get deployment coredns -n kube-system -o=jsonpath='{.spec.replicas}' || echo "0")
+  if [ "$current_replicas" = "3" ]; then
+    echo "CoreDNS deployment already has 3 replicas"
+    return 0
+  fi
+
   kubectl patch deployment coredns -n kube-system --type='merge' -p '{"spec": {"replicas": 3}}'
+  
+  # Verify the patch was applied
+  if ! kubectl rollout status deployment/coredns -n kube-system --timeout=60s; then
+    echo "Failed to scale CoreDNS deployment"
+    return 1
+  fi
+  
+  echo "Successfully scaled CoreDNS deployment to 3 replicas"
 }
📝 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
scale_up_coredns(){
kubectl patch deployment coredns -n kube-system --type='merge' -p '{"spec": {"replicas": 3}}'
}
#!/bin/bash
set -euo pipefail
scale_up_coredns(){
echo "Scaling CoreDNS deployment to 3 replicas..."
# Verify current replicas to avoid unnecessary patches
current_replicas=$(kubectl get deployment coredns -n kube-system -o=jsonpath='{.spec.replicas}' || echo "0")
if [ "$current_replicas" = "3" ]; then
echo "CoreDNS deployment already has 3 replicas"
return 0
fi
kubectl patch deployment coredns -n kube-system --type='merge' -p '{"spec": {"replicas": 3}}'
# Verify the patch was applied
if ! kubectl rollout status deployment/coredns -n kube-system --timeout=60s; then
echo "Failed to scale CoreDNS deployment"
return 1
fi
echo "Successfully scaled CoreDNS deployment to 3 replicas"
}
🧰 Tools
🪛 Shellcheck (0.10.0)

[error] 1-1: Tips depend on target shell and yours is unknown. Add a shebang or a 'shell' directive.

(SC2148)

@@ -55,6 +55,8 @@ main(){
install_backupstores
install_csi_snapshotter

scale_up_coredns
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Missing source statement for CoreDNS utilities

The scale_up_coredns function is defined in pipelines/utilities/coredns.sh, but this file is not sourced in longhorn-setup.sh or any of its sourced dependencies. Add the following line with the other source statements:

source pipelines/utilities/coredns.sh
🔗 Analysis chain

Verify CoreDNS scaling dependencies.

The scale_up_coredns function is called here, but we need to ensure it's properly sourced.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if coredns.sh is properly sourced

# Test: Search for the source statement for coredns.sh
rg -A 2 'source.*coredns.sh' 'pipelines/e2e/scripts/longhorn-setup.sh'

Length of output: 70


Script:

#!/bin/bash
# Let's check for any coredns.sh file in the repository
fd 'coredns.sh'

# Let's also check the content of longhorn-setup.sh to see all source statements
rg 'source' 'pipelines/e2e/scripts/longhorn-setup.sh'

# And check if scale_up_coredns function is defined in the same file
rg -A 5 'scale_up_coredns' 'pipelines/e2e/scripts/longhorn-setup.sh'

Length of output: 936


Script:

#!/bin/bash
# Let's check if coredns.sh is sourced in any other script that's sourced by longhorn-setup.sh
for file in $(rg -l 'source' 'pipelines/e2e/scripts/longhorn-setup.sh' | xargs rg -l 'source.*coredns.sh'); do
    echo "Found in: $file"
    rg 'source.*coredns.sh' "$file"
done

# Let's also check the content of the coredns.sh file to verify the function exists
rg -A 5 'scale_up_coredns' 'pipelines/utilities/coredns.sh'

Length of output: 267

Copy link
Contributor

@roger-ryao roger-ryao left a comment

Choose a reason for hiding this comment

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

All tests have passed successfully.

  • k3s
  • rke2

LGTM

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.

2 participants