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-1678: allow agent image configuration #48

Merged
merged 1 commit into from
Jun 5, 2024
Merged

NETOBSERV-1678: allow agent image configuration #48

merged 1 commit into from
Jun 5, 2024

Conversation

jpinsonneau
Copy link
Contributor

@jpinsonneau jpinsonneau commented Jun 5, 2024 •
edited
Loading

Description

  • Configure agent image at build time using AGENT_IMAGE param
$ USER=netobserv VERSION=main AGENT_IMAGE=quay.io/netobserv/netobserv-ebpf-agent:release-1.6 make oc-commands 
### Generating oc commands
DIST_DIR=build \
K8S_CLI_BIN=oc \
IMAGE=quay.io/netobserv/network-observability-cli:main \
PULL_POLICY=Always \
AGENT_IMAGE=quay.io/netobserv/netobserv-ebpf-agent:release-1.6 \
VERSION=main \
./scripts/inject.sh
updating CLI images to quay.io/netobserv/network-observability-cli:main
updating CLI version to main
updating CLI pull policy to Always
updating eBPF agent images to quay.io/netobserv/netobserv-ebpf-agent:release-1.6
updating K8S CLI to oc
prefixing with oc-
pull policy not provided, keeping current ones
output generated in build folder
  • Override agent image at run time using NETOBSERV_AGENT_IMAGE environment variable
$ NETOBSERV_AGENT_IMAGE=quay.io/netobserv/netobserv-ebpf-agent:release-1.6 ./build/oc-netobserv flows

Both will result in custom eBPF agent image set as:

$ oc describe pod netobserv-cli-chz4p -n netobserv-cli
Name:             netobserv-cli-chz4p
Namespace:        netobserv-cli
Containers:
  netobserv-cli:
    Image:          quay.io/netobserv/netobserv-ebpf-agent:release-1.6
...

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).

@openshift-ci-robot
Copy link
Collaborator

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

@jpinsonneau: This pull request references NETOBSERV-1678 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.17.0" version, but no target version was set.

In response to this:

Description

  • Configure agent image at build time using AGENT_IMAGE param
  • Override agent image at run time using NETOBSERV_AGENT_IMAGE environment variable

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.

@openshift-ci-robot
Copy link
Collaborator

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

@jpinsonneau: This pull request references NETOBSERV-1678 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.17.0" version, but no target version was set.

In response to this:

Description

  • Configure agent image at build time using AGENT_IMAGE param
$ USER=netobserv VERSION=main AGENT_IMAGE=quay.io/netobserv/netobserv-ebpf-agent:release-1.6 make oc-commands 
### Generating oc commands
DIST_DIR=build \
K8S_CLI_BIN=oc \
IMAGE=quay.io/netobserv/network-observability-cli:main \
PULL_POLICY=Always \
AGENT_IMAGE=quay.io/netobserv/netobserv-ebpf-agent:release-1.6 \
VERSION=main \
./scripts/inject.sh
updating CLI images to quay.io/netobserv/network-observability-cli:main
updating CLI version to main
updating CLI pull policy to Always
updating eBPF agent images to quay.io/netobserv/netobserv-ebpf-agent:release-1.6
updating K8S CLI to oc
prefixing with oc-
pull policy not provided, keeping current ones
output generated in build folder
  • Override agent image at run time using NETOBSERV_AGENT_IMAGE environment variable
$ NETOBSERV_AGENT_IMAGE=quay.io/netobserv/netobserv-ebpf-agent:release-1.6 ./build/oc-netobserv flows

Both will result in custom eBPF agent image set as:

$ oc describe pod netobserv-cli-chz4p -n netobserv-cli
Name:             netobserv-cli-chz4p
Namespace:        netobserv-cli
Containers:
 netobserv-cli:
   Image:          quay.io/netobserv/netobserv-ebpf-agent:release-1.6
...

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.

@codecov Codecov
Copy link

codecov bot commented Jun 5, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 31.49%. Comparing base (457f0a3) to head (6f84a68).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main      #48   +/-   ##
=======================================
  Coverage   31.49%   31.49%           
=======================================
  Files           5        5           
  Lines         962      962           
=======================================
  Hits          303      303           
  Misses        637      637           
  Partials       22       22
Flag Coverage Δ
unittests 31.49% <ø> (ø)

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

OlivierCazade
OlivierCazade approved these changes Jun 5, 2024
View reviewed changes
Copy link
Contributor

@OlivierCazade OlivierCazade left a comment

Choose a reason for hiding this comment

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

LGTM

Side note, I think this yaml approach will be hard to maintain if we keep adding feature here. Encryption and authentication of the connection between ebpf and cli container come to my mind.

@openshift-ci openshift-ci bot added the lgtm label Jun 5, 2024
@Amoghrd
Copy link

Amoghrd commented Jun 5, 2024

This can be merged, I will test it downstream

@jpinsonneau
Copy link
Contributor Author

LGTM

Side note, I think this yaml approach will be hard to maintain if we keep adding feature here. Encryption and authentication of the connection between ebpf and cli container come to my mind.

That's right ! We can improve using a function or yq as the filters does in a next PR.
Let's just unlock the QA for now

@OlivierCazade
Copy link
Contributor

/approve

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Jun 5, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: OlivierCazade

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

@jpinsonneau jpinsonneau mentioned this pull request Jun 5, 2024
Merged
@openshift-merge-bot openshift-merge-bot bot merged commit 90239f0 into netobserv:main Jun 5, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OlivierCazade OlivierCazade OlivierCazade approved these changes

Assignees

@OlivierCazade OlivierCazade

Labels
approved jira/valid-reference lgtm
Projects
None yet
Milestone
No milestone
Development

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