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

docs(auto-rebalance): adds new and updated content for auto-rebalancing #10698

Merged
merged 4 commits into from
Oct 21, 2024

Conversation

PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented Oct 10, 2024

Documentation

  • New procedure for triggering auto-rebalances on scaling
  • Updated node pool procedures to reflect auto-rebalance enablement
  • Update to resource status list

Checklist

Please go through this checklist and make sure all applicable tasks have been done

  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Check RBAC rights for Kubernetes / OpenShift roles
  • Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
  • Reference relevant issue(s) and close them after merging
  • Update CHANGELOG.md
  • Supply screenshots for visual changes, such as Grafana dashboards

- New procedure for triggering auto-rebalances on scaling
- Updated node pool procedures to relect auto-rebalance enablement
- Update to resource ststus list

Signed-off-by: prmellor <[email protected]>
@PaulRMellor PaulRMellor added this to the 0.44.0 milestone Oct 10, 2024
@PaulRMellor PaulRMellor requested review from ppatierno and a team October 10, 2024 11:11
@PaulRMellor PaulRMellor self-assigned this Oct 10, 2024
@see-quick see-quick self-requested a review October 14, 2024 18:47
Copy link
Contributor

@katheris katheris left a comment

Choose a reason for hiding this comment

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

LGTM

metadata:
name: my-add-remove-brokers-rebalancing-template
annotations:
strimzi.io/rebalance-template: true # <1>
Copy link
Member

Choose a reason for hiding this comment

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

This has to be "true" I think ...

Suggested change
strimzi.io/rebalance-template: true # <1>
strimzi.io/rebalance-template: "true" # <1>

Copy link
Member

Choose a reason for hiding this comment

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

This should be strimzi.io/rebalance : template as I pointed out in the previous comment

Copy link
Member

@see-quick see-quick left a comment

Choose a reason for hiding this comment

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

LGTM, just two nits. Thanks

You can apply the same template configuration for both scaling modes, use different configurations for each, or enable auto-rebalancing for only one mode.
If `autorebalance` configuration is not set for a mode, auto-rebalancing will not occur for that mode.

The template `KafkaRebalance` resource must include the `strimzi.io/rebalance-template: true` annotation.
Copy link
Member

Choose a reason for hiding this comment

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

This is not true anymore btw. You have to add annotation:

strimzi.io/rebalance : template

right @ppatierno ?

Copy link
Member

Choose a reason for hiding this comment

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

No, it changed the other way around ... from strimzi.io/rebalance : template to strimzi.io/rebalance-template: "true" ... but the "true" should be likely used here as well.

Copy link
Member

Choose a reason for hiding this comment

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

right @ppatierno ?

No as Jakub said, it's the other way around. I already asked Paul to fix it as he did.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks. I've kept as true, but added the string quotes

metadata:
name: my-add-remove-brokers-rebalancing-template
annotations:
strimzi.io/rebalance-template: true # <1>
Copy link
Member

Choose a reason for hiding this comment

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

This should be strimzi.io/rebalance : template as I pointed out in the previous comment

@scholzj scholzj merged commit aa8466b into strimzi:main Oct 21, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants