refactor: Returning error on calling GetContainerEvents() while enable_pod_events of runtime is disabled #7257

MdSahil-oss · 2023-08-29T09:00:05Z

What type of PR is this?

/kind bug

What this PR does / why we need it:

This PR adds an error message to return on calling GetContainerEvents() while enable_pod_events of runtime is disabled.

Which issue(s) this PR fixes:

#7164

Special notes for your reviewer:

Does this PR introduce a user-facing change?

the GetContainerEvents endpoint now errors when the `enable_pod_events` config field is false

openshift-ci · 2023-08-29T09:00:22Z

Hi @MdSahil-oss. Thanks for your PR.

I'm waiting for a cri-o member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

codecov · 2023-08-29T09:29:12Z

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 49.23%. Comparing base (8ea1256) to head (59f5f15).
Report is 1567 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7257   +/-   ##
=======================================
  Coverage   49.23%   49.23%           
=======================================
  Files         136      136           
  Lines       15575    15575           
=======================================
+ Hits         7668     7669    +1     
+ Misses       7000     6999    -1     
  Partials      907      907

haircommander · 2023-08-29T13:08:07Z

I should have thought of this! So yes, you do need to enable the config field to get the events. I don't think this should be enabled by default yet until it is in upstream k8s. Nice investigation

haircommander · 2023-08-29T18:28:37Z

server/container_events.go

+		return fmt.Errorf(
+			`pods are not enabled to produce container events,
+			 please enable enable_pod_events of runtime to enabling pods for producing container events`,
+		)


@harche @sairameshv WDYT? We will fail later anyway so we mine as well return early

haircommander · 2023-08-29T18:30:01Z

server/container_events.go

@@ -16,7 +17,10 @@ type containerEventConn struct {
 // GetContainerEvents sends the stream of container events to clients
 func (s *Server) GetContainerEvents(_ *types.GetEventsRequest, ces types.RuntimeService_GetContainerEventsServer) error {
 	if !s.Config().EnablePodEvents {
-		return nil
+		return fmt.Errorf(
+			`pods are not enabled to produce container events,


can you remove the newline please?
also: suggest a reword:

enable_pod_events is false. Set to true to produce container events

Done 👍🏽

…e_pod_events of runtime is disabled Signed-off-by: Md Sahil <mohdssahil1@gmail.com>

sairameshv

/lgtm

haircommander · 2023-08-30T14:29:45Z

/ok-to-test
/retest
/approve

openshift-ci · 2023-08-30T14:29:54Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: haircommander, MdSahil-oss

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [haircommander]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

sohankunkerkar · 2023-09-26T13:44:29Z

/retest

github-actions · 2023-10-27T00:02:35Z