docs: Add an explanation of using ignoring differences for app of apps pattern #18945
Conversation
❌ Preview Environment deleted from BunnyshellAvailable commands (reply to this comment):
|
❌ Preview Environment deleted from BunnyshellAvailable commands (reply to this comment):
|
andrii-korotkov-verkada
force-pushed
the
docs-for-app-of-apps-update
branch
3 times, most recently
from
49edc3b
to
4af1a41
Compare
|
Looks like License Compliance triggers on master, since I don't think my changes break it. |
| ``` | ||
| ``` | ||
|
|
||
| ### Ignoring some differences in managed applications |
There was a problem hiding this comment.
Seems like this would make more sense in docs/user-guide/diffing.md. Perhaps in an example section that could contain known patterns.
What do you think?
There was a problem hiding this comment.
I'd like to keep some reference here, since the page is dedicated to app of apps and that's where people would come to when searching for app of apps. They'd probably not go to diffing page right away. The filters are a bit specific for app of apps, so it seems to make more sense to keep them here. Though I can potentially add changes to the diffing page and link them from this page.
There was a problem hiding this comment.
| ### Ignoring some differences in managed applications | |
| ### Ignoring differences in child applications |
There was a problem hiding this comment.
@agaudreault if you Google "Argo CD app of apps" this page is the first result and is essentially the canonical source for app of apps. I think we should leave changing that pattern to another PR. In the meantime, for this PR @andrii-korotkov-verkada lets just add a link from diffing customization page to this one to discuss app of apps.
There was a problem hiding this comment.
I made some suggestions just to clean up wording a bit to clarify things. You can just click "sign off and commit suggestion" if you're ok with those changes.
Could you also clarify why the annotations need to be ignored?
The only thing I would add is a link from the diffing customization page.
| ``` | ||
| ``` | ||
|
|
||
| ### Ignoring some differences in managed applications |
There was a problem hiding this comment.
| ### Ignoring some differences in managed applications | |
| ### Ignoring differences in child applications |
|
|
||
| ### Ignoring some differences in managed applications | ||
|
|
||
| If you don't want your app of apps becoming out of sync on a regular basis and/or want to manually modify some configurations for managed applications like auto sync being enabled, you can configure ignoring differences in the app of apps, e.g. |
There was a problem hiding this comment.
| If you don't want your app of apps becoming out of sync on a regular basis and/or want to manually modify some configurations for managed applications like auto sync being enabled, you can configure ignoring differences in the app of apps, e.g. | |
| To allow changes in child apps without triggering an out-of-sync status, or modification for debugging etc, the app of apps pattern works with [diff customization](../user-guide/diffing/). The example below shows how to ignore changes to syncPolicy and other common values. |
| # To allow manually turn off auto sync for apps and preserve that setting | ||
| - /spec/syncPolicy/automated | ||
| # These are automatically updated on a regular basis. Not ignoring last applied configuration since it's used for computing diffs after normalization. | ||
| - /metadata/annotations/argocd.argoproj.io~1refresh | ||
| - /operation |
There was a problem hiding this comment.
| # To allow manually turn off auto sync for apps and preserve that setting | |
| - /spec/syncPolicy/automated | |
| # These are automatically updated on a regular basis. Not ignoring last applied configuration since it's used for computing diffs after normalization. | |
| - /metadata/annotations/argocd.argoproj.io~1refresh | |
| - /operation | |
| # Allow manually disabling auto sync for apps, useful for debugging. | |
| - /spec/syncPolicy/automated | |
| # These are automatically updated on a regular basis. Not ignoring last applied configuration since it's used for computing diffs after normalization. | |
| - /metadata/annotations/argocd.argoproj.io~1refresh | |
| - /operation |
There was a problem hiding this comment.
@andrii-korotkov-verkada Can you explain why you ignore the annotations? I wouldn't think this would add anything.
There was a problem hiding this comment.
@todaywasawesome, I've noticed that some annotations and /operation were constantly triggering out of sync status for the app of apps despite no changes in the manifests, since they could be added/removed/updated by automation. I thought it'll be cleaner to ignore them.
| ``` | ||
| ``` | ||
|
|
||
| ### Ignoring some differences in managed applications |
There was a problem hiding this comment.
@agaudreault if you Google "Argo CD app of apps" this page is the first result and is essentially the canonical source for app of apps. I think we should leave changing that pattern to another PR. In the meantime, for this PR @andrii-korotkov-verkada lets just add a link from diffing customization page to this one to discuss app of apps.
|
@andrii-korotkov-verkada Are you able to resolve some of the feedback from Dan? |
|
Yeah, I'll take a look in upcoming days. |
…s pattern Some fields updates trigger app of apps being out of sync on a regular basis, or prevent from persistently modifying some behaviors like auto sync without doing the change in the code. This update shows how to do this using ignore differences configuration. Signed-off-by: Andrii Korotkov <andrii.korotkov@verkada.com>
andrii-korotkov-verkada
force-pushed
the
docs-for-app-of-apps-update
branch
from
4af1a41
to
6d9923d
Compare
|
Updated the PR. |
Some fields updates trigger app of apps being out of sync on a regular basis, or prevent from persistently modifying some behaviors like auto sync without doing the change in the code. This update shows how to do this using ignore differences configuration.
Checklist: