Add to vendors_default the possibility to add values for IstioCNI by fjglira · Pull Request #845 · istio-ecosystem/sail-operator

fjglira · 2025-05-22T20:19:36Z

What type of PR is this?

What this PR does / why we need it:

As mentioned in the issue, this PR adds the possibility to add to the vendors_default.yaml both Istio and IstioCNI specific default values, adding the possibility for users to execute the run e2e test using this custom configuration. Also, the PR adds information in the docs to help users understand how to run this specific configuration, how to execute the test against specific istio versions, and how to understand the test result from the e2e framework.

Which issue(s) this PR fixes:

Fixes #838

Related Issue/PR #

Additional information:

codecov · 2025-05-22T20:25:32Z

Codecov Report

Attention: Patch coverage is 70.58824% with 15 lines in your changes missing coverage. Please review.

Project coverage is 76.31%. Comparing base (b803a43) to head (96b3539).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
pkg/istiovalues/vendor_defaults.go	73.33%	8 Missing and 4 partials ⚠️
controllers/istiocni/istiocni_controller.go	40.00%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #845      +/-   ##
==========================================
- Coverage   76.32%   76.31%   -0.02%     
==========================================
  Files          44       44              
  Lines        2640     2685      +45     
==========================================
+ Hits         2015     2049      +34     
- Misses        536      543       +7     
- Partials       89       93       +4

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

fjglira · 2025-05-22T20:40:11Z

I'll check on Monday to increase code coverage for the vendor default

MaxBab · 2025-05-26T15:59:24Z

tests/e2e/README.md

