Skip to content
This repository has been archived by the owner on Aug 28, 2024. It is now read-only.

Commit

Permalink
Clarify doc for ChildReconciler#ReflectChildStatusOnParent (#365)
Browse files Browse the repository at this point in the history
Signed-off-by: Scott Andrews <andrewssc@vmware.com>
  • Loading branch information
scothis authored May 3, 2023
1 parent d444a2d commit 51a1313
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions reconcilers/reconcilers.go
Original file line number Diff line number Diff line change
Expand Up @@ -978,8 +978,11 @@ type ChildReconciler[Type, ChildType client.Object, ChildListType client.ObjectL
DesiredChild func(ctx context.Context, resource Type) (ChildType, error)

// ReflectChildStatusOnParent updates the reconciled resource's status with values from the
// child. Select types of error are passed, including:
// - apierrs.IsConflict
// child. Select types of errors are passed, including:
// - apierrs.IsAlreadyExists
//
// Most errors are returned directly, skipping this method. The set of handled error types
// may grow, implementations should be defensive rather than assuming the error type.
ReflectChildStatusOnParent func(ctx context.Context, parent Type, child ChildType, err error)

// HarmonizeImmutableFields allows fields that are immutable on the current
Expand Down

0 comments on commit 51a1313

Please sign in to comment.