-
Notifications
You must be signed in to change notification settings - Fork 58
output logs containerwise. #189
Conversation
|
/assign @bbguimaraes @petr-muller @stevekuznetsov |
|
I am confused about the intention of this change. I expected to find a different feature here! :) My understanding is the following:
Can you clarify? How is this related to #185? If it's unrelated, what is this feature (a different issue?). |
|
@bbguimaraes requested the changes, but in the end, it turned out that we will need the feature described in #184. This PR adds a new feature, described in #185. |
TEMPLATES.md
Outdated
| Will output the logs of all the containers in the pod, no matter what the exit code was. | ||
| The value should be `true` to enable this feature. | ||
|
|
||
| `ci-operator.openshift.io/always-show-container-output`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if always-show-container-output is the right name for the annotation (the name was reused from the previous feature, right?). It may be misleading because it looks similar to the always-show-output one but works differently. I don't like the always part - it's not true (always != when pod fails and only if container terminated) and it is what makes it similar to always-show-output.
I am not sure about a good name, though... containers-logged-on-failure ?
TEMPLATES.md
Outdated
|
|
||
| `ci-operator.openshift.io/always-show-container-output`: | ||
| Will output the logs of the specified containers after the pod fails, if | ||
| they are in a terminated state. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Briefly describe the default state somewhere. What containers' output is captured by default?
TEMPLATES.md
Outdated
| they are in a terminated state. | ||
|
|
||
| **Note:** | ||
| To specify multiple containers in `ci-operator.openshift.io/wait-for-container-artifacts` and `ci-operator.openshift.io/always-show-container-output` annotations, the value should be splited by `,`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps include this into the descriptions themselves? This would require rewritting all of them into a different form, but I think it would be worth the improvement.
Comma-separated list of container names for which ci-operator will wait until complete / for which ci-operator will collect and log their output if pod fails
petr-muller
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think the annotation name well represents the feature - we'll need to come up with something better.
Other comments are suggestions.
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: droslean, petr-muller The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Adds the
ci-operator.openshift.io/always-show-container-outputannotation to specify which container logs, will be shown after the pod will fail.closes #185