+```
+
+### Understanding the test output
+By default, if you run the test using the make target, it will be generated a `report.xml` file the root directoyry of the project. This file contains the test results in JUnit format. For example the file will contain the following:


Could you rephrase the sentence?

Everything else looks good.

fjglira · 2025-05-26T16:56:15Z

I'm seeing some things over the default vendor values, checking to see if it's the expected behaviour or do I need to do a change

fjglira · 2025-05-27T08:35:13Z

I expect the unit test to fail because of this bug, once it is merged, I'll rebase and they will pass again

tests/e2e/README.md

dgn · 2025-06-02T09:06:49Z

tests/e2e/README.md

+#### Running with specific configuration for the Istio and IstioCNI resource
+It can be cases where you want to run the test with a specific configuration for the Istio and IstioCNI resource to match some cluster specific needs. For this, you can modify the `pkg/istiovalues/vendor_default.yaml`file to default `spec.values` for the Istio and IstioCNI resources. 
+
+This file will be used by the operator to set specific `spec.values` for the Istio and IstioCNI resources. Example:


we're already explaining this in the vendor_defaults.yaml file, should we just link to that? I'm worried we're duplicating information with the risk of one getting outdated

Signed-off-by: Francisco H <frherrer@redhat.com>

* skip succeeded pods Signed-off-by: Gergo Huszty <gergo.huszty@ibm.com> * ut added to verify succeeded pods are skipped Signed-off-by: Gergo Huszty <gergo.huszty@ibm.com> --------- Signed-off-by: Gergo Huszty <gergo.huszty@ibm.com> Signed-off-by: Francisco H <frherrer@redhat.com>

Signed-off-by: Daniel Grimm <dgrimm@redhat.com> Signed-off-by: Francisco H <frherrer@redhat.com>

Signed-off-by: Francisco H <frherrer@redhat.com>

Co-authored-by: Daniel Grimm <dgrimm@redhat.com> Signed-off-by: Francisco H <frherrer@redhat.com>

Signed-off-by: Francisco H <frherrer@redhat.com>

* upstream/main: Update github action for broken links (istio-ecosystem#888) Fix "Check broken link" workflow (istio-ecosystem#887) Split Documentation: splitting docs, adding table of content and fixing links (istio-ecosystem#881) Do not block the workflow on errors when publishing to operatorhub.io (istio-ecosystem#877) chore(docs): cleans up IstioCNI section (istio-ecosystem#867) Force push to operator hub fork (istio-ecosystem#873) Make a yaml linter in the community-operators-prod happy (istio-ecosystem#869) Adding description for release workflow run (istio-ecosystem#868) Docs: adding istiod HA documentations (istio-ecosystem#865) Add to vendors_default the possibility to add values for IstioCNI (istio-ecosystem#845) Updates release and nightly-images GH workflows to work with new FBC used in community-operators-prod (istio-ecosystem#854) Simplify logic when using `KEEP_ON_FAILURE` (istio-ecosystem#858) Add KEEP_ON_FAILURE flag to e2e kind tests (istio-ecosystem#832) switch to ubi-micro (istio-ecosystem#856) Speed up docs tests by running on a single cluster (istio-ecosystem#855) Add misspell to do basic spell validation in our docs (istio-ecosystem#853)

* upstream/main: Enchance debug information when e2e fails: add istioctl proxy status (istio-ecosystem#891) Update github action for broken links (istio-ecosystem#888) Fix "Check broken link" workflow (istio-ecosystem#887) Split Documentation: splitting docs, adding table of content and fixing links (istio-ecosystem#881) Do not block the workflow on errors when publishing to operatorhub.io (istio-ecosystem#877) chore(docs): cleans up IstioCNI section (istio-ecosystem#867) Force push to operator hub fork (istio-ecosystem#873) Make a yaml linter in the community-operators-prod happy (istio-ecosystem#869) Adding description for release workflow run (istio-ecosystem#868) Docs: adding istiod HA documentations (istio-ecosystem#865) Add to vendors_default the possibility to add values for IstioCNI (istio-ecosystem#845) Updates release and nightly-images GH workflows to work with new FBC used in community-operators-prod (istio-ecosystem#854) Simplify logic when using `KEEP_ON_FAILURE` (istio-ecosystem#858) Add KEEP_ON_FAILURE flag to e2e kind tests (istio-ecosystem#832) switch to ubi-micro (istio-ecosystem#856) Speed up docs tests by running on a single cluster (istio-ecosystem#855) Add misspell to do basic spell validation in our docs (istio-ecosystem#853)

…tio-ecosystem#845) * Add to vendors_default the possibility to add values for istiocni Signed-off-by: Francisco H <frherrer@redhat.com> * Fix lint Signed-off-by: Francisco H <frherrer@redhat.com> * Update test for vendors default Signed-off-by: Francisco H <frherrer@redhat.com> * Adding code coverage: new unit test over istiocni controller Signed-off-by: Francisco H <frherrer@redhat.com> * Update read me Signed-off-by: Francisco H <frherrer@redhat.com> * Skip succeeded (istio-ecosystem#842) * skip succeeded pods Signed-off-by: Gergo Huszty <gergo.huszty@ibm.com> * ut added to verify succeeded pods are skipped Signed-off-by: Gergo Huszty <gergo.huszty@ibm.com> --------- Signed-off-by: Gergo Huszty <gergo.huszty@ibm.com> Signed-off-by: Francisco H <frherrer@redhat.com> * enhancements: use issue ID's as SEP numbers (istio-ecosystem#849) Signed-off-by: Daniel Grimm <dgrimm@redhat.com> Signed-off-by: Francisco H <frherrer@redhat.com> * Add unit test Signed-off-by: Francisco H <frherrer@redhat.com> * Update tests/e2e/README.md Co-authored-by: Daniel Grimm <dgrimm@redhat.com> Signed-off-by: Francisco H <frherrer@redhat.com> * Update read me from review Signed-off-by: Francisco H <frherrer@redhat.com> --------- Signed-off-by: Francisco H <frherrer@redhat.com> Signed-off-by: Gergo Huszty <gergo.huszty@ibm.com> Signed-off-by: Daniel Grimm <dgrimm@redhat.com> Co-authored-by: Gergo Huszty <gergo.huszty@digitaltrip.hu> Co-authored-by: Daniel Grimm <dgrimm@redhat.com>

* upstream/main: Improve e2e test cleanup by recording & cleaning up (istio-ecosystem#889) Enchance debug information when e2e fails: add istioctl proxy status (istio-ecosystem#891) Update github action for broken links (istio-ecosystem#888) Fix "Check broken link" workflow (istio-ecosystem#887) Split Documentation: splitting docs, adding table of content and fixing links (istio-ecosystem#881) Do not block the workflow on errors when publishing to operatorhub.io (istio-ecosystem#877) chore(docs): cleans up IstioCNI section (istio-ecosystem#867) Force push to operator hub fork (istio-ecosystem#873) Make a yaml linter in the community-operators-prod happy (istio-ecosystem#869) Adding description for release workflow run (istio-ecosystem#868) Docs: adding istiod HA documentations (istio-ecosystem#865) Add to vendors_default the possibility to add values for IstioCNI (istio-ecosystem#845) Updates release and nightly-images GH workflows to work with new FBC used in community-operators-prod (istio-ecosystem#854) Simplify logic when using `KEEP_ON_FAILURE` (istio-ecosystem#858) Add KEEP_ON_FAILURE flag to e2e kind tests (istio-ecosystem#832) switch to ubi-micro (istio-ecosystem#856) Speed up docs tests by running on a single cluster (istio-ecosystem#855) Add misspell to do basic spell validation in our docs (istio-ecosystem#853)

* upstream/main: Consolidate multicluster operator deploy/cleanup (istio-ecosystem#902) Improve e2e test cleanup by recording & cleaning up (istio-ecosystem#889) Enchance debug information when e2e fails: add istioctl proxy status (istio-ecosystem#891) Update github action for broken links (istio-ecosystem#888) Fix "Check broken link" workflow (istio-ecosystem#887) Split Documentation: splitting docs, adding table of content and fixing links (istio-ecosystem#881) Do not block the workflow on errors when publishing to operatorhub.io (istio-ecosystem#877) chore(docs): cleans up IstioCNI section (istio-ecosystem#867) Force push to operator hub fork (istio-ecosystem#873) Make a yaml linter in the community-operators-prod happy (istio-ecosystem#869) Adding description for release workflow run (istio-ecosystem#868) Docs: adding istiod HA documentations (istio-ecosystem#865) Add to vendors_default the possibility to add values for IstioCNI (istio-ecosystem#845) Updates release and nightly-images GH workflows to work with new FBC used in community-operators-prod (istio-ecosystem#854) Simplify logic when using `KEEP_ON_FAILURE` (istio-ecosystem#858) Add KEEP_ON_FAILURE flag to e2e kind tests (istio-ecosystem#832) switch to ubi-micro (istio-ecosystem#856) Speed up docs tests by running on a single cluster (istio-ecosystem#855) Add misspell to do basic spell validation in our docs (istio-ecosystem#853)

* upstream/main: Fix log message for cleaner when waiting (istio-ecosystem#903) Consolidate multicluster operator deploy/cleanup (istio-ecosystem#902) Improve e2e test cleanup by recording & cleaning up (istio-ecosystem#889) Enchance debug information when e2e fails: add istioctl proxy status (istio-ecosystem#891) Update github action for broken links (istio-ecosystem#888) Fix "Check broken link" workflow (istio-ecosystem#887) Split Documentation: splitting docs, adding table of content and fixing links (istio-ecosystem#881) Do not block the workflow on errors when publishing to operatorhub.io (istio-ecosystem#877) chore(docs): cleans up IstioCNI section (istio-ecosystem#867) Force push to operator hub fork (istio-ecosystem#873) Make a yaml linter in the community-operators-prod happy (istio-ecosystem#869) Adding description for release workflow run (istio-ecosystem#868) Docs: adding istiod HA documentations (istio-ecosystem#865) Add to vendors_default the possibility to add values for IstioCNI (istio-ecosystem#845) Updates release and nightly-images GH workflows to work with new FBC used in community-operators-prod (istio-ecosystem#854) Simplify logic when using `KEEP_ON_FAILURE` (istio-ecosystem#858) Add KEEP_ON_FAILURE flag to e2e kind tests (istio-ecosystem#832) switch to ubi-micro (istio-ecosystem#856) Speed up docs tests by running on a single cluster (istio-ecosystem#855) Add misspell to do basic spell validation in our docs (istio-ecosystem#853)

* upstream/main: (21 commits) Annotate only our clusters when using kind (istio-ecosystem#904) Fix log message for cleaner when waiting (istio-ecosystem#903) Consolidate multicluster operator deploy/cleanup (istio-ecosystem#902) Improve e2e test cleanup by recording & cleaning up (istio-ecosystem#889) Enchance debug information when e2e fails: add istioctl proxy status (istio-ecosystem#891) Update github action for broken links (istio-ecosystem#888) Fix "Check broken link" workflow (istio-ecosystem#887) Split Documentation: splitting docs, adding table of content and fixing links (istio-ecosystem#881) Do not block the workflow on errors when publishing to operatorhub.io (istio-ecosystem#877) chore(docs): cleans up IstioCNI section (istio-ecosystem#867) Force push to operator hub fork (istio-ecosystem#873) Make a yaml linter in the community-operators-prod happy (istio-ecosystem#869) Adding description for release workflow run (istio-ecosystem#868) Docs: adding istiod HA documentations (istio-ecosystem#865) Add to vendors_default the possibility to add values for IstioCNI (istio-ecosystem#845) Updates release and nightly-images GH workflows to work with new FBC used in community-operators-prod (istio-ecosystem#854) Simplify logic when using `KEEP_ON_FAILURE` (istio-ecosystem#858) Add KEEP_ON_FAILURE flag to e2e kind tests (istio-ecosystem#832) switch to ubi-micro (istio-ecosystem#856) Speed up docs tests by running on a single cluster (istio-ecosystem#855) ...

…) (#897) * Add to vendors_default the possibility to add values for istiocni * Fix lint * Update test for vendors default * Adding code coverage: new unit test over istiocni controller * Update read me * Skip succeeded (#842) * skip succeeded pods * ut added to verify succeeded pods are skipped --------- * enhancements: use issue ID's as SEP numbers (#849) * Add unit test * Update tests/e2e/README.md * Update read me from review --------- Signed-off-by: Francisco H <frherrer@redhat.com> Signed-off-by: Gergo Huszty <gergo.huszty@ibm.com> Signed-off-by: Daniel Grimm <dgrimm@redhat.com> Co-authored-by: Gergo Huszty <gergo.huszty@digitaltrip.hu> Co-authored-by: Daniel Grimm <dgrimm@redhat.com>

* upstream/main: (21 commits) Annotate only our clusters when using kind (istio-ecosystem#904) Fix log message for cleaner when waiting (istio-ecosystem#903) Consolidate multicluster operator deploy/cleanup (istio-ecosystem#902) Improve e2e test cleanup by recording & cleaning up (istio-ecosystem#889) Enchance debug information when e2e fails: add istioctl proxy status (istio-ecosystem#891) Update github action for broken links (istio-ecosystem#888) Fix "Check broken link" workflow (istio-ecosystem#887) Split Documentation: splitting docs, adding table of content and fixing links (istio-ecosystem#881) Do not block the workflow on errors when publishing to operatorhub.io (istio-ecosystem#877) chore(docs): cleans up IstioCNI section (istio-ecosystem#867) Force push to operator hub fork (istio-ecosystem#873) Make a yaml linter in the community-operators-prod happy (istio-ecosystem#869) Adding description for release workflow run (istio-ecosystem#868) Docs: adding istiod HA documentations (istio-ecosystem#865) Add to vendors_default the possibility to add values for IstioCNI (istio-ecosystem#845) Updates release and nightly-images GH workflows to work with new FBC used in community-operators-prod (istio-ecosystem#854) Simplify logic when using `KEEP_ON_FAILURE` (istio-ecosystem#858) Add KEEP_ON_FAILURE flag to e2e kind tests (istio-ecosystem#832) switch to ubi-micro (istio-ecosystem#856) Speed up docs tests by running on a single cluster (istio-ecosystem#855) ...

* upstream/main: (22 commits) Use debug logging in integration tests (istio-ecosystem#906) Annotate only our clusters when using kind (istio-ecosystem#904) Fix log message for cleaner when waiting (istio-ecosystem#903) Consolidate multicluster operator deploy/cleanup (istio-ecosystem#902) Improve e2e test cleanup by recording & cleaning up (istio-ecosystem#889) Enchance debug information when e2e fails: add istioctl proxy status (istio-ecosystem#891) Update github action for broken links (istio-ecosystem#888) Fix "Check broken link" workflow (istio-ecosystem#887) Split Documentation: splitting docs, adding table of content and fixing links (istio-ecosystem#881) Do not block the workflow on errors when publishing to operatorhub.io (istio-ecosystem#877) chore(docs): cleans up IstioCNI section (istio-ecosystem#867) Force push to operator hub fork (istio-ecosystem#873) Make a yaml linter in the community-operators-prod happy (istio-ecosystem#869) Adding description for release workflow run (istio-ecosystem#868) Docs: adding istiod HA documentations (istio-ecosystem#865) Add to vendors_default the possibility to add values for IstioCNI (istio-ecosystem#845) Updates release and nightly-images GH workflows to work with new FBC used in community-operators-prod (istio-ecosystem#854) Simplify logic when using `KEEP_ON_FAILURE` (istio-ecosystem#858) Add KEEP_ON_FAILURE flag to e2e kind tests (istio-ecosystem#832) switch to ubi-micro (istio-ecosystem#856) ...

* upstream/main: (23 commits) Skip cleanup if control plane tests fail (istio-ecosystem#910) Use debug logging in integration tests (istio-ecosystem#906) Annotate only our clusters when using kind (istio-ecosystem#904) Fix log message for cleaner when waiting (istio-ecosystem#903) Consolidate multicluster operator deploy/cleanup (istio-ecosystem#902) Improve e2e test cleanup by recording & cleaning up (istio-ecosystem#889) Enchance debug information when e2e fails: add istioctl proxy status (istio-ecosystem#891) Update github action for broken links (istio-ecosystem#888) Fix "Check broken link" workflow (istio-ecosystem#887) Split Documentation: splitting docs, adding table of content and fixing links (istio-ecosystem#881) Do not block the workflow on errors when publishing to operatorhub.io (istio-ecosystem#877) chore(docs): cleans up IstioCNI section (istio-ecosystem#867) Force push to operator hub fork (istio-ecosystem#873) Make a yaml linter in the community-operators-prod happy (istio-ecosystem#869) Adding description for release workflow run (istio-ecosystem#868) Docs: adding istiod HA documentations (istio-ecosystem#865) Add to vendors_default the possibility to add values for IstioCNI (istio-ecosystem#845) Updates release and nightly-images GH workflows to work with new FBC used in community-operators-prod (istio-ecosystem#854) Simplify logic when using `KEEP_ON_FAILURE` (istio-ecosystem#858) Add KEEP_ON_FAILURE flag to e2e kind tests (istio-ecosystem#832) ...

fjglira requested a review from a team as a code owner May 22, 2025 20:19

istio-testing added the size/L label May 22, 2025

MaxBab reviewed May 26, 2025

View reviewed changes

fjglira added the do-not-merge/work-in-progress label May 26, 2025

istio-testing added size/XL and removed size/L labels May 28, 2025

fjglira removed the do-not-merge/work-in-progress label May 28, 2025

fjglira requested a review from MaxBab May 28, 2025 09:04

MaxBab approved these changes May 29, 2025

View reviewed changes

dgn reviewed Jun 2, 2025

View reviewed changes

tests/e2e/README.md Outdated Show resolved Hide resolved

dgn reviewed Jun 2, 2025

View reviewed changes

fjglira and others added 10 commits June 2, 2025 10:30

Add to vendors_default the possibility to add values for istiocni

41974c9

Signed-off-by: Francisco H <frherrer@redhat.com>

Fix lint

75e3fb3

Signed-off-by: Francisco H <frherrer@redhat.com>

Update test for vendors default

33bed9f

Signed-off-by: Francisco H <frherrer@redhat.com>

Adding code coverage: new unit test over istiocni controller

bd6d436

Signed-off-by: Francisco H <frherrer@redhat.com>

Update read me

89d2928

Signed-off-by: Francisco H <frherrer@redhat.com>

enhancements: use issue ID's as SEP numbers (istio-ecosystem#849)

4034f9d

Signed-off-by: Daniel Grimm <dgrimm@redhat.com> Signed-off-by: Francisco H <frherrer@redhat.com>

Add unit test

7c1ce3a

Signed-off-by: Francisco H <frherrer@redhat.com>

Update tests/e2e/README.md

2ca785e

Co-authored-by: Daniel Grimm <dgrimm@redhat.com> Signed-off-by: Francisco H <frherrer@redhat.com>

Update read me from review

fe7cef4

Signed-off-by: Francisco H <frherrer@redhat.com>

fjglira force-pushed the default_istio_istiocni_values branch from 29af1f2 to fe7cef4 Compare June 2, 2025 10:41

istio-testing added the needs-rebase label Jun 2, 2025

Merge branch 'main' into default_istio_istiocni_values

96b3539

istio-testing removed the needs-rebase label Jun 2, 2025

fjglira requested a review from dgn June 2, 2025 11:08

fjglira mentioned this pull request Jun 11, 2025

Manually cherri pick vendors default #896

Closed

6 tasks

fjglira mentioned this pull request Jun 11, 2025

(Manual cherry-pick) Add to vendors_default the possibility to add values for IstioCNI (#845) #897

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add to vendors_default the possibility to add values for IstioCNI#845

Add to vendors_default the possibility to add values for IstioCNI#845
istio-testing merged 11 commits intoistio-ecosystem:mainfrom
fjglira:default_istio_istiocni_values

fjglira commented May 22, 2025

Uh oh!

codecov bot commented May 22, 2025 •

edited

Loading

Uh oh!

fjglira commented May 22, 2025

Uh oh!

MaxBab May 26, 2025

Uh oh!

fjglira commented May 26, 2025

Uh oh!

fjglira commented May 27, 2025

Uh oh!

Uh oh!

dgn Jun 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

fjglira commented May 22, 2025

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Additional information:

Uh oh!

codecov bot commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

fjglira commented May 22, 2025

Uh oh!

MaxBab May 26, 2025

Choose a reason for hiding this comment

Uh oh!

fjglira commented May 26, 2025

Uh oh!

fjglira commented May 27, 2025

Uh oh!

Uh oh!

dgn Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented May 22, 2025 •

edited

Loading