Pod exec enhancements #328
Merged
Conversation
This file contains 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
Rework this example to be closer to the one provided by the official kubernetes python api. The busybox pod is now created if it does not exist, making the example easier to use. Also, use contexts to ensure resources are properly released. This prepares the work for next commits that will add more cases in this pod_exec example. Signed-off-by: Olivier Matz <[email protected]>
olivier-matz-6wind
force-pushed
the
pod-exec
branch
2 times, most recently
from
c5544ee
to
d7ec65d
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #328 +/- ##
==========================================
+ Coverage 28.11% 28.12% +0.01%
==========================================
Files 779 779
Lines 92138 92153 +15
==========================================
+ Hits 25904 25919 +15
Misses 66234 66234 ☔ View full report in Codecov by Sentry. |
tomplus
requested changes
Aug 8, 2024
Thank you for the feedback! |
When the websocket API is used to execute a command on a pod, the status is sent over the ERROR_CHANNEL on termination. Add a helper to parse this information that returns the exit code of the command. This helper can only be used if _preload_content=False. The pod_exec example will be updated in next commit to make use of this new helper. Signed-off-by: Olivier Matz <[email protected]>
Introduce an example that shows how the WsApiClient can be used to interactively execute a command on a pod. The example is similar to what is done in the official kubernetes python api. Signed-off-by: Olivier Matz <[email protected]>
The ClientSession.ws_connect() method is synchronous and returns a _RequestContextManager which takes a coroutine as parameter (here, ClientSession._ws_connect()). This context manager is in charge of closing the connection in its __aexit__() method, so it has to be used with "async with". However, this context manager can also be awaited as it has an __await__() method. In this case, it will await the _ws_connect() coroutine. This is what is done in the current code, but the connection will not be released. Remove the "await" to return the context manager, so that the user can use it with "async with", which will properly release resources. This is the documented way of using ws_connect(): https://docs.aiohttp.org/en/stable/client_quickstart.html#websockets Signed-off-by: Olivier Matz <[email protected]>
olivier-matz-6wind
force-pushed
the
pod-exec
branch
from
d7ec65d
to
c3a3128
Compare
tomplus
approved these changes
Aug 9, 2024
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 draft pull request provides some enhancements to the pod_exec example and ws API.
The last commit is an API break, so you may not want it.
Comments welcome, of course!
Fixes #322