-
Notifications
You must be signed in to change notification settings - Fork 5k
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.
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
docs: add the default resource exclusions #13897
Conversation
Signed-off-by: JenTing <hsiaoairplane@gmail.com>
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #13897 +/- ##
=======================================
Coverage 49.56% 49.57%
=======================================
Files 256 256
Lines 43920 43920
=======================================
+ Hits 21770 21773 +3
+ Misses 19987 19985 -2
+ Partials 2163 2162 -1 ☔ View full report in Codecov by Sentry. |
@@ -655,7 +655,7 @@ stringData: | |||
|
|||
## Resource Exclusion/Inclusion | |||
|
|||
Resources can be excluded from discovery and sync so that Argo CD is unaware of them. For example, `events.k8s.io` and `metrics.k8s.io` are always excluded. Use cases: | |||
Resources can be excluded from discovery and sync so that Argo CD is unaware of them. For example, the apiGroup/kind `events.k8s.io/*`, `metrics.k8s.io/*`, `coordination.k8s.io/Lease`, and `""/Endpoints` are always excluded. Use cases: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see ""/Endpoints
in the list of core exclusions, should it be ""/Event
instead?
var coreExcludedResources = []FilteredResource{ |
Resources can be excluded from discovery and sync so that Argo CD is unaware of them. For example, the apiGroup/kind `events.k8s.io/*`, `metrics.k8s.io/*`, `coordination.k8s.io/Lease`, and `""/Endpoints` are always excluded. Use cases: | |
Resources can be excluded from discovery and sync so that Argo CD is unaware of them. For example, the apiGroup/kind `events.k8s.io/*`, `metrics.k8s.io/*`, `coordination.k8s.io/Lease`, and `""/Event` are always excluded. Use cases: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@morey-tech
Thank you for reviewing the PR.
Here is the code reference
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems like Endpoints
resource isn't excluded using the resource filter mechanism but rather a separate one in the gitops engine. Not sure it makes sense to include it in the example of what is always excluded using the resource filter.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this section of the docs is for the Resource Exclusion feature and not generally about filtered resources, I'm hesitant to include Endpoints
in the list, even though they are also excluded (but in a different context). Ultimately, it's okay since the user will know they are excluded and can't change that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because the purpose of this reference is just to give an example, it doesn't need to be a compressive list. But I would leave it as is because these resources are excluded by default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because we are working on tuning the app controller CPU high issue.
It'd be good to doc existing excluded resources rather than trace the source code.
@@ -655,7 +655,7 @@ stringData: | |||
|
|||
## Resource Exclusion/Inclusion | |||
|
|||
Resources can be excluded from discovery and sync so that Argo CD is unaware of them. For example, `events.k8s.io` and `metrics.k8s.io` are always excluded. Use cases: | |||
Resources can be excluded from discovery and sync so that Argo CD is unaware of them. For example, the apiGroup/kind `events.k8s.io/*`, `metrics.k8s.io/*`, `coordination.k8s.io/Lease`, and `""/Endpoints` are always excluded. Use cases: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because the purpose of this reference is just to give an example, it doesn't need to be a compressive list. But I would leave it as is because these resources are excluded by default.
LGTM, thank you |
Signed-off-by: JenTing <hsiaoairplane@gmail.com> Co-authored-by: pasha-codefresh <pavel@codefresh.io>
Signed-off-by: JenTing <hsiaoairplane@gmail.com> Co-authored-by: pasha-codefresh <pavel@codefresh.io>
Add the full resource exclusion lists.
Checklist:
Please see Contribution FAQs if you have questions about your pull-request.