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.

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

Merged
merged 2 commits into from
Jun 15, 2023
Merged

Conversation

jenting
Copy link
Contributor

@jenting jenting commented Jun 4, 2023

Add the full resource exclusion lists.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • Optional. My organization is added to USERS.md.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.

Please see Contribution FAQs if you have questions about your pull-request.

Signed-off-by: JenTing <hsiaoairplane@gmail.com>
@jenting jenting changed the title Add the default resource exclusions doc: add the default resource exclusions Jun 4, 2023
@jenting jenting changed the title doc: add the default resource exclusions docs: add the default resource exclusions Jun 4, 2023
@codecov
Copy link

codecov bot commented Jun 4, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (3cb7eca) 49.56% compared to head (f2135ab) 49.57%.

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     

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@@ -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:
Copy link
Contributor

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{

Suggested change
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:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The Endpoints resource is filtered when the resource update event comes in. Ref to code.

The events.k8s.io/*, metrics.k8s.io/*, coordination.k8s.io/Lease resources are filtered when comparing the live state versus git manifest. Ref to code.

Copy link
Contributor

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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:
Copy link
Contributor

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.

@pasha-codefresh
Copy link
Member

LGTM, thank you

@pasha-codefresh pasha-codefresh merged commit b47daa5 into argoproj:master Jun 15, 2023
24 checks passed
@jenting jenting deleted the doc branch June 15, 2023 11:35
yyzxw pushed a commit to yyzxw/argo-cd that referenced this pull request Aug 9, 2023
Signed-off-by: JenTing <hsiaoairplane@gmail.com>
Co-authored-by: pasha-codefresh <pavel@codefresh.io>
tesla59 pushed a commit to tesla59/argo-cd that referenced this pull request Dec 16, 2023
Signed-off-by: JenTing <hsiaoairplane@gmail.com>
Co-authored-by: pasha-codefresh <pavel@codefresh.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants