fix: include message from restate in admin API errors#100
Merged
Conversation
if you registered a deployment that included breaking changes, then the admin API call would fail (because the operator doesn't pass --force or --breaking), however the error message was unclear because it didn't include the helpful message returned from restate, and it was only discoverable in the status subresource, it wasn't logged. - added a new error variant for admin API rejections - added a helper that extracts the message out of the response body - use that helper for all admin API call sites - log the error when it happens and emit a k8s event this scenario is now much easier to discover; by looking at the logs, at `describe` or `get events`.
|
All contributors have signed the CLA ✍️ ✅ |
Contributor
Author
|
I have read the CLA Document and I hereby sign the CLA |
tillrohrmann
approved these changes
Mar 19, 2026
Contributor
tillrohrmann
left a comment
tillrohrmann
left a comment
There was a problem hiding this comment.
Thanks a lot for creating this PR @lukebond. The changes look good to me. Great to have improved error reporting with the operator :-). +1 for merging.
| action: "Reconcile".into(), | ||
| secondary: None, | ||
| }, | ||
| &self.object_ref(&()), |
There was a problem hiding this comment.
self.object_ref() is this RestateDeployment right? so it means that doing kubectl describe restatedeployment/my-dep will show the error right?
Contributor
Author
There was a problem hiding this comment.
also get events will show it
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
if you registered a deployment that included breaking changes, then the admin API call would fail (because the operator doesn't pass --force or --breaking), however the error message was unclear because it didn't include the helpful message returned from restate, and it was only discoverable in the status subresource, it wasn't logged.
this scenario is now much easier to discover; by looking at the logs, at
describeorget events.i tested this by spinning up a kind cluster and registering a service that would return an error from the admin API. it emitted the event and logged it.
we really need better tests, so i filed #101.