Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider renaming events in wait from "reason" to "event" #11

Open
yorugac opened this issue Sep 18, 2024 · 0 comments
Open

Consider renaming events in wait from "reason" to "event" #11

yorugac opened this issue Sep 18, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@yorugac
Copy link
Collaborator

yorugac commented Sep 18, 2024

Right now waiting for Kubernetes events is defined like this:

let err = env.wait({
    kind: "Pod",
    name: "nginx",
    namespace: "default",
    reason: "Started",
});

While "reason" is the name used by Kubernetes for this field, it might also be confusing if one does not remember the exact structure of those events. So it makes sense to rename that field to just "event".

Sample Kubernetes events stream for reference:

NAMESPACE            LAST SEEN   TYPE      REASON              OBJECT                                                           MESSAGE
local-path-storage   27m         Normal    Created             pod/helper-pod-create-pvc-39172e80-a287-4f6c-abdc-fc6ad778d936   Created container helper-pod
local-path-storage   27m         Normal    Started             pod/helper-pod-create-pvc-39172e80-a287-4f6c-abdc-fc6ad778d936   Started container helper-pod

Related issue: #2

@yorugac yorugac added the enhancement New feature or request label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant