docs: add section on how to identify Workflows #1699
Conversation
github-actions
bot
added
Documentation
|
|
||
| In order to interact with a Workflow in Kalix, we need to assign an *type id* and one or more instance *ids*: | ||
|
|
||
| * *type id* is a unique identifier to the workflow. To define the workflow type id, the workflow class must be annotated with `@TypeId` and have a unique and stable identifier assigned. |
There was a problem hiding this comment.
@aludwiko, here is the point I realised that workflows are sharing the same space as ES entities in the Proxy.
It will be better if we prefix the persistence id for workflows internally (in the proxy) so we are sure that they never conflict (until a user prefixes their own entity type id themselves with the same prefix 🤦 ).
There was a problem hiding this comment.
As discussed, a prefix and a quick deployment are possible, because I'm the only one using this entity on prod (confirmed based on metrics). On the other hand, maybe we should not prefix it and create a separate table for events from workflows. I think it's possible, but I'm not sure about the overall ops cost of such a change.
There was a problem hiding this comment.
Another table would be nicer but increases of ops cost on our side with no real benefit for users. Not only we will need to manage another table, but there are also other things to put in place, like tracking usage, billing, etc.
No description provided.