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

e2e: wait for cluster api providers #417

Merged
merged 1 commit into from
Oct 9, 2024
Merged

e2e: wait for cluster api providers #417

merged 1 commit into from
Oct 9, 2024

Conversation

kvaps
Copy link
Member

@kvaps kvaps commented Oct 9, 2024

Signed-off-by: Andrei Kvapil [email protected]

Summary by CodeRabbit

  • New Features

    • Enhanced orchestration of the Kubernetes environment with added wait commands for critical controllers and nodes.
    • Created and configured two new storage classes (local and replicated) for improved storage management.
    • Introduced MetalLB resources for effective load balancing within the cluster.
  • Improvements

    • Implemented checks to ensure all necessary components are online before proceeding with configurations.

Copy link
Contributor

coderabbitai bot commented Oct 9, 2024

Walkthrough

The hack/e2e.sh script has been modified to improve its functionality and control flow within a Kubernetes environment. Key updates include the addition of wait commands for various Cluster-API controllers and the linstor-controller, ensuring their availability before proceeding. The script now checks that all Linstor nodes are online and creates two new storage classes with specific parameters. Additionally, it sets up MetalLB resources for load balancing, enhancing the orchestration and storage management capabilities of the Kubernetes cluster.

Changes

File Change Summary
hack/e2e.sh - Added wait commands for capi-controller-manager, capi-kamaji-controller-manager, capi-kubeadm-bootstrap-controller-manager, and capi-operator-cluster-api-operator.
- Included wait command for linstor-controller and check for online Linstor nodes.
- Created and configured two new storage classes: local and replicated.
- Set up MetalLB resources: IPAddressPool and L2Advertisement.

Poem

🐇 In the script where bunnies hop,
New waits and checks, we’ll never stop!
Storage classes, oh what a treat,
MetalLB makes our setup neat!
With every change, we leap and bound,
In our Kubernetes, joy is found! 🌟


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
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 (2)
hack/e2e.sh (2)

Line range hint 281-286: Incorrect usage of 'kubectl wait' with '--for=jsonpath='

The kubectl wait command does not support the --for=jsonpath= parameter. The --for flag should specify conditions like condition=Available or delete. Using --for=jsonpath= will result in an error.

Consider replacing these commands with a loop that checks the desired condition using kubectl get. For example:

-kubectl wait --timeout=5m --for=jsonpath=.status.readyReplicas=3 -n tenant-root sts etcd
+timeout 300 sh -c 'until [ $(kubectl get sts etcd -n tenant-root -o jsonpath="{.status.readyReplicas}") -eq 3 ]; do sleep 5; done'

-kubectl wait --timeout=5m --for=jsonpath=.status.updateStatus=operational -n tenant-root vmalert/vmalert-longterm vmalert/vmalert-shortterm vmalertmanager/alertmanager
+timeout 300 sh -c 'until [ "$(kubectl get vmalert/vmalert-longterm -n tenant-root -o jsonpath="{.status.updateStatus}")" = "operational" ] && \
                     [ "$(kubectl get vmalert/vmalert-shortterm -n tenant-root -o jsonpath="{.status.updateStatus}")" = "operational" ] && \
                     [ "$(kubectl get vmalertmanager/alertmanager -n tenant-root -o jsonpath="{.status.updateStatus}")" = "operational" ]; do sleep 5; done'

-kubectl wait --timeout=5m --for=jsonpath=.status.status=operational -n tenant-root vlogs/generic
+timeout 300 sh -c 'until [ "$(kubectl get vlogs/generic -n tenant-root -o jsonpath="{.status.status}")" = "operational" ]; do sleep 5; done'

-kubectl wait --timeout=5m --for=jsonpath=.status.clusterStatus=operational -n tenant-root vmcluster/shortterm vmcluster/longterm
+timeout 300 sh -c 'until [ "$(kubectl get vmcluster/shortterm -n tenant-root -o jsonpath="{.status.clusterStatus}")" = "operational" ] && \
                     [ "$(kubectl get vmcluster/longterm -n tenant-root -o jsonpath="{.status.clusterStatus}")" = "operational" ]; do sleep 5; done'

