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

[admin-tool][controller] Add new config into ZK and allow admin-tool to update the config #1418

Merged

Conversation

minhmo1620
Copy link
Collaborator

@minhmo1620 minhmo1620 commented Jan 6, 2025

Summary

  • Add admin operation version into ZK as a config and allow admin-tool to update the version.
    We will introduce a new field in adminTopicMetadata in ZK at cluster-level to store the admin operation version to serialize/deserialize the message.
  • Add HTTP API for admin-tool to set the version.

Why?

Please take a look at the design doc here. This PR is the first step to remove protocol upgrade deployment order. The expectation is that, with the remote protocol version at cluster-level, the deserializer will use the version, which the writer used to serialize AdminOperation, to deserialize the message. We will fail fast if necessary if the schema versions mismatch.

How was this PR tested?

added UTs and integration tests

What's next?

Update the serializer to fetch the version in ZK before serialize the message, and pass over this version for deserializer to deserialize.

Does this PR introduce any user-facing changes?

  • No. You can skip the rest of this section.
  • Yes. Make sure to explain your proposed changes and call out the behavior change.

@minhmo1620 minhmo1620 force-pushed the admin_tool/add_protocol_version_command branch from dfade0e to f1479e6 Compare February 8, 2025 03:22
@minhmo1620 minhmo1620 marked this pull request as ready for review February 10, 2025 23:32
@minhmo1620 minhmo1620 force-pushed the admin_tool/add_protocol_version_command branch from fd77b1d to b5f01d7 Compare February 12, 2025 00:46
@minhmo1620 minhmo1620 force-pushed the admin_tool/add_protocol_version_command branch from b5f01d7 to 1bf784b Compare February 12, 2025 01:08
Copy link
Contributor

@huangminchn huangminchn left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the hard work, Minh! Let's create a backlog ticket to remind us to write a README for the open-source community on using this config during an admin protocol upgrade.

Copy link
Collaborator

@sushantmane sushantmane left a comment

Choose a reason for hiding this comment

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

Let’s make sure to add a gRPC endpoint for the newly added API, either in this PR or a follow-up. Otherwise, we'll end up constantly playing catch-up. Thanks!

Copy link
Contributor

@huangminchn huangminchn left a comment

Choose a reason for hiding this comment

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

Thanks for the hard work Minh!

@minhmo1620 minhmo1620 merged commit 1e2b47d into linkedin:main Feb 14, 2025
59 checks passed
minhmo1620 added a commit that referenced this pull request Feb 14, 2025
…in proto (#1533)

Add the rpc definition to allow updateAdminOperationProtocolVersion at cluster's AdminTopicMetadata

This PR is follow-up section for #1418 PR, where we define the HTTP endpoint.
minhmo1620 added a commit that referenced this pull request Feb 18, 2025
#1535)

Add grpc endpoint for updateAdminOperationProtocolVersion
Input: clusterName, target admin operation version we want to set ( -1 for the latest version)
Output: clusterName and updated admin operation version.
This PR only contains the gRPC setup for the endpoint, the main logic can be found in PR #1418
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.

3 participants