Dataplane api for mounting unmounting topics #1457
Conversation
weeco
changed the title
Jira: CONSOLE-26
Jira: CONSOLE-26
Jira: CONSOLE-28
| import "google/api/field_behavior.proto"; | ||
| import "protoc-gen-openapiv2/options/annotations.proto"; | ||
|
|
||
| message MountTopicsRequest { |
There was a problem hiding this comment.
not needed strictly for this PR, might be good to get the API docs reviewed by docs team and improve or complete out the API documentation as needed.
| message UpdateMountTaskResponse {} | ||
|
|
||
| service CloudStorageService { | ||
| rpc MountTopics(MountTopicsRequest) returns (MountTopicsResponse) { |
There was a problem hiding this comment.
Could we add a description for CloudStorageService? Something along the lines of "Mount and unmount topics in Redpanda clusters. Requires that you have Tiered Storage enabled." This is the description we're using for the Admin API reference - we can also add links to docs when they're ready for Redpanda Cloud.
| // SourceTopic is the topic name or full reference we want to mount. The full reference | ||
| // must be used in case the same topic exists more than once. This may be the case if | ||
| // the same topic has been unmounted multiple times. List all mountable topics to | ||
| // find the full reference (contains topic name, cluster uuid and revision). |
There was a problem hiding this comment.
| // find the full reference (contains topic name, cluster uuid and revision). | |
| // find the full reference (contains topic name, cluster UUID, and revision). |
Will users also need to use the format <topic-name>/<cluster-uuid>/<initial-revision> as with the admin API? Would be good to specify in the field description... we could provide an example as well.
There was a problem hiding this comment.
Yes they would, they would retrieve the reference in the right format by listing the mountable topics. They wouldn't construct the reference themselves
| message MountTask { | ||
| message Topic { | ||
| // The topic reference within the current cluster, which may be either a simple topic name or a full reference | ||
| // in the form: cluster-uuid/topic-name/revision. |
There was a problem hiding this comment.
Is it cluster-uuid first or topic-name?
|
|
||
| message UpdateMountTaskRequest { | ||
| enum Action { | ||
| ACTION_UNSPECIFIED = 0; |
There was a problem hiding this comment.
Are users expected to "manually" update the mount/unmount with these actions each time they want it to progress?
There was a problem hiding this comment.
I think this is only needed in cases where they have been issues. Probably guided by support in that case.
|
The latest Buf updates on your PR. Results from workflow Buf CI / push-module (pull_request).
|
weeco
deleted the
CONSOLE-25-dataplane-api-for-mounting-unmounting-topics
branch
No description provided.