-
Notifications
You must be signed in to change notification settings - Fork 51
DOC-1790: Schema Registry Metadata Properties #1690
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
Merged
Feediver1
merged 21 commits into
main
from
DOC-1790-schema-registry-metadata-properties
May 13, 2026
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
db82355
DOC-1790: Document Schema Registry metadata properties
Feediver1 179c436
DOC-1790: Fix rpk metadata-properties flag documentation
Feediver1 8c4eadf
Apply suggestions from code review
Feediver1 f38a452
Apply suggestion from @Feediver1
Feediver1 1872412
Apply suggestion from @Feediver1
Feediver1 6a2e5d7
DOC-1790: Add -p/--metadata-properties flag to rpk schema create refe…
Feediver1 8943177
Apply suggestion from @Feediver1
Feediver1 a77d489
DOC-1790: Address review feedback
Feediver1 3798bee
Update modules/manage/pages/schema-reg/schema-reg-overview.adoc
Feediver1 2c5ba29
Update modules/manage/pages/schema-reg/schema-reg-overview.adoc
Feediver1 87449c9
Update modules/manage/pages/schema-reg/schema-reg-overview.adoc
Feediver1 c65f454
Apply suggestion from @Feediver1
Feediver1 82cdb89
Merge branch 'main' into DOC-1790-schema-registry-metadata-properties
Feediver1 640cbe6
Update modules/manage/pages/schema-reg/schema-reg-overview.adoc
Feediver1 0507a23
Update modules/manage/pages/schema-reg/schema-reg-overview.adoc
Feediver1 1253413
docs: reorder metadata properties section to pair REST and rpk equiva…
Feediver1 3f6e643
docs: add What's New entry for Schema Registry metadata properties
Feediver1 92e19a0
docs: add missing rpk registry context reference pages to fix build
Feediver1 5710aeb
Merge branch 'main' into DOC-1790-schema-registry-metadata-properties
Feediver1 694f06f
Apply suggestion from @Feediver1
Feediver1 de79273
docs: fix anchor for metadata-properties xref in What's New
Feediver1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
42 changes: 42 additions & 0 deletions
42
modules/reference/pages/rpk/rpk-registry/rpk-registry-context-delete.adoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| = rpk registry context delete | ||
| // tag::single-source[] | ||
|
|
||
| Delete a schema registry context. | ||
|
|
||
| A context can only be deleted once all subjects within it have been hard deleted. Soft-deleted subjects still block context deletion. Use `rpk registry subject delete --permanent` to hard delete subjects first. | ||
|
|
||
| The default context `.` cannot be deleted. | ||
|
|
||
| == Usage | ||
|
|
||
| [,bash] | ||
| ---- | ||
| rpk registry context delete [CONTEXT] [flags] | ||
| ---- | ||
|
|
||
| == Flags | ||
|
|
||
| [cols="1m,1a,2a"] | ||
| |=== | ||
| |*Value* |*Type* |*Description* | ||
|
|
||
| |-h, --help |- |Help for delete. | ||
|
|
||
| |--no-confirm |- |Disable confirmation prompt. | ||
|
|
||
| |--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. | ||
|
|
||
| |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. | ||
|
|
||
| |--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. | ||
|
|
||
| |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. | ||
|
|
||
| |--schema-context |string |Schema context to use for all registry operations. | ||
|
|
||
| |--skip-context-check |- |Skip the admin API verification of schema context support. | ||
|
|
||
| |-v, --verbose |- |Enable verbose logging. | ||
| |=== | ||
|
|
||
| // end::single-source[] |
45 changes: 45 additions & 0 deletions
45
modules/reference/pages/rpk/rpk-registry/rpk-registry-context-list.adoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| = rpk registry context list | ||
| // tag::single-source[] | ||
|
|
||
| List schema registry contexts. | ||
|
|
||
| == Usage | ||
|
|
||
| [,bash] | ||
| ---- | ||
| rpk registry context list [flags] | ||
| ---- | ||
|
|
||
| == Aliases | ||
|
|
||
| [,bash] | ||
| ---- | ||
| list, ls | ||
| ---- | ||
|
|
||
| == Flags | ||
|
|
||
| [cols="1m,1a,2a"] | ||
| |=== | ||
| |*Value* |*Type* |*Description* | ||
|
|
||
| |--format |string |Output format: `json`,`yaml`,`text`,`wide`,`help`. Default: `text`. | ||
|
|
||
| |-h, --help |- |Help for list. | ||
|
|
||
| |--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. | ||
|
|
||
| |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. | ||
|
|
||
| |--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. | ||
|
|
||
| |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. | ||
|
|
||
| |--schema-context |string |Schema context to use for all registry operations. | ||
|
|
||
| |--skip-context-check |- |Skip the admin API verification of schema context support. | ||
|
|
||
| |-v, --verbose |- |Enable verbose logging. | ||
| |=== | ||
|
|
||
| // end::single-source[] |
48 changes: 48 additions & 0 deletions
48
modules/reference/pages/rpk/rpk-registry/rpk-registry-context.adoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| = rpk registry context | ||
| // tag::single-source[] | ||
|
|
||
| Manage schema registry contexts. | ||
|
|
||
| Schema contexts provide namespace isolation within the schema registry, allowing multiple independent sets of subjects and schemas to coexist. | ||
|
|
||
| Before using schema contexts, enable the xref:reference:properties/cluster-properties.adoc#schema_registry_enable_qualified_subjects[`schema_registry_enable_qualified_subjects`] cluster property: | ||
|
|
||
| [,bash] | ||
| ---- | ||
| rpk cluster config set schema_registry_enable_qualified_subjects true | ||
| ---- | ||
|
|
||
| Use the `--schema-context` flag on the parent `registry` command to scope operations to a specific context. | ||
|
|
||
| == Usage | ||
|
|
||
| [,bash] | ||
| ---- | ||
| rpk registry context [flags] | ||
| rpk registry context [command] | ||
| ---- | ||
|
|
||
| == Flags | ||
|
|
||
| [cols="1m,1a,2a"] | ||
| |=== | ||
| |*Value* |*Type* |*Description* | ||
|
|
||
| |-h, --help |- |Help for context. | ||
|
|
||
| |--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`. | ||
|
|
||
| |-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. | ||
|
|
||
| |--ignore-profile |- |Ignore `rpk.yaml` and `redpanda.yaml`; use default settings. | ||
|
|
||
| |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. | ||
|
|
||
| |--schema-context |string |Schema context to use for all registry operations. | ||
|
|
||
| |--skip-context-check |- |Skip the admin API verification of schema context support. | ||
|
|
||
| |-v, --verbose |- |Enable verbose logging. | ||
| |=== | ||
|
|
||
| // end::single-source[] |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.