Add documentation for resource customization #1292
Conversation
* Add documentation section for resource customization including the sailoperator.io/ignore annotation usage and how it works * Remove a debug print statement in integration test Signed-off-by: bmangoen <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1292 +/- ##
==========================================
+ Coverage 77.59% 78.60% +1.01%
==========================================
Files 44 44
Lines 2834 2253 -581
==========================================
- Hits 2199 1771 -428
+ Misses 526 372 -154
- Partials 109 110 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
|
||
| * The operator **will skip reconciling UPDATE events** for that resource | ||
| * The resource **must still be owned** by the `Istio` (the ownerReference remains the associated `IstioRevision`) | ||
| * The operator **will not revert manual changes** made to resources with this annotation |
There was a problem hiding this comment.
that's not entirely correct, is it? it will still overwrite them when something else changes and triggeres a reconciliation
There was a problem hiding this comment.
Actually while the sailoperator.io/ignore is set, no change would be overwritten
There was a problem hiding this comment.
that's not true, I just verified this. I think we need some better docs on how this works in general:
- Sail Operator will re-apply all helm charts when it detects a change in any of the resources it deployed
sailoperator.io/ignore: truemakes sure that it ignores changes from that resource- changes in other resources will still lead to re-applying of all charts (ie also those resources annotated with
sailoperator.io/ignore: true) - however, only those fields which are included in the templates will be reverted back to their original values. That means that new annotations and labels can be added, but changes such as editing an existing label or a pod command line argument will be reverted
There was a problem hiding this comment.
you can try it - annotate your istiod deployment and then change a command line argument of the istiod container. it will be reverted once you make a change to another resource. the annotation stays though
There was a problem hiding this comment.
You're right ! Going to modify the doc to be more accurate how it works
There was a problem hiding this comment.
I modified this part. @dgn Let me know if it's more clear and correct now
Added some more details about how the operator behaves when the sailoperator.io/ignore annotation is set to "true". Signed-off-by: bmangoen <[email protected]>
3 participants
What type of PR is this?
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #1278