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.

Sign up for GitHub

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

Jump to bottom

NETOBSERV-1893: fix netobserv-mertics-reader role creation #799

Merged
merged 2 commits into from
Oct 3, 2024
Merged

NETOBSERV-1893: fix netobserv-mertics-reader role creation #799

merged 2 commits into from
Oct 3, 2024

Conversation

jotak
Copy link
Member

@jotak jotak commented Oct 2, 2024

Prevent undesired mutation of the role by copying it before use.

Dependencies

n/a

Checklist

If you are not familiar with our processes or don't know what to answer in the list below, let us know in a comment: the maintainers will take care of that.

  • Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • Does this PR require product documentation?
    • If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • Does this PR require a product release notes entry?
    • If so, fill in "Release Note Text" in the JIRA.
  • Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
    • If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
    • Standard QE validation, with pre-merge tests unless stated otherwise.
    • Regression tests only (e.g. refactoring with no user-facing change).
    • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

@jotak
NETOBSERV-1893: fix netobserv-mertics-reader role creation
e481bdd 
Prevent undesired mutation of the role by copying it before use.
@openshift-ci-robot
Copy link
Collaborator

openshift-ci-robot commented Oct 2, 2024 •
edited by openshift-ci bot
Loading

@jotak: This pull request references NETOBSERV-1893 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.18.0" version, but no target version was set.

In response to this:

Prevent undesired mutation of the role by copying it before use.

Dependencies

n/a

Checklist

If you are not familiar with our processes or don't know what to answer in the list below, let us know in a comment: the maintainers will take care of that.

  • Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • Does this PR require product documentation?
  • If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • Does this PR require a product release notes entry?
  • If so, fill in "Release Note Text" in the JIRA.
  • Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
  • If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
  • Standard QE validation, with pre-merge tests unless stated otherwise.
  • Regression tests only (e.g. refactoring with no user-facing change).
  • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

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 openshift-eng/jira-lifecycle-plugin repository.

@jotak jotak mentioned this pull request Oct 2, 2024
Merged
10 tasks
@Amoghrd
Copy link
Contributor

Amoghrd commented Oct 2, 2024

/ok-to-test

@openshift-ci openshift-ci bot added the ok-to-test To set manually when a PR is safe to test. Triggers image build on PR. label Oct 2, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 2, 2024

New images:

  • quay.io/netobserv/network-observability-operator:ded0f3e
  • quay.io/netobserv/network-observability-operator-bundle:v0.0.0-ded0f3e
  • quay.io/netobserv/network-observability-operator-catalog:v0.0.0-ded0f3e

They will expire after two weeks.

To deploy this build:

# Direct deployment, from operator repo
IMAGE=quay.io/netobserv/network-observability-operator:ded0f3e make deploy

# Or using operator-sdk
operator-sdk run bundle quay.io/netobserv/network-observability-operator-bundle:v0.0.0-ded0f3e

Or as a Catalog Source:

apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: netobserv-dev
  namespace: openshift-marketplace
spec:
  sourceType: grpc
  image: quay.io/netobserv/network-observability-operator-catalog:v0.0.0-ded0f3e
  displayName: NetObserv development catalog
  publisher: Me
  updateStrategy:
    registryPoll:
      interval: 1m

@codecov Codecov
Copy link

codecov bot commented Oct 2, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.62%. Comparing base (bcb5777) to head (dcc8e66).
Report is 3 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #799      +/-   ##
==========================================
+ Coverage   66.47%   66.62%   +0.14%     
==========================================
  Files          74       75       +1     
  Lines        8693     8726      +33     
