externalsecret_controller.go 49 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250
  1. /*
  2. Copyright © 2025 ESO Maintainer Team
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. https://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. // Package externalsecret implements the controller for managing ExternalSecret resources
  14. package externalsecret
  15. import (
  16. "context"
  17. "encoding/json"
  18. "errors"
  19. "fmt"
  20. "maps"
  21. "slices"
  22. "strings"
  23. "time"
  24. "github.com/go-logr/logr"
  25. "github.com/prometheus/client_golang/prometheus"
  26. v1 "k8s.io/api/core/v1"
  27. "k8s.io/apimachinery/pkg/api/equality"
  28. apierrors "k8s.io/apimachinery/pkg/api/errors"
  29. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  30. "k8s.io/apimachinery/pkg/fields"
  31. "k8s.io/apimachinery/pkg/labels"
  32. "k8s.io/apimachinery/pkg/runtime"
  33. "k8s.io/apimachinery/pkg/runtime/schema"
  34. "k8s.io/apimachinery/pkg/types"
  35. "k8s.io/client-go/rest"
  36. "k8s.io/client-go/tools/record"
  37. "k8s.io/utils/ptr"
  38. ctrl "sigs.k8s.io/controller-runtime"
  39. "sigs.k8s.io/controller-runtime/pkg/builder"
  40. "sigs.k8s.io/controller-runtime/pkg/client"
  41. "sigs.k8s.io/controller-runtime/pkg/controller"
  42. "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
  43. "sigs.k8s.io/controller-runtime/pkg/handler"
  44. "sigs.k8s.io/controller-runtime/pkg/predicate"
  45. "sigs.k8s.io/controller-runtime/pkg/reconcile"
  46. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  47. // Metrics.
  48. "github.com/external-secrets/external-secrets/pkg/controllers/externalsecret/esmetrics"
  49. ctrlmetrics "github.com/external-secrets/external-secrets/pkg/controllers/metrics"
  50. ctrlutil "github.com/external-secrets/external-secrets/pkg/controllers/util"
  51. "github.com/external-secrets/external-secrets/runtime/esutils"
  52. "github.com/external-secrets/external-secrets/runtime/esutils/resolvers"
  53. // Loading registered generators.
  54. _ "github.com/external-secrets/external-secrets/pkg/register"
  55. )
  56. const (
  57. fieldOwnerTemplate = "externalsecrets.external-secrets.io/%v"
  58. fieldOwnerTemplateSha = "externalsecrets.external-secrets.io/sha3/%x"
  59. // ExternalSecretFinalizer is the finalizer for ExternalSecret resources.
  60. ExternalSecretFinalizer = "externalsecrets.external-secrets.io/externalsecret-cleanup"
  61. // condition messages for "SecretSynced" reason.
  62. msgSynced = "secret synced"
  63. msgSyncedRetain = "secret retained due to DeletionPolicy=Retain"
  64. // condition messages for "SecretDeleted" reason.
  65. msgDeleted = "secret deleted due to DeletionPolicy=Delete"
  66. // condition messages for "SecretMissing" reason.
  67. msgMissing = "secret will not be created due to CreationPolicy=Merge"
  68. // condition messages for "SecretSyncedError" reason.
  69. msgErrorGetSecretData = "could not get secret data from provider"
  70. msgErrorDeleteSecret = "could not delete secret"
  71. msgErrorDeleteOrphaned = "could not delete orphaned secrets"
  72. msgErrorUpdateSecret = "could not update secret"
  73. msgErrorUpdateImmutable = "could not update secret, target is immutable"
  74. msgErrorBecomeOwner = "failed to take ownership of target secret"
  75. msgErrorIsOwned = "target is owned by another ExternalSecret"
  76. // log messages.
  77. logErrorGetES = "unable to get ExternalSecret"
  78. logErrorUpdateESStatus = "unable to update ExternalSecret status"
  79. logErrorGetSecret = "unable to get Secret"
  80. logErrorPatchSecret = "unable to patch Secret"
  81. logErrorSecretCacheNotSynced = "controller caches for Secret are not in sync"
  82. logErrorUnmanagedStore = "unable to determine if store is managed"
  83. // error formats.
  84. errConvert = "error applying conversion strategy %s to keys: %w"
  85. errRewrite = "error applying rewrite to keys: %w"
  86. errDecode = "error applying decoding strategy %s to data: %w"
  87. errGenerate = "error using generator: %w"
  88. errInvalidKeys = "invalid secret keys (TIP: use rewrite or conversionStrategy to change keys): %w"
  89. errFetchTplFrom = "error fetching templateFrom data: %w"
  90. errApplyTemplate = "could not apply template: %w"
  91. errExecTpl = "could not execute template: %w"
  92. errMutate = "unable to mutate secret %s: %w"
  93. errUpdate = "unable to update secret %s: %w"
  94. errUpdateNotFound = "unable to update secret %s: not found"
  95. errDeleteCreatePolicy = "unable to delete secret %s: creationPolicy=%s is not Owner"
  96. errSecretCachesNotSynced = "controller caches for secret %s are not in sync"
  97. // event messages.
  98. eventCreated = "secret created"
  99. eventUpdated = "secret updated"
  100. eventDeleted = "secret deleted due to DeletionPolicy=Delete"
  101. eventDeletedOrphaned = "secret deleted because it was orphaned"
  102. eventMissingProviderSecret = "secret does not exist at provider using spec.dataFrom[%d]"
  103. eventMissingProviderSecretKey = "secret does not exist at provider using spec.dataFrom[%d] (key=%s)"
  104. )
  105. // these errors are explicitly defined so we can detect them with `errors.Is()`.
  106. var (
  107. ErrSecretImmutable = fmt.Errorf("secret is immutable")
  108. ErrSecretIsOwned = fmt.Errorf("secret is owned by another ExternalSecret")
  109. ErrSecretSetCtrlRef = fmt.Errorf("could not set controller reference on secret")
  110. ErrSecretRemoveCtrlRef = fmt.Errorf("could not remove controller reference on secret")
  111. )
  112. const (
  113. indexESTargetSecretNameField = ".metadata.targetSecretName"
  114. indexESTargetResourceField = ".spec.target.resource"
  115. )
  116. // Reconciler reconciles a ExternalSecret object.
  117. type Reconciler struct {
  118. client.Client
  119. SecretClient client.Client
  120. Log logr.Logger
  121. Scheme *runtime.Scheme
  122. RestConfig *rest.Config
  123. ControllerClass string
  124. RequeueInterval time.Duration
  125. ClusterSecretStoreEnabled bool
  126. EnableFloodGate bool
  127. EnableGeneratorState bool
  128. AllowGenericTargets bool
  129. recorder record.EventRecorder
  130. // informerManager manages dynamic informers for generic targets
  131. informerManager InformerManager
  132. }
  133. // Reconcile implements the main reconciliation loop
  134. // for watched objects (ExternalSecret, ClusterSecretStore and SecretStore),
  135. // and updates/creates a Kubernetes secret based on them.
  136. func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, err error) {
  137. log := r.Log.WithValues("ExternalSecret", req.NamespacedName)
  138. resourceLabels := ctrlmetrics.RefineNonConditionMetricLabels(map[string]string{"name": req.Name, "namespace": req.Namespace})
  139. start := time.Now()
  140. syncCallsError := esmetrics.GetCounterVec(esmetrics.SyncCallsErrorKey)
  141. // use closures to dynamically update resourceLabels
  142. defer func() {
  143. esmetrics.GetGaugeVec(esmetrics.ExternalSecretReconcileDurationKey).With(resourceLabels).Set(float64(time.Since(start)))
  144. esmetrics.GetCounterVec(esmetrics.SyncCallsKey).With(resourceLabels).Inc()
  145. }()
  146. externalSecret := &esv1.ExternalSecret{}
  147. err = r.Get(ctx, req.NamespacedName, externalSecret)
  148. if err != nil {
  149. if apierrors.IsNotFound(err) {
  150. // NOTE: this does not actually set the condition on the ExternalSecret, because it does not exist
  151. // this is a hack to disable metrics for deleted ExternalSecrets, see:
  152. // https://github.com/external-secrets/external-secrets/pull/612
  153. conditionSynced := NewExternalSecretCondition(esv1.ExternalSecretDeleted, v1.ConditionFalse, esv1.ConditionReasonSecretDeleted, "Secret was deleted")
  154. SetExternalSecretCondition(&esv1.ExternalSecret{
  155. ObjectMeta: metav1.ObjectMeta{
  156. Name: req.Name,
  157. Namespace: req.Namespace,
  158. },
  159. }, *conditionSynced)
  160. return ctrl.Result{}, nil
  161. }
  162. log.Error(err, logErrorGetES)
  163. syncCallsError.With(resourceLabels).Inc()
  164. return ctrl.Result{}, err
  165. }
  166. // Handle deletion with finalizer
  167. if !externalSecret.GetDeletionTimestamp().IsZero() {
  168. // Always attempt cleanup to handle edge case where finalizer might be removed externally
  169. if err := r.cleanupManagedSecrets(ctx, log, externalSecret); err != nil {
  170. log.Error(err, "failed to cleanup managed secrets")
  171. return ctrl.Result{}, err
  172. }
  173. // Release informer for generic targets
  174. if isGenericTarget(externalSecret) && r.informerManager != nil {
  175. gvk := getTargetGVK(externalSecret)
  176. esName := types.NamespacedName{Name: externalSecret.Name, Namespace: externalSecret.Namespace}
  177. if err := r.informerManager.ReleaseInformer(ctx, gvk, esName); err != nil {
  178. log.Error(err, "failed to release informer for generic target",
  179. "group", gvk.Group,
  180. "version", gvk.Version,
  181. "kind", gvk.Kind)
  182. }
  183. }
  184. // Remove finalizer if it exists
  185. // Use Patch instead of Update to avoid claiming ownership of spec fields like refreshInterval
  186. patch := client.MergeFrom(externalSecret.DeepCopy())
  187. if updated := controllerutil.RemoveFinalizer(externalSecret, ExternalSecretFinalizer); updated {
  188. if err := r.Patch(ctx, externalSecret, patch); err != nil {
  189. return ctrl.Result{}, err
  190. }
  191. }
  192. return ctrl.Result{}, nil
  193. }
  194. // Add finalizer if it doesn't exist
  195. // Use Patch instead of Update to avoid claiming ownership of spec fields like refreshInterval
  196. patch := client.MergeFrom(externalSecret.DeepCopy())
  197. if updated := controllerutil.AddFinalizer(externalSecret, ExternalSecretFinalizer); updated {
  198. if err := r.Patch(ctx, externalSecret, patch); err != nil {
  199. return ctrl.Result{}, err
  200. }
  201. }
  202. // if extended metrics is enabled, refine the time series vector
  203. resourceLabels = ctrlmetrics.RefineLabels(resourceLabels, externalSecret.Labels)
  204. // skip this ExternalSecret if it uses a ClusterSecretStore and the feature is disabled
  205. if shouldSkipClusterSecretStore(r, externalSecret) {
  206. log.V(1).Info("skipping ExternalSecret, ClusterSecretStore feature is disabled")
  207. return ctrl.Result{}, nil
  208. }
  209. // skip this ExternalSecret if it uses any SecretStore not managed by this controller
  210. skip, err := shouldSkipUnmanagedStore(ctx, req.Namespace, r, externalSecret)
  211. if err != nil {
  212. log.Error(err, logErrorUnmanagedStore)
  213. syncCallsError.With(resourceLabels).Inc()
  214. return ctrl.Result{}, err
  215. }
  216. if skip {
  217. log.V(1).Info("skipping ExternalSecret, uses unmanaged SecretStore")
  218. return ctrl.Result{}, nil
  219. }
  220. // if this is a generic target, use a different reconciliation path
  221. if isGenericTarget(externalSecret) {
  222. // update the status of the ExternalSecret when this function returns, if needed
  223. currentStatus := *externalSecret.Status.DeepCopy()
  224. defer func() {
  225. if equality.Semantic.DeepEqual(currentStatus, externalSecret.Status) {
  226. return
  227. }
  228. updateErr := r.Status().Update(ctx, externalSecret)
  229. if updateErr != nil && !apierrors.IsConflict(updateErr) {
  230. log.Error(updateErr, logErrorUpdateESStatus)
  231. }
  232. }()
  233. // validate generic target configuration early
  234. if err := r.validateGenericTarget(log, externalSecret); err != nil {
  235. r.markAsFailed("invalid generic target", err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonSecretSyncedError)
  236. return ctrl.Result{}, nil // don't requeue as this is a configuration error that is not recoverable
  237. }
  238. return r.reconcileGenericTarget(ctx, externalSecret, log, start, resourceLabels, syncCallsError)
  239. }
  240. // the target secret name defaults to the ExternalSecret name, if not explicitly set
  241. secretName := externalSecret.Spec.Target.Name
  242. if secretName == "" {
  243. secretName = externalSecret.Name
  244. }
  245. // fetch the existing secret (from the partial cache)
  246. // - please note that the ~partial cache~ is different from the ~full cache~
  247. // so there can be race conditions between the two caches
  248. // - the WatchesMetadata(v1.Secret{}) in SetupWithManager() is using the partial cache
  249. // so we might receive a reconcile request before the full cache is updated
  250. // - furthermore, when `--enable-managed-secrets-caching` is true, the full cache
  251. // will ONLY include secrets with the "managed" label, so we cant use the full cache
  252. // to reliably determine if a secret exists or not
  253. secretPartial := &metav1.PartialObjectMetadata{}
  254. secretPartial.SetGroupVersionKind(v1.SchemeGroupVersion.WithKind("Secret"))
  255. err = r.Get(ctx, client.ObjectKey{Name: secretName, Namespace: externalSecret.Namespace}, secretPartial)
  256. if err != nil && !apierrors.IsNotFound(err) {
  257. log.Error(err, logErrorGetSecret, "secretName", secretName, "secretNamespace", externalSecret.Namespace)
  258. syncCallsError.With(resourceLabels).Inc()
  259. return ctrl.Result{}, err
  260. }
  261. // if the secret exists but does not have the "managed" label, add the label
  262. // using a PATCH so it is visible in the cache, then requeue immediately
  263. if secretPartial.UID != "" && secretPartial.Labels[esv1.LabelManaged] != esv1.LabelManagedValue {
  264. fqdn := fqdnFor(externalSecret.Name)
  265. patch := client.MergeFrom(secretPartial.DeepCopy())
  266. if secretPartial.Labels == nil {
  267. secretPartial.Labels = make(map[string]string)
  268. }
  269. secretPartial.Labels[esv1.LabelManaged] = esv1.LabelManagedValue
  270. err = r.Patch(ctx, secretPartial, patch, client.FieldOwner(fqdn))
  271. if err != nil {
  272. log.Error(err, logErrorPatchSecret, "secretName", secretName, "secretNamespace", externalSecret.Namespace)
  273. syncCallsError.With(resourceLabels).Inc()
  274. return ctrl.Result{}, err
  275. }
  276. return ctrl.Result{Requeue: true}, nil
  277. }
  278. // fetch existing secret (from the full cache)
  279. // NOTE: we are using the `r.SecretClient` which we only use for managed secrets.
  280. // when `enableManagedSecretsCache` is true, this is a cached client that only sees our managed secrets,
  281. // otherwise it will be the normal controller-runtime client which may be cached or make direct API calls,
  282. // depending on if `enabledSecretCache` is true or false.
  283. existingSecret := &v1.Secret{}
  284. err = r.SecretClient.Get(ctx, client.ObjectKey{Name: secretName, Namespace: externalSecret.Namespace}, existingSecret)
  285. if err != nil && !apierrors.IsNotFound(err) {
  286. log.Error(err, logErrorGetSecret, "secretName", secretName, "secretNamespace", externalSecret.Namespace)
  287. syncCallsError.With(resourceLabels).Inc()
  288. return ctrl.Result{}, err
  289. }
  290. // ensure the full cache is up-to-date
  291. // NOTE: this prevents race conditions between the partial and full cache.
  292. // we return an error so we get an exponential backoff if we end up looping,
  293. // for example, during high cluster load and frequent updates to the target secret by other controllers.
  294. if secretPartial.UID != existingSecret.UID || secretPartial.ResourceVersion != existingSecret.ResourceVersion {
  295. err = fmt.Errorf(errSecretCachesNotSynced, secretName)
  296. log.Error(err, logErrorSecretCacheNotSynced, "secretName", secretName, "secretNamespace", externalSecret.Namespace)
  297. syncCallsError.With(resourceLabels).Inc()
  298. return ctrl.Result{}, err
  299. }
  300. // refresh will be skipped if ALL the following conditions are met:
  301. // 1. refresh interval is not 0
  302. // 2. resource generation of the ExternalSecret has not changed
  303. // 3. the last refresh time of the ExternalSecret is within the refresh interval
  304. // 4. the target secret is valid:
  305. // - it exists
  306. // - it has the correct "managed" label
  307. // - it has the correct "data-hash" annotation
  308. if !shouldRefresh(externalSecret) && isSecretValid(existingSecret, externalSecret) {
  309. log.V(1).Info("skipping refresh")
  310. return r.getRequeueResult(externalSecret), nil
  311. }
  312. // update status of the ExternalSecret when this function returns, if needed.
  313. // NOTE: we use the ability of deferred functions to update named return values `result` and `err`
  314. // NOTE: we dereference the DeepCopy of the status field because status fields are NOT pointers,
  315. // so otherwise the `equality.Semantic.DeepEqual` will always return false.
  316. currentStatus := *externalSecret.Status.DeepCopy()
  317. defer func() {
  318. // if the status has not changed, we don't need to update it
  319. if equality.Semantic.DeepEqual(currentStatus, externalSecret.Status) {
  320. return
  321. }
  322. // update the status of the ExternalSecret, storing any error in a new variable
  323. // if there was no new error, we don't need to change the `result` or `err` values
  324. updateErr := r.Status().Update(ctx, externalSecret)
  325. if updateErr == nil {
  326. return
  327. }
  328. // if we got an update conflict, we should requeue immediately
  329. if apierrors.IsConflict(updateErr) {
  330. log.V(1).Info("conflict while updating status, will requeue")
  331. // we only explicitly request a requeue if the main function did not return an `err`.
  332. // otherwise, we get an annoying log saying that results are ignored when there is an error,
  333. // as errors are always retried.
  334. if err == nil {
  335. result = ctrl.Result{Requeue: true}
  336. }
  337. return
  338. }
  339. // for other errors, log and update the `err` variable if there is no error already
  340. // so the reconciler will requeue the request
  341. log.Error(updateErr, logErrorUpdateESStatus)
  342. if err == nil {
  343. err = updateErr
  344. }
  345. }()
  346. // retrieve the provider secret data.
  347. dataMap, err := r.GetProviderSecretData(ctx, externalSecret)
  348. if err != nil {
  349. r.markAsFailed(msgErrorGetSecretData, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonSecretSyncedError)
  350. return ctrl.Result{}, err
  351. }
  352. // if no data was found we can delete the secret if needed.
  353. if len(dataMap) == 0 {
  354. switch externalSecret.Spec.Target.DeletionPolicy {
  355. // delete secret and return early.
  356. case esv1.DeletionPolicyDelete:
  357. // safeguard that we only can delete secrets we own.
  358. // this is also implemented in the es validation webhook.
  359. // NOTE: this error cant be fixed by retrying so we don't return an error (which would requeue immediately)
  360. creationPolicy := externalSecret.Spec.Target.CreationPolicy
  361. if creationPolicy != esv1.CreatePolicyOwner {
  362. err = fmt.Errorf(errDeleteCreatePolicy, secretName, creationPolicy)
  363. r.markAsFailed(msgErrorDeleteSecret, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonSecretSyncedError)
  364. return ctrl.Result{}, nil
  365. }
  366. // delete the secret, if it exists
  367. if existingSecret.UID != "" {
  368. err = r.Delete(ctx, existingSecret)
  369. if err != nil && !apierrors.IsNotFound(err) {
  370. r.markAsFailed(msgErrorDeleteSecret, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonSecretSyncedError)
  371. return ctrl.Result{}, err
  372. }
  373. r.recorder.Event(externalSecret, v1.EventTypeNormal, esv1.ReasonDeleted, eventDeleted)
  374. }
  375. r.markAsDone(externalSecret, start, log, esv1.ConditionReasonSecretDeleted, msgDeleted)
  376. return r.getRequeueResult(externalSecret), nil
  377. // In case provider secrets don't exist the kubernetes secret will be kept as-is.
  378. case esv1.DeletionPolicyRetain:
  379. r.markAsDone(externalSecret, start, log, esv1.ConditionReasonSecretSynced, msgSyncedRetain)
  380. return r.getRequeueResult(externalSecret), nil
  381. // noop, handled below
  382. case esv1.DeletionPolicyMerge:
  383. }
  384. }
  385. // mutationFunc is a function which can be applied to a secret to make it match the desired state.
  386. mutationFunc := func(secret *v1.Secret) error {
  387. // get information about the current owner of the secret
  388. // - we ignore the API version as it can change over time
  389. // - we ignore the UID for consistency with the SetControllerReference function
  390. currentOwner := metav1.GetControllerOf(secret)
  391. ownerIsESKind := false
  392. ownerIsCurrentES := false
  393. if currentOwner != nil {
  394. currentOwnerGK := schema.FromAPIVersionAndKind(currentOwner.APIVersion, currentOwner.Kind).GroupKind()
  395. ownerIsESKind = currentOwnerGK.String() == esv1.ExtSecretGroupKind
  396. ownerIsCurrentES = ownerIsESKind && currentOwner.Name == externalSecret.Name
  397. }
  398. // if another ExternalSecret is the owner, we should return an error
  399. // otherwise the controller will fight with itself to update the secret.
  400. // note, this does not prevent other controllers from owning the secret.
  401. if ownerIsESKind && !ownerIsCurrentES {
  402. return fmt.Errorf("%w: %s", ErrSecretIsOwned, currentOwner.Name)
  403. }
  404. // if the CreationPolicy is Owner, we should set ourselves as the owner of the secret
  405. if externalSecret.Spec.Target.CreationPolicy == esv1.CreatePolicyOwner {
  406. err = controllerutil.SetControllerReference(externalSecret, secret, r.Scheme)
  407. if err != nil {
  408. return fmt.Errorf("%w: %w", ErrSecretSetCtrlRef, err)
  409. }
  410. }
  411. // if the creation policy is not Owner, we should remove ourselves as the owner
  412. // this could happen if the creation policy was changed after the secret was created
  413. if externalSecret.Spec.Target.CreationPolicy != esv1.CreatePolicyOwner && ownerIsCurrentES {
  414. err = controllerutil.RemoveControllerReference(externalSecret, secret, r.Scheme)
  415. if err != nil {
  416. return fmt.Errorf("%w: %w", ErrSecretRemoveCtrlRef, err)
  417. }
  418. }
  419. // initialize maps within the secret so it's safe to set values
  420. if secret.Annotations == nil {
  421. secret.Annotations = make(map[string]string)
  422. }
  423. if secret.Labels == nil {
  424. secret.Labels = make(map[string]string)
  425. }
  426. if secret.Data == nil {
  427. secret.Data = make(map[string][]byte)
  428. }
  429. // set the immutable flag on the secret if requested by the ExternalSecret
  430. if externalSecret.Spec.Target.Immutable {
  431. secret.Immutable = ptr.To(true)
  432. }
  433. // only apply the template if the secret is mutable or if the secret is new (has no UID)
  434. // otherwise we would mutate an object that is immutable and already exists
  435. objectDoesNotExistOrCanBeMutated := secret.GetUID() == "" || !externalSecret.Spec.Target.Immutable
  436. if objectDoesNotExistOrCanBeMutated {
  437. // get the list of keys that are managed by this ExternalSecret
  438. keys, err := getManagedDataKeys(secret, externalSecret.Name)
  439. if err != nil {
  440. return err
  441. }
  442. // remove any data keys that are managed by this ExternalSecret, so we can re-add them
  443. // this ensures keys added by templates are not left behind when they are removed from the template
  444. for _, key := range keys {
  445. delete(secret.Data, key)
  446. }
  447. // WARNING: this will remove any labels or annotations managed by this ExternalSecret
  448. // so any updates to labels and annotations should be done AFTER this point
  449. err = r.ApplyTemplate(ctx, externalSecret, secret, dataMap)
  450. if err != nil {
  451. return fmt.Errorf(errApplyTemplate, err)
  452. }
  453. }
  454. // we also use a label to keep track of the owner of the secret
  455. // this lets us remove secrets that are no longer needed if the target secret name changes
  456. if externalSecret.Spec.Target.CreationPolicy == esv1.CreatePolicyOwner {
  457. lblValue := esutils.ObjectHash(fmt.Sprintf("%v/%v", externalSecret.Namespace, externalSecret.Name))
  458. secret.Labels[esv1.LabelOwner] = lblValue
  459. } else {
  460. // the label should not be set if the creation policy is not Owner
  461. delete(secret.Labels, esv1.LabelOwner)
  462. }
  463. secret.Labels[esv1.LabelManaged] = esv1.LabelManagedValue
  464. secret.Annotations[esv1.AnnotationDataHash] = esutils.ObjectHash(secret.Data)
  465. return nil
  466. }
  467. switch externalSecret.Spec.Target.CreationPolicy {
  468. case esv1.CreatePolicyNone:
  469. log.V(1).Info("secret creation skipped due to CreationPolicy=None")
  470. err = nil
  471. case esv1.CreatePolicyMerge:
  472. // update the secret, if it exists
  473. if existingSecret.UID != "" {
  474. err = r.updateSecret(ctx, existingSecret, mutationFunc, externalSecret, secretName)
  475. } else {
  476. // if the secret does not exist, we wait until the next refresh interval
  477. // rather than returning an error which would requeue immediately
  478. r.markAsDone(externalSecret, start, log, esv1.ConditionReasonSecretMissing, msgMissing)
  479. return r.getRequeueResult(externalSecret), nil
  480. }
  481. case esv1.CreatePolicyOrphan:
  482. // create the secret, if it does not exist
  483. if existingSecret.UID == "" {
  484. err = r.createSecret(ctx, mutationFunc, externalSecret, secretName)
  485. } else {
  486. // if the secret exists, we should update it
  487. err = r.updateSecret(ctx, existingSecret, mutationFunc, externalSecret, secretName)
  488. }
  489. case esv1.CreatePolicyOwner:
  490. // we may have orphaned secrets to clean up,
  491. // for example, if the target secret name was changed
  492. err = r.deleteOrphanedSecrets(ctx, externalSecret, secretName)
  493. if err != nil {
  494. r.markAsFailed(msgErrorDeleteOrphaned, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonSecretSyncedError)
  495. return ctrl.Result{}, err
  496. }
  497. // create the secret, if it does not exist
  498. if existingSecret.UID == "" {
  499. err = r.createSecret(ctx, mutationFunc, externalSecret, secretName)
  500. } else {
  501. // if the secret exists, we should update it
  502. err = r.updateSecret(ctx, existingSecret, mutationFunc, externalSecret, secretName)
  503. }
  504. }
  505. if err != nil {
  506. // if we got an update conflict, we should requeue immediately
  507. if apierrors.IsConflict(err) {
  508. log.V(1).Info("conflict while updating secret, will requeue")
  509. return ctrl.Result{Requeue: true}, nil
  510. }
  511. // detect errors indicating that we failed to set ourselves as the owner of the secret
  512. // NOTE: this error cant be fixed by retrying so we don't return an error (which would requeue immediately)
  513. if errors.Is(err, ErrSecretSetCtrlRef) {
  514. r.markAsFailed(msgErrorBecomeOwner, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonSecretSyncedError)
  515. return ctrl.Result{}, nil
  516. }
  517. // detect errors indicating that the secret has another ExternalSecret as owner
  518. // NOTE: this error cant be fixed by retrying so we don't return an error (which would requeue immediately)
  519. if errors.Is(err, ErrSecretIsOwned) {
  520. r.markAsFailed(msgErrorIsOwned, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonSecretSyncedError)
  521. return ctrl.Result{}, nil
  522. }
  523. // detect errors indicating that the secret is immutable
  524. // NOTE: this error cant be fixed by retrying so we don't return an error (which would requeue immediately)
  525. if errors.Is(err, ErrSecretImmutable) {
  526. r.markAsFailed(msgErrorUpdateImmutable, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonSecretSyncedError)
  527. return ctrl.Result{}, nil
  528. }
  529. r.markAsFailed(msgErrorUpdateSecret, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonSecretSyncedError)
  530. return ctrl.Result{}, err
  531. }
  532. r.markAsDone(externalSecret, start, log, esv1.ConditionReasonSecretSynced, msgSynced)
  533. return r.getRequeueResult(externalSecret), nil
  534. }
  535. // reconcileGenericTarget handles reconciliation for generic targets (ConfigMaps, Custom Resources).
  536. func (r *Reconciler) reconcileGenericTarget(ctx context.Context, externalSecret *esv1.ExternalSecret, log logr.Logger, start time.Time, resourceLabels map[string]string, syncCallsError *prometheus.CounterVec) (ctrl.Result, error) {
  537. // retrieve the provider secret data
  538. dataMap, err := r.GetProviderSecretData(ctx, externalSecret)
  539. if err != nil {
  540. r.markAsFailed(msgErrorGetSecretData, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonResourceSyncedError)
  541. return ctrl.Result{}, err
  542. }
  543. // if no data was found, handle it according to deletion policy
  544. if len(dataMap) == 0 {
  545. switch externalSecret.Spec.Target.DeletionPolicy {
  546. case esv1.DeletionPolicyDelete:
  547. // safeguard that we only can delete resources we own
  548. creationPolicy := externalSecret.Spec.Target.CreationPolicy
  549. if creationPolicy != esv1.CreatePolicyOwner {
  550. err = fmt.Errorf("unable to delete resource: creationPolicy=%s is not Owner", creationPolicy)
  551. r.markAsFailed("could not delete resource", err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonResourceSyncedError)
  552. return ctrl.Result{}, nil
  553. }
  554. // delete the resource if it exists
  555. err = r.deleteGenericResource(ctx, log, externalSecret)
  556. if err != nil {
  557. r.markAsFailed("could not delete resource", err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonResourceSyncedError)
  558. return ctrl.Result{}, err
  559. }
  560. r.markAsDone(externalSecret, start, log, esv1.ConditionReasonResourceDeleted, msgDeleted)
  561. return r.getRequeueResult(externalSecret), nil
  562. case esv1.DeletionPolicyRetain:
  563. r.markAsDone(externalSecret, start, log, esv1.ConditionReasonResourceSynced, msgSyncedRetain)
  564. return r.getRequeueResult(externalSecret), nil
  565. case esv1.DeletionPolicyMerge:
  566. // continue to process with empty data
  567. }
  568. }
  569. // render the template for the manifest
  570. obj, err := r.applyTemplateToManifest(ctx, externalSecret, dataMap)
  571. if err != nil {
  572. r.markAsFailed("could not apply template to manifest", err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonResourceSyncedError)
  573. return ctrl.Result{}, err
  574. }
  575. // handle creation policies
  576. switch externalSecret.Spec.Target.CreationPolicy {
  577. case esv1.CreatePolicyNone:
  578. log.V(1).Info("resource creation skipped due to CreationPolicy=None")
  579. err = nil
  580. case esv1.CreatePolicyMerge:
  581. // for Merge policy, only update if resource exists
  582. existing, getErr := r.getGenericResource(ctx, log, externalSecret)
  583. if getErr != nil && !apierrors.IsNotFound(getErr) {
  584. r.markAsFailed("could not get target resource", getErr, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonResourceSyncedError)
  585. return ctrl.Result{}, getErr
  586. }
  587. if existing == nil || existing.GetUID() == "" {
  588. r.markAsDone(externalSecret, start, log, esv1.ConditionReasonResourceMissing, "resource will not be created due to CreationPolicy=Merge")
  589. return r.getRequeueResult(externalSecret), nil
  590. }
  591. obj.SetResourceVersion(existing.GetResourceVersion())
  592. obj.SetUID(existing.GetUID())
  593. // update the existing resource
  594. err = r.updateGenericResource(ctx, log, externalSecret, obj)
  595. case esv1.CreatePolicyOrphan, esv1.CreatePolicyOwner:
  596. existing, getErr := r.getGenericResource(ctx, log, externalSecret)
  597. if getErr != nil && !apierrors.IsNotFound(getErr) {
  598. r.markAsFailed("could not get target resource", getErr, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonResourceSyncedError)
  599. return ctrl.Result{}, getErr
  600. }
  601. if existing != nil {
  602. obj.SetResourceVersion(existing.GetResourceVersion())
  603. obj.SetUID(existing.GetUID())
  604. err = r.updateGenericResource(ctx, log, externalSecret, obj)
  605. } else {
  606. err = r.createGenericResource(ctx, log, externalSecret, obj)
  607. }
  608. }
  609. if err != nil {
  610. // if we got an update conflict, requeue immediately
  611. if apierrors.IsConflict(err) {
  612. log.V(1).Info("conflict while updating resource, will requeue")
  613. return ctrl.Result{RequeueAfter: 1 * time.Second}, nil
  614. }
  615. r.markAsFailed(msgErrorUpdateSecret, err, externalSecret, syncCallsError.With(resourceLabels), esv1.ConditionReasonResourceSyncedError)
  616. return ctrl.Result{}, err
  617. }
  618. // Ensure an informer exists for this GVK to enable drift detection (only if not already managed)
  619. gvk := getTargetGVK(externalSecret)
  620. esName := types.NamespacedName{Name: externalSecret.Name, Namespace: externalSecret.Namespace}
  621. if _, err := r.informerManager.EnsureInformer(ctx, gvk, esName); err != nil {
  622. // Log the error but don't fail reconciliation - the resource was successfully created/updated
  623. log.Error(err, "failed to register informer for generic target, drift detection may not work",
  624. "group", gvk.Group,
  625. "version", gvk.Version,
  626. "kind", gvk.Kind)
  627. }
  628. r.markAsDone(externalSecret, start, log, esv1.ConditionReasonResourceSynced, msgSynced)
  629. return r.getRequeueResult(externalSecret), nil
  630. }
  631. // getRequeueResult create a result with requeueAfter based on the ExternalSecret refresh interval.
  632. func (r *Reconciler) getRequeueResult(externalSecret *esv1.ExternalSecret) ctrl.Result {
  633. // default to the global requeue interval
  634. // note, this will never be used because the CRD has a default value of 1 hour
  635. refreshInterval := r.RequeueInterval
  636. if externalSecret.Spec.RefreshInterval != nil {
  637. refreshInterval = externalSecret.Spec.RefreshInterval.Duration
  638. }
  639. // if the refresh interval is <= 0, we should not requeue
  640. if refreshInterval <= 0 {
  641. return ctrl.Result{}
  642. }
  643. // if the last refresh time is not set, requeue after the refresh interval
  644. // note, this should not happen, as we only call this function on ExternalSecrets
  645. // that have been reconciled at least once
  646. if externalSecret.Status.RefreshTime.IsZero() {
  647. return ctrl.Result{RequeueAfter: refreshInterval}
  648. }
  649. timeSinceLastRefresh := time.Since(externalSecret.Status.RefreshTime.Time)
  650. // if the last refresh time is in the future, we should requeue immediately
  651. // note, this should not happen, as we always refresh an ExternalSecret
  652. // that has a last refresh time in the future
  653. if timeSinceLastRefresh < 0 {
  654. return ctrl.Result{Requeue: true}
  655. }
  656. // if there is time remaining, requeue after the remaining time
  657. if timeSinceLastRefresh < refreshInterval {
  658. return ctrl.Result{RequeueAfter: refreshInterval - timeSinceLastRefresh}
  659. }
  660. // otherwise, requeue immediately
  661. return ctrl.Result{Requeue: true}
  662. }
  663. func (r *Reconciler) markAsDone(externalSecret *esv1.ExternalSecret, start time.Time, log logr.Logger, reason, msg string) {
  664. oldReadyCondition := GetExternalSecretCondition(externalSecret.Status, esv1.ExternalSecretReady)
  665. newReadyCondition := NewExternalSecretCondition(esv1.ExternalSecretReady, v1.ConditionTrue, reason, msg)
  666. SetExternalSecretCondition(externalSecret, *newReadyCondition)
  667. externalSecret.Status.RefreshTime = metav1.NewTime(start)
  668. externalSecret.Status.SyncedResourceVersion = ctrlutil.GetResourceVersion(externalSecret.ObjectMeta)
  669. // if the status or reason has changed, log at the appropriate verbosity level
  670. if oldReadyCondition == nil || oldReadyCondition.Status != newReadyCondition.Status || oldReadyCondition.Reason != newReadyCondition.Reason {
  671. if newReadyCondition.Reason == esv1.ConditionReasonSecretDeleted {
  672. log.Info("deleted secret")
  673. } else {
  674. log.Info("reconciled secret")
  675. }
  676. } else {
  677. log.V(1).Info("reconciled secret")
  678. }
  679. }
  680. func (r *Reconciler) markAsFailed(msg string, err error, externalSecret *esv1.ExternalSecret, counter prometheus.Counter, reason string) {
  681. r.recorder.Event(externalSecret, v1.EventTypeWarning, esv1.ReasonUpdateFailed, err.Error())
  682. conditionSynced := NewExternalSecretCondition(esv1.ExternalSecretReady, v1.ConditionFalse, reason, msg)
  683. SetExternalSecretCondition(externalSecret, *conditionSynced)
  684. counter.Inc()
  685. }
  686. func (r *Reconciler) cleanupManagedSecrets(ctx context.Context, log logr.Logger, externalSecret *esv1.ExternalSecret) error {
  687. // Only delete resources if DeletionPolicy is Delete
  688. if externalSecret.Spec.Target.DeletionPolicy != esv1.DeletionPolicyDelete {
  689. log.V(1).Info("skipping resource deletion due to DeletionPolicy", "policy", externalSecret.Spec.Target.DeletionPolicy)
  690. return nil
  691. }
  692. // if this is a generic target, use deleteGenericResource
  693. if isGenericTarget(externalSecret) {
  694. return r.deleteGenericResource(ctx, log, externalSecret)
  695. }
  696. // handle Secret deletion
  697. secretName := externalSecret.Spec.Target.Name
  698. if secretName == "" {
  699. secretName = externalSecret.Name
  700. }
  701. var secret v1.Secret
  702. err := r.Get(ctx, types.NamespacedName{Name: secretName, Namespace: externalSecret.Namespace}, &secret)
  703. if err != nil {
  704. if apierrors.IsNotFound(err) {
  705. return nil
  706. }
  707. return err
  708. }
  709. // Only delete if we own it
  710. if metav1.IsControlledBy(&secret, externalSecret) {
  711. if err := r.Delete(ctx, &secret); err != nil && !apierrors.IsNotFound(err) {
  712. return err
  713. }
  714. log.V(1).Info("deleted managed secret", "secret", secretName)
  715. }
  716. return nil
  717. }
  718. func (r *Reconciler) deleteOrphanedSecrets(ctx context.Context, externalSecret *esv1.ExternalSecret, secretName string) error {
  719. ownerLabel := esutils.ObjectHash(fmt.Sprintf("%v/%v", externalSecret.Namespace, externalSecret.Name))
  720. // we use a PartialObjectMetadataList to avoid loading the full secret objects
  721. // and because the Secrets partials are always cached due to WatchesMetadata() in SetupWithManager()
  722. secretListPartial := &metav1.PartialObjectMetadataList{}
  723. secretListPartial.SetGroupVersionKind(v1.SchemeGroupVersion.WithKind("SecretList"))
  724. listOpts := &client.ListOptions{
  725. LabelSelector: labels.SelectorFromSet(map[string]string{
  726. esv1.LabelOwner: ownerLabel,
  727. }),
  728. Namespace: externalSecret.Namespace,
  729. }
  730. if err := r.List(ctx, secretListPartial, listOpts); err != nil {
  731. return err
  732. }
  733. // delete all secrets that are not the target secret
  734. for _, secretPartial := range secretListPartial.Items {
  735. if secretPartial.GetName() != secretName {
  736. err := r.Delete(ctx, &secretPartial)
  737. if err != nil && !apierrors.IsNotFound(err) {
  738. return err
  739. }
  740. r.recorder.Event(externalSecret, v1.EventTypeNormal, esv1.ReasonDeleted, eventDeletedOrphaned)
  741. }
  742. }
  743. return nil
  744. }
  745. // createSecret creates a new secret with the given mutation function.
  746. func (r *Reconciler) createSecret(ctx context.Context, mutationFunc func(secret *v1.Secret) error, es *esv1.ExternalSecret, secretName string) error {
  747. fqdn := fqdnFor(es.Name)
  748. // define and mutate the new secret
  749. newSecret := &v1.Secret{
  750. ObjectMeta: metav1.ObjectMeta{
  751. Name: secretName,
  752. Namespace: es.Namespace,
  753. Labels: map[string]string{},
  754. Annotations: map[string]string{},
  755. },
  756. Data: make(map[string][]byte),
  757. }
  758. if err := mutationFunc(newSecret); err != nil {
  759. return err
  760. }
  761. // note, we set field owner even for Create
  762. if err := r.Create(ctx, newSecret, client.FieldOwner(fqdn)); err != nil {
  763. return err
  764. }
  765. // set the binding reference to the secret
  766. // https://github.com/external-secrets/external-secrets/pull/2263
  767. es.Status.Binding = v1.LocalObjectReference{Name: newSecret.Name}
  768. r.recorder.Event(es, v1.EventTypeNormal, esv1.ReasonCreated, eventCreated)
  769. return nil
  770. }
  771. func (r *Reconciler) updateSecret(ctx context.Context, existingSecret *v1.Secret, mutationFunc func(secret *v1.Secret) error, es *esv1.ExternalSecret, secretName string) error {
  772. fqdn := fqdnFor(es.Name)
  773. // fail if the secret does not exist
  774. // this should never happen because we check this before calling this function
  775. if existingSecret.UID == "" {
  776. return fmt.Errorf(errUpdateNotFound, secretName)
  777. }
  778. // set the binding reference to the secret
  779. // https://github.com/external-secrets/external-secrets/pull/2263
  780. es.Status.Binding = v1.LocalObjectReference{Name: secretName}
  781. // mutate a copy of the existing secret with the mutation function
  782. updatedSecret := existingSecret.DeepCopy()
  783. if err := mutationFunc(updatedSecret); err != nil {
  784. return fmt.Errorf(errMutate, updatedSecret.Name, err)
  785. }
  786. // if the secret does not need to be updated, return early
  787. if equality.Semantic.DeepEqual(existingSecret, updatedSecret) {
  788. return nil
  789. }
  790. // if the existing secret is immutable, we can only update the object metadata
  791. if ptr.Deref(existingSecret.Immutable, false) {
  792. // check if the metadata was changed
  793. metadataChanged := !equality.Semantic.DeepEqual(existingSecret.ObjectMeta, updatedSecret.ObjectMeta)
  794. // check if the immutable data/type was changed
  795. var dataChanged bool
  796. if metadataChanged {
  797. // update the `existingSecret` object with the metadata from `updatedSecret`
  798. // this lets us compare the objects to see if the immutable data/type was changed
  799. existingSecret.ObjectMeta = *updatedSecret.ObjectMeta.DeepCopy()
  800. dataChanged = !equality.Semantic.DeepEqual(existingSecret, updatedSecret)
  801. // because we use labels and annotations to keep track of the secret,
  802. // we need to update the metadata, regardless of if the immutable data was changed
  803. // NOTE: we are using the `existingSecret` object here, as we ONLY want to update the metadata,
  804. // and we previously copied the metadata from the `updatedSecret` object
  805. if err := r.Update(ctx, existingSecret, client.FieldOwner(fqdn)); err != nil {
  806. // if we get a conflict, we should return early to requeue immediately
  807. // note, we don't wrap this error so we can handle it in the caller
  808. if apierrors.IsConflict(err) {
  809. return err
  810. }
  811. return fmt.Errorf(errUpdate, existingSecret.Name, err)
  812. }
  813. } else {
  814. // we know there was some change in the secret (or we would have returned early)
  815. // we know the metadata was NOT changed (metadataChanged == false)
  816. // so, the only thing that could have changed is the immutable data/type fields
  817. dataChanged = true
  818. }
  819. // if the immutable data was changed, we should return an error
  820. if dataChanged {
  821. return fmt.Errorf(errUpdate, existingSecret.Name, ErrSecretImmutable)
  822. }
  823. }
  824. // update the secret
  825. if err := r.Update(ctx, updatedSecret, client.FieldOwner(fqdn)); err != nil {
  826. // if we get a conflict, we should return early to requeue immediately
  827. // note, we don't wrap this error so we can handle it in the caller
  828. if apierrors.IsConflict(err) {
  829. return err
  830. }
  831. return fmt.Errorf(errUpdate, updatedSecret.Name, err)
  832. }
  833. r.recorder.Event(es, v1.EventTypeNormal, esv1.ReasonUpdated, eventUpdated)
  834. return nil
  835. }
  836. // getManagedDataKeys returns the list of data keys in a secret which are managed by a specified owner.
  837. func getManagedDataKeys(secret *v1.Secret, fieldOwner string) ([]string, error) {
  838. return getManagedFieldKeys(secret, fieldOwner, func(fields map[string]any) []string {
  839. dataFields := fields["f:data"]
  840. if dataFields == nil {
  841. return nil
  842. }
  843. df, ok := dataFields.(map[string]any)
  844. if !ok {
  845. return nil
  846. }
  847. return slices.Collect(maps.Keys(df))
  848. })
  849. }
  850. func getManagedFieldKeys(
  851. secret *v1.Secret,
  852. fieldOwner string,
  853. process func(fields map[string]any) []string,
  854. ) ([]string, error) {
  855. fqdn := fqdnFor(fieldOwner)
  856. var keys []string
  857. for _, v := range secret.ObjectMeta.ManagedFields {
  858. if v.Manager != fqdn {
  859. continue
  860. }
  861. fields := make(map[string]any)
  862. err := json.Unmarshal(v.FieldsV1.Raw, &fields)
  863. if err != nil {
  864. return nil, fmt.Errorf("error unmarshaling managed fields: %w", err)
  865. }
  866. for _, key := range process(fields) {
  867. if key == "." {
  868. continue
  869. }
  870. keys = append(keys, strings.TrimPrefix(key, "f:"))
  871. }
  872. }
  873. return keys, nil
  874. }
  875. func shouldSkipClusterSecretStore(r *Reconciler, es *esv1.ExternalSecret) bool {
  876. return !r.ClusterSecretStoreEnabled && es.Spec.SecretStoreRef.Kind == esv1.ClusterSecretStoreKind
  877. }
  878. // shouldSkipUnmanagedStore iterates over all secretStore references in the externalSecret spec,
  879. // fetches the store and evaluates the controllerClass property.
  880. // Returns true if any storeRef points to store with a non-matching controllerClass.
  881. func shouldSkipUnmanagedStore(ctx context.Context, namespace string, r *Reconciler, es *esv1.ExternalSecret) (bool, error) {
  882. var storeList []esv1.SecretStoreRef
  883. if es.Spec.SecretStoreRef.Name != "" {
  884. storeList = append(storeList, es.Spec.SecretStoreRef)
  885. }
  886. for _, ref := range es.Spec.Data {
  887. if ref.SourceRef != nil {
  888. storeList = append(storeList, ref.SourceRef.SecretStoreRef)
  889. }
  890. }
  891. for _, ref := range es.Spec.DataFrom {
  892. if ref.SourceRef != nil && ref.SourceRef.SecretStoreRef != nil {
  893. storeList = append(storeList, *ref.SourceRef.SecretStoreRef)
  894. }
  895. // verify that generator's controllerClass matches
  896. if ref.SourceRef != nil && ref.SourceRef.GeneratorRef != nil {
  897. _, obj, err := resolvers.GeneratorRef(ctx, r.Client, r.Scheme, namespace, ref.SourceRef.GeneratorRef)
  898. if err != nil {
  899. if apierrors.IsNotFound(err) {
  900. // skip non-existent generators
  901. continue
  902. }
  903. if errors.Is(err, resolvers.ErrUnableToGetGenerator) {
  904. // skip generators that we can't get (e.g. due to being invalid)
  905. continue
  906. }
  907. return false, err
  908. }
  909. skipGenerator, err := shouldSkipGenerator(r, obj)
  910. if err != nil {
  911. return false, err
  912. }
  913. if skipGenerator {
  914. return true, nil
  915. }
  916. }
  917. }
  918. for _, ref := range storeList {
  919. var store esv1.GenericStore
  920. switch ref.Kind {
  921. case esv1.SecretStoreKind, "":
  922. store = &esv1.SecretStore{}
  923. case esv1.ClusterSecretStoreKind:
  924. store = &esv1.ClusterSecretStore{}
  925. namespace = ""
  926. default:
  927. return false, fmt.Errorf("unsupported secret store kind: %s", ref.Kind)
  928. }
  929. err := r.Get(ctx, types.NamespacedName{
  930. Name: ref.Name,
  931. Namespace: namespace,
  932. }, store)
  933. if err != nil {
  934. if apierrors.IsNotFound(err) {
  935. // skip non-existent stores
  936. continue
  937. }
  938. return false, err
  939. }
  940. class := store.GetSpec().Controller
  941. if class != "" && class != r.ControllerClass {
  942. return true, nil
  943. }
  944. }
  945. return false, nil
  946. }
  947. func shouldRefresh(es *esv1.ExternalSecret) bool {
  948. switch es.Spec.RefreshPolicy {
  949. case esv1.RefreshPolicyCreatedOnce:
  950. if es.Status.SyncedResourceVersion == "" || es.Status.RefreshTime.IsZero() {
  951. return true
  952. }
  953. return false
  954. case esv1.RefreshPolicyOnChange:
  955. if es.Status.SyncedResourceVersion == "" || es.Status.RefreshTime.IsZero() {
  956. return true
  957. }
  958. return es.Status.SyncedResourceVersion != ctrlutil.GetResourceVersion(es.ObjectMeta)
  959. case esv1.RefreshPolicyPeriodic:
  960. return shouldRefreshPeriodic(es)
  961. default:
  962. return shouldRefreshPeriodic(es)
  963. }
  964. }
  965. func shouldRefreshPeriodic(es *esv1.ExternalSecret) bool {
  966. // if the refresh interval is 0, and we have synced previously, we should not refresh
  967. if es.Spec.RefreshInterval.Duration <= 0 && es.Status.SyncedResourceVersion != "" {
  968. return false
  969. }
  970. // if the ExternalSecret has been updated, we should refresh
  971. if es.Status.SyncedResourceVersion != ctrlutil.GetResourceVersion(es.ObjectMeta) {
  972. return true
  973. }
  974. // if the last refresh time is zero, we should refresh
  975. if es.Status.RefreshTime.IsZero() {
  976. return true
  977. }
  978. // if the last refresh time is in the future, we should refresh
  979. if es.Status.RefreshTime.Time.After(time.Now()) {
  980. return true
  981. }
  982. // if the last refresh time + refresh interval is before now, we should refresh
  983. return es.Status.RefreshTime.Add(es.Spec.RefreshInterval.Duration).Before(time.Now())
  984. }
  985. // isSecretValid checks if the secret exists, and it's data is consistent with the calculated hash.
  986. func isSecretValid(existingSecret *v1.Secret, es *esv1.ExternalSecret) bool {
  987. // Secret is always valid with `CreationPolicy=Orphan`
  988. if es.Spec.Target.CreationPolicy == esv1.CreatePolicyOrphan {
  989. return true
  990. }
  991. if existingSecret.UID == "" {
  992. return false
  993. }
  994. // if the managed label is missing or incorrect, then it's invalid
  995. if existingSecret.Labels[esv1.LabelManaged] != esv1.LabelManagedValue {
  996. return false
  997. }
  998. // if the data-hash annotation is missing or incorrect, then it's invalid
  999. // this is how we know if the data has chanced since we last updated the secret
  1000. if existingSecret.Annotations[esv1.AnnotationDataHash] != esutils.ObjectHash(existingSecret.Data) {
  1001. return false
  1002. }
  1003. return true
  1004. }
  1005. // SetupWithManager returns a new controller builder that will be started by the provided Manager.
  1006. func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager, opts controller.Options) error {
  1007. r.recorder = mgr.GetEventRecorderFor("external-secrets")
  1008. // Initialize informer manager only if generic targets are allowed
  1009. if r.AllowGenericTargets && r.informerManager == nil {
  1010. r.informerManager = NewInformerManager(ctx, mgr.GetCache(), r.Client, r.Log.WithName("informer-manager"))
  1011. }
  1012. // index ExternalSecrets based on the target secret name,
  1013. // this lets us quickly find all ExternalSecrets which target a specific Secret
  1014. if err := mgr.GetFieldIndexer().IndexField(ctx, &esv1.ExternalSecret{}, indexESTargetSecretNameField, func(obj client.Object) []string {
  1015. es := obj.(*esv1.ExternalSecret)
  1016. // Don't index generic targets here (they use indexESTargetResourceField)
  1017. if isGenericTarget(es) {
  1018. return nil
  1019. }
  1020. // if the target name is set, use that as the index
  1021. if es.Spec.Target.Name != "" {
  1022. return []string{es.Spec.Target.Name}
  1023. }
  1024. // otherwise, use the ExternalSecret name
  1025. return []string{es.Name}
  1026. }); err != nil {
  1027. return err
  1028. }
  1029. // index ExternalSecrets based on the target resource (GVK + name)
  1030. // this lets us quickly find all ExternalSecrets which target a specific generic resource
  1031. if err := mgr.GetFieldIndexer().IndexField(ctx, &esv1.ExternalSecret{}, indexESTargetResourceField, func(obj client.Object) []string {
  1032. es := obj.(*esv1.ExternalSecret)
  1033. if !r.AllowGenericTargets || !isGenericTarget(es) {
  1034. return nil
  1035. }
  1036. gvk := getTargetGVK(es)
  1037. targetName := getTargetName(es)
  1038. // Index format: "group/version/kind/name"
  1039. return []string{fmt.Sprintf("%s/%s/%s/%s", gvk.Group, gvk.Version, gvk.Kind, targetName)}
  1040. }); err != nil {
  1041. return err
  1042. }
  1043. // predicate function to ignore secret events unless they have the "managed" label
  1044. secretHasESLabel := predicate.NewPredicateFuncs(func(object client.Object) bool {
  1045. value, hasLabel := object.GetLabels()[esv1.LabelManaged]
  1046. return hasLabel && value == esv1.LabelManagedValue
  1047. })
  1048. // Build the controller
  1049. builder := ctrl.NewControllerManagedBy(mgr).
  1050. WithOptions(opts).
  1051. For(&esv1.ExternalSecret{}).
  1052. // we cant use Owns(), as we don't set ownerReferences when the creationPolicy is not Owner.
  1053. // we use WatchesMetadata() to reduce memory usage, as otherwise we have to process full secret objects.
  1054. WatchesMetadata(
  1055. &v1.Secret{},
  1056. handler.EnqueueRequestsFromMapFunc(r.findObjectsForSecret),
  1057. builder.WithPredicates(predicate.ResourceVersionChangedPredicate{}, secretHasESLabel),
  1058. )
  1059. // Watch generic targets dynamically via the informer manager
  1060. // Only add this watch source if the feature is enabled
  1061. if r.AllowGenericTargets {
  1062. builder = builder.WatchesRawSource(r.informerManager.Source())
  1063. }
  1064. return builder.Complete(r)
  1065. }
  1066. func (r *Reconciler) findObjectsForSecret(ctx context.Context, secret client.Object) []reconcile.Request {
  1067. externalSecretsList := &esv1.ExternalSecretList{}
  1068. listOps := &client.ListOptions{
  1069. FieldSelector: fields.OneTermEqualSelector(indexESTargetSecretNameField, secret.GetName()),
  1070. Namespace: secret.GetNamespace(),
  1071. }
  1072. err := r.List(ctx, externalSecretsList, listOps)
  1073. if err != nil {
  1074. return []reconcile.Request{}
  1075. }
  1076. requests := make([]reconcile.Request, len(externalSecretsList.Items))
  1077. for i := range externalSecretsList.Items {
  1078. requests[i] = reconcile.Request{
  1079. NamespacedName: types.NamespacedName{
  1080. Name: externalSecretsList.Items[i].GetName(),
  1081. Namespace: externalSecretsList.Items[i].GetNamespace(),
  1082. },
  1083. }
  1084. }
  1085. return requests
  1086. }