statedb: Add REST API for statedb queries #28872
Merged
Conversation
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
joamaki
commented
Oct 30, 2023
72d86e4 to
3ad7e57
Compare
|
/test |
|
I was planning to originally build this on top of #28729 with gRPC so there'd be proper streaming RPC goodness. I decided in the end to split this off from that since we need to have proper discussions on if/how/when to introduce competition to go-swagger/openapi and how we'd migrate. |
3ad7e57 to
f63258f
Compare
qmonnet
approved these changes
Oct 31, 2023
|
/test |
f63258f to
133f769
Compare
65e8844 to
dc13ca1
Compare
tommyp1ckles
approved these changes
Nov 3, 2023
|
/test |
derailed
reviewed
Nov 3, 2023
derailed
reviewed
Nov 3, 2023
derailed
approved these changes
Nov 3, 2023
There was a problem hiding this comment.
@joamaki Thank you for the updates! This is a great addition!
I think the TabWriter may need some TLC ie what if the output warrants custom cols or different columns ordering, etc...
But we can cross that bridge if we ever get there...
dylandreimerink
approved these changes
Nov 6, 2023
dc13ca1 to
6bd1955
Compare
|
/test |
This implements support for remotely querying the contents of StateDB tables
over the REST API. It is implemented in terms of raw queries, e.g. the table,
index names and the key []byte is transferred to the server which then performs
the query against the given table and index. This allows reuse of the Index[Obj, Key]
types and thus provides the same experience as server side:
table := statedb.NewRemoteTable[*tables.Device](client, "devices")
// Query devices by revision, least recently changed objects first.
iter, err := table.LowerBound(ctx, statedb.ByRevision[*tables.Device](0))
for device, revision, ok := iter.Next(); ok; device, revision, ok = iter.Next { ... }
// Find devices by name: all devices that start with "e":
iter, err = table.LowerBound(ctx, tables.DeviceNameIndex("e"))
// Exact matches:
iter, err = table.Get(ctx, tables.DeviceNameIndex("eth0"))
if device, revision, ok := iter.Next(); ok { ... }
On top of this API a generic utility is implemented in cilium-dbg/cmd/statedb.go
to allow adding the ability to pretty-print the contents of any table whose object
implements 'statedb.TableWritable':
// "cilium-dbg statedb devices"
statedbTableCommand[*tables.Device]("devices")
Example output:
root@kind-worker:/home/cilium# cilium statedb devices
Name Index Selected Type MTU HWAddr Flags Addresses
lxc4446c55b3291 8 false veth 1500 46:b9:9b:85:c2:e2 up|broadcast|multicast fe80::44b9:9bff:fe85:c2e2
lo 1 false device 65536 up|loopback 127.0.0.1, ::1
lxc_health 71 false veth 1500 06:d8:63:ff:20:3b up|broadcast|multicast fe80::4d8:63ff:feff:203b
cilium_host 3 false veth 1500 66:e0:0e:19:a6:9f up|broadcast|multicast 10.244.1.186
Since go-swagger does not provide an easy way to implement proper streaming APIs
this does not add support for delete events (DeleteTracker). Implementing this
is more involved and would require registering a DeleteTracker and keeping it alive
with some sort of keepalive mechanism.
Signed-off-by: Jussi Maki <jussi@isovalent.com>
6bd1955 to
4e81177
Compare
|
/test |
nathanjsweet
approved these changes
Nov 8, 2023
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 implements support for remotely querying the contents of StateDB tables over the REST API. It is implemented in terms of raw queries, e.g. the table, index names and the key []byte is transferred to the server which then performs the query against the given table and index. This allows reuse of the Index[Obj, Key] types and thus provides the same experience as server side:
On top of this API a generic utility is implemented in cilium-dbg/cmd/statedb.go to allow adding the ability to pretty-print the contents of any table whose object implements 'statedb.TabWritable':
Example output:
Since go-swagger does not provide an easy way to implement proper streaming APIs this does not add support for delete events (DeleteTracker). Implementing this is more involved and would require registering a DeleteTracker and keeping it alive with some sort of keepalive mechanism.