externalsecret_controller.go 54 KB

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