feat: add OpenShift exceptions

doronkg commented 4 months ago

What this PR does / why we need it

This PR excludes the default resources created in basic OpenShift installations. It also includes a fix in cmd/kor/crds.go to allow a new plural alias - kor crds.

PR Checklist

[x] This PR adds K8s exceptions (false positives)
[ ] This PR adds new code
[ ] This PR includes test for any new code

Github Issue

Closes #240

Notes for your reviewers

In pkg/kor/secrets.go, a new exception secret type was added - kubernetes.io/dockercfg, which is the OpenShift equivalent of kubernetes.io/dockerconfigjson.
This PR addresses all default namespaces that doesn't begin with openshift- prefix. Meaning, it covers the following namespaces: openshift, default, kube-system, kube-public, kube-node-lease & assisted-installer.

Basic OpenShift installation comes with 60+ namespaces beginning with openshift- prefix, which doesn't include additional namespaces created by OpenShift operators or customized installations, that would also be created with that prefix.

As I see it, there are 3 options to address this case:

Entirely exclude all namespaces with openshift- prefix (flexible).
Entirely exclude all the default namespaces created in the basic installation.
Exclude all the default resources created in the default namespaces.

@yonahd please share your thoughts, I'm leaning towards option no. (1).

codecov-commenter commented 4 months ago

Codecov Report

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

Project coverage is 40.96%. Comparing base (da2b1fe) to head (588aa68). Report is 14 commits behind head on main.

Files	Patch %	Lines
pkg/kor/all.go	0.00%	130 Missing :warning:
pkg/kor/kor.go	1.23%	80 Missing :warning:
pkg/kor/crds.go	0.00%	17 Missing :warning:
pkg/kor/jobs.go	66.66%	7 Missing and 3 partials :warning:
pkg/kor/clusterroles.go	62.50%	5 Missing and 1 partial :warning:
pkg/kor/configmaps.go	62.50%	5 Missing and 1 partial :warning:
pkg/kor/daemonsets.go	68.42%	5 Missing and 1 partial :warning:
pkg/kor/deployments.go	66.66%	5 Missing and 1 partial :warning:
pkg/kor/hpas.go	64.70%	5 Missing and 1 partial :warning:
pkg/kor/ingresses.go	64.70%	5 Missing and 1 partial :warning:
... and 13 more

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #262 +/- ## ========================================== - Coverage 43.37% 40.96% -2.42% ========================================== Files 58 58 Lines 2808 2910 +102 ========================================== - Hits 1218 1192 -26 - Misses 1400 1530 +130 + Partials 190 188 -2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

yonahd commented 4 months ago

Is there anything in these openshift namespaces?

doronkg commented 4 months ago

Is there anything in these openshift namespaces?

Yes, various unused resources in 30+ default openshift- namespaces. Attaching the output of kor all, not including the exclusions listed in this PR.

OpenShift Exceptions

yonahd commented 4 months ago

Is there anything in these openshift namespaces?

Yes, various unused resources in 30+ default openshift- namespaces. Attaching the output of kor all, not including the exclusions listed in this PR.

OpenShift Exceptions

Looks like we need a namespace exception for these

doronkg commented 4 months ago

Is there anything in these openshift namespaces?

Yes, various unused resources in 30+ default openshift- namespaces. Attaching the output of kor all, not including the exclusions listed in this PR. OpenShift Exceptions

Looks like we need a namespace exception for these

We can wait for #249 to be merged and then apply that logic in this PR / new one.

doronkg commented 4 months ago

Merge hell. Closing this PR and re-submitting.

yonahd / kor