Schema Migrations: wire in paused field into rpk#31077
Merged
Merged
Conversation
The core protobuf module now carries the paused field on ShadowSchemaRegistryApi. Bump the go.mod dependency and the matching buf.gen.yaml commit pin in lockstep (TestBufGenYamlCoreModuleVersion guards the two against drift) and regenerate the proto comments.
pgellert
requested review from
a team,
Copilot and
nguyen-andrew
and removed request for
a team
pgellert
requested review from
bartoszpiekny-redpanda
and removed request for
nguyen-andrew
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates rpk’s admin/v2 protobuf dependency and wires the new paused field for API-mode Schema Registry shadowing through rpk’s config types, mapping layer, and rpk shadow describe output, aligning rpk with the server-side schema introduced in the referenced follow-up work.
Changes:
- Add
pausedto rpk’sShadowSchemaRegistryAPIconfig model (JSON/YAML) and unmarshal tests. - Map
pausedto/from the adminv2 protobuf (SchemaRegistrySyncOptions_ShadowSchemaRegistryApi) and validate via mapper tests. - Surface
pausedinrpk shadow describe(table output + structured JSON/YAML describe output) and refresh protobuf inputs / generated comments.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/go/rpk/pkg/cli/shadow/types.go | Adds Paused to the Schema Registry API shadow config struct with JSON/YAML tags and inline docs. |
| src/go/rpk/pkg/cli/shadow/types_test.go | Extends YAML/JSON unmarshal coverage to include paused: true for SR API mode. |
| src/go/rpk/pkg/cli/shadow/mapper.go | Maps Paused into/out of the adminv2 protobuf message for SR API mode. |
| src/go/rpk/pkg/cli/shadow/mapper_test.go | Updates mapping tests to assert paused round-trips correctly. |
| src/go/rpk/pkg/cli/shadow/describe.go | Prints PAUSED in rpk shadow describe for SR API mode and includes it in structured describe output. |
| src/go/rpk/go.mod | Bumps the buf.build/.../core/protocolbuffers dependency to a version that includes the new field. |
| src/go/rpk/go.sum | Updates checksums for the bumped protobuf dependency version. |
| src/go/rpk/gen/protocomments/admin/v2/comments.pb.go | Adds extracted protobuf field comment text for the new paused field. |
| buf.gen.yaml | Updates the buf input module reference to the commit that contains the new proto field. |
Files not reviewed (1)
- src/go/rpk/gen/protocomments/admin/v2/comments.pb.go: Generated file
bartoszpiekny-redpanda
approved these changes
Jul 13, 2026
Surface the API-mode Schema Registry paused control in rpk, mirroring the topic/consumer-offset/security/role sync options: add the field to the user-facing config, map it both directions, and render it in describe. Placement follows the sibling sync tasks (paused printed at the top of the section, field near the top of the config struct). Tested via the YAML/JSON unmarshal round-trips, the map/toCfg fixtures, and TestShadowLinkConfigDrift, which walks the proto descriptor and fails if the config struct is missing a field the proto carries.
pgellert
force-pushed
the
slsr/rpk-sr-paused
branch
from
81998d0 to
303068c
Compare
Contributor
Author
|
force-push: noop to retry snyk devex scan |
r-vasquez
approved these changes
Jul 13, 2026
bartoszpiekny-redpanda
approved these changes
Jul 13, 2026
Collaborator
Collaborator
Retry command for Build#87060please wait until all jobs are finished before running the slash command |
Contributor
Author
|
/ci-repeat 1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the protobuf library rpk uses and surfaces the
pausedfield of the config inrpk shadow describeoutputs. Follow-up to #30984.Backports Required
Release Notes