Allow multiple `scantypes` to be used in the service and container autodiscovery (closes #1384) - #1447

Merged

Ilyesbdlala merged 26 commits into

mainfrom

Mar 22, 2023

Ilyesbdlala commented Nov 18, 2022

Member

ref: https://www.securecodebox.io/docs/architecture/architecture_decisions/adr_0013

BREAKING CHANGE:

Co-authored-by: Simon Hülkenberg simon.huelkenberg@iteratec.com

Signed-off-by: Ilyes Ben Dlala ilyes.bendlala@iteratec.com

Description

Checklist

Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
Make sure that all your commits are signed-off and that you are added to the Contributors file.
Make sure that all CI finish successfully.
Optional (but appreciated): Make sure that all commits are Verified.

Ilyesbdlala added auto-discovery breaking labels

Ilyesbdlala assigned the-simmon and Ilyesbdlala

Ilyesbdlala marked this pull request as draft

November 18, 2022 09:57

secureCodeBoxBot commented Nov 18, 2022

Contributor

This pull request includes breaking changes. Please make sure that you included the breaking changes and the steps required to upgrade in UPGRADING.md.
✨ Thank you for your contribution! ✨

github-actions Bot commented Nov 18, 2022 •

edited

Loading

MegaLinter status: ⚠️ WARNING

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
⚠️ GO	golangci-lint	10		10	12.46s
✅ SPELL	misspell	12		0	0.08s
⚠️ YAML	prettier	2		1	0.95s

See errors details in artifact MegaLinter reports on CI Job page
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

Ilyesbdlala changed the title ~~feat(auto-discovery): Allow multiple scantypes to be used in the service autodiscovery~~ feat(auto-discovery): Allow multiple scantypes to be used in the service and container autodiscovery

rfelber added this to the v4.0.0 milestone

the-simmon marked this pull request as ready for review

December 13, 2022 12:10

Ilyesbdlala force-pushed the feature/adr-13 branch from d0c481a to 1fdef71 Compare

February 20, 2023 13:28

J12934 requested changes

View reviewed changes

J12934 left a comment

Member

Also looks good and nearly ready to go, I had a bit of a problem with the scanConfigs as it was still just called scanConfig in the default local config.
Made some suggestions ton fix this and make this mistake more transparent if users also stumble across it.

UPGRADING.md Outdated

auto-discovery/kubernetes/auto-discovery-config.yaml Outdated

auto-discovery/kubernetes/auto-discovery-config.yaml Outdated

auto-discovery/kubernetes/controllers/service_scan_controller.go

auto-discovery/kubernetes/controllers/container_scan_controller.go

UPGRADING.md Outdated

J12934 reviewed

View reviewed changes

auto-discovery/kubernetes/values.yaml Outdated

J12934 reviewed

View reviewed changes

auto-discovery/kubernetes/values.yaml Outdated

J12934 previously approved these changes

View reviewed changes

Ilyesbdlala dismissed J12934’s stale review via

320d968

March 21, 2023 19:53

Ilyesbdlala force-pushed the feature/adr-13 branch from cceaca2 to 320d968 Compare

March 21, 2023 19:53

J12934 previously approved these changes

View reviewed changes

Ilyesbdlala dismissed J12934’s stale review via

c6e29f7

March 22, 2023 14:23

Ilyesbdlala and others added 11 commits

March 22, 2023 15:27


          feat(auto-discovery): Allow multiple scantypes to be used in the serv…

3ea5621

…ice autodiscovery

ref: https://www.securecodebox.io/docs/architecture/architecture_decisions/adr_0013

BREAKING CHANGE:

Co-authored-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          Change container autodiscovery scan config to list

af65fd1

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          Change auto discovery values.yaml scan config to list

c4cd3fc

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          feature(service-auto-discovery): adjusted unit tests to allow for mul…

202b171

…tiple ScanConfigs

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          fix(service-autodiscovery): fixed the name of the created scheduled s…

aa2a091

…can to fit the unit tests

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          Add name field to scanConfig type in autodiscovery

5b974cd

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          feature(service-autodiscovery): changed from including the scanType i…

7a5cebb

…n the name of th scheduledScan to

including a custom name
This is done to ensure the uniqueness of each scheduledScan

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          Use custom scan name to generate resulting scan name for container au…

f0ea68a

…to discovery

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          Check uniqueness of scan names in autodiscovery on controller setup

a7da729

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          Add unit test for non unique scan names

cf6b552

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          Add unit tests for multiple scans in container autodiscvery

ceb4c17

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>

the-simmon and others added 15 commits

March 22, 2023 15:27


          Fix bug in container autodiscovery where only one scan was created ev…

9699f49

…en though multiple scan configs were given

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          Fix container autodiscvery unit test where a scan name was used twice…

51b3d72

… by mistake

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          maintenance(service-autodiscovery): unit tests now assume two differe…

239c8aa

…nt ScanConfigs

i.e two different names
DRAFT

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          bugfix(service-autodiscovery): add a label to differentiate between s…

e75343d

…cans of different ScanConfigs

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          maintenance(service-autodiscovery): refactoring of the unit-tests

a8687b1

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          Refactor variable names in container autodiscovery #1364

a582d08

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          Add scan name to yaml files #1384

303957c

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          docs(service-autodiscovery): Minor refactoring and added comments

6cd38a2

* using context.Background() instead of ctx for SetupWithManager(): it better to use it in
initialization since it returns a non-nil, empty Context that it is never canceled, has no values, and has no deadline.

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          Add upgrading notes #1384

d77b387

Signed-off-by: Simon Hülkenberg <simon.huelkenberg@iteratec.com>


          Renamed scanConfig to scanConfigs where missing

f3bd95a

Co-authored-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          Added a warning when scanConfigs is empty or non existent

7533ad2

Co-authored-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          Added a warning when scanConfigs is empty or non existent

458846f

Co-authored-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          Apply changes to allow multiple ScanConfigs to work with #1557

6c7388e

These issues arose after a rebase

Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>


          Fix scanTypes for trivy auto-discovery

de7ab96

Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>


          Update UPGRADING.md

f6ae2bb

Made the upgrading note more explicit, detailing how to exactly perform the upgrade.

Co-authored-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>

Ilyesbdlala force-pushed the feature/adr-13 branch from c6e29f7 to f6ae2bb Compare

March 22, 2023 14:27

J12934 approved these changes

View reviewed changes

Ilyesbdlala merged commit 53f0f9e into main

Ilyesbdlala deleted the feature/adr-13 branch

March 22, 2023 15:27

rfelber added the enhancement label

rfelber changed the title ~~feat(auto-discovery): Allow multiple scantypes to be used in the service and container autodiscovery~~ Allow multiple scantypes to be used in the service and container autodiscovery

rfelber changed the title ~~Allow multiple scantypes to be used in the service and container autodiscovery~~ Allow multiple scantypes to be used in the service and container autodiscovery (closes #1384)

rfelber linked an issue

that may be closed by this pull request

Implement ADR13: Autodiscovery v2 #1384

Closed

5 of 6 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-discovery breaking enhancement