This change uses a loop with timeout and kubectl get to repeatedly check the status until the desired condition is met or the timeout expires.


Line range hint 292-294: Ensure proper validation of Grafana accessibility

Using grep Found to check for Grafana's availability might not be reliable if the response does not contain the word "Found". Consider checking the HTTP status code instead to verify successful access.

Apply this diff to improve the validation:

-ip=$(kubectl get svc -n tenant-root root-ingress-controller -o jsonpath='{.status.loadBalancer.ingress..ip}')
-
-# Check Grafana
-curl -sS -k "https://$ip" -H 'Host: grafana.example.org' | grep Found
+ip=$(kubectl get svc -n tenant-root root-ingress-controller -o jsonpath='{.status.loadBalancer.ingress..ip}')
+
+# Check Grafana
+status_code=$(curl -s -o /dev/null -w "%{http_code}" -k "https://$ip" -H 'Host: grafana.example.org')
+if [ "$status_code" -ne 200 ]; then
+  echo "Grafana is not accessible. HTTP status code: $status_code"
+  exit 1
+fi

This change checks the HTTP status code returned by the curl command, ensuring that Grafana is accessible and returns a 200 OK response.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 74649f8 and e0f0dd7.

📒 Files selected for processing (1)
  • hack/e2e.sh (1 hunks)
🧰 Additional context used

Comment on lines +221 to +222
# Wait for Cluster-API providers
kubectl wait deploy --timeout=30s --for=condition=available -n cozy-cluster-api capi-controller-manager capi-kamaji-controller-manager capi-kubeadm-bootstrap-controller-manager capi-operator-cluster-api-operator capk-controller-manager
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider increasing the timeout for Cluster-API providers

The current timeout of 30 seconds may not be sufficient for all Cluster-API providers to become available, especially in environments with slower resources or network latency. Increasing the timeout ensures that the script waits long enough for the deployments to be ready.

Apply this diff to increase the timeout:

-kubectl wait deploy --timeout=30s --for=condition=available -n cozy-cluster-api capi-controller-manager capi-kamaji-controller-manager capi-kubeadm-bootstrap-controller-manager capi-operator-cluster-api-operator capk-controller-manager
+kubectl wait deploy --timeout=5m --for=condition=available -n cozy-cluster-api capi-controller-manager capi-kamaji-controller-manager capi-kubeadm-bootstrap-controller-manager capi-operator-cluster-api-operator capk-controller-manager
📝 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
# Wait for Cluster-API providers
kubectl wait deploy --timeout=30s --for=condition=available -n cozy-cluster-api capi-controller-manager capi-kamaji-controller-manager capi-kubeadm-bootstrap-controller-manager capi-operator-cluster-api-operator capk-controller-manager
# Wait for Cluster-API providers
kubectl wait deploy --timeout=5m --for=condition=available -n cozy-cluster-api capi-controller-manager capi-kamaji-controller-manager capi-kubeadm-bootstrap-controller-manager capi-operator-cluster-api-operator capk-controller-manager

@kvaps kvaps merged commit dc9d8bb into main Oct 9, 2024
@kvaps kvaps deleted the upd-e2e branch October 9, 2024 21:50
chumkaska pushed a commit to chumkaska/cozystack that referenced this pull request Oct 15, 2024
Signed-off-by: Andrei Kvapil <[email protected]>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced orchestration of the Kubernetes environment with added wait
commands for critical controllers and nodes.
- Created and configured two new storage classes (`local` and
`replicated`) for improved storage management.
- Introduced MetalLB resources for effective load balancing within the
cluster.

- **Improvements**
- Implemented checks to ensure all necessary components are online
before proceeding with configurations.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Andrei Kvapil <[email protected]>
@coderabbitai coderabbitai bot mentioned this pull request Nov 1, 2024
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