==========================================
+ Hits         5779     5814      +35     
+ Misses       2503     2500       -3     
- Partials      411      412       +1
Flag Coverage Δ
unittests 66.62% <100.00%> (+0.14%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
controllers/flp/flp_controller.go 66.33% <100.00%> (+0.17%) ⬆️
pkg/loki/roles.go 100.00% <100.00%> (ø)
pkg/resources/static_resources.go 100.00% <100.00%> (ø)

... and 3 files with indirect coverage changes

@Amoghrd
Copy link
Contributor

Amoghrd commented Oct 2, 2024

/label qe-approved

@openshift-ci openshift-ci bot added the qe-approved QE has approved this pull request label Oct 2, 2024
@openshift-ci-robot
Copy link
Collaborator

openshift-ci-robot commented Oct 2, 2024 •
edited by openshift-ci bot
Loading

@jotak: This pull request references NETOBSERV-1893 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.18.0" version, but no target version was set.

In response to this:

Prevent undesired mutation of the role by copying it before use.

Dependencies

n/a

Checklist

If you are not familiar with our processes or don't know what to answer in the list below, let us know in a comment: the maintainers will take care of that.

  • Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • Does this PR require product documentation?
  • If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • Does this PR require a product release notes entry?
  • If so, fill in "Release Note Text" in the JIRA.
  • Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
  • If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
  • Standard QE validation, with pre-merge tests unless stated otherwise.
  • Regression tests only (e.g. refactoring with no user-facing change).
  • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

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 openshift-eng/jira-lifecycle-plugin repository.

msherif1234
msherif1234 reviewed Oct 2, 2024
View reviewed changes
controllers/flp/flp_controller.go Outdated
// Install netobserv-metrics-reader role
return r.ReconcileClusterRole(ctx, &resources.PromReaderCR)
// Install netobserv-metrics-reader role; copy to avoid any undesired mutation
cr := resources.PromReaderCR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do u need deepCopy here ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's not strictly needed today but it's right that it would be safer in case we add more mutations later...
or alternatively we can have PromReaderCR being a function, rather than a global var

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@msherif1234 changed to use a function

@openshift-ci openshift-ci bot added the lgtm label Oct 2, 2024
@jotak
Change ClusterRoles to be provided as functions
dcc8e66 
This is to avoid keeping reference to old / potentially mutated objects.
@openshift-ci openshift-ci bot removed the lgtm label Oct 2, 2024
@github-actions github-actions bot removed the ok-to-test To set manually when a PR is safe to test. Triggers image build on PR. label Oct 2, 2024
@msherif1234
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm label Oct 2, 2024
@Amoghrd
Copy link
Contributor

Amoghrd commented Oct 2, 2024

/ok-to-test

@openshift-ci openshift-ci bot added the ok-to-test To set manually when a PR is safe to test. Triggers image build on PR. label Oct 2, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 2, 2024

New images:

  • quay.io/netobserv/network-observability-operator:5e28435
  • quay.io/netobserv/network-observability-operator-bundle:v0.0.0-5e28435
  • quay.io/netobserv/network-observability-operator-catalog:v0.0.0-5e28435

They will expire after two weeks.

To deploy this build:

# Direct deployment, from operator repo
IMAGE=quay.io/netobserv/network-observability-operator:5e28435 make deploy

# Or using operator-sdk
operator-sdk run bundle quay.io/netobserv/network-observability-operator-bundle:v0.0.0-5e28435

Or as a Catalog Source:

apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: netobserv-dev
  namespace: openshift-marketplace
spec:
  sourceType: grpc
  image: quay.io/netobserv/network-observability-operator-catalog:v0.0.0-5e28435
  displayName: NetObserv development catalog
  publisher: Me
  updateStrategy:
    registryPoll:
      interval: 1m

@Amoghrd
Copy link
Contributor

Amoghrd commented Oct 2, 2024

LGTM

@jotak
Copy link
Member Author

jotak commented Oct 3, 2024

/approve

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Oct 3, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jotak

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:

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

@openshift-ci openshift-ci bot added the approved label Oct 3, 2024
@openshift-merge-bot openshift-merge-bot bot merged commit efe1407 into netobserv:main Oct 3, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@msherif1234 msherif1234 msherif1234 left review comments

@OlivierCazade OlivierCazade OlivierCazade approved these changes

@jpinsonneau jpinsonneau Awaiting requested review from jpinsonneau

Assignees

@msherif1234 msherif1234

@OlivierCazade OlivierCazade

Labels
approved jira/valid-reference lgtm ok-to-test To set manually when a PR is safe to test. Triggers image build on PR. qe-approved QE has approved this pull request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jotak @openshift-ci-robot @Amoghrd @msherif1234 @OlivierCazade