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-1426: subnet labelling enhancements #586

Merged
merged 1 commit into from
Mar 25, 2024
Merged

NETOBSERV-1426: subnet labelling enhancements #586

merged 1 commit into from
Mar 25, 2024

Conversation

jotak
Copy link
Member

@jotak jotak commented Feb 5, 2024 •
edited
Loading

Description

Breaking change migration guide

E.g., if you have some "add_ip_category" rule defined such as:

        transform:
          type: "network"
          network:
            rules:
            - input: "the_address"
              output: "subnet"
              type: add_ip_category
            ipCategories:
            - cidrs:
              - 101.1.0.0/32
              - 100.1.0.0/16
              name: "MySite.com"

This must be rewritten as:

        transform:
          type: "network"
          network:
            rules:
            - type: add_subnet_label
              add_subnet_label:
                input: "the_address"
                output: "subnet"
            subnetLabels:
            - cidrs:
              - 101.1.0.0/32
              - 100.1.0.0/16
              name: "MySite.com"

Dependencies

#580 (merged)

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.

  • Will this change affect NetObserv / Network Observability operator? If not, you can ignore the rest of this checklist.
  • 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).

@openshift-ci-robot
Copy link
Collaborator

openshift-ci-robot commented Feb 5, 2024 •
edited by openshift-ci bot
Loading

@jotak: This pull request references NETOBSERV-1426 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 story to target the "4.16.0" version, but no target version was set.

In response to this:

Description

Dependencies

#580

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.

  • Will this change affect NetObserv / Network Observability operator? If not, you can ignore the rest of this checklist.
  • 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 added the breaking-change This pull request has breaking changes. They should be described in PR description. label Feb 5, 2024
@codecov Codecov
Copy link

codecov bot commented Feb 5, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 84.00000% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 67.43%. Comparing base (d2b2352) to head (b22cb55).
Report is 1 commits behind head on main.

Files Patch % Lines
pkg/pipeline/transform/transform_network.go 84.00% 2 Missing and 2 partials ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #586      +/-   ##
==========================================
+ Coverage   67.41%   67.43%   +0.01%     
==========================================
  Files         102      102              
  Lines        7589     7593       +4     
==========================================
+ Hits         5116     5120       +4     
  Misses       2162     2162              
  Partials      311      311
Flag Coverage Δ
unittests 67.43% <84.00%> (+0.01%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jotak jotak force-pushed the subnet-labels-next branch from f95f6a3 to 2e5bc67 Compare March 5, 2024 08:52
@jotak jotak requested a review from OlivierCazade March 5, 2024 08:52
@openshift-ci-robot
Copy link
Collaborator

openshift-ci-robot commented Mar 5, 2024 •
edited by openshift-ci bot
Loading

@jotak: This pull request references NETOBSERV-1426 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 story to target the "4.16.0" version, but no target version was set.

In response to this:

Description

Dependencies

#580 (merged)

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.

  • Will this change affect NetObserv / Network Observability operator? If not, you can ignore the rest of this checklist.
  • 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 marked this pull request as ready for review March 5, 2024 08:52
@openshift-ci-robot
Copy link
Collaborator

openshift-ci-robot commented Mar 5, 2024 •
edited by openshift-ci bot
Loading

@jotak: This pull request references NETOBSERV-1426 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 story to target the "4.16.0" version, but no target version was set.

In response to this:

Description

Breaking change migration guide

E.g., if you have some "add_ip_category" rule defined such as:

       transform:
         type: "network"
         network:
           rules:
           - input: "the_address"
             output: "subnet"
             type: add_ip_category
           ipCategories:
           - cidrs:
             - 101.1.0.0/32
             - 100.1.0.0/16
             name: "MySite.com"

This must be rewritten as:

       transform:
         type: "network"
         network:
           rules:
           - type: add_subnet_label
             add_subnet_label:
               input: "the_address"
               output: "subnet"
           subnetLabels:
           - cidrs:
             - 101.1.0.0/32
             - 100.1.0.0/16
             name: "MySite.com"

Dependencies

#580 (merged)

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.

  • Will this change affect NetObserv / Network Observability operator? If not, you can ignore the rest of this checklist.
  • 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 requested a review from jpinsonneau March 25, 2024 09:29
@jotak
Subnet labels: some renaming, allow skipping
b22cb55 
- rename IPCategories -> SubnetLabels
- allow to skip applying labels when a given field is present (in order
  to save space / processing by avoiding redundant information)

Adapt to refactored API

remove skipping option (not useful until proved otherwise)
@jotak jotak force-pushed the subnet-labels-next branch from f079773 to b22cb55 Compare March 25, 2024 09:39
@jotak
Copy link
Member Author

jotak commented Mar 25, 2024

(rebased)

jpinsonneau
jpinsonneau approved these changes Mar 25, 2024
View reviewed changes
Copy link
Collaborator

@jpinsonneau jpinsonneau left a comment

Choose a reason for hiding this comment

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

LGTM in terms of code (not tested)

@openshift-ci openshift-ci bot added the lgtm label Mar 25, 2024
@jotak jotak added no-qe This PR doesn't necessitate QE approval no-doc This PR doesn't require documentation change on the NetObserv operator labels Mar 25, 2024
@jotak
Copy link
Member Author

jotak commented Mar 25, 2024

/approve

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Mar 25, 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-merge-bot openshift-merge-bot bot merged commit 5feb3c6 into netobserv:main Mar 25, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jpinsonneau jpinsonneau jpinsonneau approved these changes

@OlivierCazade OlivierCazade Awaiting requested review from OlivierCazade

Assignees

@jpinsonneau jpinsonneau

Labels
approved breaking-change This pull request has breaking changes. They should be described in PR description. jira/valid-reference lgtm no-doc This PR doesn't require documentation change on the NetObserv operator no-qe This PR doesn't necessitate QE approval
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jotak @openshift-ci-robot @jpinsonneau @openshift-merge-robot