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

[Doc][bugfix] Example broke Ensemble>=WriteQuorum>=AckQuorum Rule #17956

Merged
merged 1 commit into from
Oct 10, 2022

Conversation

dave2wave
Copy link
Member

Motivation

Our admin examples must not show users incorrect information.

Modifications

Changed Bookkeeper persistence example.

Verifying this change

  • Make sure that the change passes the CI checks.

(Please pick either of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

  • Added integration tests for end-to-end deployment with large payloads (10MB)
  • Extended integration test for recovery after broker failure

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • Anything that affects deployment

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Oct 7, 2022
@dave2wave dave2wave changed the title [Doc][bugfixx] Example broke Ensemble>=WriteQuorum>=AckQuorum Rule [Doc][bugfix] Example broke Ensemble>=WriteQuorum>=AckQuorum Rule Oct 7, 2022
Copy link
Contributor

@merlimat merlimat left a comment

Choose a reason for hiding this comment

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

We should add a check that rejects the invalid configuration

@dave2wave
Copy link
Member Author

We should add a check that rejects the invalid configuration

There is a checkArgument if we set the policy through an admin call. Are you suggesting that we also test validity when a policy is created? This can be incomplete since the full check includes knowing the broker configuration to handle the currently allowed maximums for the ensemble size. I don't think testing without the max part is wrong, I'm just looking for clarification. In any case I think that check is a separate PR.

Copy link
Contributor

@Huanli-Meng Huanli-Meng left a comment

Choose a reason for hiding this comment

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

LGTM

@Huanli-Meng
Copy link
Contributor

@dave2wave could you please help confirm whether docs in other releases also need to be updated? Thanks.

@dave2wave
Copy link
Member Author

@Huanli-Meng this change and #17955 need to be propagated to prior branches. Thank you.

@dave2wave dave2wave closed this Oct 10, 2022
@dave2wave dave2wave reopened this Oct 10, 2022
@dave2wave dave2wave merged commit c5ae308 into master Oct 10, 2022
@Huanli-Meng
Copy link
Contributor

@Huanli-Meng this change and #17955 need to be propagated to prior branches. Thank you.

@dave2wave thanks for your confirmation. BTW, would you like to help update these updates to prior branches? Thanks

@tisonkun tisonkun deleted the dave2wave-patch-2 branch December 4, 2022 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants